程序包 com.github.xiaoymin.knife4j.aggre.core

类 RouteDispatcher

java.lang.Object

com.github.xiaoymin.knife4j.aggre.core.RouteDispatcher

public class RouteDispatcher
extends java.lang.Object

作者:

xiaoymin@foxmail.com 2020/10/29 20:08

字段概要

字段

修饰符和类型	字段	说明
private java.util.Set<java.lang.String>	ignoreHeaders
(专用程序包) org.slf4j.Logger	logger
static java.lang.String	OPENAPI_GROUP_ENDPOINT
static java.lang.String	OPENAPI_GROUP_INSTANCE_ENDPOINT
private java.lang.String	rootPath	当前项目的contextPath
static java.lang.String	ROUTE_BASE_PATH
static java.lang.String	ROUTE_PROXY_HEADER_BASIC_NAME
static java.lang.String	ROUTE_PROXY_HEADER_NAME	请求头
private RouteCache<java.lang.String,SwaggerRoute>	routeCache
private RouteExecutor	routeExecutor
private RouteRepository	routeRepository

构造器概要

构造器

构造器	说明
RouteDispatcher(RouteRepository routeRepository, RouteCache<java.lang.String,SwaggerRoute> routeRouteCache, ExecutorEnum executorEnum, java.lang.String rootPath)

方法概要

修饰符和类型	方法	说明
protected void	buildContext(RouteRequestContext routeRequestContext, javax.servlet.http.HttpServletRequest request)	构建路由的请求上下文
boolean	checkRoute(java.lang.String header)
void	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.lang.String	getRootPath()
SwaggerRoute	getRoute(java.lang.String header)
java.util.List<SwaggerRoute>	getRoutes()
private void	initExecutor(ExecutorEnum executorEnum)
protected void	writeBody(RouteResponse routeResponse, javax.servlet.http.HttpServletResponse response)	响应内容
protected void	writeDefault(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String errMsg)
protected void	writeResponseHeader(RouteResponse routeResponse, javax.servlet.http.HttpServletResponse response)	Write响应头
protected void	writeResponseStatus(RouteResponse routeResponse, javax.servlet.http.HttpServletResponse response)	Write 响应状态码

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

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

字段详细资料

ROUTE_PROXY_HEADER_NAME

public static final java.lang.String ROUTE_PROXY_HEADER_NAME

请求头

另请参阅:

常量字段值

ROUTE_PROXY_HEADER_BASIC_NAME

public static final java.lang.String ROUTE_PROXY_HEADER_BASIC_NAME

另请参阅:

常量字段值

OPENAPI_GROUP_ENDPOINT

public static final java.lang.String OPENAPI_GROUP_ENDPOINT

另请参阅:

常量字段值

OPENAPI_GROUP_INSTANCE_ENDPOINT

public static final java.lang.String OPENAPI_GROUP_INSTANCE_ENDPOINT

另请参阅:

常量字段值

ROUTE_BASE_PATH

public static final java.lang.String ROUTE_BASE_PATH

另请参阅:

常量字段值

logger

org.slf4j.Logger logger

rootPath

private java.lang.String rootPath

当前项目的contextPath

routeRepository

private RouteRepository routeRepository

routeExecutor

private RouteExecutor routeExecutor

routeCache

private RouteCache<java.lang.String,SwaggerRoute> routeCache

ignoreHeaders

private java.util.Set<java.lang.String> ignoreHeaders

构造器详细资料

RouteDispatcher

public RouteDispatcher(RouteRepository routeRepository,
                       RouteCache<java.lang.String,SwaggerRoute> routeRouteCache,
                       ExecutorEnum executorEnum,
                       java.lang.String rootPath)

方法详细资料

initExecutor

private void initExecutor(ExecutorEnum executorEnum)

checkRoute

public boolean checkRoute(java.lang.String header)

execute

public void execute(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)

writeDefault

protected void writeDefault(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            java.lang.String errMsg)

writeResponseStatus

protected void writeResponseStatus(RouteResponse routeResponse,
                                   javax.servlet.http.HttpServletResponse response)

Write 响应状态码

参数:

routeResponse - routeResponse

response - response

writeResponseHeader

protected void writeResponseHeader(RouteResponse routeResponse,
                                   javax.servlet.http.HttpServletResponse response)

Write响应头

参数:

routeResponse - route响应对象

response - 响应response

writeBody

protected void writeBody(RouteResponse routeResponse,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.io.IOException

响应内容

参数:

routeResponse - route响应对象

response - 响应对象

抛出:

java.io.IOException

buildContext

protected void buildContext(RouteRequestContext routeRequestContext,
                            javax.servlet.http.HttpServletRequest request)
                     throws java.io.IOException

构建路由的请求上下文

参数:

routeRequestContext - 请求上下文

request - 请求对象

抛出:

java.io.IOException

getRoute

public SwaggerRoute getRoute(java.lang.String header)

getRoutes

public java.util.List<SwaggerRoute> getRoutes()

getRootPath

public java.lang.String getRootPath()