Shiro+JWT+Spring Boot Restful简易教程

 序言

我也是半路出家的人，若是你们有什么好的意见或批评，请务必issue下。

项目地址：https://github.com/Smith-Cruise/Spring-Boot-Shiro 。

若是想要直接体验，直接clone项目，运行mvn spring-boot:run命令便可进行访问。网址规则自行看教程后面。

特性

• 彻底使用了Shiro的注解配置，保持高度的灵活性。
• 放弃Cookie,Session,使用JWT进行鉴权，彻底实现无状态鉴权。
• JWT密钥支持过时时间。
• 对跨域提供支持

准备工做

在开始本教程以前，请保证已经熟悉如下几点。

• Spring Boot 基本语法，至少要懂得Controller、RestController、Autowired等这些基本注释。其实看看官方的Getting-Start教程就差很少了。
• JWT （Json Web Token）的基本概念，而且会简单操做JWT的 JAVA SDK。
• Shiro的基本操做，看下官方的 10 Minute Tutorial 便可。
• 模拟HTTP请求工具，我使用的是PostMan。

简要的说明下咱们为何要用JWT，由于咱们要实现彻底的先后端分离，因此不可能使用session，cookie的方式进行鉴权，因此JWT就被派上了用场，你能够经过一个加密密钥来进行先后端的鉴权。

程序逻辑

1. 咱们POST用户名与密码到/login进行登入，若是成功返回一个加密token，失败的话直接返回401错误。
2. 以后用户访问每个须要权限的网址请求必须在header中添加Authorization字段，例如Authorization: token，token为密钥。
3. 后台会进行token的校验，若是有误会直接返回401。

Token加密说明

• 携带了username信息在token中。
• 设定了过时时间。
• 使用用户登入密码对token进行加密。

Token校验流程

1. 得到token中携带的username信息。
2. 进入数据库搜索这个用户，获得他的密码。
3. 使用用户的密码来检验token是否正确。

准备Maven文件

新建一个Maven工程，添加相关的dependencies。

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.inlighting</groupId> <artifactId>shiro-study</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.3.2</version> </dependency> <dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.2.0</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>1.5.8.RELEASE</version> </dependency> </dependencies> <build> <plugins> <!-- Srping Boot 打包工具 --> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <version>1.5.7.RELEASE</version> <executions> <execution> <goals> <goal>repackage</goal> </goals> </execution> </executions> </plugin> <!-- 指定JDK编译版本 --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>1.8</source> <target>1.8</target> <encoding>UTF-8</encoding> </configuration> </plugin> </plugins> </build> </project> 

注意指定JDK版本和编码

构建简易的数据源

为了缩减教程的代码，我使用HashMap本地模拟了一个数据库，结构以下

username	password	role	permission
smith	smith123	user	view
danny	danny123	admin	view,edit

这是一个最简单的用户权限表，若是想更加进一步了解，自行百度RBAC。

以后再构建一个UserService来模拟数据库查询，而且把结果放到UserBean之中。

UserService.java

@Component public class UserService { public UserBean getUser(String username) { // 没有此用户直接返回null if (! DataSource.getData().containsKey(username)) return null; UserBean user = new UserBean(); Map<String, String> detail = DataSource.getData().get(username); user.setUsername(username); user.setPassword(detail.get("password")); user.setRole(detail.get("role")); user.setPermission(detail.get("permission")); return user; } } 

UserBean.java

public class UserBean { private String username; private String password; private String role; private String permission; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getRole() { return role; } public void setRole(String role) { this.role = role; } public String getPermission() { return permission; } public void setPermission(String permission) { this.permission = permission; } } 

配置JWT

咱们写一个简单的JWT加密，校验工具，而且使用用户本身的密码充当加密密钥，这样保证了token 即便被他人截获也没法破解。而且咱们在token中附带了username信息，而且设置密钥5分钟就会过时。

public class JWTUtil { // 过时时间5分钟 private static final long EXPIRE_TIME = 5*60*1000; /** * 校验token是否正确 * @param token 密钥 * @param secret 用户的密码 * @return 是否正确 */ public static boolean verify(String token, String username, String secret) { try { Algorithm algorithm = Algorithm.HMAC256(secret); JWTVerifier verifier = JWT.require(algorithm) .withClaim("username", username) .build(); DecodedJWT jwt = verifier.verify(token); return true; } catch (Exception exception) { return false; } } /** * 得到token中的信息无需secret解密也能得到 * @return token中包含的用户名 */ public static String getUsername(String token) { try { DecodedJWT jwt = JWT.decode(token); return jwt.getClaim("username").asString(); } catch (JWTDecodeException e) { return null; } } /** * 生成签名,5min后过时 * @param username 用户名 * @param secret 用户的密码 * @return 加密的token */ public static String sign(String username, String secret) { try { Date date = new Date(System.currentTimeMillis()+EXPIRE_TIME); Algorithm algorithm = Algorithm.HMAC256(secret); // 附带username信息 return JWT.create() .withClaim("username", username) .withExpiresAt(date) .sign(algorithm); } catch (UnsupportedEncodingException e) { return null; } } } 

构建URL

ResponseBean.java

既然想要实现restful，那咱们要保证每次返回的格式都是相同的，所以我创建了一个ResponseBean来统一返回的格式。

public class ResponseBean { // http 状态码 private int code; // 返回信息 private String msg; // 返回的数据 private Object data; public ResponseBean(int code, String msg, Object data) { this.code = code; this.msg = msg; this.data = data; } public int getCode() { return code; } public void setCode(int code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public Object getData() { return data; } public void setData(Object data) { this.data = data; } } 

自定义异常

为了实现我本身可以手动抛出异常，我本身写了一个UnauthorizedException.java

public class UnauthorizedException extends RuntimeException { public UnauthorizedException(String msg) { super(msg); } public UnauthorizedException() { super(); } } 

URL结构

URL	做用
/login	登入
/article	全部人均可以访问，可是用户与游客看到的内容不一样
/require_auth	登入的用户才能够进行访问
/require_role	admin的角色用户才能够登入
/require_permission	拥有view和edit权限的用户才能够访问

Controller

@RestController public class WebController { private static final Logger LOGGER = LogManager.getLogger(WebController.class); private UserService userService; @Autowired public void setService(UserService userService) { this.userService = userService; } @PostMapping("/login") public ResponseBean login(@RequestParam("username") String username, @RequestParam("password") String password) { UserBean userBean = userService.getUser(username); if (userBean.getPassword().equals(password)) { return new ResponseBean(200, "Login success", JWTUtil.sign(username, password)); } else { throw new UnauthorizedException(); } } @GetMapping("/article") public ResponseBean article() { Subject subject = SecurityUtils.getSubject(); if (subject.isAuthenticated()) { return new ResponseBean(200, "You are already logged in", null); } else { return new ResponseBean(200, "You are guest", null); } } @GetMapping("/require_auth") @RequiresAuthentication public ResponseBean requireAuth() { return new ResponseBean(200, "You are authenticated", null); } @GetMapping("/require_role") @RequiresRoles("admin") public ResponseBean requireRole() { return new ResponseBean(200, "You are visiting require_role", null); } @GetMapping("/require_permission") @RequiresPermissions(logical = Logical.AND, value = {"view", "edit"}) public ResponseBean requirePermission() { return new ResponseBean(200, "You are visiting permission require edit,view", null); } @RequestMapping(path = "/401") @ResponseStatus(HttpStatus.UNAUTHORIZED) public ResponseBean unauthorized() { return new ResponseBean(401, "Unauthorized", null); } } 

处理框架异常

以前说过restful要统一返回的格式，因此咱们也要全局处理Spring Boot的抛出异常。利用@RestControllerAdvice能很好的实现。

@RestControllerAdvice public class ExceptionController { // 捕捉shiro的异常 @ResponseStatus(HttpStatus.UNAUTHORIZED) @ExceptionHandler(ShiroException.class) public ResponseBean handle401(ShiroException e) { return new ResponseBean(401, e.getMessage(), null); } // 捕捉UnauthorizedException @ResponseStatus(HttpStatus.UNAUTHORIZED) @ExceptionHandler(UnauthorizedException.class) public ResponseBean handle401() { return new ResponseBean(401, "Unauthorized", null); } // 捕捉其余全部异常 @ExceptionHandler(Exception.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public ResponseBean globalException(HttpServletRequest request, Throwable ex) { return new ResponseBean(getStatus(request).value(), ex.getMessage(), null); } private HttpStatus getStatus(HttpServletRequest request) { Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code"); if (statusCode == null) { return HttpStatus.INTERNAL_SERVER_ERROR; } return HttpStatus.valueOf(statusCode); } } 

配置Shiro

你们能够先看下官方的 Spring-Shiro 整合教程，有个初步的了解。不过既然咱们用了Spring-Boot，那咱们确定要争取零配置文件。

实现JWTToken

JWTToken差很少就是Shiro用户名密码的载体。由于咱们是先后端分离，服务器无需保存用户状态，因此不须要RememberMe这类功能，咱们简单的实现下AuthenticationToken接口便可。由于token本身已经包含了用户名等信息，因此这里我就弄了一个字段。若是你喜欢钻研，能够看看官方的UsernamePasswordToken是如何实现的。

public class JWTToken implements AuthenticationToken { // 密钥 private String token; public JWTToken(String token) { this.token = token; } @Override public Object getPrincipal() { return token; } @Override public Object getCredentials() { return token; } } 

实现Realm

realm的用于处理用户是否合法的这一块，须要咱们本身实现。

@Service public class MyRealm extends AuthorizingRealm { private static final Logger LOGGER = LogManager.getLogger(MyRealm.class); private UserService userService; @Autowired public void setUserService(UserService userService) { this.userService = userService; } /** * 大坑！，必须重写此方法，否则Shiro会报错 */ @Override public boolean supports(AuthenticationToken token) { return token instanceof JWTToken; } /** * 只有当须要检测用户权限的时候才会调用此方法，例如checkRole,checkPermission之类的 */ @Override protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) { String username = JWTUtil.getUsername(principals.toString()); UserBean user = userService.getUser(username); SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo(); simpleAuthorizationInfo.addRole(user.getRole()); Set<String> permission = new HashSet<>(Arrays.asList(user.getPermission().split(","))); simpleAuthorizationInfo.addStringPermissions(permission); return simpleAuthorizationInfo; } /** * 默认使用此方法进行用户名正确与否验证，错误抛出异常便可。 */ @Override protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken auth) throws AuthenticationException { String token = (String) auth.getCredentials(); // 解密得到username，用于和数据库进行对比 String username = JWTUtil.getUsername(token); if (username == null) { throw new AuthenticationException("token invalid"); } UserBean userBean = userService.getUser(username); if (userBean == null) { throw new AuthenticationException("User didn't existed!"); } if (! JWTUtil.verify(token, username, userBean.getPassword())) { throw new AuthenticationException("Username or password error"); } return new SimpleAuthenticationInfo(token, token, "my_realm"); } } 

在doGetAuthenticationInfo中用户能够自定义抛出不少异常，详情见文档。

重写Filter

全部的请求都会先通过Filter，因此咱们继承官方的BasicHttpAuthenticationFilter，而且重写鉴权的方法。

代码的执行流程preHandle->isAccessAllowed->isLoginAttempt->executeLogin

public class JWTFilter extends BasicHttpAuthenticationFilter { private Logger LOGGER = LoggerFactory.getLogger(this.getClass()); /** * 判断用户是否想要登入。 * 检测header里面是否包含Authorization字段便可 */ @Override protected boolean isLoginAttempt(ServletRequest request, ServletResponse response) { HttpServletRequest req = (HttpServletRequest) request; String authorization = req.getHeader("Authorization"); return authorization != null; } /** * */ @Override protected boolean executeLogin(ServletRequest request, ServletResponse response) throws Exception { HttpServletRequest httpServletRequest = (HttpServletRequest) request; String authorization = httpServletRequest.getHeader("Authorization"); JWTToken token = new JWTToken(authorization); // 提交给realm进行登入，若是错误他会抛出异常并被捕获 getSubject(request, response).login(token); // 若是没有抛出异常则表明登入成功，返回true return true; } /** * 这里咱们详细说明下为何最终返回的都是true，即容许访问 * 例如咱们提供一个地址 GET /article * 登入用户和游客看到的内容是不一样的 * 若是在这里返回了false，请求会被直接拦截，用户看不到任何东西 * 因此咱们在这里返回true，Controller中能够经过 subject.isAuthenticated() 来判断用户是否登入 * 若是有些资源只有登入用户才能访问，咱们只须要在方法上面加上 @RequiresAuthentication 注解便可 * 可是这样作有一个缺点，就是不可以对GET,POST等请求进行分别过滤鉴权(由于咱们重写了官方的方法)，但实际上对应用影响不大 */ @Override protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) { if (isLoginAttempt(request, response)) { try { executeLogin(request, response); } catch (Exception e) { response401(request, response); } } return true; } /** * 对跨域提供支持 */ @Override protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception { HttpServletRequest httpServletRequest = (HttpServletRequest) request; HttpServletResponse httpServletResponse = (HttpServletResponse) response; httpServletResponse.setHeader("Access-control-Allow-Origin", httpServletRequest.getHeader("Origin")); httpServletResponse.setHeader("Access-Control-Allow-Methods", "GET,POST,OPTIONS,PUT,DELETE"); httpServletResponse.setHeader("Access-Control-Allow-Headers", httpServletRequest.getHeader("Access-Control-Request-Headers")); // 跨域时会首先发送一个option请求，这里咱们给option请求直接返回正常状态 if (httpServletRequest.getMethod().equals(RequestMethod.OPTIONS.name())) { httpServletResponse.setStatus(HttpStatus.OK.value()); return false; } return super.preHandle(request, response); } /** * 将非法请求跳转到 /401 */ private void response401(ServletRequest req, ServletResponse resp) { try { HttpServletResponse httpServletResponse = (HttpServletResponse) resp; httpServletResponse.sendRedirect("/401"); } catch (IOException e) { LOGGER.error(e.getMessage()); } } } 

getSubject(request, response).login(token);这一步就是提交给了realm进行处理

配置Shiro

@Configuration public class ShiroConfig { @Bean("securityManager") public DefaultWebSecurityManager getManager(MyRealm realm) { DefaultWebSecurityManager manager = new DefaultWebSecurityManager(); // 使用本身的realm manager.setRealm(realm); /* * 关闭shiro自带的session，详情见文档 * http://shiro.apache.org/session-management.html#SessionManagement-StatelessApplications%28Sessionless%29 */ DefaultSubjectDAO subjectDAO = new DefaultSubjectDAO(); DefaultSessionStorageEvaluator defaultSessionStorageEvaluator = new DefaultSessionStorageEvaluator(); defaultSessionStorageEvaluator.setSessionStorageEnabled(false); subjectDAO.setSessionStorageEvaluator(defaultSessionStorageEvaluator); manager.setSubjectDAO(subjectDAO); return manager; } @Bean("shiroFilter") public ShiroFilterFactoryBean factory(DefaultWebSecurityManager securityManager) { ShiroFilterFactoryBean factoryBean = new ShiroFilterFactoryBean(); // 添加本身的过滤器而且取名为jwt Map<String, Filter> filterMap = new HashMap<>(); filterMap.put("jwt", new JWTFilter()); factoryBean.setFilters(filterMap); factoryBean.setSecurityManager(securityManager); factoryBean.setUnauthorizedUrl("/401"); /* * 自定义url规则 * http://shiro.apache.org/web.html#urls- */ Map<String, String> filterRuleMap = new HashMap<>(); // 全部请求经过咱们本身的JWT Filter filterRuleMap.put("/**", "jwt"); // 访问401和404页面不经过咱们的Filter filterRuleMap.put("/401", "anon"); factoryBean.setFilterChainDefinitionMap(filterRuleMap); return factoryBean; } /** * 下面的代码是添加注解支持 */ @Bean @DependsOn("lifecycleBeanPostProcessor") public DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator() { DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator = new DefaultAdvisorAutoProxyCreator(); // 强制使用cglib，防止重复代理和可能引发代理出错的问题 // https://zhuanlan.zhihu.com/p/29161098 defaultAdvisorAutoProxyCreator.setProxyTargetClass(true); return defaultAdvisorAutoProxyCreator; } @Bean public LifecycleBeanPostProcessor lifecycleBeanPostProcessor() { return new LifecycleBeanPostProcessor(); } @Bean public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(DefaultWebSecurityManager securityManager) { AuthorizationAttributeSourceAdvisor advisor = new AuthorizationAttributeSourceAdvisor(); advisor.setSecurityManager(securityManager); return advisor; } } 

里面URL规则本身参考文档便可http://shiro.apache.org/web.html 。

总结

我就说下代码还有哪些能够进步的地方吧

• 没有实现Shiro的Cache功能。
• Shiro中鉴权失败时不可以直接返回401信息，而是经过跳转到/401地址实现。