SpringBoot多controller添加URL前綴的實現方法
前言
在某些情況下,服務的controller中前綴是一致的,例如所有URL的前綴都為/context-path/api/v1,需要為某些URL添加統一的前綴。
能想到的處理辦法為修改服務的context-path,在context-path中添加api/v1,這樣修改全局的前綴能夠解決上面的問題,但存在弊端,如果URL存在多個前綴,例如有些URL需要前綴為api/v2,就無法區分瞭,如果服務中的一些靜態資源不想添加api/v1,也無法區分。
下面通過自定義註解的方式實現某些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(); } }
到此這篇關於SpringBoot多controller添加URL前綴的實現方法的文章就介紹到這瞭,更多相關SpringBoot添加URL前綴內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- springboot如何為web層添加統一請求前綴
- spring boot 如何請求後綴匹配
- Spring5路徑匹配器PathPattern解析
- SpringBoot 屬性配置中獲取值的方式
- SpringBoot對不同Bean註解的區別和使用場景說明