SpringBoot：整合Shiro

目录

• 1、Shiro简介
  • 1.1、什么是Shiro？
  • 1.2、有哪些功能
  • 1.3、Shiro架构（外部）
  • 1.4、Shiro架构（内部）
• 2、HelloWorld
• 3、Shiro整合Spring Boot
  • 3.1、环境搭建
  • 3.2、登录拦截
  • 3.3、用户认证
  • 3.4、Shiro整合MyBatis
  • 3.5、用户授权
  • 3.6、Shiro整合Thymeleaf

Shiro的简单介绍、入门Shiro、SpringBoot整合Shiro，登录拦截、用户认证和授权、Shiro整合Thymeleaf。

1、Shiro简介

1.1、什么是Shiro？

• Apache Shiro 是一个Java的安全（权限）框架。
• Shiro可以非常容易的开发出足够好的应用，其不仅可以应用在JavaSE环境，也可以应用在JavaEE环境。
• Shiro可以完成，认证，授权，加密，会话管理，Web集成，缓存等
• 下载地址

1.2、有哪些功能

• Authentication: 身份认证，有时被被称登录，验证用户用户是不是拥有相应的身份。
• Authorization: 授权，即权限验证，验证某个已认证的用户是否拥有某个权限，即判断用户能否进行什么操作，如：验证某个用户是否拥有某个角色，或者细粒度的验证某个用户对某个资源是否具有某个权限！
• Session Management: 会话管理，即用户登录后就是一次会话，在没有退出之前，它的所有信息都在会话中；会话可以是普通的JavaSE环境，也可以是Web环境。
• Cryptography: 加密，保护数据的安全性，如密码加密存储到数据库中，而不是明文存储；
• Web Support：Web支持，可以非常容易的集成到Web环境；
• Caching：缓存，比如用户登录后，其用户信息，拥有的角色、权限不必每次去查，这样可以提高效率。
• Concurrency：Shiro支持多线程应用的并发验证，即，如在一个线程中开启另一个线程，能不权限自动的传播过去。
• Testing：提供测试的支持。
• Run As：允许一个用户假装为另一个用户（如果它们允许）的身份进行访问；
• Remember Me：记住我，这是个非常常见的功能，即一次登录后，下次再来的话，不用再登录了；

1.3、Shiro架构（外部）

从外部看Shiro，即从应用程序角度来观察如何使用Shrio完成工作：

• subject：应用代码直接交互的对象是 Subject，也就是说Shiro的对外API核心就是Subjcet，Subject代表了当前用户，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是 Subject，如网络爬虫，机器人等，与Subject的所有交互都会委托给 SecurityManager；Subject其实是一个门面，SecurityManager才是实际的执行者。
• SecurityManager：安全管理器；及所有与安全有关的操作都会与SecurityManager交互，并且它管理所有的Subject，可以看出它是Shirot的核心，它负责与Shiro的其他组件进行交互，它相当于SpringMVC的DispatchServlet的角色
• Realm：Shiro从Realm获取安全数据（如用户、角色、权限），也就是说SecurityManager要验证用户身份，那么它需要从Realm获取相应的用户进行比较，来确定用户的身份是否合法；也需要从Realm得到用户相应的角色、权限，进行验证用户的操作是否能够进行，可以把Realm看成DataSource。

1.4、Shiro架构（内部）

• Subjetc：任何可以与用户交互的"用户"；

• Security Manager：相当于SpringMVC中的DispathcServlet；是Shiro的心脏，所有具体的交互都通过Security Manager进行控制，他管理所有的Subjcet，且负责进行认证、授权、会话、及缓存的管理。

• Authenticator：负责Subject认证，是一个扩展点，可以自定义实现；可以使用认证策略（Authoentication Strategy），即什么情况下算用户认证通过了；

• Authorizer：授权器，及访问控制器，用来决定主体是否有权限进行相应的操作；即控制着用户能访问应用中的哪些功能；

• Realm：可以有一个或者多个 realm，可以认为是安全实体数据源，即用于获取安全实体，可以用JDBC实现，也可以是内存实现等等，由用户提供；所以一般在应用中都需要实现自己的realm

• SessionManager：管理Session生命周期的组件，而Shiro并不仅可以用在Web环境，也可以用在普通的JavaSE环境中。

• CacherManager：缓存控制器，来管理用户、角色、权限等缓存的；因为这些数据基本上很少改变，放到缓存中可以提高访问的性能。

• Cryptography：密码模块，Shiro提供了一些常见的加密组件，用于加密和解密。

2、HelloWorld

第一步：导入依赖

<dependency>
  <groupId>org.apache.shiro</groupId>
  <artifactId>shiro-core</artifactId>
  <version>1.4.1</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-simple</artifactId>
  <version>1.7.21</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>jcl-over-slf4j</artifactId>
  <version>1.7.21</version>
</dependency>

<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

第二步：配置文件

Shiro 默认使用的日志是 commons-logging

shiro.ini

# =============================================================================
# Tutorial INI configuration
#
# Usernames/passwords are based on the classic Mel Brooks' film "Spaceballs" :)
# =============================================================================

# -----------------------------------------------------------------------------
# Users and their (optional) assigned roles
# username = password, role1, role2, ..., roleN
# -----------------------------------------------------------------------------
[users]
root = secret, admin
guest = guest, guest
presidentskroob = 12345, president
darkhelmet = ludicrousspeed, darklord, schwartz
lonestarr = vespa, goodguy, schwartz

# -----------------------------------------------------------------------------
# Roles with assigned permissions
# roleName = perm1, perm2, ..., permN
# -----------------------------------------------------------------------------
[roles]
admin = *
schwartz = lightsaber:*
goodguy = winnebago:drive:eagle5

log4j.properties

log4j.rootLogger=INFO, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n

# General Apache libraries
log4j.logger.org.apache=WARN

# Spring
log4j.logger.org.springframework=WARN

# Default Shiro logging
log4j.logger.org.apache.shiro=INFO

# Disable verbose logging
log4j.logger.org.apache.shiro.util.ThreadContext=WARN
log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

第三步：HelloWorld

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.Factory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Quickstart {

    private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);

    public static void main(String[] args) {

        Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
        SecurityManager securityManager = factory.getInstance();
        SecurityUtils.setSecurityManager(securityManager);

        // 获取Subject对象
        Subject currentUser = SecurityUtils.getSubject();

        // 获取Session，不需要web容器获取EJB容器
        Session session = currentUser.getSession();
        session.setAttribute("key", "Value");
        String value = (String) session.getAttribute("key");
        if (value.equals("Value")) {
            log.info("session=>key= [" + value + "]");
        }

        // 判断当前用户是否被认证
        if (!currentUser.isAuthenticated()) {

            // Token：令牌
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            // 记住我
            token.setRememberMe(true);
            try {
                // 登录
                currentUser.login(token);
            } catch (UnknownAccountException uae) {
                log.info("There is no user with username of " + token.getPrincipal());
            } catch (IncorrectCredentialsException ice) {
                log.info("Password for account " + token.getPrincipal() + " was incorrect!");
            } catch (LockedAccountException lae) {
                log.info("The account for username " + token.getPrincipal() + " is locked.  " +
                        "Please contact your administrator to unlock it.");
            }
            // ... catch more exceptions here (maybe custom ones specific to your application?
            catch (AuthenticationException ae) {
                //unexpected condition?  error?
            }
        }

        //say who they are:
        //print their identifying principal (in this case, a username):
        log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");

        // 
        if (currentUser.hasRole("schwartz")) {
            log.info("May the Schwartz be with you!");
        } else {
            log.info("Hello, mere mortal.");
        }

        // 粗粒度
        if (currentUser.isPermitted("lightsaber:wield")) {
            log.info("You may use a lightsaber ring.  Use it wisely.");
        } else {
            log.info("Sorry, lightsaber rings are for schwartz masters only.");
        }

        // 细粒度
        if (currentUser.isPermitted("winnebago:drive:eagle5")) {
            log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'.  " +
                    "Here are the keys - have fun!");
        } else {
            log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
        }

        //all done - log out!
        currentUser.logout();

        System.exit(0);
    }
}

日志输出结果：

方法：Spring Security 中也有！

// 获取Subject对象
Subject currentUser = SecurityUtils.getSubject();
// 获取Session，不需要web容器获取EJB容器
Session session = currentUser.getSession();
// 判断当前用户是否被认证
currentUser.isAuthenticated()
// 登录
currentUser.login(token);
// 获取包含当前授权用户的名称的一些信息
currentUser.getPrincipal()
// 判断该用户是否有该角色
currentUser.hasRole("schwartz")
// 验证权限
currentUser.isPermitted("lightsaber:wield")
// 登出
currentUser.logout();

3、Shiro整合Spring Boot

3.1、环境搭建

导入依赖

<!--shiro springboot 整合包-->
<dependency>
    <groupId>org.apache.shiro</groupId>
    <artifactId>shiro-spring</artifactId>
    <version>1.4.1</version>
</dependency>

编写首页

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

<h1>首页</h1>
<h2 th:text="${msg}"></h2>

<a th:href="@{/user/toAdd}">添加</a> | 
<a th:href="@{/user/toUpdate}">修改</a>

</body>
</html>

编写Controller

@Controller
public class MyController {

    @RequestMapping({"/", "/index"})
    public String toIndex(Model model) {

        model.addAttribute("msg", "hello,shiro");
        return "index";
    }
     
    @GetMapping("/user/toAdd")
    public String toAdd() {
        return "user/add";
    }

    @GetMapping("/user/toUpdate")
    public String toUpdate() {
        return "user/update";
    }

}

UserRealm

// 自定义的 Realm，需要继承 AuthorizingRealm
public class UserRealm extends AuthorizingRealm {

    // 授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        System.out.println("执行了=>授权doGetAuthorizationInfo");
        return null;
    }


    // 认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        System.out.println("执行了=>认证doGetAuthorizationInfo");
        return null;
    }
}

ShiroConfig

package com.rainszj.config;

import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ShiroConfig {

    // ShiroFilterFactoryBean:3
    @Bean
    public ShiroFilterFactoryBean shiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {

        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        // 设置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);

        return bean;
    }


    // DefaultWebSecuriyManager:2
    @Bean(name = "securityManager")
    public DefaultWebSecurityManager defaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();

        // 关联 Realm
        securityManager.setRealm(userRealm);

        return securityManager;
    }


    // 创建 Realm 对象，需要自定义:1
    @Bean
    public UserRealm userRealm() {
        return new UserRealm();
    }
}

3.2、登录拦截

编写login页面

<form action="" method="post">
    <p>用户名：<input type="text" name="username"></p>
    <p>密码：<input type="password" name="password"></p>
    <p><input type="submit"></p>
</form>

编写controller

@GetMapping("/toLogin")
public String toLogin() {

    return "login";
}

在 ShiroFilterFactoryBean 中添加

// ShiroFilterFactoryBean:3
@Bean
public ShiroFilterFactoryBean shiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {

  ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
  // 设置安全管理器
  bean.setSecurityManager(defaultWebSecurityManager);

  /*
		anon：无需认证就可以访问
		authc：必须认证了才能访问
		user：必须拥有记住我功能才能使用
		perms：拥有对某个资源的权限才能访问
		role：拥有某个角色权限才能访问
		// filterMap.put("/user/toAdd", "authc");
		// filterMap.put("/user/toUpdate", "authc");
  */
    
  // 添加shior内置的过滤器：
  // 和 Druid 一样，往 Map里put值
  Map<String, String> filterMap = new LinkedHashMap<>();
  // 拦截请求路径
  filterMap.put("/user/*", "authc");
  
  bean.setFilterChainDefinitionMap(filterMap);
  // 登录拦截
  bean.setLoginUrl("/toLogin");

  return bean;
}

在首页中再次点击 修改和添加按钮时，会跳到登录页面！

3.3、用户认证

在Contorller里面写一个登录的请求

@RequestMapping("/login")
public String login(String username, String password, Model model) {
    // 获取当前的用户
    Subject subject = SecurityUtils.getSubject();
    // 封装用户登录的数据
    UsernamePasswordToken token = new UsernamePasswordToken(username, password);

    try {
        // 执行登录的方法，如果没有异常说明就 OK！
        subject.login(token);

        return "index";
    } catch (UnknownAccountException e) {  // 用户名不存在
        model.addAttribute("msg", "用户名错误");

        return "login";
    } catch (IncorrectCredentialsException e) {  // 密码不存在
        model.addAttribute("msg", "密码错误");

        return "login";
    }

}

在登录页面显示返回的数据

<p th:text="${msg}" style="color:red;"></p>

这时随便输入用户名和密码，会看到后台进入了 protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token)这个认证方法

在UserRealm中

// 认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
    System.out.println("执行了=>认证doGetAuthorizationInfo");

    // 用户名，密码，数据库中取
    String username = "root";
    String password = "123456";

    // 这里的Token，是全局的，你在 login方法中设置了，这里可以获取到
    UsernamePasswordToken userToken = (UsernamePasswordToken) token;

    if (!userToken.getUsername().equals(username)) {
        // shiro 会自动帮我们抛出用户名错误的异常
        return null;
    }

    // 密码认证 Shiro 自动帮我们做
    // 获取当前用户的认证
    // 获取当前密码的对象
    // 获取认证名

    return new SimpleAuthenticationInfo("", password, "");
}

SimpleAuthenticationInfo的参数：

AuthenticationInfo是一个接口，我们返回它的实现类：

3.4、Shiro整合MyBatis

Shiro整合MyBatis和前面SpringBoot整合Mybatis是一样的，无非这次认证的时候，数据是从数据库中查出来的！在Realm中进行验证。

在SpringBoot整合MyBatis时有，这里不再重复赘述！步骤：

• 导入 mysql-connecotr-java、druid，log4j、mybatis-spring-boot-starter 的依赖
• 创建pojo实体类
• 编写mapper接口
• 编写相应的mapper配置文件
• 编写service层

整合完毕，别忘了先测试是否成功！

目录结构：

主要是在自定义的 Realm中添加了一些代码：

package com.rainszj.shiro;

import com.rainszj.pojo.User;
import com.rainszj.service.UserService;
import org.apache.shiro.authc.*;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.springframework.beans.factory.annotation.Autowired;

// 自定义的 Realm，需要继承 AuthorizingRealm
public class UserRealm extends AuthorizingRealm {

    @Autowired
    private UserService userService;

    // 授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        System.out.println("执行了=>授权doGetAuthorizationInfo");
        return null;
    }


    // 认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        System.out.println("执行了=>认证doGetAuthorizationInfo");

        // 这里的Token，是全局的，你在 login方法中设置了，这里可以获取到
        UsernamePasswordToken userToken = (UsernamePasswordToken) token;

        // 从数据库中获取用户名和密码
        User user = userService.queryUserByName(userToken.getUsername());

        if (user == null) { // 没有这个人
            return null;    // UnknownAccountException
        }

        // 可以加密，例如：MD5加密，MD5盐值加密
        return new SimpleAuthenticationInfo("", user.getPwd(), "");
    }
}

3.5、用户授权

先模拟权限操作

在 ShiroCofig 的 ShiroFilterFactoryBean中：

 // ShiroFilterFactoryBean:3
    @Bean
    public ShiroFilterFactoryBean shiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {

        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        // 设置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);

        /*
            anon：无需认证就可以访问
            authc：必须认证了才能访问
            user：必须拥有记住我功能才能使用
            perms：拥有对某个资源的权限才能访问
            role：拥有某个角色权限才能访问
            // filterMap.put("/user/add", "authc");
            // filterMap.put("/user/update", "authc");

         */
        // 添加shior内置的过滤器：
        // 和 Druid 一样，往 Map里put值
        // 拦截
        Map<String, String> filterMap = new LinkedHashMap<>();
				
      	// 设置权限
        filterMap.put("/user/toAdd", "perms[user:add]");
        filterMap.put("/user/toUpdate", "perms[user:update]");

        filterMap.put("/user/*", "authc");

        bean.setFilterChainDefinitionMap(filterMap);

        // 登录拦截
        bean.setLoginUrl("/toLogin");
        // 未经授权，跳转的页面
        bean.setUnauthorizedUrl("/noauth");

        return bean;
    }

编写noauth请求：

@RequestMapping("/noauth")
@ResponseBody
public String unauthorized() {
    return "未经授权，无法访问！";
}

在自定义的 Realm中给用户设置权限，应该在数据库中用户有权限的属性！

public class UserRealm extends AuthorizingRealm {

    @Autowired
    private UserService userService;

    // 授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        System.out.println("执行了=>授权doGetAuthorizationInfo");

        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();

         info.addStringPermission("user:add");

        return info;
    }

现在可以访问：http://localhost:8080，测试一下相应页面的能否访问！

现在在数据库中给用户添加 权限 的域对象，也就是添加一列权限的属性

修改User对象：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private int id;
    private String name;
    private String pwd;
    private String perms;
}

ShiroConfig

@Configuration
public class ShiroConfig {

    // ShiroFilterFactoryBean:3
    @Bean
    public ShiroFilterFactoryBean shiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {

        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        // 设置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);

        /*
            anon：无需认证就可以访问
            authc：必须认证了才能访问
            user：必须拥有记住我功能才能使用
            perms：拥有对某个资源的权限才能访问
            role：拥有某个角色权限才能访问
            // filterMap.put("/user/add", "authc");
            // filterMap.put("/user/update", "authc");

         */
        // 添加shior内置的过滤器：
        // 和 Druid 一样，往 Map里put值
        // 拦截
        Map<String, String> filterMap = new LinkedHashMap<>();

        filterMap.put("/user/toAdd", "perms[user:add]");
        filterMap.put("/user/toUpdate", "perms[user:update]");
        filterMap.put("/user/*", "authc");

        bean.setFilterChainDefinitionMap(filterMap);

        // 登录拦截
        bean.setLoginUrl("/toLogin");
        // 未经授权，跳转的页面
        bean.setUnauthorizedUrl("/noauth");
        return bean;
    }
  // DefaultSecurityManager：2
  
  // 自定义的Realm：1
}

在 UserRealm 做如下修改：

登出请求：

@GetMapping("/logout")
public String logout() {
    // 获取当前用户
    Subject subject = SecurityUtils.getSubject();

    subject.logout();
    return "redirect:index";
}

测试一下就OK！

总的来说在自定义的 Realm 对象中有两个方法，

一个授权：protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals)

一个认证：protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token)，用户登录会走认证方法，访问页面会走授权方法，在认证方法中查询该用户是否在数据库中存在，在授权方法中设置该用户拥有的相应权限，这里的权限是对访问路径的权限，也就是访问页面的权限，对路径权限的设置在 ShiroFilterFactoryBean中设置。

3.6、Shiro整合Thymeleaf

官网

首先导入 Shiro整合 Thymeleaf 的依赖

<!--shiro thymeleaf 整合包-->
<dependency>
    <groupId>com.github.theborakompanioni</groupId>
    <artifactId>thymeleaf-extras-shiro</artifactId>
    <version>2.0.0</version>
</dependency>

shiro的thymeleaf的命名空间：

xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro"

首先要在 Shiro 的Config中添加 ShiroDielect（Shiro方言）：

// ShiroDialect：用来整合 thymeleaf
@Bean
public ShiroDialect getShiroDialect() {
    return new ShiroDialect();
}

这里放到 UserRealm 的认证方法中：

// 将查询的用户存入到Shiro的Session中
Subject currentSubject = SecurityUtils.getSubject();
Session session = currentSubject.getSession();
session.setAttribute("loginUser", user);

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org"
      xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

<h1>首页</h1>
<h2 th:text="${msg}"></h2>
<!--从Session中取值判断！不能用getXX方法-->
<div th:if="${session.loginUser == null}">
    <a th:href="@{/toLogin}">登录</a>
</div>
  
<div th:if="${session.loginUser != null}">
    <p>欢迎您，<span th:text="${session.loginUser.name}"></span></p>
    <a th:href="@{/logout}">登出</a>
</div>

<hr/>
<div shiro:hasPermission="user:add">
    <a th:href="@{/user/toAdd}">添加</a>
</div>

<div shiro:hasPermission="user:update">
    <a th:href="@{/user/toUpdate}">修改</a>
</div>
</body>
</html>