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

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<>();
        //游客场仲，開發(fā)權限
        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將會創(chuàng)建一些有用的默認 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

注意：

有很多人會發(fā)現琳状，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里邊創(chuàng)建一個 subject
        Subject subject = SecurityUtils.getSubject();
        // 在認證提交前準備 token（令牌）
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        // 執(zhí)行認證登陸
        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)
    //創(chuàng)建一個新的JWT比勉，并使用給定的算法進行標記
    .sign(algorithm);

過濾器

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

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

1. 檢驗請求頭是否帶有 token ((HttpServletRequest) request).getHeader("Token") != null
2. 如果帶有 token观蜗，執(zhí)行 shiro 的 login() 方法，將 token 提交到 Realm 中進行檢驗衣洁；如果沒有 token墓捻，說明當前狀態(tài)為游客狀態(tài)（或者其他一些不需要進行認證的接口）

    @Override
    protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws UnauthorizedException {
        //判斷請求的請求頭是否帶上 "Token"
        if (((HttpServletRequest) request).getHeader("Token") != null) {
            //如果存在，則進入 executeLogin 方法執(zhí)行登入坊夫，檢查 token 是否正確
            try {
                executeLogin(request, response);
                return true;
            } catch (Exception e) {
                //token 錯誤
                responseError(response, e.getMessage());
            }
        }
        //如果請求頭不存在 Token砖第，則可能是執(zhí)行登陸操作或者是游客狀態(tài)訪問，無需檢查 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（所有人可以訪問）
  不做權限處理