# 使用MongoDB访问数据
本指南将引导您完成使用 的过程, [Spring Data MongoDB](https://projects.spring.io/spring-data-mongodb/) 来构建应用程序 该应用程序将数据存储在 并从 检索 [MongoDB中 MongoDB](https://www.mongodb.org/) , (基于文档的数据库)中 数据。
## 你会建立什么
您将存储 `Customer` 通过使用Spring Data MongoDB,在MongoDB数据库中实现POJO(普通的旧Java对象)。
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本
* [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi)
* 您还可以将代码直接导入到IDE中:
* [弹簧工具套件(STS)](https://spring.io/guides/gs/sts)
* [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/)
## 如何完成本指南
像大多数Spring 一样 [入门指南](https://spring.io/guides) ,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。 无论哪种方式,您最终都可以使用代码。
要 **从头开始** ,请继续进行“ [从Spring Initializr开始”](https://spring.io/guides/gs/accessing-data-mongodb/#scratch) 。
要 **跳过基础知识** ,请执行以下操作:
* [下载](https://github.com/spring-guides/gs-accessing-data-mongodb/archive/master.zip) 并解压缩本指南的源存储库,或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) : `git clone [https://github.com/spring-guides/gs-accessing-data-mongodb.git](https://github.com/spring-guides/gs-accessing-data-mongodb.git)`
* 光盘进入 `gs-accessing-data-mongodb/initial`
* 继续 [安装并启动MongoDB](https://spring.io/guides/gs/accessing-data-mongodb/#initial) 。
**完成后** ,您可以根据中的代码检查结果 `gs-accessing-data-mongodb/complete`.
## 从Spring Initializr开始
如果您使用Maven,请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=accessing-data-mongodb&name=accessing-data-mongodb&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.accessing-data-mongodb&dependencies=data-mongodb) 以生成具有所需依赖项的新项目(Spring Data MongoDB)。
以下清单显示了 `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.4.3</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>
~~~
如果您使用Maven,请访问 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=accessing-data-mongodb&name=accessing-data-mongodb&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.accessing-data-mongodb&dependencies=data-mongodb) 以生成具有所需依赖项的新项目(Spring Data MongoDB)。
以下清单显示了 `build.gradle`选择Gradle时创建的文件:
~~~
plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.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'
}
test {
useJUnitPlatform()
}
~~~
配置该项目以适合本教程中的示例。
### 手动初始化(可选)
如果要手动初始化项目而不是使用前面显示的链接,请按照以下步骤操作:
1. 导航到 [https://start.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系,并为您完成大部分设置。
2. 选择Gradle或Maven以及您要使用的语言。 本指南假定您选择了Java。
3. 单击 **Dependencies** 并选择 **Spring Data MongoDB** 。
4. 点击 **生成** 。
5. 下载生成的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/上](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参考指南》](https://docs.spring.io/spring-data/mongodb/docs/current/reference/html/) )
现在,您需要修改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数据 。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解