Spring Boot 中为所有 Controller 接口添加统一前缀的五种方法

在 Spring Boot 项目开发中，为了更好地组织和管理接口，有时需要为所有的 Controller 接口添加统一前缀。这不仅有助于提高接口的可读性和可维护性，还能在一定程度上优化路由的管理。以下将介绍五种实现此需求的方法。

方法一：使用 @RequestMapping 注解

在每个 Controller 类上使用 @RequestMapping 注解来指定统一的前缀。例如：

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

    // 接口方法
}

方法二：配置 WebMvcConfigurer

通过实现 WebMvcConfigurer 接口，重写 addResourceHandlers 方法来添加前缀。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/api/**").addResourceLocations("classpath:/static/");
    }
}

方法三：利用 PathVariable

在接口方法中使用 PathVariable 来接收前缀部分的值，然后根据需要进行处理。

@RestController
public class MyController {

    @GetMapping("/{prefix}/myMethod")
    public String myMethod(@PathVariable String prefix) {
        // 处理逻辑
    }
}

方法四：使用 HandlerInterceptor

创建一个自定义的 HandlerInterceptor 拦截器，在拦截请求时处理前缀。

public class PrefixInterceptor extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 前缀处理逻辑
        return true;
    }
}

然后将拦截器注册到 Spring Boot 配置中。

方法五：自定义 RequestMappingHandlerMapping

通过自定义 RequestMappingHandlerMapping 来实现前缀的添加。

@Configuration
public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {

    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
        // 自定义前缀处理逻辑
        return super.getMappingForMethod(method, handlerType);
    }
}

以上五种方法都可以为 Spring Boot 中的所有 Controller 接口添加统一前缀，开发者可以根据项目的实际需求和架构选择合适的方法。在实际应用中，合理地运用这些方法能够使项目的接口管理更加规范和高效。