本章介紹一下常用的認證框架Shiro結合springboot以及集合jwt快速帶您開發完成一個認證框架機制。

Maven配置依賴

<dependency>
	<groupId>org.apache.shiro</groupId>
	<artifactId>shiro-spring</artifactId>
	<version>1.3.2</version>
</dependency>

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 包裡面的類。

• shirFilter 方法中主要是設定了一些重要的跳轉 url，比如未登陸時，無許可權時的跳轉；以及設定了各類 url 的許可權攔截，比如 /user 開始的 url 需要 user 許可權，/admin 開始的 url 需要 admin 許可權等

許可權攔截Filter

當執行一個Web應用程式時，Shiro將會建立一些有用的預設 Filter 例項，並自動地將它們置為可用，而這些預設的 Filter 例項是被 DefaultFilter 列舉類定義的，當然我們也可以自定義 Filter 例項，這些在以後的文章中會講到。

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

注意

• 第一組認證過濾器：anon, authc, authcBasic, user
• 第二組授權過濾器：perms, port, rest, roles, ssl 是，要通過授權過濾器，就先要完成登陸認證操作（即先要完成認證才能前去尋找授權) 才能走第二組授權器（例如訪問需要 roles 許可權的 url，如果沒有登陸，會跳轉到 shiroFilterFactoryBean.setLoginUrl(); 設定的 url

自定義 realm 類

首先要繼承 AuthorizingRealm 類來自定義我們自己的 realm 以進行我們自定義的身份，許可權認證操作。

記得要 Override 重寫 doGetAuthenticationInfo 和 doGetAuthorizationInfo 兩個方法（兩個方法名很相似，不要搞錯）

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 {
        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 作為引數傳入，便會跑進這兩個方法裡面。

  • 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();
    }
  @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("許可權錯誤！");
    }
}

Jwt整合shiro服務框架

JWTUtil

利用 JWT 的工具類來生成我們的 token，這個工具類主要有生成 token 和 校驗 token 兩個方法

生成 token 時，指定 token 過期時間 EXPIRE_TIME 和簽名金鑰 SECRET，然後將 date 和 username 寫入 token 中，並使用帶有金鑰的 HS256 簽名演算法進行簽名

Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME);
Algorithm algorithm = Algorithm.HMAC256(SECRET);
JWT.create()
    .withClaim("username", username)
    //到期時間
    .withExpiresAt(date)
    //建立一個新的JWT，並使用給定的演算法進行標記
    .sign(algorithm);

過濾器

因為 JWT 的整合，我們需要自定義自己的過濾器 JWTFilter，JWTFilter 繼承了 BasicHttpAuthenticationFilter，並部分原方法進行了重寫

該過濾器主要有三步：''

1. 檢驗請求頭是否帶有 token ((HttpServletRequest) request).getHeader("Token") != null
2. 如果帶有 token，執行 shiro 的 login() 方法，將 token 提交到 Realm 中進行檢驗；如果沒有 token，說明當前狀態為遊客狀態（或者其他一些不需要進行認證的介面）

    @Override
    protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws UnauthorizedException {
        //判斷請求的請求頭是否帶上 "Token"
        if (((HttpServletRequest) request).getHeader("Token") != null) {
            //如果存在，則進入 executeLogin 方法執行登入，檢查 token 是否正確
            try {
                executeLogin(request, response);
                return true;
            } catch (Exception e) {
                //token 錯誤
                responseError(response, e.getMessage());
            }
        }
        //如果請求頭不存在 Token，則可能是執行登陸操作或者是遊客狀態訪問，無需檢查 token，直接返回 true
        return true;
    }

    @Override
    protected boolean executeLogin(ServletRequest request, ServletResponse response) throws Exception {
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        String token = httpServletRequest.getHeader("Token");
        JWTToken jwtToken = new JWTToken(token);
        // 提交給realm進行登入，如果錯誤他會丟擲異常並被捕獲
        getSubject(request, response).login(jwtToken);
        // 如果沒有丟擲異常則代表登入成功，返回true
        return true;
    }

3. 如果在 token 校驗的過程中出現錯誤，如 token 校驗失敗，那麼我會將該請求視為認證不通過，則重定向到 /unauthorized/**

另外，我將跨域支援放到了該過濾器來處理

Realm 類

依然是我們的自定義 Realm ，對這一塊還不瞭解的可以先看我的上一篇 shiro 的文章

• 身份認證

if (username == null || !JWTUtil.verify(token, username)) {
    throw new AuthenticationException("token認證失敗！");
}
String password = userMapper.getPassword(username);
if (password == null) {
    throw new AuthenticationException("該使用者不存在！");
}
int ban = userMapper.checkUserBanStatus(username);
if (ban == 1) {
    throw new AuthenticationException("該使用者已被封號！");
}

拿到傳來的 token ，檢查 token 是否有效，使用者是否存在，以及使用者的封號情況

• 許可權認證

SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
//獲得該使用者角色
String role = userMapper.getRole(username);
//每個角色擁有預設的許可權
String rolePermission = userMapper.getRolePermission(username);
//每個使用者可以設定新的許可權
String permission = userMapper.getPermission(username);
Set<String> roleSet = new HashSet<>();
Set<String> permissionSet = new HashSet<>();
//需要將 role, permission 封裝到 Set 作為 info.setRoles(), info.setStringPermissions() 的引數
roleSet.add(role);
permissionSet.add(rolePermission);
permissionSet.add(permission);
//設定該使用者擁有的角色和許可權
info.setRoles(roleSet);
info.setStringPermissions(permissionSet);

利用 token 中獲得的 username，分別從資料庫查到該使用者所擁有的角色，許可權，存入 SimpleAuthorizationInfo 中

ShiroConfig 配置類

設定好我們自定義的 filter，並使所有請求通過我們的過濾器，除了我們用於處理未認證請求的 /unauthorized/**

@Bean
public ShiroFilterFactoryBean factory(SecurityManager securityManager) {
    ShiroFilterFactoryBean factoryBean = new ShiroFilterFactoryBean();
    // 新增自己的過濾器並且取名為jwt
    Map<String, Filter> filterMap = new HashMap<>();
    //設定我們自定義的JWT過濾器
    filterMap.put("jwt", new JWTFilter());
    factoryBean.setFilters(filterMap);
    factoryBean.setSecurityManager(securityManager);
    Map<String, String> filterRuleMap = new HashMap<>();
    // 所有請求通過我們自己的JWT Filter
    filterRuleMap.put("/**", "jwt");
    // 訪問 /unauthorized/** 不通過JWTFilter
    filterRuleMap.put("/unauthorized/**", "anon");
    factoryBean.setFilterChainDefinitionMap(filterRuleMap);
    return factoryBean;
}

許可權控制註解 @RequiresRoles， @RequiresPermissions

這兩個註解為我們主要的許可權控制註解, 如

// 擁有 admin 角色可以訪問
@RequiresRoles("admin")

// 擁有 user 或 admin 角色可以訪問
@RequiresRoles(logical = Logical.OR, value = {"user", "admin"})

// 擁有 vip 和 normal 許可權可以訪問
@RequiresPermissions(logical = Logical.AND, value = {"vip", "normal"})

// 擁有 user 或 admin 角色，且擁有 vip 許可權可以訪問
@GetMapping("/getVipMessage")
@RequiresRoles(logical = Logical.OR, value = {"user", "admin"})
@RequiresPermissions("vip")
public ResultMap getVipMessage() {
    return resultMap.success().code(200).message("成功獲得 vip 資訊！");
}

當我們寫的介面擁有以上的註解時，如果請求沒有帶有 token 或者帶了 token 但許可權認證不通過，則會報 UnauthenticatedException 異常，但是我在 ExceptionController 類對這些異常進行了集中處理

@ExceptionHandler(ShiroException.class)
public ResultMap handle401() {
    return resultMap.fail().code(401).message("您沒有許可權訪問！");
}

這時，出現 shiro 相關的異常時則會返回

{
    "result": "fail",
    "code": 401,
    "message": "您沒有許可權訪問！"
}

除了以上兩種，還有 @RequiresAuthentication ，@RequiresUser 等註解

功能實現

使用者角色分為三類，管理員 admin，普通使用者 user，遊客 guest；admin 預設許可權為 vip，user 預設許可權為 normal，當 user 升級為 vip 許可權時可以訪問 vip 許可權的頁面。

登陸

登陸介面不帶有 token，當登陸密碼，使用者名稱驗證正確後返回 token。

@PostMapping("/login")
public ResultMap login(@RequestParam("username") String username,
                       @RequestParam("password") String password) {
    String realPassword = userMapper.getPassword(username);
    if (realPassword == null) {
        return resultMap.fail().code(401).message("使用者名稱錯誤");
    } else if (!realPassword.equals(password)) {
        return resultMap.fail().code(401).message("密碼錯誤");
    } else {
        return resultMap.success().code(200).message(JWTUtil.createToken(username));
    }
}

{
    "result": "success",
    "code": 200,
    "message": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MjUxODQyMzUsInVzZXJuYW1lIjoiaG93aWUifQ.fG5Qs739Hxy_JjTdSIx_iiwaBD43aKFQMchx9fjaCRo"
}

異常處理

    // 捕捉shiro的異常
    @ExceptionHandler(ShiroException.class)
    public ResultMap handle401() {
        return resultMap.fail().code(401).message("您沒有許可權訪問！");
    }

    // 捕捉其他所有異常
    @ExceptionHandler(Exception.class)
    public ResultMap globalException(HttpServletRequest request, Throwable ex) {
        return resultMap.fail()
                .code(getStatus(request).value())
                .message("訪問出錯，無法訪問: " + ex.getMessage());
    }

許可權控制

• UserController（user 或 admin 可以訪問）

在介面上帶上 @RequiresRoles(logical = Logical.OR, value = {"user", "admin"})

• vip 許可權
  再加上@RequiresPermissions("vip")

• AdminController（admin 可以訪問）
  在介面上帶上 @RequiresRoles("admin")

• GuestController（所有人可以訪問）
  不做許可權處理