如何在Spring Boot中为所有控制器指定前缀？

Question

我有控制器映射/user和/order：

@RestController
@RequestMapping("/users")
public class UserController {
    ...
}

@RestController
@RequestMapping("/orders")
public class OrderController {
    ...
}

我想分别通过URL http://localhost:8080/api/users 和访问这些URL
http://localhost:8080/api/orders。

如何在Spring Boot中实现这一目标？

Answer 1

您可以/api/*在自定义配置中提供到Spring Boot应用程序的根上下文路径的映射。

import org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration;
import org.springframework.boot.context.embedded.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.DispatcherServlet;

@Configuration
public class DispatcherServletCustomConfiguration {

    @Bean
    public DispatcherServlet dispatcherServlet() {
        return new DispatcherServlet();
    }

    @Bean
    public ServletRegistrationBean dispatcherServletRegistration() {
        ServletRegistrationBean registration = new ServletRegistrationBean(
                dispatcherServlet(), "/api/");
        registration.setName(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME);
        return registration;
    }
}

或将此添加到您的application.propertiesin src\main\resources文件夹中

server.contextPath=/api/*

编辑

从Spring Boot 2.x开始，该属性已被弃用，应替换为

server.servlet.contextPath=/api/*

您可以在此处找到更多的内容Spring Boot Context
Root，
并在此处将servlet映射添加到DispatcherServlet