原文： http://zetcode.com/springboot/mongodb/

Spring Boot MongoDB 教程展示了如何在 Spring Boot 框架中访问 MongoDB 中的数据。

Spring 是流行的 Java 应用框架，而 Spring Boot 是 Spring 的演进，可以帮助轻松地创建独立的，生产级的基于 Spring 的应用。

MongoDB

MongoDB 是 NoSQL 跨平台的面向文档的数据库。 它是可用的最受欢迎的数据库之一。 MongoDB 由 MongoDB Inc. 开发，并作为免费和开源软件发布。

Spring Data MongoDB 项目提供了与 MongoDB 文档数据库的集成。

安装 MongoDB

以下命令可用于在基于 Debian 的 Linux 上安装 MongoDB。

  1. $ sudo apt-get install mongodb

该命令将安装 MongoDB 随附的必要包。

  1. $ sudo service mongodb status
  2. mongodb start/running, process 975

使用sudo service mongodb status命令，我们检查mongodb服务器的状态。

  1. $ sudo service mongodb start
  2. mongodb start/running, process 6448

mongodb服务器由sudo service mongodb start命令启动。

Spring Boot MongoDB 示例

在以下示例中，我们创建一个使用 MongoDB 数据库的简单 Spring Boot 应用。 请注意，默认情况下，没有任何特定配置，Spring Boot 会尝试使用test数据库名称连接到本地托管的 MongoDB 实例。

  1. pom.xml
  2. src
  3. ├───main
  4. │   ├───java
  5. │   │   └───com
  6. │   │       └───zetcode
  7. │   │           │   Application.java
  8. │   │           │   MyRunner.java
  9. │   │           ├───model
  10. │   │           │       Country.java
  11. │   │           └───repository
  12. │   │                   CountryRepository.java
  13. │   └───resources
  14. │           application.properties
  15. └───test
  16.     └───java
  17.         └───com
  18.             └───zetcode
  19.                     MongoTest.java

这是 Spring 应用的项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5.          http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6.     <modelVersion>4.0.0</modelVersion>
  8.     <groupId>com.zetcode</groupId>
  9.     <artifactId>springbootmongodb</artifactId>
  10.     <version>1.0-SNAPSHOT</version>
  12.     <packaging>jar</packaging>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.         <maven.compiler.source>11</maven.compiler.source>
  16.         <maven.compiler.target>11</maven.compiler.target>
  17.     </properties>
  19.     <parent>
  20.         <groupId>org.springframework.boot</groupId>
  21.         <artifactId>spring-boot-starter-parent</artifactId>
  22.         <version>2.1.1.RELEASE</version>
  23.     </parent>
  25.     <dependencies>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-data-mongodb</artifactId>
  30.         </dependency>
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-starter-test</artifactId>
  35.             <scope>test</scope>
  36.         </dependency>
  38.     </dependencies>
  40.     <build>
  41.         <plugins>
  42.             <plugin>
  43.                 <groupId>org.springframework.boot</groupId>
  44.                 <artifactId>spring-boot-maven-plugin</artifactId>
  45.             </plugin>
  46.         </plugins>
  47.     </build>
  48. </project>

这是 Maven pom.xml文件。

Spring Boot 启动器是一组方便的依赖项描述符，可以极大地简化 Maven 配置。 spring-boot-starter-parent具有 Spring Boot 应用的一些常用配置。 spring-boot-starter-data-mongodb是使用 MongoDB 面向文档的数据库和 Spring Data MongoDB 的入门。 spring-boot-starter-test是使用包含 JUnit，Hamcrest 和 Mockito 的库测试 Spring Boot 应用的入门程序。

在spring-boot-maven-plugin提供了 Maven 的 Spring Boot 支持，使我们能够打包可执行的 JAR 或 WAR 档案。 它的spring-boot:run目标运行 Spring Boot 应用。

resources/application.properties

  1. spring.main.banner-mode=off
  2. logging.level.org.springframework=ERROR

在application.properties中，我们打开 Spring Boot 横幅并设置日志记录属性。 默认情况下，Spring Boot 会尝试使用测试数据库连接到 MongoDB 的本地托管实例。

  1. # mongodb
  2. spring.data.mongodb.host=localhost
  3. spring.data.mongodb.port=27017
  4. spring.data.mongodb.database=testdb

如果要配置 MongoDB，可以设置相应的属性。

com/zetcode/model/Country.java

  1. package com.zetcode.model;
  3. import org.springframework.data.annotation.Id;
  4. import org.springframework.data.mongodb.core.mapping.Document;
  6. import java.util.Objects;
  8. @Document
  9. public class Country {
  11.     @Id
  12.     private String id;
  13.     private String name;
  14.     private int population;
  16.     public Country(String name, int population) {
  17.         this.name = name;
  18.         this.population = population;
  19.     }
  21.     public String getId() {
  22.         return id;
  23.     }
  25.     public void setId(String id) {
  26.         this.id = id;
  27.     }
  29.     public String getName() {
  30.         return name;
  31.     }
  33.     public void setName(String name) {
  34.         this.name = name;
  35.     }
  37.     public int getPopulation() {
  38.         return population;
  39.     }
  41.     public void setPopulation(int population) {
  42.         this.population = population;
  43.     }
  45.     @Override
  46.     public boolean equals(Object o) {
  47.         if (this == o) return true;
  48.         if (o == null || getClass() != o.getClass()) return false;
  49.         Country country = (Country) o;
  50.         return population == country.population &&
  51.                 Objects.equals(id, country.id) &&
  52.                 Objects.equals(name, country.name);
  53.     }
  55.     @Override
  56.     public int hashCode() {
  57.         return Objects.hash(id, name, population);
  58.     }
  60.     @Override
  61.     public String toString() {
  62.         final StringBuilder sb = new StringBuilder("Country{");
  63.         sb.append("id='").append(id).append('\'');
  64.         sb.append(", name='").append(name).append('\'');
  65.         sb.append(", population=").append(population);
  66.         sb.append('}');
  67.         return sb.toString();
  68.     }
  69. }

这是Country bean，具有三个属性：id，name和population。

  1. @Document
  2. public class Country {

Bean 用可选的@Document注解修饰。

  1. @Id
  2. private String id;

id用@Id注解修饰。 Spring 会自动为一个新生成的国家对象生成一个新的 ID。

com/zetcode/repository/CountryRepository.java

  1. package com.zetcode.repository;
  3. import com.zetcode.model.Country;
  4. import org.springframework.data.mongodb.repository.MongoRepository;
  6. public interface CountryRepository extends MongoRepository<Country, String> {
  8. }

通过从MongoRepository扩展，我们可以直接使用许多操作，包括标准 CRUD 操作。

com/zetcode/MyRunner.java

  1. package com.zetcode;
  3. import com.zetcode.model.Country;
  4. import com.zetcode.repository.CountryRepository;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.boot.CommandLineRunner;
  9. import org.springframework.stereotype.Component;
  11. @Component
  12. public class MyRunner implements CommandLineRunner {
  14.     private static final Logger logger = LoggerFactory.getLogger(MyRunner.class);
  16.     @Autowired
  17.     private CountryRepository repository;
  19.     @Override
  20.     public void run(String... args) throws Exception {
  22.         repository.deleteAll();
  24.         repository.save(new Country("China", 1382050000));
  25.         repository.save(new Country("India", 1313210000));
  27.         repository.findAll().forEach((country) -> {
  28.             logger.info("{}", country);
  29.         });
  30.     }
  31. }

我们有一个命令行运行器。 在其run()方法中，我们访问 MongoDB。

  1. @Autowired
  2. private CountryRepository repository;

CountryRepository注入了@Autowired注解。

  1. repository.deleteAll();

如果有，我们将使用deleteAll()删除所有国家。

  1. repository.save(new Country("China", 1382050000));

我们用save()保存一个国家。

  1. repository.findAll().forEach((country) -> {
  2.     logger.info("{}", country);
  3. });

我们使用findAll()方法遍历数据库中的所有国家。

com/zetcode/Application.java

  1. package com.zetcode;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class Application  {
  9.     public static void main(String[] args) {
  10.         SpringApplication.run(Application.class, args);
  11.     }
  12. }

这段代码设置了 Spring Boot 应用。

com/zetcode/MongoTest.java

  1. package com.zetcode;
  3. import com.zetcode.model.Country;
  4. import com.zetcode.repository.CountryRepository;
  5. import org.junit.Before;
  6. import org.junit.Test;
  7. import org.junit.runner.RunWith;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.boot.test.context.SpringBootTest;
  10. import org.springframework.data.domain.Example;
  11. import org.springframework.test.context.junit4.SpringRunner;
  13. import java.util.Optional;
  15. import static junit.framework.TestCase.assertEquals;
  16. import static org.assertj.core.api.Assertions.assertThat;
  18. @RunWith(SpringRunner.class)
  19. @SpringBootTest
  20. public class MongoTest {
  22.     @Autowired
  23.     private CountryRepository repository;
  25.     private static final int NUMBER_OF_COUNTRIES = 6;
  27.     @Before
  28.     public void init() {
  30.         repository.deleteAll();
  32.         repository.save(new Country("China", 1382050000));
  33.         repository.save(new Country("India", 1313210000));
  34.         repository.save(new Country("USA", 324666000));
  35.         repository.save(new Country("Indonesia", 260581000));
  36.         repository.save(new Country("Brazil", 207221000));
  37.         repository.save(new Country("Pakistan", 196626000));
  38.     }
  40.     @Test
  41.     public void countAllCountries() {
  43.         var countries = repository.findAll();
  44.         assertEquals(NUMBER_OF_COUNTRIES, countries.size());
  45.     }
  47.     @Test
  48.     public void countOneCountry() {
  50.         Example<Country> example = Example.of(new Country("China", 1382050000));
  52.         assertThat(repository.count(example)).isEqualTo(1L);
  53.     }
  55.     @Test
  56.     public void setsIdOnSave() {
  58.         Country nigeria = repository.save(new Country("Nigeria", 186988000));
  59.         assertThat(nigeria.getId()).isNotNull();
  60.     }
  62.     @Test
  63.     public void findOneCountry() {
  65.         Example<Country> example = Example.of(new Country("India", 1313210000));
  67.         Optional<Country> country = repository.findOne(example);
  68.         assertThat(country.get().getName()).isEqualTo("India");
  69.     }
  70. }

我们有四种测试方法。

  1. @Before
  2. public void init() {
  4.     repository.deleteAll();
  6.     repository.save(new Country("China", 1382050000));
  7.     repository.save(new Country("India", 1313210000));
  8.     repository.save(new Country("USA", 324666000));
  9.     repository.save(new Country("Indonesia", 260581000));
  10.     repository.save(new Country("Brazil", 207221000));
  11.     repository.save(new Country("Pakistan", 196626000));
  12. }

在init()方法中，我们保存了六个国家。

  1. @Test
  2. public void countAllCountries() {
  4.     var countries = repository.findAll();
  5.     assertEquals(NUMBER_OF_COUNTRIES, countries.size());
  6. }

我们测试数据库中有六个国家。

  1. @Test
  2. public void countOneCountry() {
  4.     Example<Country> example = Example.of(new Country("China", 1382050000));
  6.     assertThat(repository.count(example)).isEqualTo(1L);
  7. }

此方法测试数据库中只有一个中国。

  1. @Test
  2. public void setsIdOnSave() {
  4.     Country nigeria = repository.save(new Country("Nigeria", 186988000));
  5.     assertThat(nigeria.getId()).isNotNull();
  6. }

我们测试了在保存新国家/地区时，自动生成的 ID 不等于null。

  1. @Test
  2. public void findOneCountry() {
  4.     Example<Country> example = Example.of(new Country("India", 1313210000));
  6.     Optional<Country> country = repository.findOne(example);
  7.     assertThat(country.get().getName()).isEqualTo("India");
  8. }

我们测试findOne()方法找到一个国家，即印度。

在本教程中，我们学习了如何在 Spring Boot 应用中使用 MongoDB。 您可能也对相关教程感兴趣： Spring Boot REST 数据 JPA 教程， Spring Boot REST H2 教程， MongoDB Java 教程， Java 教程 或列出所有 Spring Boot 教程。