2025年swagger2注解（swagger注解大全）

大家好，我是讯享网，很高兴认识大家。

讯享网

先说一说Springfox和Swagger的关系

Swagger 是一种规范。

springfox-swagger 是基于 Spring 生态系统的该规范的实现。

springfox-swagger-ui 是对 swagger-ui 的封装，使得其可以使用 Spring 的服务。

由于工作中遇到需要基于 Swagger Json 做一些处理，但 Swagger Json 的格式不是那么满足需求。

本文springfox-swagger版本号：2.6.0

本文从问题出发，探索涉及的源码。

1. GET 方法的参数对象

第一个问题，当方法是GET请求，但参数是一个自定义 Object，在展示时（生成的JSON）是不包括本 Object 描述的。所以，就要看看什么时候会生成这些 Model 的描述。

万事有始有终，SpringFox始就在：springfox.documentation.spring.web.plugins下的 DocumentationPluginsBootstrapper。

该类实现了 SmartLifecycle 接口，实现此接口且通过@Component注入到容器的bean, 容器初始化后会执行start()方法.

@Component
public&nbsp;class&nbsp;DocumentationPluginsBootstrapper&nbsp;implements&nbsp;SmartLifecycle&nbsp;{

讯享网

接着看 start 方法

讯享网@Override
public&nbsp;void&nbsp;start()&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(initialized.compareAndSet(false,&nbsp;true))&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;拿到&nbsp;DocumentationPlugin&nbsp;插件
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List&lt;DocumentationPlugin&gt;&nbsp;plugins&nbsp;=&nbsp;pluginOrdering()
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.sortedCopy(documentationPluginsManager.documentationPlugins());
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(DocumentationPlugin&nbsp;each&nbsp;:&nbsp;plugins)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//获取文档类型
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DocumentationType&nbsp;documentationType&nbsp;=&nbsp;each.getDocumentationType();
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(each.isEnabled())&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;启用则扫描生成文档
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;scanDocumentation(buildContext(each));
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}
&nbsp;&nbsp;&nbsp;&nbsp;}
}

调用了 buildContext 方法, 通过 Docket 对象创建 DocumentaionContext 对象

private&nbsp;DocumentationContext&nbsp;buildContext(DocumentationPlugin&nbsp;each)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;each.configure(this.defaultContextBuilder(each));
}

再往下走

讯享网private&nbsp;DocumentationContextBuilder&nbsp;defaultContextBuilder(DocumentationPlugin&nbsp;each)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;DocumentationType&nbsp;documentationType&nbsp;=&nbsp;each.getDocumentationType();
&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;获取所有的RequestHnadler
&nbsp;&nbsp;&nbsp;&nbsp;List&lt;RequestHandler&gt;&nbsp;requestHandlers&nbsp;=&nbsp;FluentIterable.from(this.handlerProviders).transformAndConcat(this.handlers()).toList();
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;this.documentationPluginsManager.createContextBuilder(documentationType,&nbsp;this.defaultConfiguration).requestHandlers(requestHandlers);
}

handlerProviders 是 RequestHandlerProvider 接口，实现类是 WebMvcRequestHandlerProvider,其中 requestHandlers 方法会接收Spring中的所有请求映射。

接着看 DocumentationContextBuilder的构造过程：documentationPluginsManager.createContextBuilder

public&nbsp;DocumentationContextBuilder&nbsp;createContextBuilder(DocumentationType&nbsp;documentationType,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DefaultConfiguration&nbsp;defaultConfiguration)&nbsp;{
&nbsp;&nbsp;return&nbsp;defaultsProviders.getPluginFor(documentationType,&nbsp;defaultConfiguration)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.create(documentationType)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.withResourceGroupingStrategy(resourceGroupingStrategy(documentationType));
}

defaultsProviders 是也是一个插件接口 DefaultsProviderPlugin，只有一个实现类DefaultConfiguration，不过该类未使用@Compoent注解，所以需要给一个替换值defaultConfiguration，也就是DefaultConfiguration。在看DefaultConfiguration的create方法：

讯享网@Override
public&nbsp;DocumentationContextBuilder&nbsp;create(DocumentationType&nbsp;documentationType)&nbsp;{
&nbsp;&nbsp;return&nbsp;new&nbsp;DocumentationContextBuilder(documentationType)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.operationOrdering(defaults.operationOrdering())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.apiDescriptionOrdering(defaults.apiDescriptionOrdering())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.apiListingReferenceOrdering(defaults.apiListingReferenceOrdering())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.additionalIgnorableTypes(defaults.defaultIgnorableParameterTypes())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.rules(defaults.defaultRules(typeResolver))
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.defaultResponseMessages(defaults.defaultResponseMessages())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.pathProvider(new&nbsp;RelativePathProvider(servletContext))
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.typeResolver(typeResolver)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.enableUrlTemplating(false)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.selector(ApiSelector.DEFAULT);
}

这里在给DocumentationContextBuilder设置相关参数，至此拿到了 DocumentationContextBuilder

回到上面提到的buildContext方法，defaultContextBuilder方法执行完毕，接下来是 configure

return&nbsp;each.configure(this.defaultContextBuilder(each));

DocumentationPlugin只有一个实现类Docket，到这里就有点熟悉了。Docket对象是我们开发人员在外部通过@Bean来创建的，而外部赋值的对象值，最终都会整合到DocumentationContext。这里的config就是在二次赋值。可以看一下一般自己定义的Docket对象。

讯享网public&nbsp;class&nbsp;SwaggerConfig&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;@Bean
&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;Docket&nbsp;docket()&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;new&nbsp;Docket(DocumentationType.SWAGGER_2)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.groupName(SWAGGER_GROUP)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.apiInfo(new&nbsp;ApiInfoBuilder().title(“xx”).version(“1.0.0”).build())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;……
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.select()
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.apis(basePackage(“xxx”))
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.paths(PathSelectors.any())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.build();
&nbsp;&nbsp;&nbsp;&nbsp;}
}

到这里实际只设置了默认的参数。但接口，定义，模型等关键信息等都未初始化。

回到最初start(), 看看scanDocumentation(buildContext(each))的scanDocumentation

private&nbsp;void&nbsp;scanDocumentation(DocumentationContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;scanned.addDocumentation(resourceListing.scan(context));
}

其中 scan 位于 ApiDocumentationScanner类

讯享网public&nbsp;Documentation&nbsp;scan(DocumentationContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;ApiListingReferenceScanResult&nbsp;result&nbsp;=&nbsp;apiListingReferenceScanner.scan(context);
&nbsp;&nbsp;…
&nbsp;&nbsp;Multimap&lt;String,&nbsp;ApiListing&gt;&nbsp;apiListings&nbsp;=&nbsp;apiListingScanner.scan(listingContext);
&nbsp;&nbsp;…

apiListingReferenceScanner.scan位于 ApiListingReferenceScanner类

public&nbsp;ApiListingReferenceScanResult&nbsp;scan(DocumentationContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;…
&nbsp;&nbsp;//&nbsp;接口选择器&nbsp;在构建Docket时通过.select()默认配置&nbsp;
&nbsp;&nbsp;ApiSelector&nbsp;selector&nbsp;=&nbsp;context.getApiSelector();
&nbsp;&nbsp;//&nbsp;根据package路径(一般)或注解区分,&nbsp;过滤筛选掉不符规则的&nbsp;RequestHandler&nbsp;接口
&nbsp;&nbsp;Iterable&lt;RequestHandler&gt;&nbsp;matchingHandlers&nbsp;=&nbsp;from(context.getRequestHandlers())
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.filter(selector.getRequestHandlerSelector());
&nbsp;&nbsp;for&nbsp;(RequestHandler&nbsp;handler&nbsp;:&nbsp;matchingHandlers)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;接口分组&nbsp;resourceGroup&nbsp;=&nbsp;Controller，RequestMapping&nbsp;=&nbsp;method
&nbsp;&nbsp;&nbsp;&nbsp;ResourceGroup&nbsp;resourceGroup&nbsp;=&nbsp;new&nbsp;ResourceGroup(handler.groupName(),
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;handler.declaringClass(),&nbsp;0);
&nbsp;&nbsp;&nbsp;&nbsp;RequestMappingContext&nbsp;requestMappingContext
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=&nbsp;new&nbsp;RequestMappingContext(context,&nbsp;handler);
&nbsp;&nbsp;&nbsp;&nbsp;resourceGroupRequestMappings.put(resourceGroup,&nbsp;requestMappingContext);
&nbsp;&nbsp;}
&nbsp;&nbsp;return&nbsp;new&nbsp;ApiListingReferenceScanResult(asMap(resourceGroupRequestMappings));
}

到这已经拿到了所有接口并进行了分组，其中ArrayListMultimap是guava的方法。

再回到 ApiDocumentationScanner的 scan方法，看 apiListingScanner.scan

讯享网public&nbsp;Multimap&lt;String,&nbsp;ApiListing&gt;&nbsp;scan(ApiListingScanningContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;…
&nbsp;&nbsp;for&nbsp;(ResourceGroup&nbsp;resourceGroup&nbsp;:&nbsp;sortedByName(requestMappingsByResourceGroup.keySet()))&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(RequestMappingContext&nbsp;each&nbsp;:&nbsp;sortedByMethods(requestMappingsByResourceGroup.get(resourceGroup)))&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;循环Controller下的所有接口的实例对象,&nbsp;拿到该接口的所有Model
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;models.putAll(apiModelReader.read(each.withKnownModels(models)));
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;apiDescriptions.addAll(apiDescriptionReader.read(each));
&nbsp;&nbsp;&nbsp;&nbsp;}

each.withKnownModels 是复制对象，主要看apiModelReader.read,读取该接口的 Model 信息。

public&nbsp;Map&lt;String,&nbsp;Model&gt;&nbsp;read(RequestMappingContext&nbsp;context)&nbsp;{
&nbsp;//&nbsp;忽略的class
&nbsp;&nbsp;Set&lt;Class&gt;&nbsp;ignorableTypes&nbsp;=&nbsp;newHashSet(context.getIgnorableParameterTypes());
&nbsp;&nbsp;Set&lt;ModelContext&gt;&nbsp;modelContexts&nbsp;=&nbsp;pluginsManager.modelContexts(context);
&nbsp;&nbsp;Map&lt;String,&nbsp;Model&gt;&nbsp;modelMap&nbsp;=&nbsp;newHashMap(context.getModelMap());
&nbsp;&nbsp;for&nbsp;(ModelContext&nbsp;each&nbsp;:&nbsp;modelContexts)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;markIgnorablesAsHasSeen(typeResolver,&nbsp;ignorableTypes,&nbsp;each);
&nbsp;&nbsp;&nbsp;&nbsp;Optional&lt;Model&gt;&nbsp;pModel&nbsp;=&nbsp;modelProvider.modelFor(each);
&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(pModel.isPresent())&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mergeModelMap(modelMap,&nbsp;pModel.get());
&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;else&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;}
&nbsp;&nbsp;&nbsp;&nbsp;populateDependencies(each,&nbsp;modelMap);
&nbsp;&nbsp;}
&nbsp;&nbsp;return&nbsp;modelMap;
}

就是从 modelContexts转化为 Model，看看pluginsManager.modelContexts，怎么取modelContexts

讯享网public&nbsp;Set&lt;ModelContext&gt;&nbsp;modelContexts(RequestMappingContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;DocumentationType&nbsp;documentationType&nbsp;=&nbsp;context.getDocumentationContext().getDocumentationType();
&nbsp;&nbsp;//&nbsp;构建接口的ModelContext集合
&nbsp;&nbsp;for&nbsp;(OperationModelsProviderPlugin&nbsp;each&nbsp;:&nbsp;operationModelsProviders.getPluginsFor(documentationType))&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;each.apply(context);
&nbsp;&nbsp;}
&nbsp;&nbsp;return&nbsp;context.operationModelsBuilder().build();
}

OperationModelsProviderPlugin有两个实现类，通过文档类型来获取。

OperationModelsProviderPlugin：处理返回类型，参数类型等
SwaggerOperationModelsProvider：swagger注解提供的值类型， @ApiResponse， @ApiOperation等

先看OperationModelsProviderPlugin

@Override
public&nbsp;void&nbsp;apply(RequestMappingContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;//&nbsp;收集返回类型
&nbsp;&nbsp;collectFromReturnType(context);
&nbsp;&nbsp;//&nbsp;收集参数类型
&nbsp;&nbsp;collectParameters(context);
&nbsp;&nbsp;//&nbsp;收集接口型号
&nbsp;&nbsp;collectGlobalModels(context);
}

到了这，本问题（ GET 方法的请求Object不描述）的答案就要呼之欲出了。来看 collectParameters

讯享网private&nbsp;void&nbsp;collectParameters(RequestMappingContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;//&nbsp;获取所有类型
&nbsp;&nbsp;List&lt;ResolvedMethodParameter&gt;&nbsp;parameterTypes&nbsp;=&nbsp;context.getParameters();
&nbsp;&nbsp;for&nbsp;(ResolvedMethodParameter&nbsp;parameterType&nbsp;:&nbsp;parameterTypes)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;过滤&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(parameterType.hasParameterAnnotation(RequestBody.class)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;parameterType.hasParameterAnnotation(RequestPart.class))&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ResolvedType&nbsp;modelType&nbsp;=&nbsp;context.alternateFor(parameterType.getParameterType());
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;context.operationModelsBuilder().addInputParam(modelType);
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}
&nbsp;&nbsp;}
}

破案了，可以看到过滤时只会处理两种：通过@RequestBody和@ReuqestPart注解标注的, 而GET方法的参数是不可以使用这两个注解的。（当然从规范来说，GET方法也不应该这种参数）。

至于OperationModelsProviderPlugin的另一个实现类SwaggerOperationModelsProvider主要是收集使用@ApiOperation时主句属性值和@ApiResponse响应状态码涉及到的型号，不再详细列出。

而apiModelReader.read中的 modelContexts转化为 Model的modelProvider.modelFor()是通过ModelProvider实现，下一个问题会详细阐述。

那么，如何解决这个问题：

使用   Docket的 additionalModels方法，在配置类中注入   TypeResolver

return&nbsp;new&nbsp;Docket(DocumentationType.SWAGGER_2)
.additionalModels(typeResolver.resolve(xxx))
…

借助第三方类库如swagger-bootstrap-ui的工具类（我没接，但可以..）
重写

重写OperationModelsProviderPlugin的apply方法，添加自定义收集器。或者直接重写 collectParameters也行。比如

讯享网private&nbsp;void&nbsp;collectGetParameters(RequestMappingContext&nbsp;context)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(ResolvedMethodParameter&nbsp;parameterType&nbsp;:&nbsp;parameterTypes)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;不存在@RequestBody注解
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(!parameterType.hasParameterAnnotation(RequestBody.class)…)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(xxx)&nbsp;{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ResolvedType&nbsp;modelType&nbsp;=&nbsp;context.alternateFor(parameterType.getParameterType());
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;context.operationModelsBuilder().addInputParam(modelType);
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}}

问题解决。

2. Enum的描述格式

问题是对于枚举类，在生成的JSON文件中描述是在原参数对象中的如下格式：

“xxx”:&nbsp;{…}
&nbsp;&nbsp;&nbsp;“periodUnit”:{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;“type”:“string”,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;“enum”:[
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;“MINUTE”,
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;“HOUR”
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;…
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]}

一般枚举使用会如MINUTE(1,“分钟”),也就是包括了code和name描述。

但实际enum的值会是二者之一。且不会生成如下的可重用的外部引用。

讯享网“schema”:{
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;“$ref”:”#/definitions/xxxForm”
}

注意：可重用的问题在3.0+可以通过配置处理。

如果需要强制将enum的值设为code或name，或拓展更多的内容，就需要来看看，enum类何时会被处理。

上一个问题的结尾说到apiModelReader.read， modelContexts转化为 Model的modelProvider.modelFor()方法是通过ModelProvider实现，其实 ModelProvider是接口，有两个实现类：<ul data-tool="mdnice编辑器" class="list-paddingleft-2" style="margin-top: 8px;margin-bottom: 8px;padding-left: 25px;"><li><section style="margin-top: 5px;margin-bottom: 5px;line-height: 26px;color: rgb(1, 1, 1);">DefaultModelProvider：默认，每次都会将modelContext转换为model</section></li><li><section style="margin-top: 5px;margin-bottom: 5px;line-height: 26px;color: rgb(1, 1, 1);">CachingModelProvider：声明了guava缓存池，先从缓存池取，没有则调用初始化处理器，转换为模型，再放入缓存池。</section></li></ul>在<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">ApiModelReader</code>的构造方法里指定了使用<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">CachingModelProvider</code>,不过第一次调用缓存里是没有的，所以往下走到<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">populateDependencies</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private void populateDependencies(ModelContext modelContext, Map<String, Model> modelMap) {   Map<String, Model> dependencies = modelProvider.dependencies(modelContext);   for (Model each : dependencies.values()) {     mergeModelMap(modelMap, each);   } } </code></pre><code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">CachingModelProvider</code>的<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">dependencies</code>依赖的是<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">DefaultModelProvider</code>的<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">public Map<String, Model> dependencies(ModelContext modelContext) {   return delegate.dependencies(modelContext); } </code></pre>所以看<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">DefaultModelProvider</code>中的实现<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">public Map<String, Model> dependencies(ModelContext modelContext) {   Map<String, Model> models = newHashMap();   for (ResolvedType resolvedType : dependencyProvider.dependentModels(modelContext)) {     ModelContext parentContext = ModelContext.fromParent(modelContext, resolvedType);     Optional<Model> model = modelFor(parentContext).or(mapModel(parentContext, resolvedType));     if (model.isPresent()) {       models.put(model.get().getName(), model.get());     }   }   return models; } </code></pre><code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">dependencyProvider.dependentModels</code>和上面一个路子，一默认一缓存，交替接口。<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">public Set<ResolvedType> dependentModels(ModelContext modelContext) {   return from(resolvedDependencies(modelContext))       .filter(ignorableTypes(modelContext))       .filter(not(baseTypes(modelContext)))       .toSet(); } </code></pre>后面是两个过滤，暂且不提。看<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">resolvedDependencies</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private List<ResolvedType> resolvedDependencies(ModelContext modelContext) {   ...   List<ResolvedType> dependencies = newArrayList(resolvedTypeParameters(modelContext, resolvedType));   dependencies.addAll(resolvedArrayElementType(modelContext, resolvedType));   dependencies.addAll(resolvedPropertiesAndFields(modelContext, resolvedType));   ... } </code></pre>这里都是在构造拓展类型 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">ResolvedType</code>,有一个叫<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">resolvedPropertiesAndFields</code>,看名字就是它了，进去<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private List<ResolvedType> resolvedPropertiesAndFields(ModelContext modelContext, ResolvedType resolvedType) {   ...   List<ResolvedType> properties = newArrayList();   for (ModelProperty property : nonTrivialProperties(modelContext, resolvedType)) {     ...     properties.addAll(maybeFromCollectionElementType(modelContext, property));     properties.addAll(maybeFromMapValueType(modelContext, property));     properties.addAll(maybeFromRegularType(modelContext, property));   }} </code></pre>看到<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">ModelProperty</code>,也就是对象内部属性代表的Model了，那就看<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">nonTrivialProperties</code>方法<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private FluentIterable<ModelProperty> nonTrivialProperties(ModelContext modelContext, ResolvedType resolvedType) {   return from(propertiesFor(modelContext, resolvedType))       .filter(not(baseProperty(modelContext))); } </code></pre>之后是<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">propertiesFor</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private List<ModelProperty> propertiesFor(ModelContext modelContext, ResolvedType resolvedType) {   return propertiesProvider.propertiesFor(resolvedType, modelContext); } </code></pre>这个<code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">propertiesProvider.propertiesFor</code>仍是一cache一default的策略，直接看实现<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">public List<ModelProperty> propertiesFor(ResolvedType type, ModelContext givenContext) {   ...   for (Map.Entry<String, BeanPropertyDefinition> each : propertyLookup.entrySet()) {     BeanPropertyDefinition jacksonProperty = each.getValue();     Optional<AnnotatedMember> annotatedMember         = Optional.fromNullable(safeGetPrimaryMember(jacksonProperty));     if (annotatedMember.isPresent()) {       properties.addAll(candidateProperties(type, annotatedMember.get(), jacksonProperty, givenContext));     }   }... } </code></pre>可以看到 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">List<ModelProperty></code>通过 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">candidateProperties</code>方法获取<pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">@VisibleForTesting List<ModelProperty> candidateProperties(     ResolvedType type,     AnnotatedMember member,     BeanPropertyDefinition jacksonProperty,     ModelContext givenContext) {   List<ModelProperty> properties = newArrayList();   if (member instanceof AnnotatedMethod) {     properties.addAll(findAccessorMethod(type, member)         .transform(propertyFromBean(givenContext, jacksonProperty))         .or(new ArrayList<ModelProperty>()));   } else if (member instanceof AnnotatedField) {     properties.addAll(findField(type, jacksonProperty.getInternalName())         .transform(propertyFromField(givenContext, jacksonProperty))         .or(new ArrayList<ModelProperty>()));   } else if (member instanceof AnnotatedParameter) {     ModelContext modelContext = ModelContext.fromParent(givenContext, type);     properties.addAll(fromFactoryMethod(type, jacksonProperty, (AnnotatedParameter) member, modelContext));   }  ... } </code></pre>这里根据 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">AnnotatedMember</code>判断类成员的类型，进行不同的处理。enum使用的是 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">propertyFromBean</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">...   public List<ModelProperty> apply(ResolvedMethod input) {     ResolvedType type = paramOrReturnType(typeResolver, input);     if (!givenContext.canIgnore(type)) {       if (shouldUnwrap(input)) {           return propertiesFor(type, fromParent(givenContext, type));       }       return newArrayList(beanModelProperty(input, jacksonProperty, givenContext));     }...     }}; </code></pre>接着是 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">beanModelProperty</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">private ModelProperty beanModelProperty(     ...   return schemaPluginsManager.property(       new ModelPropertyContext(propertyBuilder,           jacksonProperty,           typeResolver,           ... </code></pre>最后调用了 <code style="margin-right: 2px;margin-left: 2px;padding: 3px 5px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;background: rgb(248, 245, 236);color: rgb(255, 53, 2);line-height: 1.5;font-size: 14.4px;border-radius: 2px;">schemaPluginsManager.property</code><pre data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;border-radius: 5px;box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;"><span style="margin-bottom: -7px;display: block;background: url("https://mmbiz.qpic.cn/mmbiz_png/N34tfh8WYkiaLFs2KuooHic09reYSOGCYN938V141MicAnZKbxKiaBibICHbtDaSlSpGgicp15VH7LxEEV02ywPiaoLsQ/640?wx_fmt=png") 10px 10px / 40px no-repeat rgb(250, 250, 250);height: 30px;width: 524px;border-radius: 5px;"><code style="padding: 15px 16px 16px;overflow-x: auto;color: rgb(56, 58, 66);display: -webkit-box;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;font-size: 12px;background: rgb(250, 250, 250);border-radius: 5px;">public ModelProperty property(ModelPropertyContext context) {   // 根据文档类型取出 ModelPropertyBuilderPlugin   for (ModelPropertyBuilderPlugin enricher : propertyEnrichers.getPluginsFor(context.getDocumentationType())) {     enricher.apply(context);   }   return context.getBuilder().build(); } ModelPropertyBuilderPlugin是一个接口，看它的其中一个实现类`ApiModelPropertyPropertyBuilder
public void apply(ModelPropertyContext context) {
  // 取出元素的注解
  Optional<ApiModelProperty> annotation = Optional.absent();
  …
  if (annotation.isPresent()) {
    context.getBuilder()
        .allowableValues(annotation.transform(toAllowableValues()).orNull())
        .required(annotation.transform(toIsRequired()).or(false))
        .readOnly(annotation.transform(toIsReadOnly()).or(false))
        .description(annotation.transform(toDescription()).orNull())
        .isHidden(annotation.transform(toHidden()).or(false))
        .type(annotation.transform(toType(context.getResolver())).orNull())
        .position(annotation.transform(toPosition()).or(0))
        .example(annotation.transform(toExample()).orNull());
  }
}

可以看到通过判断是否存在注解，再设置具体的配置。

其中type就是enum展示的类型了，可以固定。allowableValues就是enum的value,可以自定义，还可以加入description.

具体实现可以通过重写ApiModelPropertyPropertyBuilder的apply实现。

到这里，两个问题都得到解决。Springfox的加载过程也基本介绍了一遍。

●Redis面试突击专用

●InnoDB中一棵B+树可以存放多少行数据？

●你这个数据量多大？分库分表怎么做？用的哪个组件？

●关于 TCP/IP，必知必会的十个问题

●因为BitMap，白白搭进去8台服务器…

             Java架构师日记                                扫描上面二维码发现更多精彩！                   

小贴士

返回上一级输入“基础” 等关键词获取相关资料推荐。

2025年swagger2注解（swagger注解大全）

1. GET 方法的参数对象

2. Enum的描述格式

相关推荐