教你 Shiro 整合 SpringBoot，避開各類坑

時間 2019-11-17

標籤 shiro 整合 springboot 避開各類欄目 Spring 简体版

原文原文鏈接

最近搞了下 Shiro 安全框架，找了一些網上的博客文章，可是一到本身實現的時候就遇到了各類坑，須要各類查資料看源碼以及各類測試。那麼這篇文章就教你們如何將 Shiro 整合到 SpringBoot 中，並避開一些小坑，此次實現了基本的登錄以及角色權限，日後的文章也講解了其餘的功能，如《教你 Shiro + SpringBoot 整合 JWT》java

附上源碼：github.com/HowieYuan/s…git

依賴包

<dependency>
	<groupId>org.apache.shiro</groupId>
	<artifactId>shiro-spring</artifactId>
	<version>1.3.2</version>
</dependency>
複製代碼

數據庫表

一切從簡，用戶 user 表，以及角色 role 表 github

Shiro 相關類

Shiro 配置類

@Configuration
public class ShiroConfig {
    @Bean
    public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager) {
        ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
        // 必須設置 SecurityManager
        shiroFilterFactoryBean.setSecurityManager(securityManager);
        // setLoginUrl 若是不設置值，默認會自動尋找Web工程根目錄下的"/login.jsp"頁面 或 "/login" 映射
        shiroFilterFactoryBean.setLoginUrl("/notLogin");
        // 設置無權限時跳轉的 url;
        shiroFilterFactoryBean.setUnauthorizedUrl("/notRole");

        // 設置攔截器
        Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>();
        //遊客，開發權限
        filterChainDefinitionMap.put("/guest/**", "anon");
        //用戶，須要角色權限 「user」
        filterChainDefinitionMap.put("/user/**", "roles[user]");
        //管理員，須要角色權限 「admin」
        filterChainDefinitionMap.put("/admin/**", "roles[admin]");
        //開放登錄接口
        filterChainDefinitionMap.put("/login", "anon");
        //其他接口一概攔截
        //主要這行代碼必須放在全部權限設置的最後，否則會致使全部 url 都被攔截
        filterChainDefinitionMap.put("/**", "authc");

        shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap);
        System.out.println("Shiro攔截器工廠類注入成功");
        return shiroFilterFactoryBean;
    }

    /**
     * 注入 securityManager
     */
    @Bean
    public SecurityManager securityManager() {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        // 設置realm.
        securityManager.setRealm(customRealm());
        return securityManager;
    }

    /**
     * 自定義身份認證 realm;
     * <p>
     * 必須寫這個類，並加上 @Bean 註解，目的是注入 CustomRealm，
     * 不然會影響 CustomRealm類 中其餘類的依賴注入
     */
    @Bean
    public CustomRealm customRealm() {
        return new CustomRealm();
    }
}
複製代碼

注意：裏面的 SecurityManager 類導入的應該是 import org.apache.shiro.mgt.SecurityManager; 可是，若是你是複製代碼過來的話，會默認導入 java.lang.SecurityManager 這裏也稍稍有點坑，其餘的類的話，也是都屬於 shiro 包裏面的類spring

shirFilter 方法中主要是設置了一些重要的跳轉 url，好比未登錄時，無權限時的跳轉；以及設置了各種 url 的權限攔截，好比 /user 開始的 url 須要 user 權限，/admin 開始的 url 須要 admin 權限等數據庫

權限攔截 Filter

當運行一個Web應用程序時，Shiro將會建立一些有用的默認 Filter 實例，並自動地將它們置爲可用，而這些默認的 Filter 實例是被 DefaultFilter 枚舉類定義的，固然咱們也能夠自定義 Filter 實例，這些在之後的文章中會講到 apache

Filter	解釋
anon	無參，開放權限，能夠理解爲匿名用戶或遊客
authc	無參，須要認證
logout	無參，註銷，執行後會直接跳轉到`shiroFilterFactoryBean.setLoginUrl();` 設置的 url
authcBasic	無參，表示 httpBasic 認證
user	無參，表示必須存在用戶，當登入操做時不作檢查
ssl	無參，表示安全的URL請求，協議爲 https
perms[user]	參數可寫多個，表示須要某個或某些權限才能經過，多個參數時寫 perms["user, admin"]，當有多個參數時必須每一個參數都經過纔算經過
roles[admin]	參數可寫多個，表示是某個或某些角色才能經過，多個參數時寫 roles["admin，user"]，當有多個參數時必須每一個參數都經過纔算經過
rest[user]	根據請求的方法，至關於 perms[user:method]，其中 method 爲 post，get，delete 等
port[8081]	當請求的URL端口不是8081時，跳轉到schemal://serverName:8081?queryString 其中 schmal 是協議 http 或 https 等等，serverName 是你訪問的 Host，8081 是 Port 端口，queryString 是你訪問的 URL 裏的 ? 後面的參數

經常使用的主要就是 anon，authc，user，roles，perms 等json

注意：anon, authc, authcBasic, user 是第一組認證過濾器，perms, port, rest, roles, ssl 是第二組受權過濾器，要經過受權過濾器，就先要完成登錄認證操做（即先要完成認證才能前去尋找受權) 才能走第二組受權器（例如訪問須要 roles 權限的 url，若是尚未登錄的話，會直接跳轉到 shiroFilterFactoryBean.setLoginUrl(); 設置的 url ）安全

自定義 realm 類

咱們首先要繼承 AuthorizingRealm 類來自定義咱們本身的 realm 以進行咱們自定義的身份，權限認證操做。記得要 Override 重寫 doGetAuthenticationInfo 和 doGetAuthorizationInfo 兩個方法（兩個方法名很類似，不要搞錯）bash

public class CustomRealm extends AuthorizingRealm {
    private UserMapper userMapper;

    @Autowired
    private void setUserMapper(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    /**
     * 獲取身份驗證信息
     * Shiro中，最終是經過 Realm 來獲取應用程序中的用戶、角色及權限信息的。
     *
     * @param authenticationToken 用戶身份信息 token
     * @return 返回封裝了用戶信息的 AuthenticationInfo 實例
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("————身份認證方法————");
        UsernamePasswordToken token = (UsernamePasswordToken) authenticationToken;
        // 從數據庫獲取對應用戶名密碼的用戶
        String password = userMapper.getPassword(token.getUsername());
        if (null == password) {
            throw new AccountException("用戶名不正確");
        } else if (!password.equals(new String((char[]) token.getCredentials()))) {
            throw new AccountException("密碼不正確");
        }
        return new SimpleAuthenticationInfo(token.getPrincipal(), password, getName());
    }

    /**
     * 獲取受權信息
     *
     * @param principalCollection
     * @return
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("————權限認證————");
        String username = (String) SecurityUtils.getSubject().getPrincipal();
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        //得到該用戶角色
        String role = userMapper.getRole(username);
        Set<String> set = new HashSet<>();
        //須要將 role 封裝到 Set 做爲 info.setRoles() 的參數
        set.add(role);
        //設置該用戶擁有的角色
        info.setRoles(set);
        return info;
    }
}
複製代碼

重寫的兩個方法分別是實現身份認證以及權限認證，shiro 中有個做登錄操做的 Subject.login() 方法，當咱們把封裝了用戶名，密碼的 token 做爲參數傳入，便會跑進這兩個方法裏面（不必定兩個方法都會進入）app

其中 doGetAuthorizationInfo 方法只有在須要權限認證時纔會進去，好比前面配置類中配置了 filterChainDefinitionMap.put("/admin/**", "roles[admin]"); 的管理員角色，這時進入 /admin 時就會進入 doGetAuthorizationInfo 方法來檢查權限；而 doGetAuthenticationInfo 方法則是須要身份認證時（好比前面的 Subject.login() 方法）纔會進入

再說下 UsernamePasswordToken 類，咱們能夠從該對象拿到登錄時的用戶名和密碼（登錄時會使用 new UsernamePasswordToken(username, password);），而 get 用戶名或密碼有如下幾個方法

token.getUsername()  //得到用戶名 String
token.getPrincipal() //得到用戶名 Object 
token.getPassword()  //得到密碼 char[]
token.getCredentials() //得到密碼 Object
複製代碼

注意：有不少人會發現，UserMapper 等類，接口沒法經過 @Autowired 注入進來，跑程序的時候會報 NullPointerException，網上說了不少諸如是 Spring 加載順序等緣由，但其實有一個很重要的地方要你們注意，CustomRealm 這個類是在 shiro 配置類的 securityManager.setRealm() 方法中設置進去的，而不少人直接寫securityManager.setRealm(new CustomRealm()); ,這樣是不行的，必需要使用 @Bean 注入 MyRealm，不能直接 new 對象：

@Bean
    public SecurityManager securityManager() {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        // 設置realm.
        securityManager.setRealm(customRealm());
        return securityManager;
    }

    @Bean
    public CustomRealm customRealm() {
        return new CustomRealm();
    }
複製代碼

道理也很簡單，和 Controller 中調用 Service 同樣，都是 SpringBean，不能本身 new

固然，一樣的道理也能夠這樣寫：

@Bean
    public SecurityManager securityManager(CustomRealm customRealm) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        // 設置realm.
        securityManager.setRealm(customRealm);
        return securityManager;
    }
複製代碼

而後只要在 CustomRealm 類加上個相似 @Component 的註解便可

功能實現

本文的功能所有以接口返回 json 數據的方式實現

根據 url 權限分配 controller

遊客
@RestController
@RequestMapping("/guest")
public class GuestController{
    @Autowired    
    private final ResultMap resultMap;

    @RequestMapping(value = "/enter", method = RequestMethod.GET)
    public ResultMap login() {
        return resultMap.success().message("歡迎進入，您的身份是遊客");
    }

    @RequestMapping(value = "/getMessage", method = RequestMethod.GET)
    public ResultMap submitLogin() {
        return resultMap.success().message("您擁有得到該接口的信息的權限！");
    }
}
複製代碼

普通登錄用戶
@RestController
@RequestMapping("/user")
public class UserController{
    @Autowired    
    private final ResultMap resultMap;

    @RequestMapping(value = "/getMessage", method = RequestMethod.GET)
    public ResultMap getMessage() {
        return resultMap.success().message("您擁有用戶權限，能夠得到該接口的信息！");
    }
}
複製代碼

管理員
@RestController
@RequestMapping("/admin")
public class AdminController {
    @Autowired    
    private final ResultMap resultMap;

    @RequestMapping(value = "/getMessage", method = RequestMethod.GET)
    public ResultMap getMessage() {
        return resultMap.success().message("您擁有管理員權限，能夠得到該接口的信息！");
    }
}
複製代碼

忽然注意到 CustomRealm 類那裏拋出了 AccountException 異常，如今建個類進行異常捕獲

@RestControllerAdvice
public class ExceptionController {
    private final ResultMap resultMap;

    @Autowired
    public ExceptionController(ResultMap resultMap) {
        this.resultMap = resultMap;
    }

    // 捕捉 CustomRealm 拋出的異常
    @ExceptionHandler(AccountException.class)
    public ResultMap handleShiroException(Exception ex) {
        return resultMap.fail().message(ex.getMessage());
    }
}
複製代碼

固然還有進行登錄等處理的 LoginController

@RestController
public class LoginController {
    @Autowired    
    private ResultMap resultMap;
    private UserMapper userMapper;

    @RequestMapping(value = "/notLogin", method = RequestMethod.GET)
    public ResultMap notLogin() {
        return resultMap.success().message("您還沒有登錄！");
    }

    @RequestMapping(value = "/notRole", method = RequestMethod.GET)
    public ResultMap notRole() {
        return resultMap.success().message("您沒有權限！");
    }

    @RequestMapping(value = "/logout", method = RequestMethod.GET)
    public ResultMap logout() {
        Subject subject = SecurityUtils.getSubject();
        //註銷
        subject.logout();
        return resultMap.success().message("成功註銷！");
    }

    /**
     * 登錄
     *
     * @param username 用戶名
     * @param password 密碼
     */
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    public ResultMap login(String username, String password) {
        // 從SecurityUtils裏邊建立一個 subject
        Subject subject = SecurityUtils.getSubject();
        // 在認證提交前準備 token（令牌）
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        // 執行認證登錄
        subject.login(token);
        //根據權限，指定返回數據
        String role = userMapper.getRole(username);
        if ("user".equals(role)) {
            return resultMap.success().message("歡迎登錄");
        }
        if ("admin".equals(role)) {
            return resultMap.success().message("歡迎來到管理員頁面");
        } 
        return resultMap.fail().message("權限錯誤！");
    }
}
複製代碼