com.github.netty.protocol.servlet.util

类 AntPathMatcher

java.lang.Object

com.github.netty.protocol.servlet.util.AntPathMatcher

public class AntPathMatcher
extends Object

implementation for Ant-style path patterns.

Part of this mapping code has been kindly borrowed from Apache Ant.

The mapping matches URLs using the following rules:

• ? matches one character
• * matches zero or more characters
• ** matches zero or more directories in a path
• {spring:[a-z]+} matches the regexp [a-z]+ as a path variable named "spring"

Examples

• com/t?st.jsp — matches com/test.jsp but also com/tast.jsp or com/txst.jsp
• com/*.jsp — matches all .jsp files in the com directory
• com/**/test.jsp — matches all test.jsp files underneath the com path
• org/springframework/**/*.jsp — matches all .jsp files underneath the org/springframework path
• org/**/servlet/bla.jsp — matches org/springframework/servlet/bla.jsp but also org/springframework/testing/servlet/bla.jsp and org/servlet/bla.jsp
• com/{filename:\\w+}.jsp will match com/test.jsp and assign the value test to the filename variable

Note: a pattern and a path must both be absolute or must both be relative in order for the two to match. Therefore it is recommended that users of this implementation to sanitize patterns in order to prefix them with "/" as it makes sense in the context in which they're used.

从以下版本开始:

16.07.2003

作者:

Alef Arendsen, Juergen Hoeller, Rob Harrop, Arjen Poutsma, Rossen Stoyanchev, Sam Brannen

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_PATH_SEPARATOR Default path separator: "/"

构造器概要

构造器

构造器和说明
AntPathMatcher() Create a new instance with the DEFAULT_PATH_SEPARATOR.
AntPathMatcher(String pathSeparator) A convenient, alternative constructor to use with a custom path separator.

方法概要

限定符和类型	方法和说明
String	combine(String pattern1, String pattern2) Combine two patterns into a new pattern.
String	extractPathWithinPattern(String pattern, String path) Given a pattern and a full path, determine the pattern-mapped part.
Map<String,String>	extractUriTemplateVariables(String pattern, String path)
Comparator<String>	getPatternComparator(String path) Given a full path, returns a Comparator suitable for sorting patterns in order of explicitness.
static boolean	hasText(CharSequence str)
boolean	isPattern(String path)
boolean	match(String pattern, String path)
boolean	match(String pattern, String path, String allToken)
boolean	matchStart(String pattern, String path)
void	setCachePatterns(boolean cachePatterns) Specify whether to cache parsed pattern metadata for patterns passed into this matcher's match(java.lang.String, java.lang.String, java.lang.String) method.
void	setCaseSensitive(boolean caseSensitive) Specify whether to perform pattern matching in a case-sensitive fashion.
void	setPathSeparator(String pathSeparator) Set the path separator to use for pattern parsing.
void	setTrimTokens(boolean trimTokens) Specify whether to trim tokenized paths and patterns.
static String[]	tokenizeToStringArray(String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens)

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

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

字段详细资料

DEFAULT_PATH_SEPARATOR

public static final String DEFAULT_PATH_SEPARATOR

Default path separator: "/"

另请参阅:

常量字段值

构造器详细资料

AntPathMatcher

public AntPathMatcher()

Create a new instance with the DEFAULT_PATH_SEPARATOR.

AntPathMatcher

public AntPathMatcher(String pathSeparator)

A convenient, alternative constructor to use with a custom path separator.

参数:

pathSeparator - the path separator to use, must not be null.

从以下版本开始:

4.1

方法详细资料

setPathSeparator

public void setPathSeparator(String pathSeparator)

Set the path separator to use for pattern parsing. Default is "/", as in Ant.

参数:

pathSeparator - pathSeparator

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Specify whether to perform pattern matching in a case-sensitive fashion. Default is true. Switch this to false for case-insensitive matching.

参数:

caseSensitive - caseSensitive

从以下版本开始:

4.2

setTrimTokens

public void setTrimTokens(boolean trimTokens)

Specify whether to trim tokenized paths and patterns. Default is false.

参数:

trimTokens - trimTokens

setCachePatterns

public void setCachePatterns(boolean cachePatterns)

Specify whether to cache parsed pattern metadata for patterns passed into this matcher's match(java.lang.String, java.lang.String, java.lang.String) method. A value of true activates an unlimited pattern cache; a value of false turns the pattern cache off completely.

Default is for the cache to be on, but with the variant to automatically turn it off when encountering too many patterns to cache at runtime (the threshold is 65536), assuming that arbitrary permutations of patterns are coming in, with little chance for encountering a recurring pattern.

参数:

cachePatterns - cachePatterns

从以下版本开始:

4.0.1

另请参阅:

getStringMatcher(String)

isPattern

public boolean isPattern(String path)

match

public boolean match(String pattern,
                     String path,
                     String allToken)

match

public boolean match(String pattern,
                     String path)

matchStart

public boolean matchStart(String pattern,
                          String path)

extractPathWithinPattern

public String extractPathWithinPattern(String pattern,
                                       String path)

Given a pattern and a full path, determine the pattern-mapped part.

For example:

• '/docs/cvs/commit.html' and '/docs/cvs/commit.html -- ''
• '/docs/*' and '/docs/cvs/commit -- 'cvs/commit'
• '/docs/cvs/*.html' and '/docs/cvs/commit.html -- 'commit.html'
• '/docs/**' and '/docs/cvs/commit -- 'cvs/commit'
• '/docs/**\/*.html' and '/docs/cvs/commit.html -- 'cvs/commit.html'
• '/*.html' and '/docs/cvs/commit.html -- 'docs/cvs/commit.html'
• '*.html' and '/docs/cvs/commit.html -- '/docs/cvs/commit.html'
• '*' and '/docs/cvs/commit.html -- '/docs/cvs/commit.html'

Assumes that match(java.lang.String, java.lang.String, java.lang.String) returns true for 'pattern' and 'path', but does not enforce this.

参数:

pattern - pattern

path - path

返回:

Path cvs/commit.html

extractUriTemplateVariables

public Map<String,String> extractUriTemplateVariables(String pattern,
                                                      String path)

combine

public String combine(String pattern1,
                      String pattern2)

Combine two patterns into a new pattern.

This implementation simply concatenates the two patterns, unless the first pattern contains a file extension match (e.g., *.html). In that case, the second pattern will be merged into the first. Otherwise, an IllegalArgumentException will be thrown. /*.html /hotels.html /hotels.html

参数:

pattern1 - the first pattern

pattern2 - the second pattern

返回:

the combination of the two patterns

抛出:

IllegalArgumentException - if the two patterns cannot be combined

getPatternComparator

public Comparator<String> getPatternComparator(String path)

Given a full path, returns a Comparator suitable for sorting patterns in order of explicitness.

ThisComparator will sort a list so that more specific patterns (without uri templates or wild cards) come before generic patterns. So given a list with the following patterns:

1. /hotels/new
2. /hotels/{hotel}
3. /hotels/*

the returned comparator will sort this list so that the order will be as indicated.

The full path given as parameter is used to test for exact matches. So when the given path is /hotels/2, the pattern /hotels/2 will be sorted before /hotels/1.

参数:

path - the full path to use for comparison

返回:

a comparator capable of sorting patterns in order of explicitness

tokenizeToStringArray

public static String[] tokenizeToStringArray(String str,
                                             String delimiters,
                                             boolean trimTokens,
                                             boolean ignoreEmptyTokens)

hasText

public static boolean hasText(CharSequence str)