入门

Spring Data REST 本身就是一个 Spring MVC 应用程序，其设计旨在轻松集成到您现有的 Spring MVC 应用程序中。现有的（或未来的）服务层只需少量额外工作即可与 Spring Data REST 并行运行。

将 Spring Data REST 添加到 Spring Boot 项目

最简单的入门方法是构建一个 Spring Boot 应用程序，因为 Spring Boot 为 Spring Data REST 提供了一个启动器并使用自动配置。以下示例演示如何使用 Gradle 将 Spring Data Rest 包含到 Spring Boot 项目中

示例 1. 使用 Gradle 的 Spring Boot 配置

dependencies {
  ...
  compile("org.springframework.boot:spring-boot-starter-data-rest")
  ...
}

以下示例演示如何使用 Maven 将 Spring Data Rest 包含到 Spring Boot 项目中

示例 2. 使用 Maven 的 Spring Boot 配置

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

如果您使用Spring Boot Gradle 插件或Spring Boot Maven 插件，则无需提供版本号。

当您使用 Spring Boot 时，Spring Data REST 会自动配置。

将 Spring Data REST 添加到 Gradle 项目

要将 Spring Data REST 添加到基于 Gradle 的项目，请将spring-data-rest-webmvc构件添加到您的编译时依赖项，如下所示

dependencies {
  … other project dependencies
  compile("org.springframework.data:spring-data-rest-webmvc:4.4.0")
}

将 Spring Data REST 添加到 Maven 项目

要将 Spring Data REST 添加到基于 Maven 的项目，请将spring-data-rest-webmvc构件添加到您的编译时依赖项，如下所示

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-rest-webmvc</artifactId>
  <version>4.4.0</version>
</dependency>

配置 Spring Data REST

要在现有 Spring MVC 应用程序中安装 Spring Data REST，您需要包含相应的 MVC 配置。Spring Data REST 配置在名为RepositoryRestMvcConfiguration的类中定义，您可以将该类导入到应用程序的配置中。

如果您使用 Spring Boot 的自动配置，则无需执行此步骤。当您包含 **spring-boot-starter-data-rest** 以及您的依赖项列表中您的应用程序使用 `@SpringBootApplication` 或 `@EnableAutoConfiguration` 标记时，Spring Boot 会自动启用 Spring Data REST。

要自定义配置，请注册一个RepositoryRestConfigurer并实现或覆盖与您的用例相关的configure…方法。

确保您还为使用的存储配置 Spring Data 资源库。有关详细信息，请参阅相应的 Spring Data 模块的参考文档。

Spring Data REST 的基本设置

本节介绍配置 Spring Data REST 应用程序时可以操作的基本设置，包括

设置资源库检测策略
更改基本 URI
更改其他 Spring Data REST 属性

设置资源库检测策略

Spring Data REST 使用RepositoryDetectionStrategy来确定是否将资源库导出为 REST 资源。RepositoryDiscoveryStrategies枚举包含以下值

表 1. 资源库检测策略
名称	描述
`DEFAULT`	公开所有公共资源库接口，但会考虑`@(Repository)RestResource`的`exported`标志。
`ALL`	公开所有资源库，与类型可见性和注释无关。
`ANNOTATED`	仅公开使用`@(Repository)RestResource`注释的资源库，除非其`exported`标志设置为`false`。
`VISIBILITY`	仅公开公共注释资源库。

更改基本 URI

默认情况下，Spring Data REST 在根 URI“/”上提供 REST 资源。有多种方法可以更改基本路径。

对于 Spring Boot 1.2 及更高版本，您可以通过在application.properties中设置单个属性来更改基本 URI，如下所示

spring.data.rest.basePath=/api

对于 Spring Boot 1.1 或更早版本，或者如果您不使用 Spring Boot，您可以执行以下操作

@Configuration
class CustomRestMvcConfiguration {

  @Bean
  public RepositoryRestConfigurer repositoryRestConfigurer() {

    return new RepositoryRestConfigurer() {

      @Override
      public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config, CorsRegistry cors) {
        config.setBasePath("/api");
      }
    };
  }
}

或者，您可以将RepositoryRestConfigurer的自定义实现注册为 Spring bean，并确保它被组件扫描拾取，如下所示

@Component
public class CustomizedRestMvcConfiguration extends RepositoryRestConfigurer {

  @Override
  public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config, CorsRegistry cors) {
    config.setBasePath("/api");
  }
}

上述两种方法都将基本路径更改为/api。

更改其他 Spring Data REST 属性

您可以更改以下属性

表 2. Spring Boot 可配置属性
属性	描述
`basePath`	Spring Data REST 的根 URI
`defaultPageSize`	更改单页中提供的项目数量的默认值
`maxPageSize`	更改单页中的最大项目数
`pageParamName`	更改用于选择页面的查询参数的名称
`limitParamName`	更改页面中显示的项目数量的查询参数的名称
`sortParamName`	更改排序的查询参数的名称
`defaultMediaType`	更改未指定时使用的默认媒体类型
`returnBodyOnCreate`	更改创建新实体时是否应返回正文
`returnBodyOnUpdate`	更改更新实体时是否应返回主体

启动应用程序

此时，您还必须配置您的关键数据存储。

Spring Data REST 正式支持

以下入门指南可以帮助您快速上手

这些链接的指南介绍了如何添加相关数据存储的依赖项、配置域对象和定义存储库。

您可以将应用程序作为 Spring Boot 应用程序运行（使用前面显示的链接），也可以将其配置为经典的 Spring MVC 应用程序。

一般来说，Spring Data REST 不会为给定的数据存储添加功能。这意味着，根据定义，它应该与任何支持存储库编程模型的 Spring Data 项目一起工作。上面列出的数据存储是我们编写集成测试以验证 Spring Data REST 是否与它们一起工作的数据存储。

从这一点开始，您可以自定义 Spring Data REST，并使用各种选项。