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

目录

• 如何为web层添加统一请求前缀
• 配置文件方式
• 实现WebMvcConfigurer接口
• spring web访问页面出现多余前缀和后缀情况
• 页面中出现hello.jsp
• 解决方法

如何为web层添加统一请求前缀

配置文件方式

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

spring web访问页面出现多余前缀和后缀情况

页面中出现hello.jsp

解决方法

去掉servlet中的前缀后缀配置项

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。