com.citrsw.core

类 ApiContext

java.lang.Object

com.citrsw.core.ApiContext

@Component
public class ApiContext
extends Object

上下文(核心)

版本:

1.0

作者:

Zhenfeng Li

构造器概要

构造器

构造器和说明
ApiContext()

方法概要

限定符和类型	方法和说明
Doc	getDoc()
Field	getParentField(Class<?> clazz, String fieldName) 获取父类中的属性
Set<DocClass>	handleClass(Set<Class<?>> classes) 处理扫描到的类
DocProperty	handleGeneric(DocProperty docProperty, Type gType, Map<String,Boolean> propertyMap, boolean isParam, boolean isJson, Set<Class<?>> repeats, Map<String,ApiParamModelProperty> apiModelPropertyMap, Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap, Map<String,ApiMapProperty> apiMapPropertyMap, Map<String,ApiParam> apiMapParamMap, Map<String,ApiReturn> apiMapReturnMap, Map<String,ApiProperty> paramGlobalApiPropertyMap, Map<String,ApiProperty> returnGlobalApiPropertyMap) 处理泛型
DocProperty	handleMap(DocProperty docProperty, Type gType, Map<String,Boolean> propertyMap, boolean isParam, boolean isJson, Set<Class<?>> repeats, Map<String,ApiParamModelProperty> apiModelPropertyMap, Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap, Map<String,ApiMapProperty> apiMapPropertyMap, Map<String,ApiParam> apiMapParamMap, Map<String,ApiReturn> apiMapReturnMap, Map<String,ApiProperty> paramGlobalApiPropertyMap, Map<String,ApiProperty> returnGlobalApiPropertyMap) 处理Map
Set<DocMethod>	handleMethod(Method[] methods, org.springframework.web.bind.annotation.RequestMapping requestMapping) 处理Controller中的方法
DocProperty	handleModel(DocProperty docProperty, Class<?> aClass, Type type, Map<String,Boolean> propertyMap, boolean isParam, boolean isJson, Set<Class<?>> repeats, Map<String,ApiParamModelProperty> apiModelPropertyMap, Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap, Map<String,ApiMapProperty> apiMapPropertyMap, Map<String,ApiParam> apiMapParamMap, Map<String,ApiReturn> apiMapReturnMap, Map<String,ApiProperty> paramGlobalApiPropertyMap, Map<String,ApiProperty> returnGlobalApiPropertyMap) 处理模型
DocModel	handleParam(ApiMapParam apiMapParam, ApiAppointParam apiAppointParam, ApiParamModelProperty[] apiModelProperties, Parameter[] parameters) 处理方法的入参
DocModel	handleReturn(ApiMapReturn apiMapReturn, ApiBasicReturn apiBasicReturn, Class<?> returnType, Type genericReturnType, ApiReturnModelProperty[] apiReturnModelProperties) 处理方法的出参
String	humpToLine(String str) 驼峰转下划线
void	init()
Type	realType(Type type, TypeVariable<? extends Class<?>>[] typeParameters, Type genericType) 对包含泛型的属性类型进行重新包装
Type	regenerateType(Type returnType) 重新生成符合泛型形式的Type 用于返回形式的泛型

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ApiContext

public ApiContext()

方法详细资料

getDoc

public Doc getDoc()

init

@PostConstruct
public void init()

handleClass

public Set<DocClass> handleClass(Set<Class<?>> classes)

处理扫描到的类

参数:

classes - 扫描到的类

handleMethod

public Set<DocMethod> handleMethod(Method[] methods,
                                   org.springframework.web.bind.annotation.RequestMapping requestMapping)

处理Controller中的方法

参数:

methods - Controller中的方法

requestMapping - Controller上的RequestMapping

返回:

处理后的方法结果

handleParam

public DocModel handleParam(ApiMapParam apiMapParam,
                            ApiAppointParam apiAppointParam,
                            ApiParamModelProperty[] apiModelProperties,
                            Parameter[] parameters)
                     throws ParamException

处理方法的入参

参数:

apiMapParam - 自定义方法的入参注解

apiAppointParam - 指定对象属性的注解

apiModelProperties - 重新配置入参属性信息注解

parameters - 方法的入参

返回:

处理后的入参模型

抛出:

ParamException

handleReturn

public DocModel handleReturn(ApiMapReturn apiMapReturn,
                             ApiBasicReturn apiBasicReturn,
                             Class<?> returnType,
                             Type genericReturnType,
                             ApiReturnModelProperty[] apiReturnModelProperties)

处理方法的出参

参数:

apiMapReturn - 自定义方法的出参

apiBasicReturn - 自定义基本数据类型出参

returnType - 方法的出参类型

genericReturnType - 方法的出参类型

apiReturnModelProperties - 重新配置出参属性信息注解

返回:

处理后的出参模型

handleModel

public DocProperty handleModel(DocProperty docProperty,
                               Class<?> aClass,
                               Type type,
                               Map<String,Boolean> propertyMap,
                               boolean isParam,
                               boolean isJson,
                               Set<Class<?>> repeats,
                               Map<String,ApiParamModelProperty> apiModelPropertyMap,
                               Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap,
                               Map<String,ApiMapProperty> apiMapPropertyMap,
                               Map<String,ApiParam> apiMapParamMap,
                               Map<String,ApiReturn> apiMapReturnMap,
                               Map<String,ApiProperty> paramGlobalApiPropertyMap,
                               Map<String,ApiProperty> returnGlobalApiPropertyMap)

处理模型

参数:

docProperty - 属性类

aClass - 类

propertyMap - 自定义入参对象属性

isParam - 是否是入参

isJson - 是否是json

repeats - 循环依赖集合

apiModelPropertyMap - 重新配置入参属性信息注解

apiReturnModelPropertyMap - 重新配置出参属性信息注解

apiMapPropertyMap - Map类型属性注解集合

apiMapParamMap - Map类型入参注解集合

apiMapReturnMap - Map类型出参注解集合

paramGlobalApiPropertyMap - 全局配置入参类的属性集合

returnGlobalApiPropertyMap - 全局配置出参类的属性集合

返回:

处理后的模型属性

getParentField

public Field getParentField(Class<?> clazz,
                            String fieldName)

获取父类中的属性

参数:

clazz - 当前类

fieldName - 属性名

返回:

获取到到属性

realType

public Type realType(Type type,
                     TypeVariable<? extends Class<?>>[] typeParameters,
                     Type genericType)

对包含泛型的属性类型进行重新包装

参数:

type - 属性类型

typeParameters - 当前类的泛型集合

genericType - 当前类的真实返回类型

返回:

包装后的真实类型

handleGeneric

public DocProperty handleGeneric(DocProperty docProperty,
                                 Type gType,
                                 Map<String,Boolean> propertyMap,
                                 boolean isParam,
                                 boolean isJson,
                                 Set<Class<?>> repeats,
                                 Map<String,ApiParamModelProperty> apiModelPropertyMap,
                                 Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap,
                                 Map<String,ApiMapProperty> apiMapPropertyMap,
                                 Map<String,ApiParam> apiMapParamMap,
                                 Map<String,ApiReturn> apiMapReturnMap,
                                 Map<String,ApiProperty> paramGlobalApiPropertyMap,
                                 Map<String,ApiProperty> returnGlobalApiPropertyMap)

处理泛型

参数:

docProperty - 属性类

gType - 类型

propertyMap - 自定义入参对象属性

isParam - 是否是入参

isJson - 是否是json

repeats - 循环依赖集合

apiModelPropertyMap - 重新配置入参属性信息注解

apiReturnModelPropertyMap - 重新配置出参属性信息注解

apiMapPropertyMap - Map类型属性注解集合

apiMapParamMap - Map类型入参注解集合

apiMapReturnMap - Map类型出参注解集合

paramGlobalApiPropertyMap - 全局配置入参类的属性集合

returnGlobalApiPropertyMap - 全局配置出参类的属性集合

返回:

处理后的模型属性

regenerateType

public Type regenerateType(Type returnType)

重新生成符合泛型形式的Type 用于返回形式的泛型

参数:

returnType - 返回的Type

返回:

符合泛型形式的Type

handleMap

public DocProperty handleMap(DocProperty docProperty,
                             Type gType,
                             Map<String,Boolean> propertyMap,
                             boolean isParam,
                             boolean isJson,
                             Set<Class<?>> repeats,
                             Map<String,ApiParamModelProperty> apiModelPropertyMap,
                             Map<String,ApiReturnModelProperty> apiReturnModelPropertyMap,
                             Map<String,ApiMapProperty> apiMapPropertyMap,
                             Map<String,ApiParam> apiMapParamMap,
                             Map<String,ApiReturn> apiMapReturnMap,
                             Map<String,ApiProperty> paramGlobalApiPropertyMap,
                             Map<String,ApiProperty> returnGlobalApiPropertyMap)

处理Map

参数:

docProperty - 属性类

gType - 类型

propertyMap - 自定义入参对象属性

isParam - 是否是入参

isJson - 是否是json

apiModelPropertyMap - 重新配置入参属性信息注解

apiReturnModelPropertyMap - 重新配置出参属性信息注解

apiMapPropertyMap - 类属性为Map的注解

apiMapParamMap - Map类型入参注解集合

apiMapReturnMap - Map类型入参注解集合

paramGlobalApiPropertyMap - 全局配置入参类的属性集合

returnGlobalApiPropertyMap - 全局配置出参类的属性集合

返回:

处理后的模型属性

humpToLine

public String humpToLine(String str)

驼峰转下划线

参数:

str - 原始字符串

返回:

下滑线格式的字符串