入门·使用MongoDB访问数据

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

你会建立什么

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

你需要什么

约15分钟
最喜欢的文本编辑器或IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- Spring Tool Suite (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开始

对于所有Spring应用程序，您应该从Spring Initializr开始。Initializr提供了一种快速的方法来提取应用程序所需的所有依赖关系，并为您完成了许多设置。此示例仅需要Spring Data MongoDB依赖项。下图显示了此示例项目的Initializr设置：

上图显示了选择Maven作为构建工具的Initializr。您也可以使用Gradle。它还显示了com.example和accessing-data-mongodb分别是Group和Artifact。在本示例的其余部分中，将使用这些值。

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

<?xml version="1.0" encoding="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>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.7.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>accessing-data-mongodb</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>accessing-data-mongodb</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-mongodb</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

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

plugins {
	id 'org.springframework.boot' version '2.1.7.RELEASE'
	id 'io.spring.dependency-management' version '1.0.8.RELEASE'
	id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

安装并启动MongoDB

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

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

$ 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内部使用。创建新实例时，您还可以使用一个构造函数来填充实体。

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

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，因此您无需处理任何管道或基础结构。

只要这些存储库包含在您的同一软件包（或子软件包）中，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启动时会自动调用该方法。您应该看到类似以下的内容（以及其他输出，例如查询）：

== 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许可证和写作的Attribution，NoDerivatives创作共用许可证发布。