Source/BladeX-Tool/blade-core-cloud/src/main/java/org/springblade/core/cloud/version/BladeRequestMappingHandlerMapping.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,104 @@
/*
 *      Copyright (c) 2018-2028, DreamLu All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the dreamlu.net developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: DreamLu å¢æ˜¥æ¢¦ (596392912@qq.com)
 */
package org.springblade.core.cloud.version;

import org.springblade.core.cloud.annotation.ApiVersion;
import org.springblade.core.cloud.annotation.UrlVersion;
import org.springblade.core.tool.utils.StringPool;
import org.springblade.core.tool.utils.StringUtil;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.lang.Nullable;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import java.lang.reflect.Method;
import java.util.Map;

/**
 * url版本号处理 å’Œ header ç‰ˆæœ¬å¤„理
 *
 * <p>
 *     url: /v1/user/{id}
 *     header: Accept application/vnd.blade.VERSION+json
 * </p>
 *
 * æ³¨æ„ï¼šc ä»£è¡¨å®¢æˆ·ç«¯ç‰ˆæœ¬
 *
 * @author L.cm
 */
public class BladeRequestMappingHandlerMapping extends RequestMappingHandlerMapping {

   @Nullable
   @Override
   protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
      RequestMappingInfo mappinginfo = super.getMappingForMethod(method, handlerType);
      if (mappinginfo != null) {
         RequestMappingInfo apiVersionMappingInfo = getApiVersionMappingInfo(method, handlerType);
         return apiVersionMappingInfo == null ? mappinginfo : apiVersionMappingInfo.combine(mappinginfo);
      }
      return null;
   }

   @Nullable
   private RequestMappingInfo getApiVersionMappingInfo(Method method, Class<?> handlerType) {
      // url ä¸Šçš„版本，优先获取方法上的版本
      UrlVersion urlVersion = AnnotatedElementUtils.findMergedAnnotation(method, UrlVersion.class);
      // å†æ¬¡å°è¯•ç±»ä¸Šçš„版本
      if (urlVersion == null || StringUtil.isBlank(urlVersion.value())) {
         urlVersion = AnnotatedElementUtils.findMergedAnnotation(handlerType, UrlVersion.class);
      }
      // Media Types ç‰ˆæœ¬ä¿¡æ¯
      ApiVersion apiVersion = AnnotatedElementUtils.findMergedAnnotation(method, ApiVersion.class);
      // å†æ¬¡å°è¯•ç±»ä¸Šçš„版本
      if (apiVersion == null || StringUtil.isBlank(apiVersion.value())) {
         apiVersion = AnnotatedElementUtils.findMergedAnnotation(handlerType, ApiVersion.class);
      }
      boolean nonUrlVersion = urlVersion == null || StringUtil.isBlank(urlVersion.value());
      boolean nonApiVersion = apiVersion == null || StringUtil.isBlank(apiVersion.value());
      // å…ˆåˆ¤æ–­åŒæ—¶ä¸çº¯åœ¨
      if (nonUrlVersion && nonApiVersion) {
         return null;
      }
      // å¦‚æžœ header ç‰ˆæœ¬ä¸å­˜åœ¨
      RequestMappingInfo.Builder mappingInfoBuilder = null;
      if (nonApiVersion) {
         mappingInfoBuilder = RequestMappingInfo.paths(urlVersion.value());
      } else {
         mappingInfoBuilder = RequestMappingInfo.paths(StringPool.EMPTY);
      }
      // å¦‚æžœurl版本不存在
      if (nonUrlVersion) {
         String vsersionMediaTypes = new BladeMediaType(apiVersion.value()).toString();
         mappingInfoBuilder.produces(vsersionMediaTypes);
      }
      return mappingInfoBuilder.build();
   }

   @Override
   protected void handlerMethodsInitialized(Map<RequestMappingInfo, HandlerMethod> handlerMethods) {
      // æ‰“印路由信息 spring boot 2.1 åŽ»æŽ‰äº†è¿™ä¸ª æ—¥å¿—的打印
      if (logger.isInfoEnabled()) {
         for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet()) {
            RequestMappingInfo mapping = entry.getKey();
            HandlerMethod handlerMethod = entry.getValue();
            logger.info("Mapped \"" + mapping + "\" onto " + handlerMethod);
         }
      }
      super.handlerMethodsInitialized(handlerMethods);
   }
}