Spring Date MongoDB 查询返回指定字段

我就是我 2022-10-28 10:13 241阅读 0赞

最近的工作内容是重构会员合同，什么是合同(电子合同)？作为第三方支付公司，合同其实就是我们写商户签订的合约。里面包含允许商户操作业务类型、支付方法各种手续费配置及商户结算相关的配置。由于需要考虑到扩展性，所以合同设计采用了三级结构的设计。合同只会保存当时有效的版本在数据库里面，但是产品需求是能够展示合同的的变通记录，也就是合同的版本的概念。

## 1、系统引入 MongoDB ##

由于合同是一种三级结构，其实这个时候可以把它看成一种树形结构。这个时候要动态的比对合同的变化情况，需要把合同的原合同信息与当前合同信息都保存起来。但是数据库里面应该只会保存当前有效的这个合同。所以在设计的时候就引入了 MongoDB 这个文档型数据。在保存合同信息在 MongodDB 时，设计的数据结构大概如下：

> ContractChangeInfo.java

private class ContractChangeInfo { 
    
    	// mongoDB id
    	private String _id;
    
    	// 合同变通请求号
    	private String requestNo;
    
    	// 商户号
    	private String merchantNo;
    
    	// 合同号
    	private String contractNo;
    
    	// 原合同树形信息
    	private ContractInfo sourceContract;
    
    	// 变更后的合同信息
    	private ContractInfo targetContract;
    
    	// 变更人
    	private String modifier;
    
    	// 变更时间
    	private Date modifiedTime;
    
    	......
    }

所以在 MongoDB 里面保留了历史版本，比如：

*  商户在 2020-01-01 这个时间点签订了子合同 A，数据库保存了合同 A 同时在 MongoDB，这个时候的合同版本就是 1。
 *  商户在 2020-02-01 这个时间点由于业务需求添加了新的业务方式比如：收单，这个时候数据库保存的是最新的合同 A1并且把A 和 A1 这个合同内容保存到了 MongoDB，这个时候合同的版本号就是 2。
 *  商户在 2020-04-01 这个时间点由于业务量在我公司上来了，需要把它的手续费降低，这个时候数据库保存的是合同 A2 并且把 A1 和 A2 都保存到了 MongoDB，这个时候的合同的版本号就是 3.

在合同详情页面的时候就需要展示它的变更历史时间以及在版本1 之后都会展示在合同 2 的时候展示合同 2 与 合同1 修改了什么。合同 3 的后面展示合同 3 与合同 2 的修改点。

合同对比内部其实有点类似 Apollo 的发布历史：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70]  
同时在合同进行对比上与借鉴了一下 Apollo 里面的对比机制，以支付方式为例：

*  先对需要对比的版本合同`ContractInfo targetContract` 根据：`业务类型 + 支付方式` 进行分组，后文以 **变更合同映射** 称呼
 *  先对上一个版本的合同`ContractInfo sourceContract` 根据：`业务类型 + 支付方式` 进行分组，后文以 **原合同映射** 称呼
 *  先以 **原合同映射** 为基准数据进行 `Map#entrySet` 遍历，如果在 **变更合同映射** 里面根据前者的 Key 找不到该支付方式就说明是 **删除** 了该支付方式。如果在 **变更合同映射** 里面找得到就比较两者是否存在差异，如果存在就说明 **修改** 了该支付方式。
 *  然后以 **变更合同映射** 进行 `Map#entrySet` 遍历，如果在 **原合同映射** 根据前者的 Key 找不到该支付方式就说明这个支付方式是 **新增的**。

## 2、Mongo 支持查询返回指定字段 ##

当然进行合同对比的时候就需要查询合同修改信息的，但是我们在查询数据的时候。有些信息是需要的，有些信息是可以不需要的。就像我们使用 Mysql 进行查询的时候，我们可以指定哪些字段进行返回。同样的 mongoDB 在查询数据的时候也支持保存的文档数据是可以指定数据里面哪些字段是可以返回的，哪些字段是可以排除的。

默认情况下，MongoDB查询返回匹配文档中的所有字段。为了限制MongoDB发送给应用程序的数据量，可以包含一个投影文档来指定或限制返回的字段。

> 返回所有的字段

如果不指定投影文档，db.collection.find()方法将返回匹配文档中的所有字段。

以下示例返回库存集合中状态为“A”的所有文档中的所有字段:

db.inventory.find( {  status: "A" } )

对应的SQL语句如下:

SELECT * from inventory WHERE status = "A"

> 只返回指定的字段和\_id字段

通过将投影文档中的 field 设置为1，投影可以显式地包含几个字段。下面的操作返回与查询匹配的所有文档。在结果集中，只有item、status和\_id字段(默认情况下)在匹配的文档中返回。

db.inventory.find( {  status: "A" }, {  item: 1, status: 1 } )

对应的SQL语句如下:

SELECT _id, item, status from inventory WHERE status = "A"

> 排除 \_id 字段

也可以在投影中将\_id字段设置为0，从而从结果中删除它，示例如下:

db.inventory.find( {  status: "A" }, {  item: 1, status: 1, _id: 0 } )

对应的SQL语句如下:

SELECT item, status from inventory WHERE status = "A"

> 返回其它字段不包括排除字段

mongoDB 同样支持使用投影来排除特定的字段，而不是列出要在匹配文档中返回的字段。以下示例返回匹配文档中除 status 和 instock 字段外的所有字段:。

db.inventory.find( {  status: "A" }, {  status: 0, instock: 0 } )

**注意：除了 \_id 字段之外，不能在投影文档中组合使用包含和排除语句。**

更加操作技巧可以查看 [mongoDB 官方文档][mongoDB]

## 3、Spring Data MongoDB 操作 ##

Spring Data 项目中有 Spring Data MongoDB 支持 MongoDB 数据库的操作。下面我们就来说明如何使用 `MongoTemplate` 进行指定数据返回的操作。以 `MongoTemplate#find` 这个接口举例。它需要传入三个参数:

*  `Query query` ：查询条件对象，可以以对象的形式构建查询 mongodb 的语句。
 *  `Class<T> entityClass` ：实体对象，查询 MongoDB 后返回后的对象的 Class。
 *  `String collectionName` ：集合名称，查询 MongoDB 的集合的名称

可以看到这里就应该是使用`Query query` 这个查询对象来指定 mongoDB 查询返回指定字段了。

Query query = new Query();
    //包含该字段
    query.fields().include("sourceContract").include("targetContract"); 
    
    //不包含该字段
    query.fields().exclude("merchantNo");

上面就是 `MongoTemplate` 的操作了，这样可以减少返回 `Class<T> entityClass` 这个对象里面包含的字段了减少生成这个对象在 JVM 所在的内存。

> 如果排除的字段特别大，而且操作 mongoDB 还比较频繁这样也会优化程序的性能。

参考文章：

*  [mongoDB – project-fields-from-query-results/][mongoDB]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70]: /images/20221024/d7cef960d969468f83f4764b407f22d0.png
[mongoDB]: https://docs.mongodb.com/manual/tutorial/project-fields-from-query-results/