程序包 cn.taketoday.web.handler

类 MappedInterceptor

java.lang.Object

cn.taketoday.web.handler.MappedInterceptor

所有已实现的接口:

HandlerInterceptor

public final class MappedInterceptor
extends Object
implements HandlerInterceptor

Wraps a HandlerInterceptor and uses URL patterns to determine whether it applies to a given request.

Pattern matching can be done with PathMatcher or with parsed PathPattern. The syntax is largely the same with the latter being more tailored for web usage and more efficient.

从以下版本开始:

4.0 2022/4/18 15:36

作者:

Keith Donald, Rossen Stoyanchev, Brian Clozel, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static final class	MappedInterceptor.CompiledPattern	Contains both the parsed PathPattern and the raw String pattern, and uses the former when the cached path is PathContainer or the latter otherwise.

字段概要

字段

修饰符和类型	字段	说明
private static final cn.taketoday.core.PathMatcher	defaultPathMatcher
private final MappedInterceptor.CompiledPattern[]	excludePatterns
private final MappedInterceptor.CompiledPattern[]	includePatterns
private final HandlerInterceptor	interceptor
private cn.taketoday.core.PathMatcher	pathMatcher

从接口继承的字段 cn.taketoday.web.HandlerInterceptor

EMPTY_ARRAY, NONE_RETURN_VALUE

构造器概要

构造器

构造器	说明
MappedInterceptor(String[] includePatterns, HandlerInterceptor interceptor)	Variant of MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser) with include patterns only.
MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor)	Variant of MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser) without a provided parser.
MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor, PathPatternParser parser)	Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.

方法概要

修饰符和类型	方法	说明
void	afterProcess(RequestContext request, Object handler, Object result)	After Handler processed.
boolean	beforeProcess(RequestContext request, Object handler)	Before Handler process.
private boolean	doMatch(MappedInterceptor.CompiledPattern adapter, PathContainer path)
HandlerInterceptor	getInterceptor()	The target HandlerInterceptor to invoke in case of a match.
cn.taketoday.core.PathMatcher	getPathMatcher()	The configured PathMatcher.
String[]	getPathPatterns()	Return the patterns this interceptor is mapped to.
Object	intercept(RequestContext request, InterceptorChain chain)	handler's interceptor intercept entrance
boolean	matches(PathContainer lookupPath)	Check whether this interceptor is mapped to the request.
boolean	matches(RequestContext request)	Check whether this interceptor is mapped to the request.
void	setPathMatcher(cn.taketoday.core.PathMatcher pathMatcher)	Configure the PathMatcher to use to match URL paths with against include and exclude patterns.

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

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

字段详细资料

defaultPathMatcher

private static final cn.taketoday.core.PathMatcher defaultPathMatcher

includePatterns

@Nullable
private final MappedInterceptor.CompiledPattern[] includePatterns

excludePatterns

@Nullable
private final MappedInterceptor.CompiledPattern[] excludePatterns

interceptor

private final HandlerInterceptor interceptor

pathMatcher

private cn.taketoday.core.PathMatcher pathMatcher

构造器详细资料

MappedInterceptor

public MappedInterceptor(@Nullable
 String[] includePatterns,
 @Nullable
 String[] excludePatterns,
 HandlerInterceptor interceptor,
 @Nullable
 PathPatternParser parser)

Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.

参数:

includePatterns - patterns to which requests must match, or null to match all paths

excludePatterns - patterns to which requests must not match

interceptor - the target interceptor

parser - a parser to use to pre-parse patterns into PathPattern; when not provided, PathPatternParser.defaultInstance is used.

MappedInterceptor

public MappedInterceptor(@Nullable
 String[] includePatterns,
 HandlerInterceptor interceptor)

Variant of MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser) with include patterns only.

MappedInterceptor

public MappedInterceptor(@Nullable
 String[] includePatterns,
 @Nullable
 String[] excludePatterns,
 HandlerInterceptor interceptor)

Variant of MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser) without a provided parser.

方法详细资料

setPathMatcher

public void setPathMatcher(cn.taketoday.core.PathMatcher pathMatcher)

Configure the PathMatcher to use to match URL paths with against include and exclude patterns.

This is an advanced property that should be used only when a customized AntPathMatcher or a custom PathMatcher is required.

By default this is AntPathMatcher.

getPathMatcher

public cn.taketoday.core.PathMatcher getPathMatcher()

The configured PathMatcher.

getPathPatterns

@Nullable
public String[] getPathPatterns()

Return the patterns this interceptor is mapped to.

getInterceptor

public HandlerInterceptor getInterceptor()

The target HandlerInterceptor to invoke in case of a match.

matches

public boolean matches(RequestContext request)

Check whether this interceptor is mapped to the request.

The request mapping path is expected to have been resolved externally. See also class-level Javadoc.

参数:

request - the request to match to

返回:

true if the interceptor should be applied to the request

matches

public boolean matches(PathContainer lookupPath)

Check whether this interceptor is mapped to the request.

The request mapping path is expected to have been resolved externally. See also class-level Javadoc.

参数:

lookupPath - the request path to match to

返回:

true if the interceptor should be applied to the request

doMatch

private boolean doMatch(MappedInterceptor.CompiledPattern adapter,
 PathContainer path)

beforeProcess

public boolean beforeProcess(RequestContext request,
 Object handler)
                      throws Throwable

从接口复制的说明: HandlerInterceptor

Before Handler process.

指定者:

beforeProcess 在接口中 HandlerInterceptor

参数:

request - Current request Context

handler - Request handler , HandlerMethod

返回:

If is it possible to execute the target handler

抛出:

Throwable - If any exception occurred

另请参阅:

• HandlerMethod.unwrap(Object)

afterProcess

public void afterProcess(RequestContext request,
 Object handler,
 Object result)
                  throws Throwable

从接口复制的说明: HandlerInterceptor

After Handler processed.

指定者:

afterProcess 在接口中 HandlerInterceptor

参数:

request - Current request Context

handler - Request handler, HandlerMethod

result - Handler returned value

抛出:

Throwable - If any exception occurred

另请参阅:

• HandlerMethod.unwrap(Object)

intercept

@Nullable
public Object intercept(RequestContext request,
 InterceptorChain chain)
                 throws Throwable

从接口复制的说明: HandlerInterceptor

handler's interceptor intercept entrance

指定者:

intercept 在接口中 HandlerInterceptor

返回:

return value is target handler's result

抛出:

Throwable

另请参阅:

• HandlerMethod.unwrap(Object)