SpringBoot多controller添加URL前綴的實現方法

更新時間：2023年02月15日 16:58:33 作者：碼農-文若書生

這篇文章主要介紹了SpringBoot多controller添加URL前綴的方法,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

前言

在某些情況下，服務的controller中前綴是一致的，例如所有URL的前綴都為/context-path/api/v1，需要為某些URL添加統一的前綴。

能想到的處理辦法為修改服務的context-path，在context-path中添加api/v1，這樣修改全局的前綴能夠解決上面的問題，但存在弊端，如果URL存在多個前綴，例如有些URL需要前綴為api/v2，就無法區(qū)分了，如果服務中的一些靜態(tài)資源不想添加api/v1，也無法區(qū)分。

下面通過自定義注解的方式實現某些URL前綴的統一添加。

一、配置文件內添加前綴配置

如果需要多種前綴，添加多組配置，例如添加：api.prefix.v2=/api/v2

###############url前綴配置##################
api.prefix.v1=/api/v1

二、配置映射的實體

@Data
@Component
@ConfigurationProperties(prefix = "api.prefix")
public class ApiPrefix {
    private String v1;
}

三、自定義注解

此注解功能與@RestController一致，對應api.prefix.v1的配置，如果有多組配置，定義多個注解即可

@RestController
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiV1RestController {
}

四、自定義PathMatch添加前綴

添加一個配置類繼承WebMvcConfigurer，重寫configurePathMatch方法，為類上有ApiV1RestController注解的controller中的接口添加對應的前綴。

@AutoConfiguration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ApiPrefix apiPrefix;
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix(apiPrefix.getV1(), c -> c.isAnnotationPresent(ApiV1RestController.class));
    }
}

五、測試

需要在對應的controller上使用@ApiV1RestController注解代替@RestController注解

@ApiV1RestController
@RequestMapping("/test/apiv1")
public class TestApiV1RestController {
    @GetMapping()
    public ResponseEntity get() {
        return new ResponseEntity();
    }
}