程序包 cn.dev33.satoken.filter

类 SaServletFilter

java.lang.Object
cn.dev33.satoken.filter.SaServletFilter
所有已实现的接口:
cn.dev33.satoken.filter.SaFilter, jakarta.servlet.Filter
@Order(-100) public class SaServletFilter extends Object implements cn.dev33.satoken.filter.SaFilter, jakarta.servlet.Filter
Jakarta-Servlet 全局鉴权过滤器

默认优先级为 -100，尽量保证在其它过滤器之前执行

从以下版本开始:
1.34.0
作者:
click33

  • 字段详细资料

    • includeList

      public List<String> includeList
      拦截路由

    • excludeList

      public List<String> excludeList
      放行路由

    • auth

      public cn.dev33.satoken.filter.SaFilterAuthStrategy auth
      认证函数：每次请求执行

    • error

      public cn.dev33.satoken.filter.SaFilterErrorStrategy error
      异常处理函数：每次[认证函数]发生异常时执行此函数

    • beforeAuth

      public cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth
      前置函数：在每次[认证函数]之前执行 注意点：前置认证函数将不受 includeList 与 excludeList 的限制，所有路由的请求都会进入 beforeAuth

  • 构造器详细资料

    • SaServletFilter

      public SaServletFilter()

  • 方法详细资料

    • addInclude

      public SaServletFilter addInclude(String... paths)
      指定者:
      addInclude 在接口中 cn.dev33.satoken.filter.SaFilter

    • addExclude

      public SaServletFilter addExclude(String... paths)
      指定者:
      addExclude 在接口中 cn.dev33.satoken.filter.SaFilter

    • setIncludeList

      public SaServletFilter setIncludeList(List<String> pathList)
      指定者:
      setIncludeList 在接口中 cn.dev33.satoken.filter.SaFilter

    • setExcludeList

      public SaServletFilter setExcludeList(List<String> pathList)
      指定者:
      setExcludeList 在接口中 cn.dev33.satoken.filter.SaFilter

    • setAuth

      public SaServletFilter setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth)
      指定者:
      setAuth 在接口中 cn.dev33.satoken.filter.SaFilter

    • setError

      public SaServletFilter setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error)
      指定者:
      setError 在接口中 cn.dev33.satoken.filter.SaFilter

    • setBeforeAuth

      public SaServletFilter setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth)
      指定者:
      setBeforeAuth 在接口中 cn.dev33.satoken.filter.SaFilter

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      指定者:
      doFilter 在接口中 jakarta.servlet.Filter
      抛出:
      IOException
      jakarta.servlet.ServletException

    • init

      public void init(jakarta.servlet.FilterConfig filterConfig)
      指定者:
      init 在接口中 jakarta.servlet.Filter

    • destroy

      public void destroy()
      指定者:
      destroy 在接口中 jakarta.servlet.Filter