1. 存在的问题
我们在项目中使用swagger2.0时,发现如下问题:
我们想要按字段排序必须显示声明排序字段@ApiModelProperty(position=0)
swagger对注解@ApiOperation不支持position属性了,即不能按照指定接口顺序排序。(ps:官方也不提供解决,说设计如此,通过接口地址来排序。链接)
2.解决方法
查询官网
使用对应的扩展插件(ModelPropertyBuilderPlugin、OperationBuilderPlugin)
2.1使用ModelPropertyBuilderPlugin按代码顺序展示请求和响应字段
可以参考ModelPropertyBuilderPlugin的实现类ApiModelPropertyPropertyBuilder来实现自己的插件,
大概实现思路为:获取到字段上有ApiModelProperty注解的字段所在的类,然后获取所有字段数组,看这个字段在数组的哪个位置,就设置position属性。
实现代码如下:
/**
* 通过编写插件实现字段按类变量定义顺序排序,丰富模型属性
*/
@Component
public class CustomApiModelPropertyPositionBuilder implements ModelPropertyBuilderPlugin {undefined
private Log log = LogFactory.getLog(getClass());
@Override
public boolean supports(DocumentationType delimiter) {undefined
return SwaggerPluginSupport.pluginDoesApply(delimiter);
}
@Override
public void apply(ModelPropertyContext context) {undefined
Optional beanPropertyDefinitionOpt = context.getBeanPropertyDefinition();
Optional annotation = Optional.absent();
if (context.getAnnotatedElement().isPresent()) {undefined
annotation = annotation.or(findApiModePropertyAnnotation(context.getAnnotatedElement().get()));
}
if (context.getBeanPropertyDefinition().isPresent()) {undefined
annotation = annotation.or(findPropertyAnnotation(context.getBeanPropertyDefinition().get(), ApiModelProperty.class));
}
//必须是有ApiModelProperty注解的字段,并且beanPropertyDefinitionOpt带有注解
if (annotation.isPresent() && beanPropertyDefinitionOpt.isPresent()) {undefined
BeanPropertyDefinition beanPropertyDefinition = beanPropertyDefinitionOpt.get();
//获取到注解字段
AnnotatedField field = beanPropertyDefinition.getField();
//获取到字段所在的类
Class> clazz = field.getDeclaringClass();
//获取类中所有字段
Field[] declaredFields = clazz.getDeclaredFields();
Field declaredField;//获取当前字段的Field
try {undefined
declaredField = clazz.getDeclaredField(field.getName());
} catch (NoSuchFieldException | SecurityException e) {undefined
log.error("", e);
return;
}
//获取当前字段在数组中的位置。然后设置position属性
int indexOf = ArrayUtils.indexOf(declaredFields, declaredField);
if (indexOf != -1) {undefined
context.getBuilder().position(indexOf);
}
}
}
}
2.2使用OperationBuilderPlugin按代码顺序展示请求接口
可以参考OperationBuilderPlugin的实现类OperationHiddenReader来实现自己的插件,
大概实现思路为:获取到接口上有ApiOperation注解所在的类,然后获取到该接口方法在类中的多少行,用行号来进行接口排序。
实现代码如下:
/**
* 通过编写插件实现接口按定义顺序排序
*/
@Component
public class CustomOperationBuilderPlugin implements OperationBuilderPlugin {undefined
private static final Logger log = LoggerFactory.getLogger(CustomOperationBuilderPlugin.class);
@Override
public boolean supports(DocumentationType documentationType) {undefined
return SwaggerPluginSupport.pluginDoesApply(documentationType);
}
@Override
public void apply(OperationContext context) {undefined
//1.没有ApiOperation注解的直接返回
Optional apiOperation = context.findAnnotation(ApiOperation.class);
if (!apiOperation.isPresent()) {undefined
return;
}
//2.获取当前方法的位置,然后设置进position中
try {undefined
Class extends OperationContext> operationContextClass = context.getClass();
Field requestContextFiled = operationContextClass.getDeclaredField("requestContext");
requestContextFiled.setAccessible(true);
RequestMappingContext requestContext = (RequestMappingContext) requestContextFiled.get(context);
Class extends RequestMappingContext> requestContextClass = requestContext.getClass();
Field handler = requestContextClass.getDeclaredField("handler");
handler.setAccessible(true);
RequestHandler requestHandler = (RequestHandler) handler.get(requestContext);
//得到当前handler对应的Controller
Class> aClass = requestHandler.declaringClass();
//获取所有方法
// Method[] declaredMethods = aClass.getDeclaredMethods();
//获取当前api对应哪个方法
Method nowMethod = requestHandler.getHandlerMethod().getMethod();
//等到当前方法在所有方法中的位置(TO:位置变成了编译后的位置,需要找到编译前的位置)
// int indexOf = ArrayUtils.indexOf(declaredMethods, nowMethod);
//使用javasisit获取到对应方法在原始类的多少行
int indexOf = getMethodOriginalLine(aClass, nowMethod);
if (indexOf != -1) {undefined
//swagger-ui高版本不支持position排序了,解决方法是引入knife4j-spring-ui
//ps:找不到swagger-ui前端页面源代码加载位置,所以搞不定了~~~。有能力的小伙伴可以直接去修改swagger-ui的前端源代码
context.operationBuilder().position(indexOf);
//添加扩展参数:x-order(支持knife4j-spring-ui)
context.operationBuilder().extensions(Lists.newArrayList(new StringVendorExtension("x-order", indexOf + "")));
}
} catch (Exception e) {undefined
log.warn("加载swagger中方法api={},设置顺序出错。", context.getName(), e);
}
}
/**
* 获取方法在类中的原始开始行数
*
* @param clazz 原始类
* @param nowMethod 需要查找的哪个方法
* @return
*/
private int getMethodOriginalLine(Class clazz, Method nowMethod) throws Exception {undefined
ClassPool pool = ClassPool.getDefault();
String className = clazz.getName();
CtClass cc = pool.get(className);
Class>[] parameterTypes = nowMethod.getParameterTypes();
String[] objects = Arrays.stream(parameterTypes).map(Class::getName).collect(Collectors.toList()).toArray(new String[]{});
return cc.getDeclaredMethod(nowMethod.getName(), pool.get(objects)).getMethodInfo().getLineNumber(0);
}
}
3.注意事项
原来swagger-ui.html地址也会保留
访问地址: http://ip:port/doc.html
使用到的包:
用于获取接口在源代码中的行数:
org.javassist
javassist
3.21.0-GA
用于前端页面展示:
com.github.xiaoymin
knife4j-spring-ui
2.0.8
4.参考资料
原网址: 访问
创建于: 2021-12-02 17:22:46
目录: default
标签: 无
未标明原创文章均为采集,版权归作者所有,转载无需和我联系,请注明原出处,南摩阿彌陀佛,知识,不只知道,要得到
java windows火焰图_mob64ca12ec8020的技术博客_51CTO博客 - 在windows下不可行,不知道作者是怎样搞的 监听SpringBoot 服务启动成功事件并打印信息_监听springboot启动完毕-CSDN博客 SpringBoot中就绪探针和存活探针_management.endpoint.health.probes.enabled-CSDN博客 u2u转换板 - 嘉立创EDA开源硬件平台 Spring Boot 项目的轻量级 HTTP 客户端 retrofit 框架,快来试试它!_Java精选-CSDN博客 手把手教你打造一套最牛的知识笔记管理系统! - 知乎 - 想法有重合-理论可参考 安宇雨 闲鱼 机械键盘 客制化 开贴记录 文本 linux 使用find命令查找包含某字符串的文件_beijihukk的博客-CSDN博客_find 查找字符串 ---- mac 也适用 安宇雨 打字音 记录集合 B站 bilibili 自行搭建 开坑 真正的客制化 安宇雨 黑苹果开坑 查找工具包maven pom 引用地 工具网站 Dantelis 介绍的玩轴入坑攻略 --- 关于轴的一些说法 --- 非官方 ---- 心得而已 --- 长期开坑更新 [本人问题][新开坑位]关于自动化测试的工具与平台应用 机械键盘 开团 网站记录 -- 能做一个收集的程序就好了 不过现在没时间 -- 信息大多是在群里发的 - 你要让垃圾佬 都去一个地方看难度也是很大的 精神支柱 [超级前台]sprinbboot maven superdesk-app 记录 [信息有用] [环境准备] [基本完成] [sebp/elk] 给已创建的Docker容器增加新的端口映射 - qq_30599553的博客 - CSDN博客 [正在研究] Elasticsearch, Logstash, Kibana (ELK) Docker image documentation elasticsearch centos 安装记录 及 启动手记 正式服务器 39 elasticsearch 问题合集 不断更新 6.1.1 | 6.5.1 两个版本 博客程序 - 测试 - bug记录 等等问题 laravel的启动过程解析 - lpfuture - 博客园 OAuth2 Server PHP 用 Laravel 搭建带 OAuth2 验证的 RESTful 服务 | Laravel China 社区 - 高品质的 Laravel 和 PHP 开发者社区 利用Laravel 搭建oauth2 API接口 附 Unauthenticated 解决办法 - 煮茶的博客 - SegmentFault 思否 使用 OAuth2-Server-php 搭建 OAuth2 Server - 午时的海 - 博客园 基于PHP构建OAuth 2.0 服务端 认证平台 - Endv - 博客园 Laravel 的 Artisan 命令行工具 Laravel 的文件系统和云存储功能集成 浅谈Chromium中的设计模式--终--Observer模式 浅谈Chromium中的设计模式--二--pre/post和Delegate模式 浅谈Chromium中的设计模式--一--Chromium中模块分层和进程模型 DeepMind 4 Hacking Yourself README.md update 20211011
Laravel China 简书 知乎 博客园 CSDN博客 开源中国 Go Further Ryan是菜鸟 | LNMP技术栈笔记 云栖社区-阿里云 Netflix技术博客 Techie Delight Linkedin技术博客 Dropbox技术博客 Facebook技术博客 淘宝中间件团队 美团技术博客 360技术博客 古巷博客 - 一个专注于分享的不正常博客 软件测试知识传播 - 测试窝 有赞技术团队 阮一峰 语雀 静觅丨崔庆才的个人博客 软件测试从业者综合能力提升 - isTester IBM Java 开发 使用开放 Java 生态系统开发现代应用程序 pengdai 一个强大的博主 HTML5资源教程 | 分享HTML5开发资源和开发教程 蘑菇博客 - 专注于技术分享的博客平台 个人博客-leapMie 流星007 CSDN博客 - 舍其小伙伴 稀土掘金 Go 技术论坛 | Golang / Go 语言中国知识社区
最新评论