SpringBoot でルーティング カバレッジをカスタマイズする方法

背景

同社は最近、一部の機能の変換を必要とするプロジェクトの第 2 フェーズに取り組んでいます。これには、構築された機能の一部のパーソナライズされたカスタマイズが含まれます。 -フレームワークのビジネスインターフェースに組み込まれており、古いインターフェース機能と互換性があり、新しいデータリターンも追加されています。フロントエンド呼び出しのこれらのインターフェースは分散して断片化されており、修正とテストのコストが高いため、ルーティングを提供する予定ですフレームワーク レベルでのカバレッジ機能を使用して、プロジェクトの進行を加速し、技術的な内容を含まない変更によって引き起こされるシステム リスクを軽減します。およびカバーする必要がある新しいルーティング アドレス

システムの開始時にすべての注釈をスキャンするデータとマッピングの処理
カスタム ルート マッピング構成クラスを登録する
実装

• アノテーションの定義

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

アノテーションのスキャンと管理

システムがオリジナルのマッピングを開始するときに initRoute メソッドを呼び出します。ルートと、マップのキーと値のペアへの対応するオーバーレイ ルート #

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

Register 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 でルーティング カバレッジをカスタマイズする方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。