使用MongoDB访问数据_Spring 中文网

本指南将引导您完成使用Spring Data MongoDB构建应用程序的过程，该应用程序将数据存储在MongoDB中，并从MongoDB（基于文档的数据库）中检索数据。

你会建立什么

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

你需要什么

约15分钟
最喜欢的文本编辑器或IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- 弹簧工具套件（STS）
- IntelliJ IDEA

如何完成本指南

像大多数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开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Data MongoDB）。

以下清单显示了pom.xml选择Maven时创建的文件：

<？xml版本=“ 1.0”编码=“ UTF-8”？>
<project xmlns =“ http://maven.apache.org/POM/4.0.0” xmlns：xsi =“ http://www.w3.org/2001/XMLSchema-instance”
	xsi：schemaLocation =“ http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd”>
	<modelVersion> 4.0.0 </ modelVersion>
	<父母>
		<groupId> org.springframework.boot </ groupId>
		<artifactId> spring-boot-starter-parent </ artifactId>
		<version> 2.4.3 </ version>
		<relativePath /> <！-从存储库中查找父级->
	</ parent>
	<groupId> com.example </ groupId>
	<artifactId> accessing-data-mongodb </ artifactId>
	<version> 0.0.1-SNAPSHOT </ version>
	<name> accessing-data-mongodb </ name>
	<description> Spring Boot的演示项目</ description>
	<属性>
		<java.version> 1.8 </java.version>
	</ properties>
	<依赖项>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-data-mongodb </ artifactId>
		</ dependency>

		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-test </ artifactId>
			<scope>测试</ scope>
		</ dependency>
	</ dependencies>

	<内部版本>
		<插件>
			<插件>
				<groupId> org.springframework.boot </ groupId>
				<artifactId> spring-boot-maven-plugin </ artifactId>
			</ plugin>
		</ plugins>
	</ build>

</ project>

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Data MongoDB）。

以下清单显示了build.gradle选择Gradle时创建的文件：

插件{
	id'org.springframework.boot'版本'2.4.3'
	id'io.spring.dependency-management'版本'1.0.11.RELEASE'
	id'java'
}

组='com.example'
版本='0.0.1-SNAPSHOT'
sourceCompatibility ='1.8'

储存库{
	mavenCentral（）
}

依赖项{
	实现'org.springframework.boot：spring-boot-starter-data-mongodb'
	testImplementation'org.springframework.boot：spring-boot-starter-test'
}

测试 {
	useJUnitPlatform（）
}

配置该项目以适合本教程中的示例。

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。
单击Dependencies并选择Spring Data MongoDB。
点击生成。
下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。

安装并启动MongoDB

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

如果将Mac与Homebrew一起使用，则可以运行以下命令：

$ brew install mongodb

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

$ port install mongodb

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

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

$ mongod

您应该看到类似于以下内容的输出：

所有输出将转到：/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内部使用。创建新实例时，您还可以使用一个构造函数来填充实体。

在本指南中，为简洁起见，省略了典型的吸气剂和吸气剂。

id 适合MongoDB ID的标准名称，因此不需要任何特殊注释即可为Spring Data MongoDB标记它。

其他两个属性firstName和和lastName则未添加注释。假定它们已映射到与属性本身共享相同名称的字段。

便捷的toString()方法可以打印出有关客户的详细信息。

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

创建简单查询

Spring Data MongoDB专注于在MongoDB中存储数据。它还继承了Spring Data Commons项目的功能，例如导出查询的功能。本质上，您无需学习MongoDB的查询语言。您可以编写一些方法，并且查询是为您编写的。

要查看它是如何工作的，请创建一个查询Customer文档的存储库接口，如清单1中的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操作（创建，读取，更新和删除）。

您可以通过声明其他查询的方法签名来定义它们。在这种情况下，addfindByFirstName实质上是寻找类型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，因此您无需处理任何管道或基础结构。

只要它们包含在类的同一包（或子包）中，Spring Boot就会自动处理这些存储库@SpringBootApplication。为了更好地控制注册过程，可以使用@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。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

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

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

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

此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件。

作为AccessingDataMongodbApplication实现CommandLineRunner，该run方法在Spring Boot启动时自动调用。您应该看到类似以下的内容（以及其他输出，例如查询）：

==使用findAll（）找到的客户：
客户[id = 51df1b0a3004cb49c50210f8，firstName ='Alice'，lastName ='Smith']
客户[id = 51df1b0a3004cb49c50210f9，firstName ='Bob'，lastName ='Smith']

==找到带有findByFirstName（'Alice'）的客户：
客户[id = 51df1b0a3004cb49c50210f8，firstName ='Alice'，lastName ='Smith']
==使用findByLastName（'Smith'）找到的客户：
客户[id = 51df1b0a3004cb49c50210f8，firstName ='Alice'，lastName ='Smith']
客户[id = 51df1b0a3004cb49c50210f9，firstName ='Bob'，lastName ='Smith']

概括

恭喜你！您设置了一个MongoDB服务器，并编写了一个简单的应用程序，该应用程序使用Spring Data MongoDB将对象保存到数据库中并从数据库中获取对象，而无需编写具体的存储库实现。

如果您想轻松地使用基于超媒体的RESTful前端公开MongoDB存储库，请阅读使用REST访问MongoDB数据。

也可以看看

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

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。