类 SaStrategy

java.lang.Object
cn.dev33.satoken.strategy.SaStrategy

public final class SaStrategy extends Object
Sa-Token 策略对象

此类统一定义框架内的一些关键性逻辑算法,方便开发者进行按需重写,例:

 // SaStrategy全局单例,所有方法都用以下形式重写
 SaStrategy.instance.setCreateToken((loginId, loginType) -》 {
 // 自定义Token生成的算法
 return "xxxx";
 });
 
从以下版本开始:
1.27.0
作者:
click33
  • 字段详细资料

    • instance

      public static final SaStrategy instance
      获取 SaStrategy 对象的单例引用
    • createToken

      public SaCreateTokenFunction createToken
      创建 Token 的策略
    • createSession

      public SaCreateSessionFunction createSession
      创建 Session 的策略
    • hasElement

      public SaHasElementFunction hasElement
      判断:集合中是否包含指定元素(模糊匹配)
    • checkMethodAnnotation

      public SaCheckMethodAnnotationFunction checkMethodAnnotation
      对一个 [Method] 对象进行注解校验 (注解鉴权内部实现)
    • checkElementAnnotation

      public SaCheckElementAnnotationFunction checkElementAnnotation
      对一个 [元素] 对象进行注解校验 (注解鉴权内部实现)
    • checkOrAnnotation

      public SaCheckOrAnnotationFunction checkOrAnnotation
      对一个 @SaCheckOr 进行注解校验
    • getAnnotation

      public SaGetAnnotationFunction getAnnotation
      从元素上获取注解
    • isAnnotationPresent

      public SaIsAnnotationPresentFunction isAnnotationPresent
      判断一个 Method 或其所属 Class 是否包含指定注解
    • generateUniqueToken

      public SaGenerateUniqueTokenFunction generateUniqueToken
      生成唯一式 token 的算法
    • createStpLogic

      public SaCreateStpLogicFunction createStpLogic
      创建 StpLogic 的算法
    • INVALID_CHARACTER

      public static String[] INVALID_CHARACTER
      请求 path 不允许出现的字符
    • checkRequestPath

      public SaCheckRequestPathFunction checkRequestPath
      校验请求 path 的算法
    • requestPathInvalidHandle

      public SaRequestPathInvalidHandleFunction requestPathInvalidHandle
      当请求 path 校验不通过时处理方案的算法,自定义示例:
                      SaStrategy.instance.requestPathInvalidHandle = (e, extArg1, extArg2) -> {
                              // 自定义处理逻辑 ...
            };
       
    • me

      @Deprecated public static final SaStrategy me
      已过时。
      请更换为 instance
  • 方法详细资料

    • setCreateToken

      public SaStrategy setCreateToken(SaCreateTokenFunction createToken)
      重写创建 Token 的策略
      参数:
      createToken - /
      返回:
      /
    • setCreateSession

      public SaStrategy setCreateSession(SaCreateSessionFunction createSession)
      重写创建 Session 的策略
      参数:
      createSession - /
      返回:
      /
    • setHasElement

      public SaStrategy setHasElement(SaHasElementFunction hasElement)
      判断:集合中是否包含指定元素(模糊匹配)
      参数:
      hasElement - /
      返回:
      /
    • setCheckMethodAnnotation

      public SaStrategy setCheckMethodAnnotation(SaCheckMethodAnnotationFunction checkMethodAnnotation)
      对一个 [Method] 对象进行注解校验 (注解鉴权内部实现)
      参数:
      checkMethodAnnotation - /
      返回:
      /
    • setCheckElementAnnotation

      public SaStrategy setCheckElementAnnotation(SaCheckElementAnnotationFunction checkElementAnnotation)
      对一个 [元素] 对象进行注解校验 (注解鉴权内部实现)
      参数:
      checkElementAnnotation - /
      返回:
      /
    • setCheckOrAnnotation

      public SaStrategy setCheckOrAnnotation(SaCheckOrAnnotationFunction checkOrAnnotation)
      对一个 @SaCheckOr 进行注解校验

      参数 [SaCheckOr 注解的实例]

      参数:
      checkOrAnnotation - /
      返回:
      /
    • setGetAnnotation

      public SaStrategy setGetAnnotation(SaGetAnnotationFunction getAnnotation)
      从元素上获取注解
      参数:
      getAnnotation - /
      返回:
      /
    • setIsAnnotationPresent

      public SaStrategy setIsAnnotationPresent(SaIsAnnotationPresentFunction isAnnotationPresent)
      判断一个 Method 或其所属 Class 是否包含指定注解
      参数:
      isAnnotationPresent - /
      返回:
      /
    • setGenerateUniqueToken

      public SaStrategy setGenerateUniqueToken(SaGenerateUniqueTokenFunction generateUniqueToken)
      生成唯一式 token 的算法
      参数:
      generateUniqueToken - /
      返回:
      /
    • setCreateStpLogic

      public SaStrategy setCreateStpLogic(SaCreateStpLogicFunction createStpLogic)
      创建 StpLogic 的算法
      参数:
      createStpLogic - /
      返回:
      /