芋道 Spring Boot MongoDB 入门

spring boot 集群连接mongodb 1、pom <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-mongodb</artifactId> </d... 阅读详情

点击上方“芋道源码”,选择“设为星标”

做积极的人,而不是积极废人!

源码精品专栏

 

摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/MongoDB/ 「芋道源码」欢迎转载,保留摘要,谢谢!

  • 1. 概述

  • 2. 快速入门

  • 3. 基于方法名查询

  • 4. 基于 Example 查询

  • 5. MongoTemplate

  • 6. 自增主键

  • 666. 彩蛋


1. 概述

可能有一些胖友对 MongoDB 不是很了解,这里我们引用一段介绍:

FROM 《分布式文档存储数据库 MongoDB》

MongoDB 是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。

他支持的数据结构非常松散,是类似 json 的 bjson 格式,因此可以存储比较复杂的数据类型。

Mongo 最大的特点是他支持的查询语言非常强大,其语法有点类似于面向对象的查询语言,几乎可以实现类似关系数据库单表查询的绝大部分功能,而且还支持对数据建立索引。

MongoDB 中的许多概念在 MySQL 中具有相近的类比。本表概述了每个系统中的一些常见概念。

对于不熟悉的胖友,可以先看下该表,然后开始本文的旅程。

MySQLMongoDB
库 Database库 Database
表 Table集合 Collection
行 Row文档 Document
列 Column字段 Field
joins嵌入文档或者链接

在早期,在项目中 MongoDB 的 ORM 框架使用 Morphia 较多。随着 Spring Data MongoDB 的日趋完善,更为主流。目前,艿艿手头所有的项目,都从 Morphia 该用 Spring Data MongoDB 。

在 Spring Data MongoDB 中,有两种方式进行 MongoDB 操作:

  • Spring Data Repository 方式

  • MongoTemplate

艿艿:如果胖友还没安装 MongoDB ,可以参考下 《芋道 MongoDB 安装部署》 文章,先进行下安装。

2. 快速入门

示例代码对应仓库:lab-16-spring-data-mongodb 。

  • MongoDB 版本号:4.2.1

本小节,我们会使用 spring-boot-starter-data-mongodb 自动化配置 Spring Data MongoDB 主要配置。同时,使用 Spring Data Repository 实现的 MongoDB 的 CRUD 操作。

2.1 引入依赖

在 pom.xml 文件中,引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-16-spring-data-mongodb</artifactId>

    <dependencies>
        <!-- 自动化配置 Spring Data Mongodb -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>

        <!-- 方便等会写单元测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

</project>

具体每个依赖的作用,胖友自己认真看下艿艿添加的所有注释噢。

2.2 Application

创建 Application.java 类,配置 @SpringBootApplication 注解即可。代码如下:

// Application.java

@SpringBootApplication(exclude = {ElasticsearchAutoConfiguration.class, ElasticsearchDataAutoConfiguration.class})
public class Application {
}

2.3 MongoDBConfig

在 cn.iocoder.springboot.lab16.springdatamongodb.config 包路径下,创建 MongoDBConfig 配置类。代码如下:

// MongoDBConfig.java

@Configuration
public class MongoDBConfig {

    @Bean // 目的,就是为了移除 _class field 。参考博客 https://blog.youkuaiyun.com/bigtree_3721/article/details/82787411
    public MappingMongoConverter mappingMongoConverter(MongoDbFactory factory,
                                                       MongoMappingContext context,
                                                       BeanFactory beanFactory) {
        // 创建 DbRefResolver 对象
        DbRefResolver dbRefResolver = new DefaultDbRefResolver(factory);
        // 创建 MappingMongoConverter 对象
        MappingMongoConverter mappingConverter = new MappingMongoConverter(dbRefResolver, context);
        // 设置 conversions 属性
        try {
            mappingConverter.setCustomConversions(beanFactory.getBean(CustomConversions.class));
        } catch (NoSuchBeanDefinitionException ignore) {
        }
        // 设置 typeMapper 属性,从而移除 _class field 。
        mappingConverter.setTypeMapper(new DefaultMongoTypeMapper(null));
        return mappingConverter;
    }

}
  • 通过在自定义 MappingMongoConverter Bean 对象,避免实体保存到 MongoDB 中时,会多一个 _class 字段,存储实体的全类名。

2.4 配置文件

在 application.yml 中,添加 MongoDB 配置,如下:

spring:
  data:
    # MongoDB 配置项,对应 MongoProperties 类
    mongodb:
      host: 127.0.0.1
      port: 27017
      database: yourdatabase
      username: test01
      password: password01
      # 上述属性,也可以只配置 uri

logging:
  level:
    org:
      springframework:
        data:
          mongodb:
            core: DEBUG # 打印 mongodb 操作的具体语句。生产环境下,不建议开启。

2.5 UserDO

在 cn.iocoder.springboot.lab16.springdatamongodb.dataobject 包路径下,创建 UserDO 类。代码如下:

@Document(collection = "User")
public class UserDO {

    /**
     * 用户信息
     */
    public static class Profile {

        /**
         * 昵称
         */
        private String nickname;
        /**
         * 性别
         */
        private Integer gender;

        // ... 省略 setting/getting 方法

    }

    @Id
    private Integer id;
    /**
     * 账号
     */
    private String username;
    /**
     * 密码
     */
    private String password;
    /**
     * 创建时间
     */
    private Date createTime;
    /**
     * 用户信息
     */
    private Profile profile;

    // ... 省略 setting/getting 方法

}
  • 在 UserDO 类中,我们内嵌了一个 profile 属性,它是 Profile 类。这里仅仅作为示例,实际场景下,还是建议把 User 和 Profile 拆分开。

  • 推荐阅读 《你应该知道的 MongoDB 最佳实践》 文章。对于初用 MongoDB 的开发者,往往错误的使用内嵌属性,需要去理解一下。

2.6 UserRepository

在 cn.iocoder.springboot.lab16.springdatamongodb.repository 包路径下,创建 UserRepository 接口。代码如下:

// ProductRepository.java

public interface UserRepository extends MongoRepository<UserDO, Integer> {
}
  • 继承 org.springframework.data.mongodb.repository.MongoRepository 接口,第一个泛型设置对应的实体是 UserDO ,第二个泛型设置对应的主键类型是 Integer 。

  • 因为实现了 MongoRepository 接口,Spring Data MongoDB 会自动生成对应的 CRUD 等等的代码。???? 是不是很方便。

  • MongoRepository 类图如下:

    • 每个接口定义的方法,胖友可以点击下面每个链接,自己瞅瞅,简单~

    • org.springframework.data.repository.CrudRepository

    • org.springframework.data.repository.PagingAndSortingRepository

    • org.springframework.data.repository.query.QueryByExampleExecutor :定义基于 org.springframework.data.domain.Example.Example 的查询操作。在 「4. 基于 Example 查询」 中,我们再来详细介绍。

    • org.springframework.data.mongodb.repository.MongoRepository :主要重写 PagingAndSortingRepository 和 CrudRepository 接口,将 findXXX 方法返回的结果从 Iterable 放大成 List ,同时增加 insert 插入方法。

艿艿:如果胖友看过艿艿写的 《芋道 Spring Boot JPA 入门》 文章,会发现和 Spring Data JPA 的使用方式,基本一致。这就是 Spring Data 带给我们的好处,使用相同的 API ,统一访问不同的数据源。o( ̄▽ ̄)d 点赞。

2.7 简单测试

创建 UserRepositoryTest 测试类,我们来测试一下简单的 UserRepositoryTest 的每个操作。代码如下:

// UserRepositoryTest.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    @Test // 插入一条记录
    public void testInsert() {
        // 创建 UserDO 对象
        UserDO user = new UserDO();
        user.setId(1); // 这里先临时写死一个 ID 编号,后面演示自增 ID 的时候,在修改这块
        user.setUsername("yudaoyuanma");
        user.setPassword("buzhidao");
        user.setCreateTime(new Date());
        // 创建 Profile 对象
        UserDO.Profile profile = new UserDO.Profile();
        profile.setNickname("芋道源码");
        profile.setGender(1);
        user.setProfile(profile);
        // 存储到 DB
        userRepository.insert(user);
    }

    // 这里要注意,如果使用 save 方法来更新的话,必须是全量字段,否则其它字段会被覆盖。
    // 所以,这里仅仅是作为一个示例。
    @Test // 更新一条记录
    public void testUpdate() {
        // 查询用户
        Optional<UserDO> userResult = userRepository.findById(1);
        Assert.isTrue(userResult.isPresent(), "用户一定要存在");
        // 更新
        UserDO updateUser = userResult.get();
        updateUser.setUsername("yutou");
        userRepository.save(updateUser);
    }

    @Test // 根据 ID 编号,删除一条记录
    public void testDelete() {
        userRepository.deleteById(1);
    }

    @Test // 根据 ID 编号,查询一条记录
    public void testSelectById() {
        Optional<UserDO> userDO = userRepository.findById(1);
        System.out.println(userDO.isPresent());
    }

    @Test // 根据 ID 编号数组,查询多条记录
    public void testSelectByIds() {
        Iterable<UserDO> users = userRepository.findAllById(Arrays.asList(1, 4));
        users.forEach(System.out::println);
    }

}
  • 每个测试单元方法,胖友自己看看方法上的注释。

具体的,胖友可以自己跑跑,妥妥的。

3. 基于方法名查询

示例代码对应仓库:lab-16-spring-data-mongodb 。

在 《芋道 Spring Boot JPA 入门》 文章的「4. 基于方法名查询」小节中,我们已经提到:

在 Spring Data 中,支持根据方法名作生成对应的查询(WHERE)条件,进一步进化我们使用 JPA ,具体是方法名以 findBy、existsBy、countBy、deleteBy 开头,后面跟具体的条件。具体的规则,在 《Spring Data JPA —— Query Creation》 文档中,已经详细提供。如下:

关键字方法示例JPQL snippet
AndfindByLastnameAndFirstname… where x.lastname = ?1 and x.firstname = ?2
OrfindByLastnameOrFirstname… where x.lastname = ?1 or x.firstname = ?2
Is, EqualsfindByFirstname,findByFirstnameIs,findByFirstnameEquals… where x.firstname = ?1
BetweenfindByStartDateBetween… where x.startDate between ?1 and ?2
LessThanfindByAgeLessThan… where x.age < ?1
LessThanEqualfindByAgeLessThanEqual… where x.age <= ?1
GreaterThanfindByAgeGreaterThan… where x.age > ?1
GreaterThanEqualfindByAgeGreaterThanEqual… where x.age >= ?1
AfterfindByStartDateAfter… where x.startDate > ?1
BeforefindByStartDateBefore… where x.startDate < ?1
IsNull, NullfindByAge(Is)Null… where x.age is null
IsNotNull, NotNullfindByAge(Is)NotNull… where x.age not null
LikefindByFirstnameLike… where x.firstname like ?1
NotLikefindByFirstnameNotLike… where x.firstname not like ?1
StartingWithfindByFirstnameStartingWith… where x.firstname like ?1 (parameter bound with appended %)
EndingWithfindByFirstnameEndingWith… where x.firstname like ?1 (parameter bound with prepended %)
ContainingfindByFirstnameContaining… where x.firstname like ?1 (parameter bound wrapped in %)
OrderByfindByAgeOrderByLastnameDesc… where x.age = ?1 order by x.lastname desc
NotfindByLastnameNot… where x.lastname <> ?1
InfindByAgeIn(Collection ages)… where x.age in ?1
NotInfindByAgeNotIn(Collection ages)… where x.age not in ?1
TruefindByActiveTrue()… where x.active = true
FalsefindByActiveFalse()… where x.active = false
IgnoreCasefindByFirstnameIgnoreCase… where UPPER(x.firstame) = UPPER(?1)
  • 注意,如果我们有排序需求,可以使用 OrderBy 关键字。

下面,我们来编写一个简单的示例。

艿艿:IDEA 牛逼,提供的插件已经能够自动提示上述关键字。太强了~

3.1 UserRepository02

在 cn.iocoder.springboot.lab16.springdatamongodb.repository 包路径下,创建 UserRepository02 接口。代码如下:

// UserRepository02.java

public interface UserRepository02 extends MongoRepository<UserDO, Integer> {

    UserDO findByUsername(String username);

    Page<UserDO> findByUsernameLike(String username, Pageable pageable);

}
  • 对于分页操作,需要使用到 Pageable 参数,需要作为方法的最后一个参数。

  • 注意噢,基于方法名查询,不支持内嵌对象的属性。(⊙o⊙)… 至少在网上翻了一波资料,没有提及这块。

3.2 简单测试

创建 UserRepository02Test 测试类,我们来测试一下简单的 UserRepository02Test 的每个操作。代码如下:

// UserRepository02Test.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserRepository02Test {

    @Autowired
    private UserRepository02 userRepository;

    @Test // 根据名字获得一条记录
    public void testFindByName() {
        UserDO user = userRepository.findByUsername("yutou");
        System.out.println(user);
    }

    @Test // 使用 username 模糊查询,分页返回结果
    public void testFindByNameLike() {
        // 创建排序条件
        Sort sort = new Sort(Sort.Direction.DESC, "id"); // ID 倒序
        // 创建分页条件。
        Pageable pageable = PageRequest.of(0, 10, sort);
        // 执行分页操作
        Page<UserDO> page = userRepository.findByUsernameLike("yu", pageable);
        // 打印
        System.out.println(page.getTotalElements());
        System.out.println(page.getTotalPages());
    }

}
  • 每个测试单元方法,胖友自己看看方法上的注释。

具体的,胖友可以自己跑跑,妥妥的。

4. 基于 Example 查询

示例代码对应仓库:lab-16-spring-data-mongodb 。

实际场景下,我们并不会基于 Example 查询。所以本小节,胖友可以选择性看看即可。

对于大多数胖友,可能不了解 Spring Data Example 。我们先来一起看看官方文档的介绍:

Query by Example (QBE) is a user-friendly querying technique with a simple interface. 使用 Example 进行查询,是一种友好的查询方式,可以使用便捷的 API 方法。

It allows dynamic query creation and does not require to write queries containing field names. 它允许创建动态查询,而无需编写包含字段名的查询。

In fact, Query by Example does not require to write queries using store-specific query languages at all. 事实上,在使用 Example 进行查询的时候,我们无需使用特定的存储器(数据库)的查询语言。

  • 请原谅艿艿蹩脚的翻译。简单来说,我们可以通过 Example 进行编写动态的查询条件,而无需使用每个不同的 Spring Data 实现类的 Query 对象。例如说:

    • Spring Data JPA 提供的 javax.persistence.criteria.Predicate

    • Spring Data MongoDB 提供的 org.springframework.data.mongodb.core.query.Query 。

  • 相当于说,不同 Spring Data 实现框架,会将 Spring Data Example 条件,翻译成对应的查询对象。例如说:

    • Spring Data JPA 将 Example 转换成 Predicate 。

    • Spring Data MongoDB 将 Example 转换成 Query 。

  • 当然,并不是所有 Spring Data 实现都支持 Spring Data Example 。例如说,Spring Data Elasticsearch 并不支持。一般情况下,支持 Spring Data Example 的 Spring Data 实现框架,它们的 Repository 都继承了 org.springframework.data.repository.query.QueryByExampleExecutor 接口。例如说:

    • Spring Data JPA 的 JpaRepository 接口。

    • Spring Data MongoDB 的 MongoRepository 接口。

Example API 一共包含三部分:

  • Probe :含有对应字段的实体对象。通过设置该实体对象的字段,作为查询字段。

    注意,Probe 并不是一个类,而是实体对象的泛指。

  • ExampleMatcher :ExampleMatcher 可以定义特定字段的匹配模式。例如说,全模糊匹配、前缀模糊匹配等等。

    简单来说,通过实体对象的字段作为查询条件,只能满足相等的情况,对于 != 、LIKE 等等情况,需要通过 ExampleMatcher 特殊指定。如果不理解,没事,看了示例会更容易明白。

  • Example :是 Probe 和 ExampleMatcher 的组合,构成查询对象。

当然,Example 有它的限制条件:

No support for nested/grouped property constraints like firstname = ?0 or (firstname = ?1 and lastname = ?2) 不支持嵌套或分组约束。例如说,firstname = ?0 or (firstname = ?1 and lastname = ?2) 。

Only supports starts/contains/ends/regex matching for strings and exact matching for other property types 对于字符串,只支持 tarts/contains/ends/regex 匹配方式;对于其它类型,只支持精确匹配。

4.1 UserRepository03

在 cn.iocoder.springboot.lab16.springdatamongodb.repository 包路径下,创建 UserRepository02 接口。代码如下:

// UserRepository03.java

public interface UserRepository03 extends MongoRepository<UserDO, Integer> {

    // 使用 username 精准匹配
    default UserDO findByUsername01(String username) {
        // 创建 Example 对象,使用 username 查询
        UserDO probe = new UserDO();
        probe.setUsername(username); // 精准匹配 username 查询
        Example<UserDO> example = Example.of(probe);
        // 执行查询
        return findOne(example)
                .orElse(null); // 如果为空,则返回 null
    }

    // 使用 username 模糊匹配
    default UserDO findByUsernameLike01(String username) {
        // 创建 Example 对象,使用 username 查询
        UserDO probe = new UserDO();
        probe.setUsername(username); // 这里还需要设置
        ExampleMatcher matcher = ExampleMatcher.matching()
                .withMatcher("username", ExampleMatcher.GenericPropertyMatchers.contains()); // 模糊匹配 username 查询
        Example<UserDO> example = Example.of(probe, matcher);
        // 执行查询
        return findOne(example)
                .orElse(null); // 如果为空,则返回 null
    }

}

4.2 简单测试

创建 UserRepository03Test 测试类,我们来测试一下简单的 UserRepository03Test 的每个操作。代码如下:

// UserRepository03Test.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserRepository03Test {

    @Autowired
    private UserRepository03 userRepository;

    @Test
    public void testFindByUsername01() {
        UserDO user = userRepository.findByUsername01("yutou");
        System.out.println(user);
    }

    @Test
    public void testFindByUsernameLike01() {
        UserDO user = userRepository.findByUsernameLike01("yu");
        System.out.println(user);
    }

}
  • 每个测试单元方法,胖友自己看看方法上的注释。

具体的,胖友可以自己跑跑,妥妥的。更多示例,可以看看如下文章:

  • 《Spring Data JPA Query by Example》

  • 《Spring Data JPA 使用 Example 快速实现动态查询》

5. MongoTemplate

示例代码对应仓库:lab-16-spring-data-mongodb 。

在 Spring Data MongoDB 中,有一个 MongoTemplate 类,提供了 MongoDB 操作模板,方便我们操作 MongoDB 。

5.1 UserDao

在 cn.iocoder.springboot.lab16.springdatamongodb.dao 包路径下,创建 UserDao 类。代码如下:

// UserDao.java

@Repository
public class UserDao {

    @Autowired
    private MongoTemplate mongoTemplate;

    public void insert(UserDO entity) {
        mongoTemplate.insert(entity);
    }

    public void updateById(UserDO entity) {
        // 生成 Update 条件
        final Update update = new Update();
        // 反射遍历 entity 对象,将非空字段设置到 Update 中
        ReflectionUtils.doWithFields(entity.getClass(), new ReflectionUtils.FieldCallback() {

            @Override
            public void doWith(Field field) throws IllegalArgumentException, IllegalAccessException {
                // 排除指定条件
                if ("id".equals(field.getName()) // 排除 id 字段,因为作为查询主键
                        || field.getAnnotation(Transient.class) != null // 排除 @Transient 注解的字段,因为非存储字段
                        || Modifier.isStatic(field.getModifiers())) { // 排除静态字段
                    return;
                }
                // 设置字段可反射
                if (!field.isAccessible()) {
                    field.setAccessible(true);
                }
                // 排除字段为空的情况
                if (field.get(entity) == null) {
                    return;
                }
                // 设置更新条件
                update.set(field.getName(), field.get(entity));
            }

        });
        // 防御,避免有业务传递空的 Update 对象
        if (update.getUpdateObject().isEmpty()) {
            return;
        }
        // 执行更新
        mongoTemplate.updateFirst(new Query(Criteria.where("_id").is(entity.getId())), update, UserDO.class);
    }

    public void deleteById(Integer id) {
        mongoTemplate.remove(new Query(Criteria.where("_id").is(id)), UserDO.class);
    }

    public UserDO findById(Integer id) {
        return mongoTemplate.findOne(new Query(Criteria.where("_id").is(id)), UserDO.class);
    }

    public UserDO findByUsername(String username) {
        return mongoTemplate.findOne(new Query(Criteria.where("username").is(username)), UserDO.class);
    }

    public List<UserDO> findAllById(List<Integer> ids) {
        return mongoTemplate.find(new Query(Criteria.where("_id").in(ids)), UserDO.class);
    }

}
  • 使用 MongoTemplate 实现了 CRUD 的功能。其它 findAndModify/findAndRemove/count/upsert 等操作,胖友可以自己尝试下。

  • 对于 #updateById(UserDO entity) 方法,胖友可以自己抽象成一个通用的 #updateEntityFieldsById(Object id, Object entity) 方法,封装在一个 BaseMongoDao 抽象类中。

    友情提示:此处暂时有个问题,对于 UserDO 内嵌的 profile 对象,一旦设置了值,是整个 Profile 对象覆盖更新。所以,使用时需要注意下。

    目前艿艿自己项目里,大多数内嵌对象,全量更新不存在问题。如果存在问题的,提供了另外的方法解决。

    当然,也可以进一步封装 #updateEntityFieldsById(Object id, Object entity, String... fields) 方法,只更新指定字段。

5.2 简单测试

创建 UserDaoTest 测试类,我们来测试一下简单的 UserDaoTest 的每个操作。代码如下:

// UserDaoTest.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserDaoTest {

    @Autowired
    private UserDao userDao;

    @Test // 插入一条记录
    public void testInsert() {
        // 创建 UserDO 对象
        UserDO user = new UserDO();
        user.setId(1); // 这里先临时写死一个 ID 编号,后面演示自增 ID 的时候,在修改这块
        user.setUsername("yudaoyuanma");
        user.setPassword("buzhidao");
        user.setCreateTime(new Date());
        // 创建 Profile 对象
        UserDO.Profile profile = new UserDO.Profile();
        profile.setNickname("芋道源码");
        profile.setGender(1);
        user.setProfile(profile);
        // 存储到 DB
        userDao.insert(user);
    }

    // 这里要注意,如果使用 save 方法来更新的话,必须是全量字段,否则其它字段会被覆盖。
    // 所以,这里仅仅是作为一个示例。
    @Test // 更新一条记录
    public void testUpdate() {
        // 创建 UserDO 对象
        UserDO updateUser = new UserDO();
        updateUser.setId(1);
        updateUser.setUsername("nicai");

        // 执行更新
        userDao.updateById(updateUser);
    }

    @Test // 根据 ID 编号,删除一条记录
    public void testDelete() {
        userDao.deleteById(1);
    }

    @Test // 根据 ID 编号,查询一条记录
    public void testSelectById() {
        UserDO userDO = userDao.findById(1);
        System.out.println(userDO);
    }

    @Test // 根据 ID 编号数组,查询多条记录
    public void testSelectByIds() {
        List<UserDO> users = userDao.findAllById(Arrays.asList(1, 4));
        users.forEach(System.out::println);
    }

}
  • 每个测试单元方法,胖友自己看看方法上的注释。

具体的,胖友可以自己跑跑,妥妥的。

6. 自增主键

示例代码对应仓库:lab-16-spring-data-mongodb 。

MongoDB 自带的主键选择是 ObjectId 类型,需要占用 12 字节。相比 Int 4 字节或者 Long 8 字节占用更多的内存空间。而绝大多数业务场景下,Int 或 Long 足够使用,所以我们更加偏向使用 Int 或 Long 作为自增 ID 主键。

当然,我们在日志记录上,我们还是采用 ObjectId 为主。

我们在实现 MongoDB 自增主键时,会创建一个名为 "sequence" 的集合。字段如下:

"sequence" 集合名,也可以取其它名字,看自己喜好。

  • _id :String 类型,集合的实体类名。

  • value :Long 类型,存储每个集合的自增序列。

在程序中,每次插入实体对象到 MongoDB 之前,通过 $inc 操作,从 "sequence" 自增获得最新的 ID ,然后将该 ID 赋值给实体对象,最终在插入到 MongoDB 之中。

当然,考虑到并不是所有实体都需要使用自增 ID ,所以我们要有方式去标记:

  • 方式一:创建自定义 @AutoIncKey 注解,添加到 ID 属性上。

  • 方式二:创建 IncIdEntity 抽象基类,这样需要自增的实体继承它。

对于方式一,网上博客比较多,胖友可以看看 《Java 中实现 MongoDB 主键自增》 文章。

对于方式二,目前艿艿项目采用这种方式,主要是我们自己的 BaseMongoDao 提供的很多方法,是基于 IncIdEntity 抽象类的。例如说,#updateEntityFieldsById(final IncIdEntity entity, String... fields) 方法,这样可以方便的直接获取到 ID 属性。

当然,无论方式一还是方式二,实现原理是一致的,差异仅仅在于获取 ID 属性不同。下面,本小节我们就来实现下方式二。

6.1 IncIdEntity

在 cn.iocoder.springboot.lab16.springdatamongodb.mongo 包路径下,创建 IncIdEntity 类。代码如下:

// IncIdEntity.java

/**
 * 自增主键实体
 *
 * @param <T> 主键泛型
 */
public abstract class IncIdEntity<T extends Number> {

    @Id
    private T id;

    public T getId() {
        return id;
    }

    public void setId(T id) {
        this.id = id;
    }

}

6.2 ProductDO

在 cn.iocoder.springboot.lab16.springdatamongodb.dataobject 包路径下,创建 ProductDO 类。代码如下:

// ProductDO.java

@Document(collection = "Product")
public class ProductDO extends IncIdEntity<Integer> {

    /**
     * 商品名
     */
    private String name;

    public String getName() {
        return name;
    }

    public ProductDO setName(String name) {
        this.name = name;
        return this;
    }

}
  • 继承 IncIdEntity 抽象类,使用 Integer 自增主键。

6.3 MongoInsertEventListener

在 cn.iocoder.springboot.lab16.springdatamongodb.dataobject 包路径下,创建 MongoInsertEventListener 类。代码如下:

// MongoInsertEventListener.java

@Component
public class MongoInsertEventListener extends AbstractMongoEventListener<IncIdEntity> {

    /**
     * sequence - 集合名
     */
    private static final String SEQUENCE_COLLECTION_NAME = "sequence";
    /**
     * sequence - 自增值的字段名
     */
    private static final String SEQUENCE_FIELD_VALUE = "value";

    @Autowired
    private MongoTemplate mongoTemplate;

    @Override
    public void onBeforeConvert(BeforeConvertEvent<IncIdEntity> event) {
        IncIdEntity entity = event.getSource();
        // 判断 id 为空
        if (entity.getId() == null) {
            // 获得下一个编号
            Number id = this.getNextId(entity);
            // 设置到实体中
            // noinspection unchecked
            entity.setId(id);
        }
    }

    /**
     * 获得实体的下一个主键 ID 编号
     *
     * @param entity 实体对象
     * @return ID 编号
     */
    private Number getNextId(IncIdEntity entity) {
        // 使用实体名的简单类名,作为 ID 编号
        String id = entity.getClass().getSimpleName();
        // 创建 Query 对象
        Query query = new Query(Criteria.where("_id").is(id));
        // 创建 Update 对象
        Update update = new Update();
        update.inc(SEQUENCE_FIELD_VALUE, 1); // 自增值
        // 创建 FindAndModifyOptions 对象
        FindAndModifyOptions options = new FindAndModifyOptions();
        options.upsert(true); // 如果不存在时,则进行插入
        options.returnNew(true); // 返回新值
        // 执行操作
        @SuppressWarnings("unchecked")
        HashMap<String, Object> result = mongoTemplate.findAndModify(query, update, options,
                HashMap.class, SEQUENCE_COLLECTION_NAME);
        // 返回主键
        return (Number) result.get(SEQUENCE_FIELD_VALUE);
    }

}
  • MongoDB 实体对象在插入之前,会发布 BeforeConvertEvent 事件。所以,我们可以通过创建 MongoInsertEventListener 监听器,监听该事件,生成自增主键 ID 主键,设置到实体对象中。

  • 如果胖友想要使用集合名作为 "sequence" 集合的 "id" ,可以使用 BeforeConvertEvent.collectionName 属性。

6.4 ProductRepository

在 cn.iocoder.springboot.lab16.springdatamongodb.repository 包路径下,创建 ProductRepository 接口。代码如下:

// ProductRepository.java

public interface ProductRepository extends MongoRepository<ProductDO, Integer> {
}

6.5 简单测试

创建 ProductRepositoryTest 测试类,我们来测试一下简单的 ProductRepositoryTest 的每个操作。代码如下:

// ProductRepositoryTest.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class ProductRepositoryTest {

    @Autowired
    private ProductRepository productRepository;

    @Test
    public void testInsert() {
        // 创建 ProductDO 对象
        ProductDO product = new ProductDO();
        product.setName("芋头");
        // 插入
        productRepository.insert(product);
        // 打印 ID
        System.out.println(product.getId());
    }

}

666. 彩蛋

艿艿的项目中,只采用 MongoTemplate 。主要是我们封装了 BaseMongoDao ,提供了一些我们日常开发需要的功能,例如说:

  • #insertToMongo(Object objectToSave) 方法:插入实体,使用自增 ID 主键。

  • #updateEntityFieldsById(final IncIdEntity entity, String... fields) 方法:只更新实体指定字段。

推荐阅读:

  • 《性能测试 —— MongoDB 基准测试》



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

Spring Boot 中使用 MongoDB 增删改查 本文快速入门,MongoDB 结合SpringBoot starter-data-mongodb 进行增删改查 1、什么是MongoDB ? MongoDB 是由C++语言编写的,是一个基于分布式文件存储的开源数据库系统。 在高负载的情况下,添加更多的节点,可以保证服务器性能。 MongoDB 旨在为WEB应用提供可扩展的高性能数据存储解决方案。 MongoDB 将数据存储为一个文档,数据结构由键值(key=>value)对组成。 MongoDB 文档类似于 JSON 对象。... 阅读详情

相关推荐

Spring Boot如何集成MongoDB?

🏆 本文精选收录于《滚雪球学SpringBoot》专栏,专为零基础学习者量身打造。从Spring基础到项目实战,手把手带你掌握核心技术,助力你快速提升,迈向职场巅峰,开启财富自由之路🚀!无论你是刚入门的小白,还是已有基础的开发者,都能在这里找到适合自己的学习路径!    🌟 关注、收藏、订阅,持续更新中!和我们一起高速成长,突破自我!💡

**My Coding Family** 1174

Spring Boot MongoDB 入门配置和使用教程

芋道 Spring Boot MongoDB 入门

zhaoyang10的专栏 324

spring MVC morphia mongo 整合的例子

spring MVC morphia mongo 整合的例子 网上下载的例子 自己调试保证绝对能运行

MongoDB(介绍,安装,操作,Springboot整合MonggoDB)

MongoDB中文网MongoDB是一个基于分布式文档型存储的NoSQL数据库。旨在为WEB应用提供可扩展的高性能数据存储解决方案。MongoDB由C++语言编写,是非关系数据库当中功能最丰富,最像关系数据库的,它支持的数据结构非常松散,是类似json的bson格式,因此可以存储比较复杂的数据类型。

qq_1424674116的博客 2277

基于Morphia实现MongoDB按小时、按天聚合操作方法

MongoDB按照天数或小时聚合 需求 最近接到需求,需要对用户账户下的设备状态,分别按照天以及小时进行聚合,以此为基础绘制设备状态趋势图. 实现思路是启动定时任务,对各用户的设备状态数据分别按照小时以及天进行聚合,并存储进数据库中供用户后续查询. 涉及到的技术栈分别为:Spring Boot,MongoDB,Morphia. 数据模型 @Data @Builder @Entity(value = "rawDevStatus", noClassnameStored = true) // 设备状态索引 @Indexes({ // 设置数据超时时间(TTL,MongoDB根据TTL在后台

Python实战:3步搞定DICOM转JPG/PNG(附批量处理脚本)

本文详细介绍了如何使用Python在3步内将DICOM医学影像转换为JPG/PNG格式,并提供了批量处理脚本。通过Pydicom、Pillow和NumPy库的组合,解决了像素值处理、批量转换效率和医学图像特性保留等关键问题,适合医疗AI开发者和放射科医生快速集成到工作流中。

numpy6sculptor的博客 594

芋道 Spring Boot Elasticsearch 入门

点击上方“芋道源码”,选择“设为星标”做积极的人,而不是积极废人!源码精品专栏原创 | Java 2020 超神之路,很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网...

芋艿V 613

来自工业界的知识库 RAG 服务(二),RagFlow 源码全流程深度解析

前面介绍过有道 QAnything 源码解析,通过深入了解工业界的知识库 RAG 服务,得到了不少调优 RAG 服务的新想法。因此本次趁热打铁,额外花费一点时间,深入研究了另一个火热的开源 RAG 服务RagFlow的完整实现流程,希望同样有所收获。首先依旧可以先从框架图入手,与常规的 RAG 架构进行一些比较可以看到右侧知识库被明显放大,同时最右侧详细介绍了文件解析的各种手段,比如OCR等,这些在常规的 RAG 中可能会作为一个不起眼的。

易迟的专栏 2万+

芋道 SpringCloud微服务框架运行,内含步骤

芋道 Spring Boot是一款国产的SpringCloud微服务框架,包括Outh2.0、微服务网关、微服务注册中心、配置中心、消息队列、任务调度、链路追踪、服务保障等。今天介绍下芋道yudao-cloud Spring微服务框架运行,把数据库、gateway、业务系统都运行起来。

Java 技术专栏,从入门到精通,熟悉企业级开发 1万+

Win11家庭版彻底关闭Hyper-V的3种方法(实测有效)

本文详细介绍了Win11家庭版彻底关闭Hyper-V的3种实测有效方法,解决与VMware的兼容性问题。包括命令行禁用虚拟化功能、微软官方工具DG_Readiness深度清理以及组策略与功能组件联用方案,帮助用户高效禁用Hyper-V并优化系统性能。

weixin_33728268的博客 2697

【SWAT水文模型】SWAT-CUP参数率定与模型验证实战指南

本文提供了SWAT水文模型参数率定与模型验证的完整实战指南。详细介绍了如何使用SWAT-CUP工具,特别是SUFI-2算法,进行自动化参数校准,并阐述了模型验证的关键步骤以避免过度拟合。内容涵盖从工程搭建、核心参数选择、迭代优化到结果分析与常见问题排查的全流程,旨在帮助用户提升SWAT模型模拟的准确性与可靠性。

weixin_29072299的博客 501

MongoDB、Hbase、Redis等NoSQL优劣势、应用场景

NoSQL的四大种类NoSQL数据库在整个数据库领域的江湖地位已经不言而喻。在大数据时代,虽然RDBMS很优秀,但是面对快速增长的数据规模和日渐复杂的数据模型,RDBMS渐渐力不从心,无法应对很多数据库处理任务,这时NoSQL凭借易扩展、大数据量和高性能以及灵活的数据模型成功的在数据库领域站稳了脚跟。目前大家基本认同将NoSQL数据库分为四大类:键值存储数据库,文档型数据库,...

weixin_33816821的博客 879

[QMT量化交易小白入门]-七十三、主力资金动向:板块与个股资金流数据API(量化python代码解析)

本专栏主要是介绍QMT的基础用法,常见函数,写策略的方法,也会分享一些量化交易的思路,大概会写100篇左右。QMT的相关资料较少,在使用过程中不断的摸索,遇到了一些问题,记录下来和大家一起沟通,共同进步。

木头大左的博客 1122

Spring Boot MongoDB 入门

1. 概述 可能有一些胖友对 MongoDB 不是很了解,这里我们引用一段介绍: FROM《分布式文档存储数据库 MongoDB》 MongoDB 是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。 他支持的数据结构非常松散,是类似 json 的 bjson 格式,因此可以存储比较复杂的数据类型。 Mongo 最大的特点是他支持的查询语言非...

weixin_42073629的博客 263

QLineEdit控件: 实现IP地址输入框(基于编辑信号)

在开发网络应用程序时,经常需要用户输入IP地址。直接使用普通输入框容易导致格式错误,用户体验也较差。本文将手把手教你用Qt的QLineEdit控件实现一个智能IP地址输入框。即使你是刚接触Qt的新手,也能通过本文理解核心实现原理。

u011186532的专栏 652

天地图下载带审图号(审图号: GS(2024)0650号)的 “行政区划” 数据(含shp文件下载地址)

在科研投稿论文过程中,多数期刊杂志要求我们制作涉及国界的图件,必须使用自然资源部地图技术审查中心发布的标准地图底图。如地理学报、地理科学等期刊的投稿指南中写到:非标准底图本刊不予发表!(如图1.1所示)如果一定要用,凡涉国界图件(国内部分地区、全国、世界部分地区、全球)必须使用自然资源部标准地图服务系统标准地图底图(http://bzdt.ch.mnr.gov.cn/)(如图1.1所示)或国家测绘局地理信息局标准地图底图(如图1.2所示),所用底图边界要完全无修改(包括南海诸岛位置)。

JData_Engineer的博客 2306

MongoDB - Java连接MongoDB:Spring Boot集成MongoDB的步骤

本文介绍了在Spring Boot中集成MongoDB的全过程。首先通过Spring Initializr创建项目并添加MongoDB依赖,然后配置连接信息。接着详细说明了如何定义MongoDB实体类,包括使用@Document、@Id等注解进行对象映射。文章还演示了Repository接口的使用方法,涵盖基本CRUD操作、自定义查询和分页功能。通过清晰的代码示例和配置说明,帮助开发者快速掌握Spring Boot与MongoDB的集成开发。

千淘万漉虽辛苦,吹尽狂沙始到金 2万+

从微服务到 Agent 服务:架构思维的迁移

微服务的概念最早在2014年由Martin Fowler提出,核心是“将单体应用拆分为一组小的服务,每个服务运行在独立的进程中,服务之间采用轻量级的通信机制互相协作,每个服务围绕具体业务构建,并且可以独立部署到生产环境”。单一职责:每个微服务只负责一个业务领域的功能,比如订单服务只处理订单相关的逻辑,用户服务只处理用户相关的逻辑被动响应:微服务是“哑的”,只有收到外部请求的时候才会执行逻辑,本身没有主动决策的能力固定流程:微服务的逻辑是硬编码的,执行流程是提前定义好的,只能按照程序员写的代码处理请求。

AI智能探索者的博客 275

Spring Boot 集成 MongoDB 快速使用入门

目录 Bulk操作 有序操作 无序操作 类文件完整内容 本文承接《MongoDB 通过 Java 代码 CRUD 文档》 Bulk操作 MongoDB提供了一种称为 BulkWrite(块)操作方式,数据不会被立即被持久化到数据库中,而是等待程序调度,确定合适的时间持久化到数据库中,其实就是批量操作。 API :com.mongodb.client.MongoCollect...

蚩尤后裔-汪茂雄 1万+

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

spring boot 整合mongodb

Spring Boot其设计目的是用来简化新Spring应用的初始搭建以及开发过程,简化配置

xphsc的专栏 1万+

廖雪峰Python教程[完整版]

廖雪峰的python教程整理的,已经排好版了,而且还是完整的,适合小白

Spring Boot MongoDB 从入门到精通

本文详细介绍了MongoDB与Spring Boot的集成开发实践。主要内容包括:MongoDB的核心概念与文档型数据模型;Spring Boot项目配置与MongoDB连接;数据模型设计中的实体类注解与复杂类型处理;Repository模式的基础查询与自定义实现;MongoTemplate的高级CRUD操作、复杂查询构建和聚合框架应用;事务管理的配置与使用;性能优化策略如索引设计和查询优化;以及变更流、批量操作等高级特性。最后通过电商系统实战案例,展示了领域模型设计和业务服务实现,并总结了文档设计、索引策

油墨香^-^的博客 1090

霍尼韦尔SoftMaster使用说明

霍尼韦尔SoftMaster使用说明

Spring Boot集成MongoDB教程

本文介绍了SpringBoot集成MongoDB并使用SpringDataMongodb实现文章评论的CRUD操作。主要内容包括:搭建SpringBoot项目并引入spring-boot-starter-data-mongodb依赖,配置MongoDB连接信息,设计评论实体类并创建复合索引,实现Controller和Service层对评论的增删改查功能。通过MongoRepository提供的接口简化了数据库操作,展现了SpringBoot与MongoDB整合的便捷性。

热爱技术、喜欢学习、乐于分享 1382

spring boot 连接mongodb

介绍: MongoDB是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。它支持的数据结构非常松散,是类似json的bson格式,因此可以存储比较复杂的数据类型。Mongo最大的特点是它支持的查询语言非常强大,其语法有点类似于面向对象的查询语言,几乎可以实现类似关系数据库单表查询的绝大部分功能,而且还支持对数据建立索引。 传统的关系数据库一般由数据库(da...

凉白开不加冰 5559

Spring Boot应用MongoDB

Spring Boot 与 MongoDB 高效集成指南。引入 Maven 依赖,配置连接参数,轻松实现与 MongoDB 的连接。定义模型类,创建 Repository 接口简化 CRUD 操作。编写 Service 层逻辑,在业务中便捷操作数据库。通过 Controller 进行测试,涵盖添加、获取和查询用户等功能。还介绍了 MongoDB 在 Spring Boot 中的常用函数,包括增删改查、聚合操作、分页排序等。

J老熊 2122
上一篇: 如何解决代码中 if…else 过多的问题
下一篇: 一次 SQL 查询优化原理分析(900W+ 数据,从 17s 到 300ms)
公众号-芋道源码
博客等级 码龄10年 1637粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值