1. 概述
在使用Spring Data MongoDB时,我们可能需要将日志级别设置得比默认的更高。通常情况下,我们可能希望看到诸如语句执行或查询参数等额外信息。
在这篇简短的教程中,我们将学习如何修改MongoDB查询的日志级别。
2. 配置MongoDB查询日志
MongoDB支持提供了MongoOperations
接口或其主要的MongoTemplate
实现来访问数据,因此我们需要配置MongoTemplate
类的调试级别。
就像任何Spring或Java应用程序一样,我们可以使用一个日志库并为MongoTemplate
定义一个日志级别。
通常,我们可以在配置文件中写入类似的内容:
<logger name="org.springframework.data.mongodb.core.MongoTemplate" level="DEBUG" />
然而,如果我们正在运行一个Spring Boot应用,我们可以在application.properties
文件中进行配置:
logging.level.org.springframework.data.mongodb.core.MongoTemplate=DEBUG
同样,我们可以使用YAML
语法:
logging:
level:
org:
springframework:
data:
mongodb:
core:
MongoTemplate: DEBUG
3. 日志测试类
首先,让我们创建一个Book
类:
@Document(collection = "book")
public class Book {
@MongoId
private ObjectId id;
private String bookName;
private String authorName;
// getters and setters
}
我们想要创建一个简单的测试类,并查看日志。
为了演示这一点,我们将使用嵌入式MongoDB。首先,让我们检查一下我们的依赖关系:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
<groupId>de.flapdoodle.embed</groupId>
<artifactId>de.flapdoodle.embed.mongo</artifactId>
<version>${embed.mongo.version}</version>
<scope>test</scope>
</dependency>
最后,让我们使用Spring Boot测试定义我们的测试类:
@SpringBootTest
@TestPropertySource(properties = { "logging.level.org.springframework.data.mongodb.core.MongoTemplate=DEBUG" })
public class LoggingUnitTest {
private static final String CONNECTION_STRING = "mongodb://%s:%d";
private MongodExecutable mongodExecutable;
private MongoTemplate mongoTemplate;
@AfterEach
void clean() {
mongodExecutable.stop();
}
@BeforeEach
void setup() throws Exception {
String ip = "localhost";
int port = 27017;
ImmutableMongodConfig mongodbConfig = MongodConfig.builder()
.version(Version.Main.PRODUCTION)
.net(new Net(ip, port, Network.localhostIsIPv6()))
.build();
MongodStarter starter = MongodStarter.getDefaultInstance();
mongodExecutable = starter.prepare(mongodbConfig);
mongodExecutable.start();
mongoTemplate = new MongoTemplate(MongoClients.create(String.format(CONNECTION_STRING, ip, port)), "test");
}
// tests
}
4. 日志示例
在这一部分,我们将定义一些简单的测试用例,并展示相关的日志,以测试最常见的情况,如查找、插入、更新或聚合文档。
4.1. 插入
首先,让我们从插入单个文档开始:
Book book = new Book();
book.setBookName("Book");
book.setAuthorName("Author");
mongoTemplate.insert(book);
日志会显示我们在哪个集合中插入。在查找文档时,也会记录id:
[2022-03-20 17:42:47,093]-[main] DEBUG MongoTemplate - Inserting Document containing fields: [bookName, authorName, _class] in collection: book
...
[2022-03-20 17:42:47,144]-[main] DEBUG MongoTemplate - findOne using query: { "id" : { "$oid" : "623759871ff6275fe96a5ecb"}} fields: Document{{}} for class: class com.baeldung.mongodb.models.Book in collection: book
[2022-03-20 17:42:47,149]-[main] DEBUG MongoTemplate - findOne using query: { "_id" : { "$oid" : "623759871ff6275fe96a5ecb"}} fields: {} in db.collection: test.book
4.2. 更新
同样,当更新文档时:
Book book = new Book();
book.setBookName("Book");
book.setAuthorName("Author");
mongoTemplate.insert(book);
String authorNameUpdate = "AuthorNameUpdate";
book.setAuthorName(authorNameUpdate);
mongoTemplate.updateFirst(query(where("bookName").is("Book")), update("authorName", authorNameUpdate), Book.class);
我们可以看到日志中实际更新的文档字段:
[2022-03-20 17:48:31,759]-[main] DEBUG MongoTemplate - Calling update using query: { "bookName" : "Book"} and update: { "$set" : { "authorName" : "AuthorNameUpdate"}} in collection: book
4.3. 批量插入
让我们添加一个批量插入的例子:
Book book = new Book();
book.setBookName("Book");
book.setAuthorName("Author");
Book book1 = new Book();
book1.setBookName("Book1");
book1.setAuthorName("Author1");
mongoTemplate.insert(Arrays.asList(book, book1), Book.class);
我们可以看到日志中插入的文档数量:
[2022-03-20 17:52:00,564]-[main] DEBUG MongoTemplate - Inserting list of Documents containing 2 items
4.4. 删除
同样,我们添加一个删除的例子:
Book book = new Book();
book.setBookName("Book");
book.setAuthorName("Author");
mongoTemplate.insert(book);
mongoTemplate.remove(book);
在这种情况下,日志中会显示被删除文档的id:
[2022-03-20 17:56:42,151]-[main] DEBUG MongoTemplate - Remove using query: { "_id" : { "$oid" : "62375cca2a2cba4db774d8c1"}} in collection: book.
4.5. 聚合
让我们看看聚合的例子。在这个例子中,我们需要定义一个结果类。例如,我们将根据作者名称进行聚合:
public class GroupByAuthor {
@Id
private String authorName;
private int authCount;
// getters and setters
}
接下来,我们定义一个分组的测试用例:
Book book = new Book();
book.setBookName("Book");
book.setAuthorName("Author");
Book book1 = new Book();
book1.setBookName("Book1");
book1.setAuthorName("Author");
Book book2 = new Book();
book2.setBookName("Book2");
book2.setAuthorName("Author");
mongoTemplate.insert(Arrays.asList(book, book1, book2), Book.class);
GroupOperation groupByAuthor = group("authorName")
.count()
.as("authCount");
Aggregation aggregation = newAggregation(groupByAuthor);
AggregationResults<GroupByAuthor> aggregationResults = mongoTemplate.aggregate(aggregation, "book", GroupByAuthor.class);
我们可以看到日志中显示的聚合字段以及聚合管道:
[2022-03-20 17:58:51,237]-[main] DEBUG MongoTemplate - Executing aggregation: [{ "$group" : { "_id" : "$authorName", "authCount" : { "$sum" : 1}}}] in collection book
5. 总结
在这篇文章中,我们探讨了如何在Spring Data MongoDB中启用调试日志级别。
我们定义了一些常见的查询场景,并在实际测试中查看了相应的日志。
如往常一样,这些示例的代码可以在GitHub上找到这里。