基于Java的Torna接口文档管理解决方案设计源码

package cn.torna.swaggerplugin; import cn.torna.sdk.client.OpenClient; import cn.torna.sdk.param.DebugEnv; import cn.torna.sdk.param.DocItem; import cn.torna.sdk.param.DocParamCode; import cn.torna.sdk.param.DocParamHeader; import cn.torna.sdk.param.DocParamPath; import cn.torna.sdk.param.DocParamReq; import cn.torna.sdk.param.DocParamResp; import cn.torna.sdk.param.EnumInfoParam; import cn.torna.sdk.param.IParam; import cn.torna.sdk.request.DocPushRequest; import cn.torna.sdk.request.EnumBatchPushRequest; import cn.torna.sdk.response.DocPushResponse; import cn.torna.sdk.response.EnumPushResponse; import cn.torna.swaggerplugin.bean.ApiParamWrapper; import cn.torna.swaggerplugin.bean.Booleans; import cn.torna.swaggerplugin.bean.CodeInfo; import cn.torna.swaggerplugin.bean.CodeItem; import cn.torna.swaggerplugin.bean.ControllerInfo; import cn.torna.swaggerplugin.bean.DocParamInfo; import cn.torna.swaggerplugin.bean.ModeEnum; import cn.torna.swaggerplugin.bean.PluginConstants; import cn.torna.swaggerplugin.bean.PushFeature; import cn.torna.swaggerplugin.bean.TornaConfig; import cn.torna.swaggerplugin.builder.ApiDocBuilder; import cn.torna.swaggerplugin.builder.DataType; import cn.torna.swaggerplugin.builder.FieldDocInfo; import cn.torna.swaggerplugin.builder.MvcRequestInfoBuilder; import cn.torna.swaggerplugin.builder.RequestInfoBuilder; import cn.torna.swaggerplugin.exception.HiddenException; import cn.torna.swaggerplugin.exception.IgnoreException; import cn.torna.swaggerplugin.util.ClassUtil; import cn.torna.swaggerplugin.util.PluginUtil; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONArray; import com.alibaba.fastjson.serializer.SerializerFeature; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import io.swagger.annotations.Extension; import io.swagger.annotations.ExtensionProperty; import lombok.AllArgsConstructor; import lombok.Data; import org.springframework.beans.BeanUtils; import org.springframework.core.annotation.AnnotationUtils; import org.springframework.core.annotation.Order; import org.springframework.http.HttpMethod; import org.springframework.util.CollectionUtils; import org.springframework.util.ReflectionUtils; import org.springframework.util.StringUtils; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestParam; import springfox.documentation.annotations.ApiIgnore; import java.lang.annotation.Annotation; import java.lang.reflect.Method; import java.lang.reflect.Parameter; import java.lang.reflect.Type; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; /** * @author tanghc */ public class SwaggerPluginService { private final TornaConfig tornaConfig; private final OpenClient client; private boolean existsApiIgnore = true; public SwaggerPluginService(TornaConfig tornaConfig) { this.tornaConfig = tornaConfig; client = new OpenClient(tornaConfig.getUrl()); try { Class.forName("springfox.documentation.annotations.ApiIgnore"); } catch (ClassNotFoundException e) { existsApiIgnore = false; System.out.println("Warning: no 'springfox-core' dependency is imported, 'ApiIgnore' check will be skipped."); } } public void pushDoc() { if (!tornaConfig.getEnable()) { return; } String basePackage = tornaConfig.getBasePackage(); if (StringUtils.isEmpty(basePackage)) { throw new IllegalArgumentException("basePackage can not empty."); } this.doPush(); this.pushCode(); } protected void doPush() { String packageConfig = tornaConfig.getBasePackage(); String[] pkgs = packageConfig.split(";"); Set<Class<?>> classes = new HashSet<>(); for (String basePackage : pkgs) { Set<Class<?>> clazzs = ClassUtil.getClasses(basePackage, Api.class); classes.addAll(clazzs); } Map<ControllerInfo, List<DocItem>> controllerDocMap = new HashMap<>(32); for (Class<?> clazz : classes) { ControllerInfo controllerInfo; try { controllerInfo = buildControllerInfo(clazz); } catch (HiddenException | IgnoreException e) { System.out.println(e.getMessage()); continue; } List<DocItem> docItems = controllerDocMap.computeIfAbsent(controllerInfo, k -> new ArrayList<>()); ReflectionUtils.doWithMethods(clazz, method -> { try { DocItem apiInfo = buildDocItem(new MvcRequestInfoBuilder(method, tornaConfig)); docItems.add(apiInfo); } catch (HiddenException | IgnoreException e) { System.out.println(e.getMessage()); } catch (Exception e) { System.out.printf("Create doc error, method:%s%n", method); throw new RuntimeException(e.getMessage(), e); } }, this::match); } List<DocItem> docItems = mergeSameFolder(controllerDocMap); this.push(docItems); } /** * 推送错误码 */ protected void pushCode() { List<CodeInfo> codes = this.tornaConfig.getCodes(); if (CollectionUtils.isEmpty(codes)) { return; } checkCode(codes); formatCode(codes); String json = JSONArray.toJSONString(codes); List<EnumInfoParam> enumInfoParams = JSONArray.parseArray(json, EnumInfoParam.class); String token = tornaConfig.getToken(); EnumBatchPushRequest request = new EnumBatchPushRequest(token); request.setEnums(enumInfoParams); // 发送请求 EnumPushResponse response = client.execute(request); if (!response.isSuccess()) { System.out.println("Push code error，errorCode:" + response.getCode() + ",errorMsg:" + response.getMsg()); } } private void checkCode(List<CodeInfo> codeInfos) { for (CodeInfo codeInfo : codeInfos) { if (StringUtils.isEmpty(codeInfo.getName())) { throw getDefineCodeException("missing code name"); } List<CodeItem> items = codeInfo.getItems(); if (CollectionUtils.isEmpty(items)) { throw getDefineCodeException("missing code items"); } for (CodeItem item : items) { if (StringUtils.isEmpty(item.getValue())) { throw getDefineCodeException("missing item.value"); } if (StringUtils.isEmpty(item.getDescription())) { throw getDefineCodeException("missing item.description"); } } } } private static IllegalArgumentException getDefineCodeException(String msg) { return new IllegalArgumentException("Define code error, " + msg); } private void formatCode(List<CodeInfo> codeInfos) { for (CodeInfo codeInfo : codeInfos) { List<CodeItem> items = codeInfo.getItems(); if (CollectionUtils.isEmpty(items)) { continue; } for (CodeItem item : items) { if (StringUtils.isEmpty(item.getType())) { String type = codeInfo.getItemType(); item.setType(StringUtils.isEmpty(type) ? "string" :