Shiro+JWT+Spring Boot Restful简易教程

序言我也是半路出家的人，如果大家有什么好的意见或批评，请务必issue下。项目地址：github.com/Smith-Cruis… 。如果想要直接体验，直接clone项目，运行mvn spring-boot:run命令即可进行访问。网址规则自行看教程后面。如果想了解Spring Security可以看 Spring Boot 2.0+Srping Security+Thymeleaf的简易教程 Spring Boot 2 + Spring Security 5 + JWT 的单页应用Restful解决方案特性

完全使用了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就被派上了用场，你可以通过一个加密密钥来进行前后端的鉴权。程序逻辑

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

Token加密说明

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

Token校验流程

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

准备Maven文件新建一个Maven工程，添加相关的dependencies。

4.0.0

<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>

复制代码注意指定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地址实现。

作者：Smith 链接：juejin.cn/post/684490… 来源：掘金著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。