sa-token 路由攔截式鑒權

前言

假設我們有如下需求：

我們怎么實現呢？給每個接口加上鑒權注解？手寫全局攔截器？似乎都不是非常方便。
在這個需求中我們真正需要的是一種基於路由攔截的鑒權模式, 那么在sa-token怎么實現路由攔截鑒權呢？

使用方式

1、注冊路由攔截器

以 springboot2.0 為例, 新建配置類MySaTokenConfig.java

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
    // 注冊sa-token的登錄攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注冊登錄攔截器，並排除登錄接口地址 
        registry.addInterceptor(new SaRouteInterceptor()).addPathPatterns("/**").excludePathPatterns("/user/doLogin"); 
    }
}

以上代碼，我們注冊了一個登錄驗證攔截器，並且排除了 /user/doLogin 接口用來開放登錄
那么我們如何進行權限認證攔截呢，且往下看

2、所有攔截器示例

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
    // 注冊sa-token的所有攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        // 注冊一個登錄驗證攔截器 
        registry.addInterceptor(SaRouteInterceptor.createLoginVal()).addPathPatterns("/**").excludePathPatterns("/user/doLogin"); 

        // 注冊一個角色認證攔截器 
        registry.addInterceptor(SaRouteInterceptor.createRoleVal("super-admin")).addPathPatterns("/**"); 

        // 注冊一個權限認證攔截器 
        registry.addInterceptor(SaRouteInterceptor.createPermissionVal("user:add", "user:deelete")).addPathPatterns("/UserController/**"); 

        // 注冊一個自定義認證攔截器 (可以寫任意認證代碼)
        registry.addInterceptor(new SaRouteInterceptor((request, response, handler)->{
            System.out.println("---------- 進入自定義認證 --------------- ");
            // 你可以在這里寫任意認證代碼, 例如: StpUtil.checkLogin(); 
        })).addPathPatterns("/**");

    }
}

（你不必像上面的示例一樣注冊所有攔截器，只要按需注冊即可 ）

3、讓我們利用自定義攔截器做點快活的事情

你可以根據路由划分模塊，不同模塊不同鑒權

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
    // 注冊sa-token的所有攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SaRouteInterceptor((request, response, handler)->{
            // 根據路由划分模塊，不同模塊不同鑒權 
            SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user"));
            SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin"));
            SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods"));
            SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders"));
            SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice"));
            SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment"));
        })).addPathPatterns("/**");
    }
}

4、完整的示例

最終的代碼，可能會類似於下面的樣子：

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
    // 注冊sa-token的攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 自定義驗證攔截器 
        registry.addInterceptor(new SaRouteInterceptor((request, response, handler) -> {

            // 登錄驗證 -- 攔截所有路由，並排除/user/doLogin 用於開放登錄 
            SaRouterUtil.match("/**", "/user/doLogin", () -> StpUtil.checkLogin());

            // 角色認證 -- 攔截以 admin 開頭的路由，必須具備[admin]角色或者[super-admin]角色才可以通過認證 
            SaRouterUtil.match("/admin/**", () -> StpUtil.checkRoleOr("admin", "super-admin"));

            // 權限認證 -- 不同模塊, 校驗不同權限 
            SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user"));
            SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin"));
            SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods"));
            SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders"));
            SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice"));
            SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment"));

            // 匹配RESTful風格路由 
            SaRouterUtil.match("/article/get/{id}", () -> StpUtil.checkPermission("article"));

        })).addPathPatterns("/**");
    }
}

寫在最后

源碼開源，作者不易，如果你喜歡這個框架麻煩你隨手點一顆小星星哦！

• 官網文檔：http://sa-token.dev33.cn/
• Gitee開源地址: https://gitee.com/sz6/sa-token
• GitHub開源地址: https://github.com/click33/sa-token