Skip to content

接口放行 ​

框架使用 Sa-Token,放行有两种常用方式:配置文件排除路径 与 @SaIgnore 注解。

配置文件放行 ​

  • 在 application.yml(或对应 profile)的 sa-token.excludes 中配置不需要登录即可访问的路径列表。
  • 注册拦截器:com.sxpcwlkj.authority.config.SaTokenConfig 使用 SaInterceptor,对 /** 生效,并 excludePathPatterns(saTokenProperties.getExcludes()),与配置项绑定。

参考主工程 mms-admin 的 application.yml 中 sa-token.excludes(含 /visitor/**、静态资源、Swagger 等;以当前仓库为准)。

提示

配置类包名以代码为准:com.sxpcwlkj.authority.config(如 SaTokenConfig)。

注解放行(@SaIgnore) ​

  • 注解来自 Sa-Token:cn.dev33.satoken.annotation.SaIgnore。
  • 支持标注在类或方法上:方法级表示该接口可匿名访问;类级表示该类下接口默认可匿名访问(与其它 Sa-Token 鉴权注解并存时,以 Sa-Token 文档约定为准)。
  • 动态路径:框架会把形如 /get/{userId} 的路径按通配参与匹配,实际效果等价于类似 /get/* 的规则设计,请勿让敏感接口依赖模糊匹配。
java
import cn.dev33.satoken.annotation.SaIgnore;

@SaIgnore
@GetMapping("/health")
public String health() {
    return "ok";
}

文档勘误

历史文档中的 @Salgnore 为拼写错误,正确为 @SaIgnore(第二个字母为大写 I)。

Released under the MIT License.