springboot如何為web層添加統一請求前綴

Posted on by

如何為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中的前綴後綴配置項

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：