cn.dev33.satoken.router

类 SaRouter

java.lang.Object

cn.dev33.satoken.router.SaRouter

public class SaRouter
extends java.lang.Object

路由匹配操作工具类

作者:

kong

构造器概要

构造器

构造器和说明
SaRouter()

方法概要

限定符和类型	方法和说明
static SaRouterStaff	back() 停止匹配，结束执行，向前端返回结果
static SaRouterStaff	back(java.lang.Object result) 停止匹配，结束执行，向前端返回结果
static boolean	isMatch(java.util.List<java.lang.String> patterns, java.lang.String path) 路由匹配
static boolean	isMatch(SaHttpMethod[] methods, java.lang.String methodString) Http请求方法匹配
static boolean	isMatch(java.lang.String[] patterns, java.lang.String path) 路由匹配
static boolean	isMatch(java.lang.String pattern, java.lang.String path) 路由匹配
static boolean	isMatchCurrMethod(SaHttpMethod[] methods) Http请求方法匹配 (使用当前请求方式)
static boolean	isMatchCurrURI(java.util.List<java.lang.String> patterns) 路由匹配 (使用当前URI)
static boolean	isMatchCurrURI(java.lang.String pattern) 路由匹配 (使用当前URI)
static boolean	isMatchCurrURI(java.lang.String[] patterns) 路由匹配 (使用当前URI)
static SaRouterStaff	match(boolean flag) 根据 boolean 值进行匹配
static SaRouterStaff	match(java.util.List<java.lang.String> patterns) 路由匹配
static void	match(java.util.List<java.lang.String> patterns, java.util.List<java.lang.String> excludePatterns, SaFunction function) 已过时。
static void	match(java.util.List<java.lang.String> patterns, SaFunction function) 已过时。
static SaRouterStaff	match(SaHttpMethod... methods) Http请求方式匹配 (Enum)
static SaRouterStaff	match(SaParamRetFunction<java.lang.Object,java.lang.Boolean> fun) 根据自定义方法进行匹配 (lazy)
static SaRouterStaff	match(java.lang.String... patterns) 路由匹配
static SaRouterStaff	match(java.lang.String pattern, SaFunction fun) 路由匹配，如果匹配成功则执行认证函数
static SaRouterStaff	match(java.lang.String pattern, SaParamFunction<SaRouterStaff> fun) 路由匹配，如果匹配成功则执行认证函数
static SaRouterStaff	match(java.lang.String pattern, java.lang.String excludePattern, SaFunction fun) 路由匹配 (并指定排除匹配符)，如果匹配成功则执行认证函数
static SaRouterStaff	match(java.lang.String pattern, java.lang.String excludePattern, SaParamFunction<SaRouterStaff> fun) 路由匹配 (并指定排除匹配符)，如果匹配成功则执行认证函数
static SaRouterStaff	matchMethod(java.lang.String... methods) Http请求方法匹配 (String)
static SaRouterStaff	newMatch() 初始化一个SaRouterStaff，开始匹配
static SaRouterStaff	notMatch(boolean flag) 根据 boolean 值进行匹配排除
static SaRouterStaff	notMatch(java.util.List<java.lang.String> patterns) 路由匹配排除
static SaRouterStaff	notMatch(SaHttpMethod... methods) Http请求方法匹配排除 (Enum)
static SaRouterStaff	notMatch(SaParamRetFunction<java.lang.Object,java.lang.Boolean> fun) 根据自定义方法进行匹配排除 (lazy)
static SaRouterStaff	notMatch(java.lang.String... patterns) 路由匹配排除
static SaRouterStaff	notMatchMethod(java.lang.String... methods) Http请求方法匹配排除 (String)
static SaRouterStaff	stop() 停止匹配，跳出函数 (在多个匹配链中一次性跳出Auth函数)

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

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

构造器详细资料

SaRouter

public SaRouter()

方法详细资料

isMatch

public static boolean isMatch(java.lang.String pattern,
                              java.lang.String path)

路由匹配

参数:

pattern - 路由匹配符

path - 被匹配的路由

返回:

是否匹配成功

isMatch

public static boolean isMatch(java.util.List<java.lang.String> patterns,
                              java.lang.String path)

路由匹配

参数:

patterns - 路由匹配符集合

path - 被匹配的路由

返回:

是否匹配成功

isMatch

public static boolean isMatch(java.lang.String[] patterns,
                              java.lang.String path)

路由匹配

参数:

patterns - 路由匹配符数组

path - 被匹配的路由

返回:

是否匹配成功

isMatch

public static boolean isMatch(SaHttpMethod[] methods,
                              java.lang.String methodString)

Http请求方法匹配

参数:

methods - Http请求方法断言数组

methodString - Http请求方法

返回:

是否匹配成功

isMatchCurrURI

public static boolean isMatchCurrURI(java.lang.String pattern)

路由匹配 (使用当前URI)

参数:

pattern - 路由匹配符

返回:

是否匹配成功

isMatchCurrURI

public static boolean isMatchCurrURI(java.util.List<java.lang.String> patterns)

路由匹配 (使用当前URI)

参数:

patterns - 路由匹配符集合

返回:

是否匹配成功

isMatchCurrURI

public static boolean isMatchCurrURI(java.lang.String[] patterns)

路由匹配 (使用当前URI)

参数:

patterns - 路由匹配符数组

返回:

是否匹配成功

isMatchCurrMethod

public static boolean isMatchCurrMethod(SaHttpMethod[] methods)

Http请求方法匹配 (使用当前请求方式)

参数:

methods - Http请求方法断言数组

返回:

是否匹配成功

newMatch

public static SaRouterStaff newMatch()

初始化一个SaRouterStaff，开始匹配

返回:

SaRouterStaff

match

public static SaRouterStaff match(java.lang.String... patterns)

路由匹配

参数:

patterns - 路由匹配符集合

返回:

SaRouterStaff

notMatch

public static SaRouterStaff notMatch(java.lang.String... patterns)

路由匹配排除

参数:

patterns - 路由匹配符排除数组

返回:

SaRouterStaff

match

public static SaRouterStaff match(java.util.List<java.lang.String> patterns)

路由匹配

参数:

patterns - 路由匹配符集合

返回:

对象自身

notMatch

public static SaRouterStaff notMatch(java.util.List<java.lang.String> patterns)

路由匹配排除

参数:

patterns - 路由匹配符排除集合

返回:

对象自身

match

public static SaRouterStaff match(SaHttpMethod... methods)

Http请求方式匹配 (Enum)

参数:

methods - Http请求方法断言数组

返回:

SaRouterStaff

notMatch

public static SaRouterStaff notMatch(SaHttpMethod... methods)

Http请求方法匹配排除 (Enum)

参数:

methods - Http请求方法断言排除数组

返回:

SaRouterStaff

matchMethod

public static SaRouterStaff matchMethod(java.lang.String... methods)

Http请求方法匹配 (String)

参数:

methods - Http请求方法断言数组

返回:

SaRouterStaff

notMatchMethod

public static SaRouterStaff notMatchMethod(java.lang.String... methods)

Http请求方法匹配排除 (String)

参数:

methods - Http请求方法断言排除数组

返回:

SaRouterStaff

match

public static SaRouterStaff match(boolean flag)

根据 boolean 值进行匹配

参数:

flag - boolean值

返回:

SaRouterStaff

notMatch

public static SaRouterStaff notMatch(boolean flag)

根据 boolean 值进行匹配排除

参数:

flag - boolean值

返回:

SaRouterStaff

match

public static SaRouterStaff match(SaParamRetFunction<java.lang.Object,java.lang.Boolean> fun)

根据自定义方法进行匹配 (lazy)

参数:

fun - 自定义方法

返回:

SaRouterStaff

notMatch

public static SaRouterStaff notMatch(SaParamRetFunction<java.lang.Object,java.lang.Boolean> fun)

根据自定义方法进行匹配排除 (lazy)

参数:

fun - 自定义排除方法

返回:

SaRouterStaff

match

public static SaRouterStaff match(java.lang.String pattern,
                                  SaFunction fun)

路由匹配，如果匹配成功则执行认证函数

参数:

pattern - 路由匹配符

fun - 要执行的校验方法

返回:

/

match

public static SaRouterStaff match(java.lang.String pattern,
                                  SaParamFunction<SaRouterStaff> fun)

路由匹配，如果匹配成功则执行认证函数

参数:

pattern - 路由匹配符

fun - 要执行的校验方法

返回:

/

match

public static SaRouterStaff match(java.lang.String pattern,
                                  java.lang.String excludePattern,
                                  SaFunction fun)

路由匹配 (并指定排除匹配符)，如果匹配成功则执行认证函数

参数:

pattern - 路由匹配符

excludePattern - 要排除的路由匹配符

fun - 要执行的方法

返回:

/

match

public static SaRouterStaff match(java.lang.String pattern,
                                  java.lang.String excludePattern,
                                  SaParamFunction<SaRouterStaff> fun)

路由匹配 (并指定排除匹配符)，如果匹配成功则执行认证函数

参数:

pattern - 路由匹配符

excludePattern - 要排除的路由匹配符

fun - 要执行的方法

返回:

/

stop

public static SaRouterStaff stop()

停止匹配，跳出函数 (在多个匹配链中一次性跳出Auth函数)

返回:

SaRouterStaff

back

public static SaRouterStaff back()

停止匹配，结束执行，向前端返回结果

返回:

SaRouterStaff

back

public static SaRouterStaff back(java.lang.Object result)

停止匹配，结束执行，向前端返回结果

参数:

result - 要输出的结果

返回:

SaRouterStaff

match

@Deprecated
public static void match(java.util.List<java.lang.String> patterns,
                                      SaFunction function)

已过时。

本函数设计已过时，请更换为：SaRouter.match(path...).ckeck(fun)

路由匹配，如果匹配成功则执行认证函数

参数:

patterns - 路由匹配符集合

function - 要执行的方法

match

@Deprecated
public static void match(java.util.List<java.lang.String> patterns,
                                      java.util.List<java.lang.String> excludePatterns,
                                      SaFunction function)

已过时。

本函数设计已过时，请更换为：SaRouter.match(path...).notMatch(path...).ckeck(fun)

路由匹配 (并指定排除匹配符)，如果匹配成功则执行认证函数

参数:

patterns - 路由匹配符集合

excludePatterns - 要排除的路由匹配符集合

function - 要执行的方法