SpringBoot全局设置请求路径增加前缀

在使用Spring Boot进行开发时，项目的API接口通常需要有统一的请求路径前缀，以便于管理和区分不同版本的API。这不仅可以提升接口的可读性，还能够帮助进行API的版本控制。接下来，我们将探讨如何在Spring Boot中全局设置请求路径前缀，并提供相应的代码示例。

一、通过配置文件设置请求路径前缀

Spring Boot允许你通过配置文件定义全局的请求路径前缀。在application.properties或application.yml中可以进行配置。

例如，在application.yml文件中进行如下配置：

server:
  servlet:
    context-path: /api/v1

此配置会将整个应用的上下文路径设置为/api/v1。这样，所有的请求都会以 /api/v1 开头。

如果项目中有多个版本的API，可以通过不同的配置文件来区分，例如：

# application-v1.yml
server:
  servlet:
    context-path: /api/v1

# application-v2.yml
server:
  servlet:
    context-path: /api/v2

通过这种方式，我们可以轻松地在不同的环境中使用不同的API路径前缀。

二、使用Java代码设置请求路径前缀

除了通过配置文件，Spring Boot中还可以使用Java代码来全局设置请求路径前缀。可以使用@RequestMapping注解在控制器上为所有的请求添加前缀。

以下是一个示例：

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

@RestController
@RequestMapping("/api/v1")
public class MyController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }

    @GetMapping("/goodbye")
    public String goodbye() {
        return "Goodbye, World!";
    }
}

在上述代码中，MyController的所有请求路径都将自动加上 /api/v1 前缀。例如，/hello的完整请求路径变为/api/v1/hello。

三、使用Filter或Interceptor设置请求路径前缀

如果你希望更加灵活的方式来添加路径前缀，可以考虑使用Spring的Filter或Interceptor。

使用Filter的示例：

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

public class ApiPrefixFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String requestURI = httpRequest.getRequestURI();

        if (!requestURI.startsWith("/api/v1")) {
            requestURI = "/api/v1" + requestURI;
        }

        // Continue with the filter chain
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

然后在Spring Boot的@Configuration类中注册该Filter：

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<ApiPrefixFilter> loggingFilter() {
        FilterRegistrationBean<ApiPrefixFilter> registrationBean = new FilterRegistrationBean<>();

        registrationBean.setFilter(new ApiPrefixFilter());
        registrationBean.addUrlPatterns("/*"); // 拦截所有请求

        return registrationBean;
    }
}

四、总结

通过上述方法，我们可以在Spring Boot应用中全局设置请求路径前缀，无论是通过配置文件，控制器的注解还是自定义Filter。使用路径前缀不仅提升了API的可读性和管理性，还支持了更好的版本控制与扩展性。这对于构建大型的系统尤为重要。希望这些示例能够帮助你在开发中更好地使用Spring Boot。