# 使用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數據 。