将 Spring Data REST 添加到现有 Spring MVC 应用
如果您使用 Spring Boot,以下步骤则无需执行。对于 Boot 应用,添加 spring-boot-starter-data-rest 会自动将 Spring Data REST 添加到您的应用中。
您可以将 Spring Data REST 与现有的 Spring MVC 应用集成。在您的 Spring MVC 配置中(很可能就是配置 MVC 资源的地方),添加一个 bean 引用,指向负责配置 RepositoryRestController 的 Java 配置类。该类的名称为 org.springframework.data.rest.webmvc.RepositoryRestMvcConfiguration。以下示例展示了如何使用 @Import 注解添加正确的引用:
配置如下所示:
import org.springframework.context.annotation.Import;
import org.springframework.data.rest.webmvc.RepositoryRestMvcConfiguration;
@Configuration
@Import(RepositoryRestMvcConfiguration.class)
public class MyApplicationConfiguration {
…
}
<bean class="org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration"/>
当您的 ApplicationContext 遇到此 bean 定义时,它会引导启动所需的 Spring MVC 资源,从而完整配置控制器,以导出它在该 ApplicationContext 以及任何父上下文中找到的仓库。
关于所需配置的更多说明
Spring Data REST 依赖若干 Spring MVC 资源,这些资源必须正确配置,它才能在现有的 Spring MVC 应用中正常工作。我们已尽力将这些资源与您应用中已有的类似资源隔离开,但您可能希望通过修改这些 MVC 组件来定制 Spring Data REST 的某些行为。
您应特别注意 RepositoryRestHandlerMapping 的配置,下一节将对此进行介绍。
RepositoryRestHandlerMapping
我们注册了一个自定义的 HandlerMapping 实例,它仅响应 RepositoryRestController,且仅当某个路径应由 Spring Data REST 处理时才响应。为了将应由您应用处理的路径与应由 Spring Data REST 处理的路径区分开,这个自定义的 HandlerMapping 类会检查 URL 路径,并查看是否已有仓库以该名称导出。如果有,该自定义 HandlerMapping 类就让请求由 Spring Data REST 处理。如果没有以该名称导出的仓库,它会返回 null,这意味着“让其他 HandlerMapping 实例尝试处理此请求”。
Spring Data REST 的 HandlerMapping 配置为 order=(Ordered.LOWEST_PRECEDENCE - 100),这意味着在需要映射 URL 路径时,它通常排在最前面。您现有的应用永远不会有机会处理一个本应交给仓库的请求。例如,如果您有一个仓库以 person 为名导出,那么发往您应用且以 /person 开头的所有请求都由 Spring Data REST 处理,您的应用永远不会看到该请求。但如果您的仓库以另一个名称(例如 people)导出,那么发往 /people 的请求会交给 Spring Data REST,而发往 /person 的请求则由您的应用处理。