SpringBoot自定義路由覆蓋實現流程詳解
背景
公司最近有一個項目二期需要對一些功能進行改造,涉及部分框架內置業務接口個性化定制,兼容老接口功能並且增加一部分新的數據返回,由於前端調用這些接口分佈較多且較為零碎,修改測試成本較大,所以打算在框架層面提供路由覆蓋功能,加快項目進度減少無技術含量的修改帶來的系統風險
設計
- 提供自定義註解指定需要覆蓋的路由及新路由地址
- 系統啟動時掃描所有註解數據並進行映射處理
- 註冊自定義路由映射配置類
實現
註解定義
@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited public @interface CoverRoute { String value() default ""; }
註解掃描及管理
在系統啟動時調用initRoute方法,把原路由和對應的覆蓋路由映射到map鍵值對中
public class ConverRouteUtil { private static HashMap<String, String> mappingRegist = new HashMap<>(); public static void initRoute(Class runtimeClass, List<String> extraPackageNameList) { List<Class<?>> scanClassList = new ArrayList<>(); if (!runtimeClass.getPackage().getName().equals(Application.class.getPackage().getName())) { scanClassList.addAll(ScanUtil.getAllClassByPackageName_Annotation(runtimeClass.getPackage(), CoverRoute.class)); } for (String packageName : extraPackageNameList) { scanClassList.addAll(ScanUtil.getAllClassByPackageName_Annotation(packageName, CoverRoute.class)); } for (Class clazz : scanClassList) { CoverRoute coverRoute = (CoverRoute) clazz.getAnnotation(CoverRoute.class); if (StringUtil.isEmpty(coverRoute.value())) { continue; } RequestMapping requestMapping = (RequestMapping) clazz.getAnnotation(RequestMapping.class); String classRoute = ""; if (requestMapping != null) { classRoute = requestMapping.value()[0]; } else { continue; } List<Method> methodList = Arrays.asList(clazz.getDeclaredMethods()); for (Method method : methodList) { PostMapping postMapping = method.getAnnotation(PostMapping.class); String methodRoute = ""; if (postMapping != null) { methodRoute = postMapping.value()[0]; } else { GetMapping getMapping = method.getAnnotation(GetMapping.class); if (getMapping != null) { methodRoute = getMapping.value()[0]; } } if (!StringUtil.isEmpty(classRoute) && !StringUtil.isEmpty(methodRoute)) { String orginalRoute = coverRoute.value() + methodRoute; String redirectRoute = classRoute + methodRoute; mappingRegist.put(orginalRoute, redirectRoute); } } } if (mappingRegist.size() > 0) { System.out.println("掃描路由方法覆蓋:" + mappingRegist.size() + "個"); } } public static boolean checkExistCover(String orginalRoute) { return mappingRegist.containsKey(orginalRoute); } public static String getRedirectRoute(String orginalRoute) { return mappingRegist.get(orginalRoute); } }
自定義RequestMappingHandlerMapping
繼承RequestMappingHandlerMapping重寫lookupHandlerMethod方法,在spring進行路由尋址時進行覆蓋
public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping { @Override protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception { if(ConverRouteUtil.checkExistCover(lookupPath)){ String redirectRoute = ConverRouteUtil.getRedirectRoute(lookupPath); request.setAttribute("redirectTag","1"); request.setAttribute("redirectRoute",redirectRoute); request.setAttribute("lookupPath",lookupPath); lookupPath = redirectRoute; }else{ request.setAttribute("redirectTag","0"); } return super.lookupHandlerMethod(lookupPath, request); } @Override protected RequestMappingInfo getMatchingMapping(RequestMappingInfo info, HttpServletRequest request) { String redirectTag = ConvertOp.convert2String(request.getAttribute("redirectTag")); if(redirectTag.equals("1")){ String redirectRoute = ConvertOp.convert2String(request.getAttribute("redirectRoute")); boolean check = false; if( info.getPatternsCondition()!=null){ Set<String> set = info.getPatternsCondition().getPatterns(); if(set.size()>0){ String[] array = new String[set.size()]; array = set.toArray(array); String pattern = array[0]; if(pattern.equals(redirectRoute)){ check = true; } } } if(check){ return info; }else{ return super.getMatchingMapping(info, request); } }else{ return super.getMatchingMapping(info, request); } } }
註冊RequestMappingHandlerMapping
@Component public class WebRequestMappingConfig implements WebMvcRegistrations { public RequestMappingHandlerMapping getRequestMappingHandlerMapping() { RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping(); handlerMapping.setOrder(0); return handlerMapping; } }
使用示例
在個性化接口類增加@CoverRoute註解,指定需要覆蓋的路由地址,創建相同路由路徑的的方法即可,訪問原來的接口地址會自動轉發到項目個性化接口地址
原接口
@Controller @RequestMapping("/example/original") public class RedirectOriginalExampleController { @PostMapping("/getConfig") @ResponseBody @AnonymousAccess public Object getConfig(@RequestBody Map<String, Object> params) { Result result = Result.okResult(); result.add("tag","original"); return result; } }
新接口
@Controller @RequestMapping("/example/redirect") @CoverRoute("/example/original") public class RedirectExampleController { @PostMapping("/getConfig") @ResponseBody public Object getConfig(@RequestBody Map<String, Object> params) { Result result = Result.okResult(); String param1 = ConvertOp.convert2String(params.get("param1")); result.add("tag","redirect"); result.add("param1",param1); return result; } }
到此這篇關於SpringBoot自定義路由覆蓋實現流程詳解的文章就介紹到這瞭,更多相關SpringBoot自定義路由覆蓋內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- 聊聊@RequestMapping和@GetMapping @PostMapping的區別
- Springboot項目如何獲取所有的接口
- springboot RESTful以及參數註解的使用方式
- SpringBoot根據目錄結構自動生成路由前綴的實現代碼
- SpringBoot如何接收數組參數的方法