Shiro学习：一个小Demo

Shiro 简介

简介

Apache Shiro 是 Java 的一个安全框架。目前，使用 Apache Shiro 的人越来越多，因为它相当简单，对比 Spring Security，可能没有 Spring Security 做的功能强大，但是在实际工作时可能并不需要那么复杂的东西，所以使用小而简单的 Shiro 就足够了。对于它俩到底哪个好，这个不必纠结，能更简单的解决项目问题就好了。

Shiro 可以非常容易的开发出足够好的应用，其不仅可以用在 JavaSE 环境，也可以用在 JavaEE 环境。Shiro 可以帮助我们完成：认证、授权、加密、会话管理、与 Web 集成、缓存等。这不就是我们想要的嘛，而且 Shiro 的 API 也是非常简单；其基本功能点如下图所示：

Authentication：身份认证 / 登录，验证用户是不是拥有相应的身份；

Authorization：授权，即权限验证，验证某个已认证的用户是否拥有某个权限；即判断用户是否能做事情，常见的如：验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限；

Session Manager：会话管理，即用户登录后就是一次会话，在没有退出之前，它的所有信息都在会话中；会话可以是普通 JavaSE 环境的，也可以是如 Web 环境的；

Cryptography：加密，保护数据的安全性，如密码加密存储到数据库，而不是明文存储；

Web Support：Web 支持，可以非常容易的集成到 Web 环境；

Caching：缓存，比如用户登录后，其用户信息、拥有的角色 / 权限不必每次去查，这样可以提高效率；

Concurrency：shiro 支持多线程应用的并发验证，即如在一个线程中开启另一个线程，能把权限自动传播过去；

Testing：提供测试支持；

Run As：允许一个用户假装为另一个用户（如果他们允许）的身份进行访问；

Remember Me：记住我，这个是非常常见的功能，即一次登录后，下次再来的话不用登录了。

记住一点，Shiro 不会去维护用户、维护权限；这些需要我们自己去设计 / 提供；然后通过相应的接口注入给 Shiro 即可。

接下来我们分别从外部和内部来看看 Shiro 的架构，对于一个好的框架，从外部来看应该具有非常简单易于使用的 API，且 API 契约明确；从内部来看的话，其应该有一个可扩展的架构，即非常容易插入用户自定义实现，因为任何框架都不能满足所有需求。

首先，我们从外部来看 Shiro 吧，即从应用程序角度的来观察如何使用 Shiro 完成工作。如下图：

可以看到：应用代码直接交互的对象是 Subject，也就是说 Shiro 的对外 API 核心就是 Subject；其每个 API 的含义：

Subject：主体，代表了当前 “用户”，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是 Subject，如网络爬虫，机器人等；即一个抽象概念；所有 Subject 都绑定到 SecurityManager，与 Subject 的所有交互都会委托给 SecurityManager；可以把 Subject 认为是一个门面；SecurityManager 才是实际的执行者；

SecurityManager：安全管理器；即所有与安全有关的操作都会与 SecurityManager 交互；且它管理着所有 Subject；可以看出它是 Shiro 的核心，它负责与后边介绍的其他组件进行交互，如果学习过 SpringMVC，你可以把它看成 DispatcherServlet 前端控制器；

Realm：域，Shiro 从从 Realm 获取安全数据（如用户、角色、权限），就是说 SecurityManager 要验证用户身份，那么它需要从 Realm 获取相应的用户进行比较以确定用户身份是否合法；也需要从 Realm 得到用户相应的角色 / 权限进行验证用户是否能进行操作；可以把 Realm 看成 DataSource，即安全数据源。

也就是说对于我们而言，最简单的一个 Shiro 应用：

1. 应用代码通过 Subject 来进行认证和授权，而 Subject 又委托给 SecurityManager；
2. 我们需要给 Shiro 的 SecurityManager 注入 Realm，从而让 SecurityManager 能得到合法的用户及其权限进行判断。

从以上也可以看出，Shiro 不提供维护用户 / 权限，而是通过 Realm 让开发人员自己注入。

接下来我们来从 Shiro 内部来看下 Shiro 的架构，如下图所示：

Subject：主体，可以看到主体可以是任何可以与应用交互的 “用户”；

SecurityManager：相当于 SpringMVC 中的 DispatcherServlet 或者 Struts2 中的 FilterDispatcher；是 Shiro 的心脏；所有具体的交互都通过 SecurityManager 进行控制；它管理着所有 Subject、且负责进行认证和授权、及会话、缓存的管理。

Authenticator：认证器，负责主体认证的，这是一个扩展点，如果用户觉得 Shiro 默认的不好，可以自定义实现；其需要认证策略（Authentication Strategy），即什么情况下算用户认证通过了；

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

Realm：可以有 1 个或多个 Realm，可以认为是安全实体数据源，即用于获取安全实体的；可以是 JDBC 实现，也可以是 LDAP 实现，或者内存实现等等；由用户提供；注意：Shiro 不知道你的用户 / 权限存储在哪及以何种格式存储；所以我们一般在应用中都需要实现自己的 Realm；

SessionManager：如果写过 Servlet 就应该知道 Session 的概念，Session 呢需要有人去管理它的生命周期，这个组件就是 SessionManager；而 Shiro 并不仅仅可以用在 Web 环境，也可以用在如普通的 JavaSE 环境、EJB 等环境；所有呢，Shiro 就抽象了一个自己的 Session 来管理主体与应用之间交互的数据；这样的话，比如我们在 Web 环境用，刚开始是一台 Web 服务器；接着又上了台 EJB 服务器；这时想把两台服务器的会话数据放到一个地方，这个时候就可以实现自己的分布式会话（如把数据放到 Memcached 服务器）；

SessionDAO：DAO 大家都用过，数据访问对象，用于会话的 CRUD，比如我们想把 Session 保存到数据库，那么可以实现自己的 SessionDAO，通过如 JDBC 写到数据库；比如想把 Session 放到 Memcached 中，可以实现自己的 Memcached SessionDAO；另外 SessionDAO 中可以使用 Cache 进行缓存，以提高性能；

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

Cryptography：密码模块，Shiro 提高了一些常见的加密组件用于如密码加密 / 解密的。

案例

• Subject 用户
• SecurityManager 管理用户
• Realm 连接数据

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-T9knmfn8-1594654753442)(D:\我\MyBlog\Shiro 简介.assets\image-20200713105531285.png)]

简单实验：

1. 导入依赖

   <dependency>
       <groupId>org.apache.shirogroupId>
       <artifactId>shiro-springartifactId>
       <version>1.5.3version>
   dependency>
   

2. 编写Shiro配置类

   @Configuration
   public class ShrioConfig {
       //ShiroFilterFactoryBean : Step3
       @Bean
       public ShiroFilterFactoryBean getShrioFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager){
           ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
           //设置安全管理器
           bean.setSecurityManager(defaultWebSecurityManager);
           return bean;
       }
       
       //DefaultWebSecurityManager : Step2
       @Bean("securityManager")
       public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm){
           DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
           //关联userRealm
           securityManager.setRealm(userRealm);
           return securityManager;
       }
       
       //创建 realm 对象, 需要自定义类：Step1
       @Bean
       public UserRealm userRealm(){
           return new UserRealm();
       }
   }
   

3. 自定义UserRealm

   //自定义的 UserRealm
   public class UserRealm extends AuthorizingRealm {
   
       //授权
       @Override
       protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
           return null;
       }
   
       //认证
       @Override
       protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
           return null;
       }
   }
   

一个小Demo:

1. 导入依赖

   • springboot-mybatis整合
   • shiro-thymelea整合

   
   <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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0modelVersion>
       <parent>
           <groupId>org.springframework.bootgroupId>
           <artifactId>spring-boot-starter-parentartifactId>
           <version>2.3.1.RELEASEversion>
           <relativePath/> 
       parent>
       <groupId>com.kuanggroupId>
       <artifactId>shiro-springbootartifactId>
       <version>0.0.1-SNAPSHOTversion>
       <name>shiro-springbootname>
       <description>Demo project for Spring Bootdescription>
   
       <properties>
           <java.version>1.8java.version>
       properties>
   
       <dependencies>
           
           <dependency>
               <groupId>com.github.theborakompanionigroupId>
               <artifactId>thymeleaf-extras-shiroartifactId>
               <version>2.0.0version>
           dependency>
   
           <dependency>
               <groupId>mysqlgroupId>
               <artifactId>mysql-connector-javaartifactId>
               <version>8.0.20version>
           dependency>
           
           <dependency>
               <groupId>log4jgroupId>
               <artifactId>log4jartifactId>
               <version>1.2.17version>
           dependency>
           <dependency>
               <groupId>com.alibabagroupId>
               <artifactId>druidartifactId>
               <version>1.1.22version>
           dependency>
           
           <dependency>
               <groupId>org.mybatis.spring.bootgroupId>
               <artifactId>mybatis-spring-boot-starterartifactId>
               <version>2.1.1version>
           dependency>
           <dependency>
               <groupId>org.projectlombokgroupId>
               <artifactId>lombokartifactId>
               <version>1.18.12version>
           dependency>
           <dependency>
               <groupId>org.apache.shirogroupId>
               <artifactId>shiro-springartifactId>
               <version>1.5.3version>
           dependency>
           <dependency>
               <groupId>org.springframework.bootgroupId>
               <artifactId>spring-boot-starter-thymeleafartifactId>
           dependency>
           <dependency>
               <groupId>org.springframework.bootgroupId>
               <artifactId>spring-boot-starter-webartifactId>
           dependency>
   
           <dependency>
               <groupId>org.springframework.bootgroupId>
               <artifactId>spring-boot-starter-testartifactId>
               <scope>testscope>
               <exclusions>
                   <exclusion>
                       <groupId>org.junit.vintagegroupId>
                       <artifactId>junit-vintage-engineartifactId>
                   exclusion>
               exclusions>
           dependency>
       dependencies>
   
       <build>
           <plugins>
               <plugin>
                   <groupId>org.springframework.bootgroupId>
                   <artifactId>spring-boot-maven-pluginartifactId>
               plugin>
           plugins>
       build>
   
   project>
   

2. 整合MyBatis

   • 编写实体类
   • 编写mapper接口、mapper.xml、application.yml配置mybatis（别名，mapper.xml文件位置)
   • 编写service接口，serviceImpl类
     

3. 编写Shiro配置类

   @Configuration
   public class ShrioConfig {
   
       //ShiroFilterFactoryBean : Step3
       @Bean
       public ShiroFilterFactoryBean getShrioFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager){
           ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
           //设置安全管理器
           bean.setSecurityManager(defaultWebSecurityManager);
   
           //添加shiro的内置过滤器
           /*
               anno: 无需认证就可以访问
               authc: 必须认证了才可以访问
               user: 必须拥有 记住我 功能才能用
               perms: 拥有对某个资源的权限才能访问
               role: 拥有某个角色权限才能访问
           */
   
           Map<String, String> filterMap = new LinkedHashMap<>();
   
           //用户授权,正常情况下没有授权会跳转到授权页面
           filterMap.put("/user/add","perms[user:add]");
           filterMap.put("/user/update","perms[user:update]");
   
           //拦截
           //filterMap.put("/user/add","authc");
           //filterMap.put("/user/update","authc");
           filterMap.put("/user/*","authc");
   
           //设置登录请求
           bean.setLoginUrl("/toLogin");
           //设置未授权页面
           bean.setUnauthorizedUrl("/noauth");
           bean.setFilterChainDefinitionMap(filterMap);
           return bean;
       }
   
       //DefaultWebSecurityManager : Step2
       @Bean("securityManager")
       public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm){
           DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
           //关联userRealm
           securityManager.setRealm(userRealm);
           return securityManager;
       }
   
       //创建 realm 对象, 需要自定义类：Step1
       @Bean
       public UserRealm userRealm(){
           return new UserRealm();
       }
   
       //整合 ShiroDialect:用来整合shiro thymeleaf
       @Bean
       public ShiroDialect getShiroDialect(){
           return new ShiroDialect();
       }
   }
   

4. 自定义UserRealm

   //自定义的 UserRealm
   public class UserRealm extends AuthorizingRealm {
   
       @Autowired
       UserServiceImpl userService;
   
       //授权
       @Override
       protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
           System.out.println("执行了 => doGetAuthorizationInfo");
   
           SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
           // 拿到当前登录的这个对象
           Subject subject = SecurityUtils.getSubject();
           // 拿到User对象
           User currentUser = (User) subject.getPrincipal();
           // 设置当前用户的权限
           System.out.println(currentUser.getName() + "的权限为 " + currentUser.getPerms());
           info.addStringPermission(currentUser.getPerms());
   
           return info;
       }
   
       //认证
       @Override
       protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
           System.out.println("执行了 => 认证AuthenticationToken");
   
           UsernamePasswordToken userToken = (UsernamePasswordToken) authenticationToken;
           //连接真实的数据库
           User user = userService.queryUserByName(userToken.getUsername());
           if(user == null){
               //没有这个人
               return null; //抛出异常 UnknownAccountException
           }
   
           // 登录成功 将用户信息存入session
           Subject currentSubject = SecurityUtils.getSubject();
           Session session = currentSubject.getSession();
           session.setAttribute("loginUser",user.getName());
   
           // 密码认证，shiro做
           return new SimpleAuthenticationInfo(user,user.getPassword(),"");
       }
   }
   

详细代码：https://gitee.com/daniel1996/shiro_springboot/tree/master/shiro-springboot