javassist 解决Swagger2一个DTO 适用于多个接口

背景： 

    最近接到老大的一个任务，用一个DTO适用于多个接口，通过某个接口上注解解决把不需要得属性再swagger上隐藏掉。

结果：

一个DTO适用于2个接口

 

代码

   步骤一

1.引入pom
      
        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        

2.springBoot  开启
    @SpringBootApplication
    @EnableAsync
    @EnableSwagger2 //开启swagger
    public class RenrenApplication   {
	    public static void main(String[] args) {
		    SpringApplication.run(RenrenApplication.class, args);
	    }

    }

步骤二

1.自定义注解 

@Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiIgp {
        String[] value(); //对象属性值
}


2. 实现parameterBuilderPlugin 
ps: 注意这里用的是alibaba 的javassist 的包最好



@Component
@Order   //plugin加载顺序，默认是最后加载
public class MapApiReader implements ParameterBuilderPlugin {
    @Autowired
    private TypeResolver typeResolver;

    @Override
    public void apply(ParameterContext parameterContext) {
        ResolvedMethodParameter methodParameter = parameterContext.resolvedMethodParameter();
        Class originClass = parameterContext.resolvedMethodParameter().getParameterType().getErasedType();


            Optional optional = methodParameter.findAnnotation(ApiIgp.class);
            if (optional.isPresent()) {
                Random random = new Random();
                String name = originClass.getSimpleName() + "Model" + random.nextInt(100);  //model 名称
                String[] properties = optional.get().value();
                try {
                    parameterContext.getDocumentationContext()
                            .getAdditionalModels()
                            .add(typeResolver.resolve(createRefModelIgp(properties, originClass.getPackage()+"."+name, originClass)));  //像documentContext的Models中添加我们新生成的Class
                } catch (Exception e) {
                    e.printStackTrace();
                }
                parameterContext.parameterBuilder()  //修改Map参数的ModelRef为我们动态生成的class
                        .parameterType("body")
                        .modelRef(new ModelRef(name))
                        .name(name);
        }

    }

    private Class createRefModelIgp(String[] propertys, String name, Class origin) throws NotFoundException {
        ClassPool pool = ClassPool.getDefault();
        CtClass ctClass = pool.makeClass( name);
        try {
            Field[] fields = origin.getDeclaredFields();
            List fieldList = Arrays.asList(fields);
            List ignorePropertys = Arrays.asList(propertys);
            List dealFileds = fieldList.stream().filter(s -> !ignorePropertys.contains(s.getName())).collect(Collectors.toList());
            for (Field field : dealFileds) {
                CtField ctField = new CtField(ClassPool.getDefault().get(field.getType().getName()), field.getName(), ctClass);
                ctField.setModifiers(Modifier.PUBLIC);
                ApiModelProperty ampAnno = origin.getDeclaredField(field.getName()).getAnnotation(ApiModelProperty.class);
                String attributes = java.util.Optional.ofNullable(ampAnno).map(s->s.value()).orElse("");
                if (StringUtils.isNotBlank(attributes) ){ //添加model属性说明
                    ConstPool constPool = ctClass.getClassFile().getConstPool();
                    AnnotationsAttribute attr = new AnnotationsAttribute(constPool, AnnotationsAttribute.visibleTag);
                    Annotation ann = new Annotation(ApiModelProperty.class.getName(), constPool);
                    ann.addMemberValue("value", new StringMemberValue(attributes, constPool));
                    attr.addAnnotation(ann);
                    ctField.getFieldInfo().addAttribute(attr);
                }
                ctClass.addField(ctField);
            }
            return ctClass.toClass();
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }




    @Override
    public boolean supports(DocumentationType documentationType) {
        return true;
    }
}

步骤三： 

 

public class AppCustomController {
    @Autowired
    private UserService userService;


    @PostMapping("test1")
    @ApiOperation("form测试1")
    public R custom(@RequestBody RegisterForm form){
        return R.ok();
    }

    @PostMapping("test2")
    @ApiOperation("form测试2")
    public R test2(@ApiIgp ({"name","addr"})  // 这里把你不需要的DTO属性中的值填写上
                       @RequestBody RegisterForm form){
        return R.ok();
    }
}

总结

  我这边通过javassist这个类结合swagger 可拓展的插件去解决这个问题，通过自定义注解把不需要的属性值在swagger页面去掉，这里只会影响页面的显示，不会影响到接收的参数。

拓展

  当然这里你也可以通过自定义MapApiReader的类去 "正着" 处理这个问题, 你可以 把需要的属性留着，或者说  在每个请求统一加上某个属性说明都是可以做到的。

ps(这里javassist 最好使用alibaba的 异常不会影响整个swagger)