使用 MongoDB 访问数据 - springboot guide中文文档

本指南将引导您使用 Spring Data MongoDB 构建一个应用程序，该应用程序将数据存储到 MongoDB 中并从中检索数据，MongoDB 是一个基于文档的数据库。

您将构建什么

您将使用 Spring Data MongoDB 将 Customer POJO（普通 Java 对象）存储在 MongoDB 数据库中。

所需条件

大约15分钟
一个常用的文本编辑器或 IDE
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您还可以直接将代码导入到您的IDE中：

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到可运行的代码。

要 从头开始，请继续阅读使用 Spring Initializr 开始。

要 跳过基础知识，请执行以下操作：

下载并解压本指南的源码仓库，或使用 Git 克隆它：git clone https://github.com/spring-guides/gs-accessing-data-mongodb.git
进入 gs-accessing-data-mongodb/initial 目录
跳转到安装并启动 MongoDB。

完成后，您可以将您的结果与gs-accessing-data-mongodb/complete中的代码进行对比。

从 Spring Initializr 开始

您可以使用这个预先初始化的项目并点击生成以下载ZIP文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

访问 https://start.spring.io。该服务会为您拉取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假设您选择了 Java。
点击 Dependencies，然后选择 Spring Data MongoDB。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序的压缩包。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成这一过程。

您也可以从 Github 上 fork 该项目，然后在您的 IDE 或其他编辑器中打开它。

安装并启动 MongoDB

在项目设置完成后，您可以安装并启动 MongoDB 数据库。

如果您使用的是带有 Homebrew 的 Mac，可以运行以下命令：

$ brew install mongodb

使用 MacPorts，您可以运行以下命令：

$ port install mongodb

对于其他带有包管理系统的系统，如 Redhat、Ubuntu、Debian、CentOS 和 Windows，请参阅 https://docs.mongodb.org/manual/installation/ 上的说明。

安装 MongoDB 后，您可以通过在控制台窗口中运行以下命令来启动它（该命令还会启动服务器进程）：

$ mongod

您应该会看到类似以下的输出：

all output going to: /usr/local/var/log/mongodb/mongo.log

定义一个简单实体

MongoDB 是一种 NoSQL 文档存储。在这个示例中，您将存储 Customer 对象。以下清单展示了 Customer 类（位于 src/main/java/com/example/accessingdatamongodb/Customer.java）：

package com.example.accessingdatamongodb;

import org.springframework.data.annotation.Id;


public class Customer {

  @Id
  public String id;

  public String firstName;
  public String lastName;

  public Customer() {}

  public Customer(String firstName, String lastName) {
    this.firstName = firstName;
    this.lastName = lastName;
  }

  @Override
  public String toString() {
    return String.format(
        "Customer[id=%s, firstName='%s', lastName='%s']",
        id, firstName, lastName);
  }

}

这里您有一个 Customer 类，包含三个属性：id、firstName 和 lastName。id 主要用于 MongoDB 内部使用。您还有一个构造函数，用于在创建新实例时填充实体。

在本指南中，为了简洁起见，省略了典型的 getter 和 setter 方法。

id 符合 MongoDB ID 的标准命名，因此不需要任何特殊注解来标记它以用于 Spring Data MongoDB。

另外两个属性 firstName 和 lastName 则未添加注解。假设它们会被映射到与属性名称相同的字段。

方便的 toString() 方法会打印出客户的详细信息。

MongoDB 将数据存储在集合中。Spring Data MongoDB 将 Customer 类映射到一个名为 customer 的集合中。如果您想更改集合的名称，可以在类上使用 Spring Data MongoDB 的 @Document 注解。

创建简单查询

Spring Data MongoDB 专注于在 MongoDB 中存储数据。它还继承了 Spring Data Commons 项目的功能，例如派生查询的能力。本质上，您无需学习 MongoDB 的查询语言。只需编写少量方法，查询就会为您生成。

要了解其工作原理，请创建一个查询 Customer 文档的仓库接口，如下列代码所示（位于 src/main/java/com/example/accessingdatamongodb/CustomerRepository.java）：

package com.example.accessingdatamongodb;

import java.util.List;

import org.springframework.data.mongodb.repository.MongoRepository;

public interface CustomerRepository extends MongoRepository<Customer, String> {

  public Customer findByFirstName(String firstName);
  public List<Customer> findByLastName(String lastName);

}

CustomerRepository 继承自 MongoRepository 接口，并指定了它所处理的值的类型和 ID 类型：分别是 Customer 和 String。这个接口提供了许多操作，包括标准的 CRUD 操作（创建、读取、更新和删除）。

您可以通过声明方法签名来定义其他查询。在本例中，添加了 findByFirstName，它本质上查找类型为 Customer 的文档，并找到与 firstName 匹配的文档。

您还有 findByLastName，它通过姓氏查找人员列表。

在典型的 Java 应用程序中，您会编写一个实现 CustomerRepository 的类，并自己编写查询。Spring Data MongoDB 如此有用的原因在于，您无需创建这个实现。当您运行应用程序时，Spring Data MongoDB 会自动创建它。

现在，您可以连接这个应用程序，看看它的效果如何！

创建应用程序类

Spring Initializr 为应用程序创建了一个简单的类。以下清单展示了 Initializr 为此示例创建的类（位于 src/main/java/com/example/accessingdatamongodb/AccessingDataMongodbApplication.java 中）：

package com.example.accessingdatamongodb;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AccessingDataMongodbApplication {

  public static void main(String[] args) {
    SpringApplication.run(AccessingDataMongodbApplication.class, args);
  }

}

@SpringBootApplication 是一个便捷的注解，它包含了以下所有内容：

@Configuration: 将该类标记为应用程序上下文的 bean 定义源。
@EnableAutoConfiguration: 告诉 Spring Boot 根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果类路径上有 spring-webmvc，此注解会将应用程序标记为 Web 应用程序，并激活关键行为，例如设置 DispatcherServlet。
@ComponentScan: 告诉 Spring 在 com/example 包中查找其他组件、配置和服务，使其能够找到控制器。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法来启动应用程序。您是否注意到没有一行 XML 代码？也没有 web.xml 文件。这个 Web 应用程序是 100% 纯 Java 的，您不需要处理任何配置管道或基础设施。

只要这些仓库包含在您的 @SpringBootApplication 类所在的包（或子包）中，Spring Boot 就会自动处理这些仓库。为了对注册过程有更多的控制，您可以使用 @EnableMongoRepositories 注解。

默认情况下，@EnableMongoRepositories 会扫描当前包中所有扩展了 Spring Data 仓库接口的接口。如果您的项目结构包含多个项目，并且无法找到您的仓库，您可以使用 basePackageClasses=MyRepository.class 来安全地指定 Spring Data MongoDB 按类型扫描不同的根包。

Spring Data MongoDB 使用 MongoTemplate 来执行 find* 方法背后的查询。您可以自己使用该模板来处理更复杂的查询，但本指南不涵盖这部分内容。（请参阅 Spring Data MongoDB 参考指南）

现在您需要修改 Initializr 为您创建的简单类。您需要设置一些数据并使用它来生成输出。以下清单展示了完成的 AccessingDataMongodbApplication 类（位于 src/main/java/com/example/accessingdatamongodb/AccessingDataMongodbApplication.java 中）：

package com.example.accessingdatamongodb;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AccessingDataMongodbApplication implements CommandLineRunner {

  @Autowired
  private CustomerRepository repository;

  public static void main(String[] args) {
    SpringApplication.run(AccessingDataMongodbApplication.class, args);
  }

  @Override
  public void run(String... args) throws Exception {

    repository.deleteAll();

    // save a couple of customers
    repository.save(new Customer("Alice", "Smith"));
    repository.save(new Customer("Bob", "Smith"));

    // fetch all customers
    System.out.println("Customers found with findAll():");
    System.out.println("-------------------------------");
    for (Customer customer : repository.findAll()) {
      System.out.println(customer);
    }
    System.out.println();

    // fetch an individual customer
    System.out.println("Customer found with findByFirstName('Alice'):");
    System.out.println("--------------------------------");
    System.out.println(repository.findByFirstName("Alice"));

    System.out.println("Customers found with findByLastName('Smith'):");
    System.out.println("--------------------------------");
    for (Customer customer : repository.findByLastName("Smith")) {
      System.out.println(customer);
    }

  }

}

AccessingDataMongodbApplication 包含一个 main() 方法，该方法会自动装配 CustomerRepository 的一个实例。Spring Data MongoDB 会动态创建一个代理并将其注入其中。我们通过几个测试来使用 CustomerRepository。首先，它保存了一些 Customer 对象，展示了 save() 方法并设置了一些数据以供使用。接着，它调用 findAll() 从数据库中获取所有的 Customer 对象。然后，它调用 findByFirstName() 通过名字获取单个 Customer。最后，它调用 findByLastName() 来查找所有姓氏为 Smith 的客户。

默认情况下，Spring Boot 会尝试连接本地托管的 MongoDB 实例。有关将应用程序指向其他位置托管的 MongoDB 实例的详细信息，请参阅参考文档。

构建可执行的 JAR 文件

您可以使用 Gradle 或 Maven 从命令行运行该应用程序。您还可以构建一个包含所有必要依赖项、类和资源的可执行 JAR 文件，并运行它。构建可执行 JAR 文件使得在整个开发生命周期中、跨不同环境等场景下，轻松地发布、版本控制和部署该服务作为应用程序。

如果您使用 Gradle，可以通过 ./gradlew bootRun 来运行应用程序。或者，您可以使用 ./gradlew build 构建 JAR 文件，然后按以下方式运行该 JAR 文件：

java -jar build/libs/gs-accessing-data-mongodb-0.1.0.jar

如果您使用 Maven，可以通过 ./mvnw spring-boot:run 来运行应用程序。或者，您可以使用 ./mvnw clean package 构建 JAR 文件，然后运行该 JAR 文件，如下所示：

java -jar target/gs-accessing-data-mongodb-0.1.0.jar

这里描述的步骤会创建一个可运行的 JAR 文件。您也可以构建一个传统的 WAR 文件。

由于 AccessingDataMongodbApplication 实现了 CommandLineRunner，当 Spring Boot 启动时，run 方法会自动被调用。您应该会看到类似以下的内容（同时还有其他输出，比如查询等）：

== Customers found with findAll():
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
Customer[id=51df1b0a3004cb49c50210f9, firstName='Bob', lastName='Smith']

== Customer found with findByFirstName('Alice'):
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
== Customers found with findByLastName('Smith'):
Customer[id=51df1b0a3004cb49c50210f8, firstName='Alice', lastName='Smith']
Customer[id=51df1b0a3004cb49c50210f9, firstName='Bob', lastName='Smith']

总结

恭喜！您已经成功设置了一个 MongoDB 服务器，并编写了一个使用 Spring Data MongoDB 将对象保存到数据库并从数据库中获取它们的简单应用程序，这一切都不需要编写具体的仓库实现。

如果您想通过极少的努力，使用基于超媒体的RESTful前端暴露MongoDB存储库，请阅读使用REST访问MongoDB数据。

另请参阅

以下指南可能也会有所帮助：