入门 | 使用 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。
单击生成。
下载生成的 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 数据。

另请参阅

以下指南也可能有所帮助

想写新指南或为现有指南做贡献吗？请查看我们的贡献指南。

所有指南的代码均采用 ASLv2 许可，文字内容采用署名-禁止演绎知识共享许可。

使用 MongoDB 访问数据