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 {
private Log log = (getClass());
@Override
public boolean supports(DocumentationType delimiter) {
return (delimiter);
}
@Override
public void apply(ModelPropertyContext context) {
Optional beanPropertyDefinitionOpt = ();
Optional annotation = ();
if (().isPresent()) {
annotation = (findApiModePropertyAnnotation(().get()));
}
if (().isPresent()) {
annotation = (findPropertyAnnotation(().get(), ));
}
//必须是有ApiModelProperty注解的字段，并且beanPropertyDefinitionOpt带有注解
if (() && ()) {
BeanPropertyDefinition beanPropertyDefinition = ();
//获取到注解字段
AnnotatedField field = ();
//获取到字段所在的类
Class> clazz = ();
//获取类中所有字段
Field[] declaredFields = ();
Field declaredField;//获取当前字段的Field
try {
declaredField = (());
} catch (NoSuchFieldException | SecurityException e) {
("", e);
return;
}
//获取当前字段在数组中的位置。然后设置position属性
int indexOf = (declaredFields, declaredField);
if (indexOf != -1) {
().position(indexOf);
}
}
}
}
2.2使用OperationBuilderPlugin按代码顺序展示请求接口
可以参考OperationBuilderPlugin的实现类OperationHiddenReader来实现自己的插件，
大概实现思路为：获取到接口上有ApiOperation注解所在的类，然后获取到该接口方法在类中的多少行，用行号来进行接口排序。
实现代码如下：
/**
* 通过编写插件实现接口按定义顺序排序
*/
@Component
public class CustomOperationBuilderPlugin implements OperationBuilderPlugin {
private static final Logger log = ();
@Override
public boolean supports(DocumentationType documentationType) {
return (documentationType);
}
@Override
public void apply(OperationContext context) {
//1.没有ApiOperation注解的直接返回
Optional apiOperation = ();
if (!()) {
return;
}
//2.获取当前方法的位置，然后设置进position中
try {
Class extends OperationContext> operationContextClass = ();
Field requestContextFiled = ("requestContext");
(true);
RequestMappingContext requestContext = (RequestMappingContext) (context);
Class extends RequestMappingContext> requestContextClass = ();
Field handler = ("handler");
(true);
RequestHandler requestHandler = (RequestHandler) (requestContext);
//得到当前handler对应的Controller
Class> aClass = ();
//获取所有方法
// Method[] declaredMethods = ();
//获取当前api对应哪个方法
Method nowMethod = ().getMethod();
//等到当前方法在所有方法中的位置(TO:位置变成了编译后的位置，需要找到编译前的位置)
// int indexOf = (declaredMethods, nowMethod);
//使用javasisit获取到对应方法在原始类的多少行
int indexOf = getMethodOriginalLine(aClass, nowMethod);
if (indexOf != -1) {
//swagger-ui高版本不支持position排序了，解决方法是引入knife4j-spring-ui
//ps:找不到swagger-ui前端页面源代码加载位置，所以搞不定了~~~。有能力的小伙伴可以直接去修改swagger-ui的前端源代码
().position(indexOf);
//添加扩展参数：x-order(支持knife4j-spring-ui)
().extensions((new StringVendorExtension("x-order", indexOf + "")));
}
} catch (Exception e) {
("加载swagger中方法api={}，设置顺序出错。", (), e);
}
}
/**
* 获取方法在类中的原始开始行数
*
* @param clazz 原始类
* @param nowMethod 需要查找的哪个方法
* @return
*/
private int getMethodOriginalLine(Class clazz, Method nowMethod) throws Exception {
ClassPool pool = ();
String className = ();
CtClass cc = (className);
Class>[] parameterTypes = ();
String[] objects = (parameterTypes).map(Class::getName).collect(()).toArray(new String[]{});
return ((), (objects)).getMethodInfo().getLineNumber(0);
}
}
3.注意事项
原来地址也会保留
访问地址： http://ip:port/
使用到的包：
用于获取接口在源代码中的行数：
javassist
3.21.0-GA
用于前端页面展示：
knife4j-spring-ui
2.0.8
4.参考资料