SpringBoot根據(jù)目錄結構自動配置Url前綴方式
在很多其他框架中,比如Python的Flask、node.js的KOA,Controller要想能夠響應前端的請求都需要我們主動去注冊到應用程序上。而Spring不需要我們自己去注冊,由Spring通過掃描注解的方式去主動發(fā)現(xiàn)。
自定義RequestMappingInfo
Spring中的RequestMappingHandlerMapping專門來負責處理標注了@RequestMapping的控制器。創(chuàng)建一個類繼承并覆蓋其中的方法,從而實現(xiàn)對默認機制的修改。
覆蓋其中的getMappingForMethod方法,這個方法的返回值RequestMappingInfo就包含了請求的Url,修改RequestMappingInfo中的Url從而修改路由中的Url。
package com.lin.missyou.hack; import org.springframework.beans.factory.annotation.Value; import org.springframework.web.servlet.mvc.method.RequestMappingInfo; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping; import java.lang.reflect.Method; public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping { @Value("${missyou.api-package}") private String apiPackagePath ; //從配置文件中獲取根包的路徑 @Override protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) { RequestMappingInfo requestMappingInfo = super.getMappingForMethod(method, handlerType); if(null != requestMappingInfo){ //獲取url前綴 String prefix = getPrefix(handlerType); //根據(jù)url前綴生成RequestMappingInfo并與原有的RequestMappingInfo合并 RequestMappingInfo mappingInfo = RequestMappingInfo.paths(prefix).build().combine(requestMappingInfo); return mappingInfo; } return requestMappingInfo; } private String getPrefix(Class<?> handlerType){ String packageName = handlerType.getPackage().getName(); //獲取控制器所在包路徑 String dotPath = packageName.replaceAll(this.apiPackagePath,""); //將包路徑中多于的部分截取掉 return dotPath.replace(".","/"); //將包路徑中的.替換成/ } }
通過接口的形式發(fā)現(xiàn)類
創(chuàng)建一個配置類AutoPrefixConfiguration將AutoPrefixUrlMapping加入到容器。配置類AutoPrefixConfiguration實現(xiàn)接口WebMvcRegistrations并覆蓋其中的getRequestMappingHandlerMapping方法
package com.lin.missyou.core.config; import com.lin.missyou.hack.AutoPrefixUrlMapping; import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations; import org.springframework.stereotype.Component; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping; @Component public class AutoPrefixConfiguration implements WebMvcRegistrations { @Override public RequestMappingHandlerMapping getRequestMappingHandlerMapping() { return new AutoPrefixUrlMapping(); } }
在配置文件中指定根包
missyou.api-package = com.lin.missyou.api
SprinBoot的 發(fā)現(xiàn)機制 有兩種。一種是在控制器上標注特定注解,例如上一篇文章SpringBoot全局異常處理中在GlobalExceptionAdvice 上標注@ControllerAdvice。另外一種是實現(xiàn)特定接口并覆蓋其中的特定方法,例如上面的AutoPrefixConfiguration。
測試一下
訪問結果,訪問路徑/v1/banner/test可以訪問到該控制器
將訪問路徑改為/banner/test就訪問不到了
將BannerController移動到sample文件夾下訪問路徑/v1/sample/banner/test可以訪問到該控制器
這個方法存在一些爭議。一方面認為根據(jù)目錄結構自動生成url雖然比較簡單,少寫了一些代碼,但是無法通過控制器上標注的@RequestMapping中的參數(shù)直接看出url,代碼的可讀性不是太好。
另一方面認為,這個方法大大的簡化了我們代碼的編寫,同時更加易于維護,控制器隨意調整所在目錄都不需要去修改代碼。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
基于JavaMail的Java實現(xiàn)復雜郵件發(fā)送功能
這篇文章主要為大家詳細介紹了基于JavaMail的Java實現(xiàn)復雜郵件發(fā)送功能,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-09-09SpringBoot 動態(tài)配置郵箱發(fā)件人過程解析
這篇文章主要介紹了SpringBoot 動態(tài)配置郵箱發(fā)件人過程解析,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-08-08Java查詢Elasticsearch數(shù)據(jù)根據(jù)指定id檢索(in查詢)、sql權限過濾、多字段匹配檢索及數(shù)據(jù)排序
在Java開發(fā)中Elasticsearch(簡稱ES)是一個非常流行的搜索引擎,它提供了強大的全文搜索和分析功能,這篇文章主要給大家介紹了關于Java查詢Elasticsearch數(shù)據(jù)根據(jù)指定id檢索(in查詢)、sql權限過濾、多字段匹配檢索及數(shù)據(jù)排序的相關資料,需要的朋友可以參考下2024-05-05