Home  >  Article  >  Java  >  How to customize routing coverage in SpringBoot

How to customize routing coverage in SpringBoot

王林
王林forward
2023-05-10 16:43:131359browse

    Background

    The company recently has a project in the second phase that requires the transformation of some functions, which involves the personalized customization of some of the built-in business interfaces of the framework and is compatible with the old interface functions. And add some new data returns. Since the front-end calls these interfaces are scattered and fragmented, and the modification and testing cost is high, we plan to provide routing coverage function at the framework level to speed up the project progress and reduce the system risks caused by modifications without technical content.

    Design

    • Provide custom annotations to specify the routing and new routing addresses that need to be covered

    • Scan all annotations when the system starts Data and mapping processing

    • Register custom route mapping configuration class

    Implementation

    Annotation definition

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    public @interface CoverRoute {
        String value() default "";
    }

    Annotation scanning and management

    Call the initRoute method when the system starts to map the original route and the corresponding overlay route to the map key-value pair

    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);
        }
    }

    Customized RequestMappingHandlerMapping

    Inherit RequestMappingHandlerMapping and rewrite the lookupHandlerMethod method to overwrite it when spring performs routing

    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);
            }
        }
    }

    Register RequestMappingHandlerMapping

    @Component
    public class WebRequestMappingConfig implements WebMvcRegistrations {
        public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
            RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping();
            handlerMapping.setOrder(0);
            return handlerMapping;
        }
    }

    Usage example

    Add the @CoverRoute annotation to the personalized interface class , specify the routing address that needs to be covered, and create the same routing path. Access to the original interface address will be automatically forwarded to the project's personalized interface address

    Original interface

    @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;
        }
    }

    New interface

    @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;
        }
    }

    The above is the detailed content of How to customize routing coverage in SpringBoot. For more information, please follow other related articles on the PHP Chinese website!

    Statement:
    This article is reproduced at:yisu.com. If there is any infringement, please contact admin@php.cn delete