入门 | 使用 REST 访问 MongoDB 数据

您将构建什么

您将构建一个 Spring 应用程序，该程序允许您使用 Spring Data REST 创建和检索存储在 MongoDB NoSQL 数据库中的 Person 对象。Spring Data REST 融合了 Spring HATEOAS 和 Spring Data MongoDB 的特性，并自动将它们结合在一起。

Spring Data REST 也支持 Spring Data JPA、Spring Data Gemfire 和 Spring Data Neo4j 作为后端数据存储，但这些不是本指南的一部分。

所需条件

大约 15 分钟
您喜欢的文本编辑器或 IDE
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以直接将代码导入到您的 IDE 中

如何完成本指南

与大多数 Spring 入门指南类似，您可以从头开始完成每个步骤，也可以跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会获得可运行的代码。

要从头开始，请转到使用 Spring Initializr 入门。

要跳过基础部分，请执行以下操作

下载并解压缩本指南的源代码仓库，或者使用 Git 克隆：git clone https://github.com/spring-guides/gs-accessing-mongodb-data-rest.git
进入目录 gs-accessing-mongodb-data-rest/initial
跳到安装并启动 MongoDB。

完成后，您可以将您的结果与 gs-accessing-mongodb-data-rest/complete 中的代码进行对照检查。

使用 Spring Initializr 入门

您可以使用这个预配置的项目，然后点击 Generate 下载 ZIP 文件。这个项目已配置好，适用于本教程中的示例。

手动初始化项目

导航到 https://start.spring.io。该服务会为您拉取应用程序所需的所有依赖项，并完成大部分设置工作。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假定您选择了 Java。
点击 Dependencies 并选择 Rest Repositories 和 Spring Data MongoDB。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序存档。

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

您也可以从 Github Fork 项目，并在您的 IDE 或其他编辑器中打开它。

安装并启动 MongoDB

要使本指南起作用，您必须搭建一个本地 MongoDB 服务器。

在安装了 Homebrew 的 Mac OS X 机器上，运行以下命令

brew install mongodb

您可以在 https://docs.mongodb.org/manual/installation/ 找到更多安装选项。

安装 MongoDB 后，您需要启动 mongo 守护程序。在 Mac 上，您可以使用以下命令

$ mongod
all output going to: /usr/local/var/log/mongodb/mongo.log

您可以通过运行 mongo 命令从另一个终端窗口启动 MongoDB 客户端。

创建领域对象

创建一个新的领域对象来表示一个人，如以下示例（在 src/main/java/com/example/accessingmongodbdatarest/Person.java 中）所示

package com.example.accessingmongodbdatarest;

import org.springframework.data.annotation.Id;

public class Person {

  @Id private String id;

  private String firstName;
  private String lastName;

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

  public String getLastName() {
    return lastName;
  }

  public void setLastName(String lastName) {
    this.lastName = lastName;
  }
}

Person 对象具有名字和姓氏。（还有一个 ID 对象，它被配置为自动生成，因此无需处理。）

创建 Person 仓库

接下来，您需要创建一个简单的仓库，如以下清单（在 src/main/java/com/example/accessingmongodbdatarest/PersonRepository.java 中）所示

package com.example.accessingmongodbdatarest;

import java.util.List;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends MongoRepository<Person, String> {

  List<Person> findByLastName(@Param("name") String name);

}

这个仓库是一个接口，允许您执行涉及 Person 对象的各种操作。它通过继承 MongoRepository 获取这些操作，而 MongoRepository 又扩展了在 Spring Data Commons 中定义的 PagingAndSortingRepository 接口。

在运行时，Spring Data REST 会自动创建此接口的实现。然后它使用 @RepositoryRestResource 注解来指示 Spring MVC 在 /people 创建 RESTful 端点。

仓库的导出不是必需使用 @RepositoryRestResource 的。它仅用于更改导出细节，例如使用 /people 而不是默认值 /persons。

在这里，您还定义了一个自定义查询，用于根据 lastName 值检索 Person 对象列表。您可以在本指南的后续部分看到如何调用它。

默认情况下，Spring Boot 会尝试连接到本地托管的 MongoDB 实例。阅读参考文档，了解如何将您的应用程序指向托管在其他位置的 MongoDB 实例。

@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 的，您无需处理任何底层或基础设施的配置。

构建可执行 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的单一可执行 JAR 文件并运行它。构建可执行 JAR 文件使得在整个开发生命周期中、跨不同环境以及其他情况下，轻松交付、版本化和部署该服务作为应用程序成为可能。

如果您使用 Gradle，可以通过运行 ./gradlew bootRun 来运行应用程序。或者，您可以使用 ./gradlew build 构建 JAR 文件，然后按如下方式运行 JAR 文件

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

如果您使用 Maven，可以通过运行 ./mvnw spring-boot:run 来运行应用程序。或者，您可以使用 ./mvnw clean package 构建 JAR 文件，然后按如下方式运行 JAR 文件

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

这里描述的步骤将创建一个可运行的 JAR 文件。您还可以构建一个经典的 WAR 文件。

将显示日志输出。该服务应在几秒钟内启动并运行。

测试应用程序

应用程序现在正在运行，您可以测试它。您可以使用任何您想要的 REST 客户端。以下示例使用 *nix 工具 curl。

首先，您需要查看顶层服务，如以下示例所示

$ curl http://localhost:8080
{
  "_links" : {
    "people" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    }
  }
}

前面的示例首次展示了该服务器提供的功能。在 http://localhost:8080/people 有一个 people 链接。它有一些选项，例如 ?page、?size 和 ?sort。

Spring Data REST 对 JSON 输出使用 HAL 格式。它非常灵活，提供了一种方便的方式来提供与提供的数据相邻的链接。

使用 people 链接时，您会看到数据库中的 Person 记录（目前没有）

$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

目前没有元素，因此也没有页面。是时候创建一个新的 Person 了！

如果您多次运行本指南，可能会有残留数据。如果您需要重新开始，请查阅 MongoDB shell 快速参考以获取查找和删除数据库的命令。

以下命令创建一个名为“Frodo Baggins”的人

$ curl -i -X POST -H "Content-Type:application/json" -d "{  \"firstName\" : \"Frodo\",  \"lastName\" : \"Baggins\" }" http://localhost:8080/people
HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Location: http://localhost:8080/people/53149b8e3004990b1af9f229
Content-Length: 0
Date: Mon, 03 Mar 2014 15:08:46 GMT

-i：确保您能看到响应消息，包括头部信息。将显示新创建的 Person 的 URI。
-X POST：表示这是一个用于创建新条目的 POST 请求。
-H "Content-Type:application/json"：设置内容类型，以便应用程序知道请求体包含 JSON 对象。
-d '{ "firstName" : "Frodo", "lastName" : "Baggins" }'：这是发送的数据。

请注意，前面的 POST 操作包含一个 Location 头部。这包含新创建资源的 URI。Spring Data REST 还有两个方法（RepositoryRestConfiguration.setReturnBodyOnCreate(…) 和 setReturnBodyOnUpdate(…)），您可以使用它们来配置框架，以便立即返回刚刚创建/更新的资源的表示。

通过这个，您可以查询所有的人，如以下示例所示

$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "_embedded" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/53149b8e3004990b1af9f229"
        }
      }
    } ]
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

persons 对象包含一个包含 Frodo 的列表。注意它如何包含一个 self 链接。Spring Data REST 还使用 Evo Inflector 来对分组的实体名称进行复数化。

您可以直接查询单个记录，如以下示例所示

$ curl http://localhost:8080/people/53149b8e3004990b1af9f229
{
  "firstName" : "Frodo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/53149b8e3004990b1af9f229"
    }
  }
}

这看起来可能纯粹是基于 Web 的，但其背后，它正在与您启动的 MongoDB 数据库进行通信。

在本指南中，只有一个领域对象。在更复杂的系统中，如果领域对象相互关联，Spring Data REST 会呈现额外的链接以帮助导航到相关记录。

查找所有自定义查询，如以下示例所示

$ curl http://localhost:8080/people/search
{
  "_links" : {
    "findByLastName" : {
      "href" : "http://localhost:8080/people/search/findByLastName{?name}",
      "templated" : true
    }
  }
}

您可以看到查询的 URL，包括 HTTP 查询参数 name。这与嵌入在接口中的 @Param("name") 注解相匹配。

要使用 findByLastName 查询，运行以下命令

$ curl http://localhost:8080/people/search/findByLastName?name=Baggins
{
  "_embedded" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/53149b8e3004990b1af9f229"
        }
      }
    } ]
  }
}

因为您在代码中将其定义为返回 List<Person>，所以它返回所有结果。如果您将其定义为仅返回 Person，它会从中选择一个 Person 对象返回。由于这可能不可预测，对于可以返回多个条目的查询，您可能不希望这样做。

您还可以发出 PUT、PATCH 和 DELETE REST 调用，分别用于替换、更新或删除现有记录。以下示例使用一个 PUT 调用

$ curl -X PUT -H "Content-Type:application/json" -d "{ \"firstName\": \"Bilbo\", \"lastName\": \"Baggins\" }" http://localhost:8080/people/53149b8e3004990b1af9f229
$ curl http://localhost:8080/people/53149b8e3004990b1af9f229
{
  "firstName" : "Bilbo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/53149b8e3004990b1af9f229"
    }
  }
}

以下示例使用一个 PATCH 调用

$ curl -X PATCH -H "Content-Type:application/json" -d "{ \"firstName\": \"Bilbo Jr.\" }" http://localhost:8080/people/53149b8e3004990b1af9f229
$ curl http://localhost:8080/people/53149b8e3004990b1af9f229
{
  "firstName" : "Bilbo Jr.",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/53149b8e3004990b1af9f229"
    }
  }
}

PUT 替换整个记录。未提供的字段将被替换为 null。您可以使用 PATCH 更新项目子集。

您还可以删除记录，如以下示例所示

$ curl -X DELETE http://localhost:8080/people/53149b8e3004990b1af9f229
$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

这种超媒体驱动的接口的一个便捷之处在于，您可以使用 curl（或任何您喜欢的 REST 客户端）发现所有 RESTful 端点。无需与您的客户交换正式的契约或接口文档。

总结

恭喜您！您刚刚开发了一个具有基于超媒体的 REST 前端和基于 MongoDB 后端的应用程序。

另请参阅

以下指南也可能对您有帮助

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

所有指南的代码均采用 ASLv2 许可证发布，文本采用署名-禁止演绎创作共用许可协议发布。

使用 REST 访问 MongoDB 数据