org.apache.dubbo.apidocs.core

类 DubboApiDocsAnnotationScanner

java.lang.Object

org.apache.dubbo.apidocs.core.DubboApiDocsAnnotationScanner

所有已实现的接口:

EventListener, org.springframework.context.ApplicationListener<org.springframework.boot.context.event.ApplicationReadyEvent>

@Import(value=DubboDocProviderImpl.class)
public class DubboApiDocsAnnotationScanner
extends Object
implements org.springframework.context.ApplicationListener<org.springframework.boot.context.event.ApplicationReadyEvent>

Scan and process dubbo doc annotations.

字段概要

字段

限定符和类型	字段和说明
private org.apache.dubbo.config.ApplicationConfig	application
private org.springframework.context.ApplicationContext	applicationContext
private static org.apache.dubbo.common.logger.Logger	LOG
private org.apache.dubbo.config.ProtocolConfig	protocol
private org.apache.dubbo.config.ProviderConfig	providerConfig
private org.apache.dubbo.config.RegistryConfig	registry

构造器概要

构造器

构造器和说明
DubboApiDocsAnnotationScanner()

方法概要

限定符和类型	方法和说明
private <I,T> void	exportDubboService(Class<I> serviceClass, T serviceImplInstance, boolean async) export dubbo service for dubbo doc
private String	getMethodParamsDesc(Method method) get method parameter types describe string return empty string if describe string is no args and no return vals ()V
private String	getSupplierValueIfAbsent(String value, java.util.function.Supplier<String> supplier) get supplier value if @param value is blank
void	onApplicationEvent(org.springframework.boot.context.event.ApplicationReadyEvent applicationReadyEvent)
private void	processApiDocAnnotation(Method method, List<ApiCacheItem> moduleApiList, ApiModule moduleAnn, boolean async, ModuleCacheItem moduleCacheItem, String apiVersion, String apiGroup)
private List<ParamBean>	processField(Class<?> argClass, Type parameterType, Parameter parameter) For the attributes in the method parameters, only one layer is processed.
private ParamBean	processHtmlType(Class<?> classType, RequestParam annotation, ParamBean param) Determine what HTML form elements to use.

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

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

字段详细资料

LOG

private static final org.apache.dubbo.common.logger.Logger LOG

applicationContext

@Autowired
private org.springframework.context.ApplicationContext applicationContext

application

@Autowired
private org.apache.dubbo.config.ApplicationConfig application

registry

@Autowired
private org.apache.dubbo.config.RegistryConfig registry

protocol

@Autowired
private org.apache.dubbo.config.ProtocolConfig protocol

providerConfig

@Autowired(required=false)
private org.apache.dubbo.config.ProviderConfig providerConfig

构造器详细资料

DubboApiDocsAnnotationScanner

public DubboApiDocsAnnotationScanner()

方法详细资料

onApplicationEvent

public void onApplicationEvent(org.springframework.boot.context.event.ApplicationReadyEvent applicationReadyEvent)

指定者:

onApplicationEvent 在接口中 org.springframework.context.ApplicationListener<org.springframework.boot.context.event.ApplicationReadyEvent>

getSupplierValueIfAbsent

private String getSupplierValueIfAbsent(String value,
                                        java.util.function.Supplier<String> supplier)

get supplier value if @param value is blank

参数:

value - value

supplier - supplier lambda

返回:

return value if not blank, or return supplier value

processApiDocAnnotation

private void processApiDocAnnotation(Method method,
                                     List<ApiCacheItem> moduleApiList,
                                     ApiModule moduleAnn,
                                     boolean async,
                                     ModuleCacheItem moduleCacheItem,
                                     String apiVersion,
                                     String apiGroup)

getMethodParamsDesc

private String getMethodParamsDesc(Method method)

get method parameter types describe string return empty string if describe string is no args and no return vals ()V

参数:

method - method

返回:

method parameter types describe string

processField

private List<ParamBean> processField(Class<?> argClass,
                                     Type parameterType,
                                     Parameter parameter)

For the attributes in the method parameters, only one layer is processed. The deeper layer is directly converted to JSON, and the deeper layer is up to 5 layers

processHtmlType

private ParamBean processHtmlType(Class<?> classType,
                                  RequestParam annotation,
                                  ParamBean param)

Determine what HTML form elements to use.

参数:

classType - classType

annotation - annotation

param - param

返回:

org.apache.dubbo.apidocs.core.beans.ParamBean

exportDubboService

private <I,T> void exportDubboService(Class<I> serviceClass,
                                      T serviceImplInstance,
                                      boolean async)

export dubbo service for dubbo doc