如何仅为休息控制器更改基本网址？

Question

是否有任何配置选项允许仅更改其余控制器的基本 url，例如，如果我的 api 的基本 url 是 www.example.com/user/{id} 变为 www.example.com/rest/user/{ id} ?

我使用的是spring boot v1.3.2

我尝试通过添加 RequestMapping 创建扩展 RestController 的自定义注释。 这是示例，但它不起作用。

@Target(ElementType.TYPE) 
@Retention(RetentionPolicy.RUNTIME) 
@RestController 
@RequestMapping(value = "/rest", path = "/rest") 
public @interface MyRestController { }

Answer 1

选项 1：自定义注释

创建一个自定义注释来声明基本 URL 并使用它来代替 @RestController。

CustomRestControllerAnnotation.java

package com.example.stackoverflow.config;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@RestController
@RequestMapping("/rest")
public @interface CustomRestControllerAnnotation {}

FirstRestController.java

package com.example.stackoverflow.controller;

import org.springframework.web.bind.annotation.RequestMapping;

import com.example.stackoverflow.config.CustomRestControllerAnnotation;

@CustomRestControllerAnnotation
public class FirstRestController {

    @RequestMapping("/first")
    public String firstMethod(){
        return "First Controller";
    }
}

SecondRestController.java

package com.example.stackoverflow.controller;

import org.springframework.web.bind.annotation.RequestMapping;

import com.example.stackoverflow.config.CustomRestControllerAnnotation;

@CustomRestControllerAnnotation
public class SecondRestController {

    @RequestMapping("/second")
    public String secondMethod(){
        return "Second Controller";
    }
}

选项 2：基本 RestController

通过创建一个用作所有实际控制器模板的基本控制器，您可以从一个位置有效地管理根 URL。

BaseRestController.java

package com.example.stackoverflow.controller;

import org.springframework.web.bind.annotation.RequestMapping;

@RequestMapping("/rest")
public class BaseRestController {}

然后，您只需为所有实际控制器扩展此类。

FirstRestController.java

package com.example.stackoverflow.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FirstRestController extends BaseRestController{

    @RequestMapping("/first")
    public String firstMethod(){
        return "First Controller";
    }
}

SecondRestController.java

package com.example.stackoverflow.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SecondRestController extends BaseRestController{

    @RequestMapping("/second")
    public String secondMethod(){
        return "Second Controller";
    }
}

选项 3：Spring Data REST

如果您的控制器从存储库提供数据，那么 Spring Data REST 可以消除大部分样板文件并解决您最初的问题。

pom.xml

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

通过声明此依赖关系，您的所有存储库都会自动启用 REST。

您可以使用属性文件来控制基本 URL。

application.properties

spring.data.rest.basePath=/rest

Answer 2

更新了 Spring Boot v2.1.0 的配置

在 Spring Boot v2.1.0 中，您可以在 application.properties 中配置基本 URL，例如

server.servlet.context-path = /baseApiName

Complete property configuration list

Answer 3

通常您会定义一个 servlet 来处理您的所有（或特定的一组）restful 请求。然后，您将告诉该 servlet 侦听特定的 URL 模式，例如 /rest。控制器的 @RequestMapping 注释不知道该“顶级”模式。

例如，当引导您的 Spring Web 应用程序时，您可以手动创建该 restful servlet 并添加一个映射。整个设置有点太大，无法在此处发布，但请在下面找到一个 sn-p 以获得概念。

import org.springframework.web.servlet.DispatcherServlet;
import javax.servlet.ServletContext;
...

public class WebAppInitializer implements WebApplicationInitializer {

   public void onStartup(ServletContext servletContext) throws ServletException {
     ...
     ServletRegistration.Dynamic restfulServlet = servletContext.addServlet("myServlet", new DispatcherServlet(rootContext));
     restfulServlet.addMapping("/rest/*");
     ...

   }

Answer 4

您应该在 application.properties 文件中添加server.servlet-path=/api，并且您应该发送所有请求，例如 domain/api/users/{id}