SpringBoot整合MongoDB

概述

https://docs.spring.io/spring-boot/docs/current/reference/html/data.html#data.nosql.mongodb.repositories
https://docs.spring.io/spring-data/mongodb/docs/current/reference/html

环境准备

1）引入依赖

<!--spring data mongodb-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

2）配置 yml

spring:
  data:
    mongodb:
      uri: mongodb://firechou:firechou@192.168.65.174:27017/test?authSource=admin
      # uri等同于下面的配置
      # database: test
      # host: 192.168.65.174
      # port: 27017
      # username: firechou
      # password: firechou
      # authentication-database: admin

连接配置参考文档：https://docs.mongodb.com/manual/reference/connection-string/

3）使用时注入 mongoTemplate

@Autowired
MongoTemplate mongoTemplate;

4）集合操作

@Test
public void testCollection(){

    boolean exists = mongoTemplate.collectionExists("emp");
    if (exists) {
        // 删除集合
        mongoTemplate.dropCollection("emp");
    }
    // 创建集合
    mongoTemplate.createCollection("emp");
}

文档操作

相关注解

• @Document

修饰范围：用在类上。
作用：用来映射这个类的一个对象为 mongo 中一条文档数据。
属性：（ value 、collection ）用来指定操作的集合名称。

• @Id

修饰范围：用在成员变量、方法上。
作用：用来将成员变量的值映射为文档的 _id 的值。

• @Field

修饰范围：用在成员变量、方法上。
作用：用来将成员变量及其值映射为文档中一个key:value对。
属性： （name , value ）用来指定在文档中 key 的名称，默认为成员变量名。

• @Transient

修饰范围：用在成员变量、方法上。
作用：用来指定此成员变量不参与文档的序列化。

创建实体

@Document("emp")  // 对应emp集合中的一个文档
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Employee {

    @Id   // 映射文档中的_id
    private Integer id;
    
    @Field("username")
    private String name;
    
    @Field
    private int age;
    
    @Field
    private Double salary;
    
    @Field
    private Date entryDay;
}

添加文档

insert 方法返回值是新增的 Document 对象，里面包含了新增后 _id 的值。如果集合不存在会自动创建集合。通过 Spring Data MongoDB 还会给集合中多加一个 _class 的属性，存储新增时 Document 对应 Java 中类的全限定路径。这么做为了查询时能把 Document 转换为 Java 类型。

@Test
public void testInsert(){
    Employee employee = new Employee(1, "小明", 30,10000.00, new Date());

    // 添加文档
    // sava:  _id存在时更新数据
    // mongoTemplate.save(employee);
    // insert： _id存在抛出异常   支持批量操作
    mongoTemplate.insert(employee);

    List<Employee> list = Arrays.asList(
        new Employee(2, "张三", 21,5000.00, new Date()),
        new Employee(3, "李四", 26,8000.00, new Date()),
        new Employee(4, "王五",22, 8000.00, new Date()),
        new Employee(5, "张龙",28, 6000.00, new Date()),
        new Employee(6, "赵虎",24, 7000.00, new Date()),
        new Employee(7, "赵六",28, 12000.00, new Date()));
    // 插入多条数据
    mongoTemplate.insert(list,Employee.class);
}

• 插入重复数据时：insert 报 DuplicateKeyException 提示主键重复；save 对已存在的数据进行更新。
• 批处理操作时：insert 可以一次性插入所有数据，效率较高；save 需遍历所有数据，一次插入或更新，效率较低。

查询文档

Criteria 是标准查询的接口，可以引用静态的Criteria.where的把多个条件组合在一起，就可以轻松地将多个方法标准和查询连接起来，方便我们操作查询语句。

@Test
public void testFind(){

    System.out.println("==========查询所有文档===========");
    // 查询所有文档
    List<Employee> list = mongoTemplate.findAll(Employee.class);
    list.forEach(System.out::println);

    System.out.println("==========根据_id查询===========");
    // 根据_id查询
    Employee e = mongoTemplate.findById(1, Employee.class);
    System.out.println(e);

    System.out.println("==========findOne返回第一个文档===========");
    // 如果查询结果是多个，返回其中第一个文档对象
    Employee one = mongoTemplate.findOne(new Query(), Employee.class);
    System.out.println(one);

    System.out.println("==========条件查询===========");
    // new Query() 表示没有条件
    // 查询薪资大于等于8000的员工
    // Query query = new Query(Criteria.where("salary").gte(8000));
    // 查询薪资大于4000小于10000的员工
    // Query query = new Query(Criteria.where("salary").gt(4000).lt(10000));
    // 正则查询（模糊查询）  java中正则不需要有//
    // Query query = new Query(Criteria.where("name").regex("张"));

    // and  or  多条件查询
    Criteria criteria = new Criteria();
    // and  查询年龄大于25&薪资大于8000的员工
    // criteria.andOperator(Criteria.where("age").gt(25),Criteria.where("salary").gt(8000));
    // or 查询姓名是张三或者薪资大于8000的员工
    criteria.orOperator(Criteria.where("name").is("张三"),Criteria.where("salary").gt(5000));
    Query query = new Query(criteria);

    // sort排序
    // query.with(Sort.by(Sort.Order.desc("salary")));


    // skip limit 分页  skip用于指定跳过记录数，limit则用于限定返回结果数量。
    query.with(Sort.by(Sort.Order.desc("salary")))
            .skip(0)  //指定跳过记录数
            .limit(4);  //每页显示记录数


    // 查询结果
    List<Employee> employees = mongoTemplate.find(
            query, Employee.class);
    employees.forEach(System.out::println);
}

@Test
public void testFindByJson() {

    // 使用json字符串方式查询
    // 等值查询
    // String json = "{name:'张三'}";
    // 多条件查询
    String json = "{$or:[{age:{$gt:25}},{salary:{$gte:8000}}]}";
    Query query = new BasicQuery(json);

    // 查询结果
    List<Employee> employees = mongoTemplate.find(
        query, Employee.class);
    employees.forEach(System.out::println);
}

更新文档

在 MongoDB 中无论是使用客户端 API 还是使用 Spring Data，更新返回结果一定是受行数影响。如果更新后的结果和更新前的结果是相同，返回0。

• updateFirst() 只更新满足条件的第一条记录
• updateMulti() 更新所有满足条件的记录
• upsert() 没有符合条件的记录则插入数据

@Test
public void testUpdate(){

    // query设置查询条件
    Query query = new Query(Criteria.where("salary").gte(15000));

    System.out.println("==========更新前===========");
    List<Employee> employees = mongoTemplate.find(query, Employee.class);
    employees.forEach(System.out::println);

    Update update = new Update();
    // 设置更新属性
    update.set("salary",13000);

    // updateFirst() 只更新满足条件的第一条记录
    // UpdateResult updateResult = mongoTemplate.updateFirst(query, update, Employee.class);
    // updateMulti() 更新所有满足条件的记录
    // UpdateResult updateResult = mongoTemplate.updateMulti(query, update, Employee.class);

    // upsert() 没有符合条件的记录则插入数据
    // update.setOnInsert("id",11);  // 指定_id
    UpdateResult updateResult = mongoTemplate.upsert(query, update, Employee.class);

    // 返回修改的记录数
    System.out.println(updateResult.getModifiedCount());


    System.out.println("==========更新后===========");
    employees = mongoTemplate.find(query, Employee.class);
    employees.forEach(System.out::println);
}

删除文档

@Test
public void testDelete(){

    // 删除所有文档
    // mongoTemplate.remove(new Query(),Employee.class);

    // 条件删除
    Query query = new Query(Criteria.where("salary").gte(10000));
    mongoTemplate.remove(query,Employee.class);

}

如何去掉 _class 属性

@Configuration
public class MongoConfig {

    /**
     * 定制TypeMapper去掉_class属性
     * @param mongoDatabaseFactory
     * @param context
     * @param conversions
     * @return
     */
    @Bean
    MappingMongoConverter mappingMongoConverter(
            MongoDatabaseFactory mongoDatabaseFactory,
            MongoMappingContext context, MongoCustomConversions conversions){

        DbRefResolver dbRefResolver = new DefaultDbRefResolver(mongoDatabaseFactory);
        MappingMongoConverter mappingMongoConverter =
                new MappingMongoConverter(dbRefResolver,context);
        mappingMongoConverter.setCustomConversions(conversions);

        // 构造DefaultMongoTypeMapper，将typeKey设置为空值
        mappingMongoConverter.setTypeMapper(new DefaultMongoTypeMapper(null));

        return mappingMongoConverter;
    }

}