MongoTemplate及SpringBoot配置
图
MongoTemplate是为Java语言提供的MongoDB语法,使其通过API的方式调用数据库,与SpringBoot整合后使用很便捷,开箱即用,同时加上MongoDB的自动维护表,能快速迭代开发

实体的创建

/**
 * 后台管理员
 */
@Data
@Document
@Accessors(chain = true)
public class SystemAdminUser {

    /**
     * ID
     */
    @Id
    private ObjectId id;

    /**
     * 账号
     */
    private String username;

    /**
     * 密码(加密)
     */
    private String password;

    /**
     * 用户名
     */
    private String nick;

    /**
     * 状态
     * @see com.gxzn.comEnum.GlobalStatusEnum
     */
    private Integer status;

    /**
     * 学校ID,仅学校账号有
     */
    private ObjectId schoolId;

    /**
     * 创建时间
     */
    private Date createTime;

    /**
     * 更新时间
     */
    private Date updateTime;

}

@Document:指定文档(表)名
@Transient:不会在文档中插入该字段
@Id:指定id字段

注意:不建议使用包装对象类型数据,可能在表中出现null字段

自带对象

BasicDBObject

类似于Object,但是是JSON格式

示例:

@RequestParam(defaultValue = "{}") String extend

BasicDBObject.parse("{}")

查询

<T> List<T> find(Query query, Class<T> entityClass)
<T> List<T> find(final Query query, Class<T> entityClass, String collectionName)

根据id查询文档

<T> T findById(Object id, Class<T> entityClass)
<T> T findById(Object id, Class<T> entityClass, String collectionName)

查询并修改

<T> T findAndModify(Query query, Update update, Class<T> entityClass)
<T> T findAndModify(Query query, Update update, Class<T> entityClass, String collectionName)
<T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass)
<T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass, String collectionName)

查询并删除

<T> T findAndRemove(Query query, Class<T> entityClass)
<T> T findAndRemove(Query query, Class<T> entityClass, String collectionName)

总数统计

long count(Query query, Class<?> entityClass)
long count(final Query query, String collectionName)
long count(Query query, Class<?> entityClass, String collectionName)

添加

void insert(Object objectToSave)
void insert(Object objectToSave, String collectionName)

修改

WriteResult upsert(Query query, Update update, Class<?> entityClass)
WriteResult upsert(Query query, Update update, String collectionName)
WriteResult upsert(Query query, Update update, Class<?> entityClass, String collectionName)
WriteResult updateFirst(Query query, Update update, Class<?> entityClass)
WriteResult updateFirst(final Query query, final Update update, final String collectionName)
WriteResult updateFirst(Query query, Update update, Class<?> entityClass, String collectionName)
WriteResult updateMulti(Query query, Update update, Class<?> entityClass) 
WriteResult updateMulti(final Query query, final Update update, String collectionName)
WriteResult updateMulti(final Query query, final Update update, Class<?> entityClass, String collectionName)

删除

WriteResult remove(Object object)
WriteResult remove(Object object, String collection)
WriteResult remove(Query query, String collectionName)
WriteResult remove(Query query, Class<?> entityClass)
WriteResult remove(Query query, Class<?> entityClass, String collectionName)

存在

boolean exists(Query query, Class<?> entityClass)
boolean exists(Query query, String collectionName)
boolean exists(Query query, Class<?> entityClass, String collectionName)

boolean exists = mongoTemplate.exists(new Query(Criteria.where("enterpriseId").is(enterpriseId)), EnterpriseToken.class);

Query

new Query(Criteria criteria)

Criteria

where
and
is
ne
lt      // 小于
lte     // 小于等于
gt      // 大于
gte     // 大于等于
in
nin
mod
all
size
exists
type
not
regex
withinSphere
within

findAndModify

findAndModify(query,update,options,entityClass)

StrUtil.isNotBlank(Str):判断非空,含空字符串

currentDate

update.currentDate("updateDate");

$currentDate操作符是只用在更新操作上,不可以用在insert操作,更新日期类型的字段时建议使用$currentDate操作符,因为它是直接取的数据库服务端的时间,而使用new Date()设置日期取的是当前服务器上的时间,容易造成误差。

Query query = new Query();
query.addCriteria(where("keyword").is(keyword).and("app_no").is(Constant.APP_NO));
Update update = new Update();
update.inc("number", 1);
update.currentDate("updateDate");
update.setOnInsert("createDate", new Date());
mongoTemplate.findAndModify(query, update, FindAndModifyOptions.options().upsert(true), SearchKeyword.class);

排序查询

Query query = new Query();
query.with(new Sort(Sort.Direction.DESC, "number"));
query.limit(pageSize);
List<SearchKeyword> searchKeywordList = mongoTemplate.find(query, SearchKeyword.class);

注意:springboot2.2.1(含)以上的版本Sort已经不能再实例化了,构造方法已经是私有的了,使用Sort.by构造

List<Role> roles = mongoTemplate.find(query.skip((pageIndex - 1) * pageSize).limit(pageSize).with(
        Sort.by(Sort.Direction.DESC, "_id")
), Role.class);

按中文排序

List<DepartmentListRespVo> list = mongoTemplate.find(
        new Query(
                Criteria.where(FieldUtil.get(Department::getStatus)).is(GlobalStatusEnum.STATUS_NORMAL.value())
        ).with(Sort.by(Sort.Direction.ASC, FieldUtil.get(Department::getName)))
                .collation(Collation.of(Locale.CHINESE).numericOrdering(true)),
        DepartmentListRespVo.class,
        ClassUtil.getTableName(Department.class)
);

多个排序条件

// 查员工
List<DepartmentUserRespVo> user = mongoTemplate.find(
        new Query(
                Criteria.where(FieldUtil.get(User::getDepartmentId)).is(item.getId())
                        .and(FieldUtil.get(User::getStatus)).is(GlobalStatusEnum.STATUS_NORMAL.value())
        ).with(Sort.by(Sort.Direction.DESC, FieldUtil.get(User::getPrincipal)))
                .with(Sort.by(Sort.Direction.ASC, FieldUtil.get(Department::getName)))
                .collation(Collation.of(Locale.CHINESE).numericOrdering(true)),
        DepartmentUserRespVo.class,
        ClassUtil.getTableName(User.class)
);

Criteria

多条件或

Criteria c1 = null;
c1.orOperator(
    where("usr.realname").regex(keyword),
    where("user.info.name").regex(keyword),
    where("user.weId").is(weId),
    where("user.mobile").regex(keyword)
    );

顺序

注意sort -> skip -> limit的顺序

数组字段长度过滤

Criteria.where("circleIdList.0").exists(true)

批量添加

mongoTemplate.insert(list, Finance.COLLECTION_NAME);

字段不含字符匹配

// regex具有正则匹配功能,比如字段不以班主任开头
and("jobTitle").regex("^(?!班主任)")

打印执行日志

logging:
    level:
        org.springframework.data.mongodb.core.MongoTemplate: DEBUG

SpringBoot配置

# 数据
spring:
  data:
    mongodb:
      host: 192.168.137.100
      port: 27017
      database: gxzn
      username: gxzn
      password: gxzn