SpringBoot 2.1.7 集成 Spring Data MongoDB

绝地灬酷狼 2021-09-19 23:56 295阅读 0赞

# SpringBoot 2.1.7 集成 Spring Data MongoDB #

使用SpringBoot集成 Spring Data MongoDB有两种方式，本文使用IDEA搭建：

*  1.Spring Initializr
 *  2.使用IDEA插件

> *环境信息*：  
> *OS：Win10  
> Jdk：JavaSE 8  
> Ide：Idea Ultimate  
> Spring Boot：2.1.7.RELEASE*

## 2.创建Web项目 ##

Idea集成了Spring Initializr，新建项目：

*  1.选择Spring Initializr

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

*  2.填写基本信息  
    ![在这里插入图片描述][20190804211304950.png]
 *  3.选择需要的工具  
    选择`Web`和`Spring Data MongoDB`等必要依赖：

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

*  4.确认完成

忽略我的其他项目：  
![在这里插入图片描述][20190804212032569.png]

## 3.创建数据库&表 ##

### 3.1 创建数据库 ###

`手动`或`命令`创建数据库`studentService`：  
![在这里插入图片描述][2019080423582790.png]

### 3.2 创建数据表 ###

`右键`**数据库**，打开`Open Shell`执行`Js`脚本：

*  1.创建表

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

*  2.创建表索引

// -- Create students indexes --
    var studentsIndexNames = db.userRoles.getIndexes().map(function (i) { 
        return i.name
    });
    
    if (!studentsIndexNames.includes('unique_name_address')) { 
        db.students.createIndex({ 
            "name": 1,
            "address": 1
        }, { 
            name: "unique_name_address",
            background: true,
            unique: true
        });
        print('create students index unique_name_address');
    }
    
    // -- Create scores indexes --
    var scoresIndexNames = db.scores.getIndexes().map(function (i) { 
        return i.name
    });
    
    if (!scoresIndexNames.includes('unique_studentId_subject')) { 
        db.scores.createIndex({ 
            "studentId": 1,
            "subject": 1
        }, { 
            name: "unique_studentId_subject",
            background: true,
            unique: true
        });
        print('create scores index unique_studentId_subject');
    }

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

### 3.3 插入初始化数据 ###

预览数据：  
![在这里插入图片描述][2019080715402917.png]

## 4.集成Spring Data MongoDB ##

### 4.1 配置MongoDB链接信息 ###

`application-dev.yml`：

spring:
      data:
        mongodb:
          database: studentService
          host: localhost
          port: 27017

### 4.2 创建Domain ###

`Student`:

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    @Builder
    @Document(collection = "students")
    public class Student { 
        @Id
        @JsonSerialize(using = ObjectIdSerializer.class)
        private ObjectId id;
        private String name;
        private Integer age;
        private String sex;
        private List<String> hobbies;
        private String address;
    }

`Score`:

@Data
    @Builder
    @Document(collection = "scores")
    public class Score { 
        @Id
        @JsonSerialize(using = ObjectIdSerializer.class)
        private ObjectId id;
        //学生编号
        @JsonSerialize(using = ObjectIdSerializer.class)
        private ObjectId studentId;
    
        private String studentName;
        //科目
        private String subject;
        //科目成绩
        private Integer subjectScore;
    }

`StudentScore`:

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    @Builder
    public class StudentScore { 
        private String name;
        private Integer age;
        private String sex;
        private Score score;
    }

`StudentScores`:

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    @Builder
    public class StudentScores { 
        private String name;
        private Integer age;
        private String sex;
        private List<Score> scoreList;
    }

### 4.3 创建StudentRepository ###

`StudentRepository` 继承自 `CrudRepository`，可以通过方法名映射来定义方法：

public interface StudentRepository extends CrudRepository<Student, ObjectId> { 
    
        public Student findStudentByName(String name);
    
        public Student findStudentByNameAndSex(String name, String sex);
    
        public Student findStudentByNameIn(List<String> name);
    
        public Integer deleteStudentByName(String name);
    
    }

> 方法名映射，参考：[https://docs.spring.io/spring-data/jpa/docs/current/reference/html/\#jpa.query-methods.query-creation][https_docs.spring.io_spring-data_jpa_docs_current_reference_html_jpa.query-methods.query-creation]

### 4.4 创建CustomizedStudentRepository ###

当方法名映射无法满足需求的时候，可以自定义Repository，通过调用`MongoTemplate`的API来实现复杂查询、多表关联查询等：

@Repository
    public class CustomizedStudentRepositoryImpl implements CustomizedStudentRepository { 
    
        @Autowired
        private MongoTemplate mongoTemplate;
    
        @Override
        public StudentScore findStudentScoreByName(String name) { 
            return null;
        }
    
        /** * 查找大于"10"岁 性别是"男" 并且 爱好"语文"和"英语"的 童鞋们 * * @return */
        public List<Student> findStudentListByAgeAndSexAndHobbies() { 
            Query query = query(where("age").gte(10)
              .and("sex").is("Male")
              .orOperator(where("hobbies").is("YuWen"),
                where("hobbies").is("English")));
            List<Student> students = mongoTemplate.find(query, Student.class, "students");
            return students;
        }
    
        /** * 查询所有童鞋和他们的各科成绩 * * @return */
        public List<StudentScores> findStudentScoreList() { 
            Aggregation aggregation = Aggregation.newAggregation(
              newLookup()
                .from("scores")
                .localField("name")
                .foreignField("studentName")
                .as("scores"),
              project()
                .andExpression("name").as("name")
                .andExpression("age").as("age")
                .andExpression("sex").as("sex")
                .andExpression("scores").as("scoreList"));
    
            AggregationResults<StudentScores> aggregationResults = mongoTemplate.aggregate(aggregation, "students", StudentScores.class);
            List<StudentScores> studentScores = aggregationResults.getMappedResults();
            return studentScores;
        }
    
        /** * 查询大于"10岁" 喜欢"语文"或"英语" 的"男孩" 的 "英语"成绩 * * @return */
        public List<StudentScore> findStudentScores() { 
            Aggregation aggregation = Aggregation.newAggregation(
              newLookup()
                .from("scores")
                .localField("name")
                .foreignField("studentName")
                .as("scores"),
              match(where("age").gte(10)
                .and("sex").is("Male")
                //.and("scores.subjectScore").gt(60) 这里不生效
                .orOperator(where("hobbies").is("YuWen"), where("hobbies").is("English"))),
              project()
                .andExpression("name").as("name")
                .andExpression("age").as("age")
                .andExpression("sex").as("sex")
                .andExpression("scores").as("score"),
              unwind("score"),
              match(where("score.subject").is("English")));
    
            AggregationResults<StudentScore> aggregationResults = mongoTemplate.aggregate(aggregation, "students", StudentScore.class);
            List<StudentScore> studentScores = aggregationResults.getMappedResults();
            return studentScores;
        }
    }

> 定制化Repository，参考：[https://docs.spring.io/spring-data/jpa/docs/current/reference/html/\#repositories.single-repository-behavior][https_docs.spring.io_spring-data_jpa_docs_current_reference_html_repositories.single-repository-behavior]

### 4.5 创建Service ###

@Service
    public class StudentService { 
    
        @Autowired
        private StudentRepository studentRepository;
    
        @Autowired
        private CustomizedStudentRepository customizedStudentRepository;
    
        public Student addStudent(Student student) { 
            return studentRepository.save(student);
        }
    
        public Integer deleteStudentByName(String name) { 
            return studentRepository.deleteStudentByName(name);
        }
    
    
        public Student updateStudent(Student student) { 
            Student studentByName = studentRepository.findStudentByName(student.getName());
            student.setId(studentByName.getId());
            Student saveStudent = studentRepository.save(student);
            return saveStudent;
        }
    
    
        public Student findStudentById(ObjectId id) { 
            Optional<Student> studentOptional = studentRepository.findById(id);
            return studentOptional.orElseGet(Student::new);
        }
    
        public Student findStudentByNameAndSex(String name, String sex) { 
            Student student = studentRepository.findStudentByNameAndSex(name, sex);
            return student;
        }
    
        public List<Student> findStudents() { 
            List<Student> students = (List) studentRepository.findAll();
            return students;
        }
    
        public List<Student> findStudentsById(List<ObjectId> ids) { 
            List<Student> students = (List) studentRepository.findAllById(ids);
            return students;
        }
    
        public List<Student> findStudentListByAgeAndSexAndHobbies() { 
            List<Student> studentList = customizedStudentRepository.findStudentListByAgeAndSexAndHobbies();
            return studentList;
        }
    
        public List<StudentScores> findStudentScoreList() { 
            List<StudentScores> studentScoreList = customizedStudentRepository.findStudentScoreList();
            return studentScoreList;
        }
        public List<StudentScore> findStudentScores() { 
            List<StudentScore> studentScoreList = customizedStudentRepository.findStudentScores();
            return studentScoreList;
        }
    
    
    
    }

### 4.6 创建Controller ###

@RestController
    public class StudentController { 
        @Autowired
        private StudentService studentService;
    
        @GetMapping("/students")
        public List<Student> getStudentList() { 
            List<Student> students = studentService.findStudents();
            return students;
        }
    
        @PostMapping("/students")
        public Student saveStudent(@RequestBody Student student) { 
            Student addStudent = studentService.addStudent(student);
            return addStudent;
        }
    
        @DeleteMapping("/students/{name}")
        public Integer deleteStudentByName(@PathVariable String name) { 
            Integer deleteNum = studentService.deleteStudentByName(name);
            return deleteNum;
        }
    
        @PutMapping("/students")
        public Student updateStudent(@RequestBody Student student) { 
            Student updateStudent = studentService.updateStudent(student);
            return updateStudent;
        }
    
        @GetMapping("/students/list")
        public List<Student> getStudentListByAgeAndSexAndHobbies() { 
            List<Student> studentList = studentService.findStudentListByAgeAndSexAndHobbies();
            return studentList;
        }
    
        @GetMapping("/students/scores")
        public List<StudentScores> getStudentScoresList() { 
            List<StudentScores> studentList = studentService.findStudentScoreList();
            return studentList;
        }
    
        @GetMapping("/students/score")
        public List<StudentScore> getStudentScoreList() { 
            List<StudentScore> studentScores = studentService.findStudentScores();
            return studentScores;
        }
    
    }

两个比较复杂的接口返回：  
`/students/scores`：  
![在这里插入图片描述][20190807154827623.png]

`/students/score`：  
![在这里插入图片描述][20190807154900617.png]

代码 --> [https://github.com/WeisonWei/springboot-aggregation/tree/master/springboot-mvc-mongodb][https_github.com_WeisonWei_springboot-aggregation_tree_master_springboot-mvc-mongodb]

[20190731230516555.png]: /images/20210911/8f395ab6c5da48169087766049af9ff5.png
[20190804211304950.png]: /images/20210911/926279e70bf74da7bd620cda7790041f.png
[20190812231526864.png]: /images/20210911/b2e015f90a61460f8d9d2a244d93c19f.png
[20190804212032569.png]: /images/20210911/df9ce630e1e64da7974e95bab9b99ac6.png
[2019080423582790.png]: /images/20210911/a61a8b5df4a449ae9d2947a8d03d298e.png
[20190805000909587.png]: /images/20210911/dcacd520fdc94420b6802dc8344af392.png
[20190805000053795.png]: /images/20210911/9d3adbf9e4d3432ea75615980025d6ba.png
[2019080715402917.png]: /images/20210911/17cc8b944711463db85019df8e6175bd.png
[https_docs.spring.io_spring-data_jpa_docs_current_reference_html_jpa.query-methods.query-creation]: https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation
[https_docs.spring.io_spring-data_jpa_docs_current_reference_html_repositories.single-repository-behavior]: https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.single-repository-behavior
[20190807154827623.png]: /images/20210911/4c7f78ff49904f4c9f0fa4887c25d0be.png
[20190807154900617.png]: /images/20210911/8d8b7fc50b884bdea41db8110b47335e.png
[https_github.com_WeisonWei_springboot-aggregation_tree_master_springboot-mvc-mongodb]: https://github.com/WeisonWei/springboot-aggregation/tree/master/springboot-mvc-mongodb