1.环境信息

使用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

Spring Boot 2.x 集成 Spring Data MongoDB - 图1

  • 2.填写基本信息
    Spring Boot 2.x 集成 Spring Data MongoDB - 图2
  • 3.选择需要的工具
    选择Web和Spring Data MongoDB等必要依赖：

Spring Boot 2.x 集成 Spring Data MongoDB - 图3

  • 4.确认完成

忽略我的其他项目：
Spring Boot 2.x 集成 Spring Data MongoDB - 图4

3.创建数据库&表

3.1 创建数据库

手动或命令创建数据库studentService：
Spring Boot 2.x 集成 Spring Data MongoDB - 图5

3.2 创建数据表

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

  • 1.创建表
  1. var names = db.getCollectionNames();
  2. // -- Create Collections --
  3. if (!names.includes('students')) {
  4.     db.createCollection("students", {});
  5.     print("create collection students");
  6. }
  7. if (!names.includes('scores')) {
  8.     db.createCollection("scores", {});
  9.     print("create collection scores");
  10. }

Spring Boot 2.x 集成 Spring Data MongoDB - 图6

  • 2.创建表索引
  1. // -- Create students indexes --
  2. var studentsIndexNames = db.userRoles.getIndexes().map(function (i) {
  3.     return i.name
  4. });
  6. if (!studentsIndexNames.includes('unique_name_address')) {
  7.     db.students.createIndex({
  8.         "name": 1,
  9.         "address": 1
  10.     }, {
  11.         name: "unique_name_address",
  12.         background: true,
  13.         unique: true
  14.     });
  15.     print('create students index unique_name_address');
  16. }
  18. // -- Create scores indexes --
  19. var scoresIndexNames = db.scores.getIndexes().map(function (i) {
  20.     return i.name
  21. });
  23. if (!scoresIndexNames.includes('unique_studentId_subject')) {
  24.     db.scores.createIndex({
  25.         "studentId": 1,
  26.         "subject": 1
  27.     }, {
  28.         name: "unique_studentId_subject",
  29.         background: true,
  30.         unique: true
  31.     });
  32.     print('create scores index unique_studentId_subject');
  33. }

Spring Boot 2.x 集成 Spring Data MongoDB - 图7

3.3 插入初始化数据

  1. var studentsResult = db.students.findOne({"name": "Even"});
  2. if (studentsResult == null) {
  3.     db.students.insert([  /* 1 */
  4.                            {
  5.                                "name" : "Even",
  6.                                "age" : 9.0,
  7.                                "sex" : "Male",
  8.                                "address" : "Xian",
  9.                                "hobbies" : [
  10.                                    "YuWen",
  11.                                    "English"
  12.                                ]
  13.                            },
  14.                            /* 2 */
  15.                            {
  16.                                "name" : "Weison",
  17.                                "age" : 10.0,
  18.                                "sex" : "Male",
  19.                                "address" : "Henan",
  20.                                "hobbies" : [
  21.                                    "Wuli",
  22.                                    "English"
  23.                                ]
  24.                            },
  25.                            /* 3 */
  26.                            {
  27.                                "name" : "Angule",
  28.                                "age" : 13,
  29.                                "sex" : "Female",
  30.                                "hobbies" : [
  31.                                    "YuWen",
  32.                                    "English"
  33.                                ],
  34.                                "address" : "Chengdu",
  35.                                "_class" : "com.wxx.sbm.domain.Student"
  36.                            }]);
  37. }
  40. var scoresResult = db.scores.findOne({"studentName": "Even"});
  41. if (scoresResult == null) {
  42.     db.scores.insert([/* 1 */
  43.                       {
  44.                           "studentId" : "5d48dc820fd614486f1c1f09",
  45.                           "subject" : "YuWen",
  46.                           "studentName" : "Weison",
  47.                           "subjectScore" : 90
  48.                       },
  49.                       /* 2 */
  50.                       {
  51.                           "studentId" : "5d48dc820fd614486f1c1f09",
  52.                           "subject" : "English",
  53.                           "studentName" : "Weison",
  54.                           "subjectScore" : 98
  55.                       },
  56.                       /* 3 */
  57.                       {
  58.                           "studentId" : "5d48dc820fd614486f1c1f09",
  59.                           "subject" : "ShuXue",
  60.                           "studentName" : "Weison",
  61.                           "subjectScore" : 59
  62.                       },
  63.                       /* 4 */
  64.                       {
  65.                           "studentId" : "5d48dc820fd614486f1c1f08",
  66.                           "subject" : "YuWen",
  67.                           "studentName" : "Even",
  68.                           "subjectScore" : 90
  69.                       },
  70.                       /* 5 */
  71.                       {
  72.                           "studentId" : "5d48dc820fd614486f1c1f08",
  73.                           "subject" : "English",
  74.                           "studentName" : "Even",
  75.                           "subjectScore" : 98
  76.                       },
  77.                       /* 6 */
  78.                       {
  79.                           "studentId" : "5d48dc820fd614486f1c1f08",
  80.                           "subject" : "ShuXue",
  81.                           "studentName" : "Even",
  82.                           "subjectScore" : 59
  83.                       },
  84.                       /* 7 */
  85.                       {
  86.                           "studentId" : "5d48f09b4cf1451aad930f54",
  87.                           "subject" : "YuWen",
  88.                           "studentName" : "Angule",
  89.                           "subjectScore" : 90
  90.                       },
  91.                       /* 8 */
  92.                       {
  93.                           "studentId" : "5d48f09b4cf1451aad930f54",
  94.                           "subject" : "English",
  95.                           "studentName" : "Angule",
  96.                           "subjectScore" : 98
  97.                       },
  98.                       /* 9 */
  99.                       {
  100.                           "studentId" : "5d48f09b4cf1451aad930f54",
  101.                           "subject" : "ShuXue",
  102.                           "studentName" : "Angule",
  103.                           "subjectScore" : 59
  104.                       }]);
  105. }

预览数据：
Spring Boot 2.x 集成 Spring Data MongoDB - 图8

4.集成Spring Data MongoDB

4.1 配置MongoDB链接信息

application-dev.yml：

  1. spring:
  2.   data:
  3.     mongodb:
  4.       database: studentService
  5.       host: localhost
  6.       port: 27017

4.2 创建Domain

Student:

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. @Builder
  5. @Document(collection = "students")
  6. public class Student {
  7.     @Id
  8.     @JsonSerialize(using = ObjectIdSerializer.class)
  9.     private ObjectId id;
  10.     private String name;
  11.     private Integer age;
  12.     private String sex;
  13.     private List<String> hobbies;
  14.     private String address;
  15. }

Score:

  1. @Data
  2. @Builder
  3. @Document(collection = "scores")
  4. public class Score {
  5.     @Id
  6.     @JsonSerialize(using = ObjectIdSerializer.class)
  7.     private ObjectId id;
  8.     //学生编号
  9.     @JsonSerialize(using = ObjectIdSerializer.class)
  10.     private ObjectId studentId;
  12.     private String studentName;
  13.     //科目
  14.     private String subject;
  15.     //科目成绩
  16.     private Integer subjectScore;
  17. }

StudentScore:

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. @Builder
  5. public class StudentScore {
  6.     private String name;
  7.     private Integer age;
  8.     private String sex;
  9.     private Score score;
  10. }

StudentScores:

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. @Builder
  5. public class StudentScores {
  6.     private String name;
  7.     private Integer age;
  8.     private String sex;
  9.     private List<Score> scoreList;
  10. }

4.3 创建StudentRepository

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

  1. public interface StudentRepository extends CrudRepository<Student, ObjectId> {
  3.     public Student findStudentByName(String name);
  5.     public Student findStudentByNameAndSex(String name, String sex);
  7.     public Student findStudentByNameIn(List<String> name);
  9.     public Integer deleteStudentByName(String name);
  11. }

方法名映射，参考：https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation

4.4 创建CustomizedStudentRepository

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

  1. @Repository
  2. public class CustomizedStudentRepositoryImpl implements CustomizedStudentRepository {
  4.     @Autowired
  5.     private MongoTemplate mongoTemplate;
  7.     @Override
  8.     public StudentScore findStudentScoreByName(String name) {
  9.         return null;
  10.     }
  12.     /**
  13.      * 查找大于"10"岁 性别是"男" 并且 爱好"语文"和"英语"的 童鞋们
  14.      *
  15.      * @return
  16.      */
  17.     public List<Student> findStudentListByAgeAndSexAndHobbies() {
  18.         Query query = query(where("age").gte(10)
  19.           .and("sex").is("Male")
  20.           .orOperator(where("hobbies").is("YuWen"),
  21.             where("hobbies").is("English")));
  22.         List<Student> students = mongoTemplate.find(query, Student.class, "students");
  23.         return students;
  24.     }
  26.     /**
  27.      * 查询所有童鞋和他们的各科成绩
  28.      *
  29.      * @return
  30.      */
  31.     public List<StudentScores> findStudentScoreList() {
  32.         Aggregation aggregation = Aggregation.newAggregation(
  33.           newLookup()
  34.             .from("scores")
  35.             .localField("name")
  36.             .foreignField("studentName")
  37.             .as("scores"),
  38.           project()
  39.             .andExpression("name").as("name")
  40.             .andExpression("age").as("age")
  41.             .andExpression("sex").as("sex")
  42.             .andExpression("scores").as("scoreList"));
  44.         AggregationResults<StudentScores> aggregationResults = mongoTemplate.aggregate(aggregation, "students", StudentScores.class);
  45.         List<StudentScores> studentScores = aggregationResults.getMappedResults();
  46.         return studentScores;
  47.     }
  49.     /**
  50.      * 查询大于"10岁" 喜欢"语文"或"英语" 的"男孩" 的 "英语"成绩
  51.      *
  52.      * @return
  53.      */
  54.     public List<StudentScore> findStudentScores() {
  55.         Aggregation aggregation = Aggregation.newAggregation(
  56.           newLookup()
  57.             .from("scores")
  58.             .localField("name")
  59.             .foreignField("studentName")
  60.             .as("scores"),
  61.           match(where("age").gte(10)
  62.             .and("sex").is("Male")
  63.             //.and("scores.subjectScore").gt(60) 这里不生效
  64.             .orOperator(where("hobbies").is("YuWen"), where("hobbies").is("English"))),
  65.           project()
  66.             .andExpression("name").as("name")
  67.             .andExpression("age").as("age")
  68.             .andExpression("sex").as("sex")
  69.             .andExpression("scores").as("score"),
  70.           unwind("score"),
  71.           match(where("score.subject").is("English")));
  73.         AggregationResults<StudentScore> aggregationResults = mongoTemplate.aggregate(aggregation, "students", StudentScore.class);
  74.         List<StudentScore> studentScores = aggregationResults.getMappedResults();
  75.         return studentScores;
  76.     }
  77. }

定制化Repository，参考：https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.single-repository-behavior

4.5 创建Service

  1. @Service
  2. public class StudentService {
  4.     @Autowired
  5.     private StudentRepository studentRepository;
  7.     @Autowired
  8.     private CustomizedStudentRepository customizedStudentRepository;
  10.     public Student addStudent(Student student) {
  11.         return studentRepository.save(student);
  12.     }
  14.     public Integer deleteStudentByName(String name) {
  15.         return studentRepository.deleteStudentByName(name);
  16.     }
  19.     public Student updateStudent(Student student) {
  20.         Student studentByName = studentRepository.findStudentByName(student.getName());
  21.         student.setId(studentByName.getId());
  22.         Student saveStudent = studentRepository.save(student);
  23.         return saveStudent;
  24.     }
  27.     public Student findStudentById(ObjectId id) {
  28.         Optional<Student> studentOptional = studentRepository.findById(id);
  29.         return studentOptional.orElseGet(Student::new);
  30.     }
  32.     public Student findStudentByNameAndSex(String name, String sex) {
  33.         Student student = studentRepository.findStudentByNameAndSex(name, sex);
  34.         return student;
  35.     }
  37.     public List<Student> findStudents() {
  38.         List<Student> students = (List) studentRepository.findAll();
  39.         return students;
  40.     }
  42.     public List<Student> findStudentsById(List<ObjectId> ids) {
  43.         List<Student> students = (List) studentRepository.findAllById(ids);
  44.         return students;
  45.     }
  47.     public List<Student> findStudentListByAgeAndSexAndHobbies() {
  48.         List<Student> studentList = customizedStudentRepository.findStudentListByAgeAndSexAndHobbies();
  49.         return studentList;
  50.     }
  52.     public List<StudentScores> findStudentScoreList() {
  53.         List<StudentScores> studentScoreList = customizedStudentRepository.findStudentScoreList();
  54.         return studentScoreList;
  55.     }
  56.     public List<StudentScore> findStudentScores() {
  57.         List<StudentScore> studentScoreList = customizedStudentRepository.findStudentScores();
  58.         return studentScoreList;
  59.     }
  63. }

4.6 创建Controller

  1. @RestController
  2. public class StudentController {
  3.     @Autowired
  4.     private StudentService studentService;
  6.     @GetMapping("/students")
  7.     public List<Student> getStudentList() {
  8.         List<Student> students = studentService.findStudents();
  9.         return students;
  10.     }
  12.     @PostMapping("/students")
  13.     public Student saveStudent(@RequestBody Student student) {
  14.         Student addStudent = studentService.addStudent(student);
  15.         return addStudent;
  16.     }
  18.     @DeleteMapping("/students/{name}")
  19.     public Integer deleteStudentByName(@PathVariable String name) {
  20.         Integer deleteNum = studentService.deleteStudentByName(name);
  21.         return deleteNum;
  22.     }
  24.     @PutMapping("/students")
  25.     public Student updateStudent(@RequestBody Student student) {
  26.         Student updateStudent = studentService.updateStudent(student);
  27.         return updateStudent;
  28.     }
  30.     @GetMapping("/students/list")
  31.     public List<Student> getStudentListByAgeAndSexAndHobbies() {
  32.         List<Student> studentList = studentService.findStudentListByAgeAndSexAndHobbies();
  33.         return studentList;
  34.     }
  36.     @GetMapping("/students/scores")
  37.     public List<StudentScores> getStudentScoresList() {
  38.         List<StudentScores> studentList = studentService.findStudentScoreList();
  39.         return studentList;
  40.     }
  42.     @GetMapping("/students/score")
  43.     public List<StudentScore> getStudentScoreList() {
  44.         List<StudentScore> studentScores = studentService.findStudentScores();
  45.         return studentScores;
  46.     }
  48. }

两个比较复杂的接口返回：
/students/scores：
Spring Boot 2.x 集成 Spring Data MongoDB - 图9

/students/score：
Spring Boot 2.x 集成 Spring Data MongoDB - 图10

代码 —> https://github.com/WeisonWei/springboot-aggregation/tree/master/springboot-mvc-mongodb