尚医通 (二十四) --------- SpringBoot 集成 MongoDB

╰+哭是因爲堅強的太久メ 2024-03-31 08:04 43阅读 0赞

#### 目录 ####

*  一、集成简介
 *  二、搭建开发环境
 *  三、基于 MongoTemplate 开发 CRUD
 *  五、基于 MongoRepository 开发 CRUD

--------------------

## 一、集成简介 ##

spring-data-mongodb 提供了 MongoTemplate 与 MongoRepository 两种方式访问 MongoDB，MongoRepository 操作简单，MongoTemplate 操作灵活，我们在项目中可以灵活适用这两种方式操作 MongoDB，MongoRepository 的缺点是不够灵活，MongoTemplate 正好可以弥补不足。

## 二、搭建开发环境 ##

**A、初始化工程**

使用 Spring Initializr 快速初始化一个 SpringBoot 工程

Group：com.fancy
    Artifact：mongodb-demo

![在这里插入图片描述][781fa2a846e64b949316202207dcee03.png]  
![在这里插入图片描述][a007275b863c4530ba818a5b125e4ae5.png]

**B、引入依赖**

修改 pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.10.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

![在这里插入图片描述][11dbdad72a4c4c5e8d9b19f9a7cdee3a.png]

**C、添加配置**

在 application.properties 文件添加配置

spring.data.mongodb.uri=mongodb://192.168.38.130:27017/test

![在这里插入图片描述][6189c95f18f1489a876c5befccbb3197.png]

## 三、基于 MongoTemplate 开发 CRUD ##

**A、添加实体**

添加 com.fancy.mongodb.entity.User 类

@Data
    @Document("User")
    public class User {
    	@Id
    	private String id;
    	private String name;
    	private Integer age;
    	private String email;
    	private String createDate;
    }

![在这里插入图片描述][15d3fd3dcfd340ceb0fcd6da019c612a.png]

**B、实现**

<table> 
 <thead> 
  <tr> 
   <th>常用方法</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>mongoTemplate.findAll(User.class)</td> 
   <td>查询 User 文档的全部数据</td> 
  </tr> 
  <tr> 
   <td>mongoTemplate.findById(<code>&lt;id&gt;</code>, User.class)</td> 
   <td>查询 User 文档 id 为 … 的数据</td> 
  </tr> 
  <tr> 
   <td>mongoTemplate.find(query, User.class)</td> 
   <td>根据 query 内的查询条件查询</td> 
  </tr> 
  <tr> 
   <td>mongoTemplate.upsert(query, update, User.class)</td> 
   <td>修改</td> 
  </tr> 
  <tr> 
   <td>mongoTemplate.remove(query, User.class)</td> 
   <td>删除</td> 
  </tr> 
  <tr> 
   <td>mongoTemplate.insert(User)</td> 
   <td>新增</td> 
  </tr> 
 </tbody> 
</table>

**C、Query 对象**

*  创建一个 query 对象 (来封装所有条件对象)，再创建一个 criteria对象（用来构建条件）
 *  精准条件 `criteria.and("key").is("条件")`
 *  模糊条件 `criteria.and("key").regex("条件")`
 *  封装条件 `query.addCriteria(criteria)`
 *  大于 (创建新的 criteria) `Criteria gt = Criteria.where(“key”).gt(“条件”)`  
    小于(创建新的criteria) `Criteria lt = Criteria.where(“key”).lt(“条件”)`  
    Query.addCriteria(new Criteria().andOperator(gt,lt));
 *  一个 query 中只能有一个 andOperator() 。其参数也可以是`Criteria`数组。
 *  排序 `query.with（new Sort(Sort.Direction.ASC, "age"). and(new Sort(Sort.Direction.DESC, "date")))`

**D、添加测试类**

在 /test/java 下面添加测试类：

package com.fancy.mongodbdemo;
    
    import com.fancy.mongodbdemo.entity.User;
    import com.mongodb.client.result.DeleteResult;
    import com.mongodb.client.result.UpdateResult;
    import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.data.mongodb.core.MongoTemplate;
    import org.springframework.data.mongodb.core.query.Criteria;
    import org.springframework.data.mongodb.core.query.Query;
    import org.springframework.data.mongodb.core.query.Update;
    
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    import java.util.regex.Pattern;
    
    @SpringBootTest
    public class MongodbDemoApplicationTests {
        
    
        @Autowired
        private MongoTemplate mongoTemplate;
    
        //添加
        @Test
        public void createUser() {
        
            User user = new User();
            user.setAge(20);
            user.setName("test");
            user.setEmail("4932200@qq.com");
            User user1 = mongoTemplate.insert(user);
            System.out.println(user1);
        }
    
        //查询所有
        @Test
        public void findUser() {
        
            List<User> userList = mongoTemplate.findAll(User.class);
            System.out.println(userList);
        }
    
        //根据id查询
        @Test
        public void getById() {
        
            User user = mongoTemplate.findById("5ffbfa2ac290f356edf9b5aa", User.class);
            System.out.println(user);
        }
    
        //条件查询
        @Test
        public void findUserList() {
        
            Query query = new Query(Criteria
                    .where("name").is("test")
                    .and("age").is(20));
            List<User> userList = mongoTemplate.find(query, User.class);
            System.out.println(userList);
        }
    
        //模糊查询
        @Test
        public void findUsersLikeName() {
        
            String name = "est";
            String regex = String.format("%s%s%s", "^.*", name, ".*$");
            Pattern pattern = Pattern.compile(regex, Pattern.CASE_INSENSITIVE);
            Query query = new Query(Criteria.where("name").regex(pattern));
            List<User> userList = mongoTemplate.find(query, User.class);
            System.out.println(userList);
        }
    
        //分页查询
        @Test
        public void findUsersPage() {
        
            String name = "est";
            int pageNo = 1;
            int pageSize = 10;
    
            Query query = new Query();
            String regex = String.format("%s%s%s", "^.*", name, ".*$");
            Pattern pattern = Pattern.compile(regex, Pattern.CASE_INSENSITIVE);
            query.addCriteria(Criteria.where("name").regex(pattern));
            int totalCount = (int) mongoTemplate.count(query, User.class);
            List<User> userList = mongoTemplate.find(query.skip((pageNo - 1) * pageSize).limit(pageSize), User.class);
    
            Map<String, Object> pageMap = new HashMap<>();
            pageMap.put("list", userList);
            pageMap.put("totalCount",totalCount);
            System.out.println(pageMap);
        }
    
        //修改
        @Test
        public void updateUser() {
        
            User user = mongoTemplate.findById("5ffbfa2ac290f356edf9b5aa", User.class);
            user.setName("test_1");
            user.setAge(25);
            user.setEmail("493220990@qq.com");
            Query query = new Query(Criteria.where("_id").is(user.getId()));
            Update update = new Update();
            update.set("name", user.getName());
            update.set("age", user.getAge());
            update.set("email", user.getEmail());
            UpdateResult result = mongoTemplate.upsert(query, update, User.class);
            long count = result.getModifiedCount();
            System.out.println(count);
        }
    
        //删除操作
        @Test
        public void delete() {
        
            Query query = new Query(Criteria.where("_id").is("5ffbfa2ac290f356edf9b5aa"));
            DeleteResult result = mongoTemplate.remove(query, User.class);
            long count = result.getDeletedCount();
            System.out.println(count);
        }
    
    }

![在这里插入图片描述][345fbd16d9d0437ca4875ba6634719b7.png]

## 五、基于 MongoRepository 开发 CRUD ##

**A、实现**

Spring Data 提供了对 MongoDB 数据访问的支持，我们只需要继承 MongoRepository 类，按照 Spring Data 规范就可以了 SpringData 方法定义规范。

![在这里插入图片描述][f6f58498150d478a8e4ec97468f27ea9.png]  
![在这里插入图片描述][92ba54c664814639b575cb5c818829b5.png]  
1、 不是随便声明的，而需要符合一定的规范  
2、 查询方法以`find | read | get`开头  
3、 涉及条件查询时，条件的属性用条件关键字连接  
4、 要注意的是：条件属性首字母需要大写  
5、 支持属性的级联查询，但若当前类有符合条件的属性则优先使用，而不使用级联属性,若需要使用级联属性，则属性之间使用\_强制进行连接

**B、添加 Repository 类**

添加 com.fancy.mongodb.repository.UserRepository 类

package com.fancy.mongodb.repository;
    
    import com.fancy.mongodb.entity.User;
    import org.springframework.data.mongodb.repository.MongoRepository;
    import org.springframework.stereotype.Repository;
    
    import java.util.List;
    
    @Repository
    public interface UserRepository extends MongoRepository<User, String> {
    
    }

![在这里插入图片描述][aca0d75d4fc24602a91372f243cdb61b.png]

**C、添加测试类**

在 /test/java 下面添加测试类：

@SpringBootTest
    class DemomogoApplicationTests1 {
    
        @Autowired
        private UserRepository userRepository;
    
        //添加
        @Test
        public void createUser() {
            User user = new User();
            user.setAge(20);
            user.setName("张三");
            user.setEmail("3332200@qq.com");
            User user1 = userRepository.save(user);
        }
    
        //查询所有
        @Test
        public void findUser() {
            List<User> userList = userRepository.findAll();
            System.out.println(userList);
        }
    
        //id查询
        @Test
        public void getById() {
            User user = userRepository.findById("5ffbfe8197f24a07007bd6ce").get();
            System.out.println(user);
        }
    
        //条件查询
        @Test
        public void findUserList() {
            User user = new User();
            user.setName("张三");
            user.setAge(20);
            Example<User> userExample = Example.of(user);
            List<User> userList = userRepository.findAll(userExample);
            System.out.println(userList);
        }
    
        //模糊查询
        @Test
        public void findUsersLikeName() {
            //创建匹配器，即如何使用查询条件
            ExampleMatcher matcher = ExampleMatcher.matching() //构建对象
                    .withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING) //改变默认字符串匹配方式：模糊查询
                    .withIgnoreCase(true); //改变默认大小写忽略方式：忽略大小写
            User user = new User();
            user.setName("三");
            Example<User> userExample = Example.of(user, matcher);
            List<User> userList = userRepository.findAll(userExample);
            System.out.println(userList);
        }
    
        //分页查询
        @Test
        public void findUsersPage() {
            Sort sort = Sort.by(Sort.Direction.DESC, "age");
    		//0为第一页
            Pageable pageable = PageRequest.of(0, 10, sort);
    		//创建匹配器，即如何使用查询条件
            ExampleMatcher matcher = ExampleMatcher.matching() //构建对象
                    .withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING) //改变默认字符串匹配方式：模糊查询
                    .withIgnoreCase(true); //改变默认大小写忽略方式：忽略大小写
            User user = new User();
            user.setName("三");
            Example<User> userExample = Example.of(user, matcher);
    		//创建实例
            Example<User> example = Example.of(user, matcher);
            Page<User> pages = userRepository.findAll(example, pageable);
            System.out.println(pages);
        }
    
        //修改
        @Test
        public void updateUser() {
            User user = userRepository.findById("5ffbfe8197f24a07007bd6ce").get();
            user.setName("张三_1");
            user.setAge(25);
            user.setEmail("883220990@qq.com");
            User save = userRepository.save(user);
            System.out.println(save);
        }
    
        //删除
        @Test
        public void delete() {
            userRepository.deleteById("5ffbfe8197f24a07007bd6ce");
        }
    }

![在这里插入图片描述][ca2c7f1b954a4bc4866ad08070bf6188.png]

[781fa2a846e64b949316202207dcee03.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/ce4b1f2370494f2587ad34c2c3ea9027.png
[a007275b863c4530ba818a5b125e4ae5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4c43dddf2d21489e8cbf1973df8c299f.png
[11dbdad72a4c4c5e8d9b19f9a7cdee3a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/b0888e9b61fa451c8631b4a314008bbc.png
[6189c95f18f1489a876c5befccbb3197.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/41c9c5f4c70c4df0b2a55acdbf2e7f76.png
[15d3fd3dcfd340ceb0fcd6da019c612a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e931e7b91fb14fb8bc6c8480c9ae39e6.png
[345fbd16d9d0437ca4875ba6634719b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/bbdb034933bb4018a5c000863df286c8.png
[f6f58498150d478a8e4ec97468f27ea9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/eec1b846ea8e4bc8a65d77901606d013.png
[92ba54c664814639b575cb5c818829b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/abf679adec954201aecadec2cbecc327.png
[aca0d75d4fc24602a91372f243cdb61b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/835ca0879acc4dd790e3cbe1bdf0a2f2.png
[ca2c7f1b954a4bc4866ad08070bf6188.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/67722cb950ca4e708215279967e8b289.png