java - 如何在 Spring Boot 中为所有 Controller 指定前缀？

Question

我有到 /user 和 /order 的 Controller 映射:

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

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

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

如何在 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;
    }
}

或将其添加到 src\main\resources 文件夹中的 application.properties 中

server.contextPath=/api

编辑

As of Spring Boot 2.x the property has been deprecated并且应该替换为

server.servlet.contextPath=/api

您可以在这里找到更多 Spring Boot Context Root在这里Add servlet mapping to DispatcherServlet