springboot为web层添加统一请求前缀

最新推荐文章于 2025-03-04 10:16:57 发布

yzh_1346983557

最新推荐文章于 2025-03-04 10:16:57 发布

阅读量8.6k

点赞数 5

分类专栏： Spring Boot 文章标签： spring boot web层统一请求前缀

本文链接：https://blog.csdn.net/yzh_1346983557/article/details/115130575

版权

Spring Boot 专栏收录该内容

27 篇文章

订阅专栏

本文介绍了如何通过实现WebMvcConfigurer接口并自定义注解，为不同版本的REST控制器添加不同的请求路径前缀。通过@ApiRestController和@ApiV2RestController注解，可以分别设置/api和/api/v2作为前缀，提高API的版本管理灵活性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、配置文件方式

application.properties全局配置文件配置：

server.servlet.context-path=/api

二、实现WebMvcConfigurer接口

重写configurePathMatch()方法，代码：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    
    /**
     * 请求路径添加统一前缀
     *
     * @param configurer
     */
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("/api", c -> c.isAnnotationPresent(RestController.class) || c.isAnnotationPresent(Controller.class));
    }
}

上面为controller层所有都添加了统一前缀，如果不同版本想使用不同的请求前缀，可优化如下：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    
    /**
     * 请求路径添加统一前缀
     *
     * @param configurer
     */
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("/api", c -> c.isAnnotationPresent(ApiRestController.class))
            .addPathPrefix("/api/v2", c -> c.isAnnotationPresent(ApiV2RestController.class));
    }
}

对有 @ApiRestController 注解的 controller 添加 /api 前缀，对有@ApiV2RestController 注解的controller添加 /api/v2 前缀。

@ApiRestController 和 @ApiV2RestController 是自定义注解，继承自 @RestController：

import org.springframework.core.annotation.AliasFor;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RestController
@RequestMapping
public @interface ApiRestController {
    /**
     * Alias for {@link RequestMapping#name}.
     */
    @AliasFor(annotation = RequestMapping.class)
    String name() default "";

    /**
     * Alias for {@link RequestMapping#value}.
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] value() default {};

    /**
     * Alias for {@link RequestMapping#path}.
     */
    @AliasFor(annotation = RequestMapping.class)
    String[] path() default {};
}

使用：

@ApiRestController("/demo")
public class DemoController extends BaseController{
}

这样请求地址就成了：http://localhost:8080/api/demo