SpringBoot整合Shiro

2022-10-05 | 0 评论 | 0 浏览

SpringBoot整合Shiro

1.Shiro概述

1.Shiro是什么

Apache Shiro 是一个功能强大且易于使用的 Java 安全(权限)框架。Shiro 可以完

成：认证、授权、加密、会话管理、与 Web 集成、缓存等。借助 Shiro 您可以快速轻松

地保护任何应用程序——从最小的移动应用程序到最大的 Web 和企业应用程序。

官网：https://shiro.apache.org/

2.为什么要用shiro

自 2003 年以来，框架格局发生了相当大的变化，因此今天仍然有很多系统在使用

Shiro。这与 Shiro 的特性密不可分。

易于使用：使用 Shiro 构建系统安全框架非常简单。就算第一次接触也可以快速掌

握。

全面：Shiro 包含系统安全框架需要的功能，满足安全需求的“一站式服务”。

灵活：Shiro 可以在任何应用程序环境中工作。虽然它可以在 Web、EJB 和 IoC 环境

中工作，但不需要依赖它们。Shiro 也没有强制要求任何规范，甚至没有很多依赖项。

强力支持 Web：Shiro 具有出色的 Web 应用程序支持，可以基于应用程序 URL 和

Web 协议（例如 REST）创建灵活的安全策略，同时还提供一组 JSP 库来控制页面输出。

兼容性强：Shiro 的设计模式使其易于与其他框架和应用程序集成。Shiro 与

Spring、Grails、Wicket、Tapestry、Mule、Apache Camel、Vaadin 等框架无缝集成。

社区支持：Shiro 是 Apache 软件基金会的一个开源项目，有完备的社区支持，文档

支持。如果需要，像 Katasoft 这样的商业公司也会提供专业的支持和服务。

3.Shiro 与 SpringSecurity 的对比

1、Spring Security 基于 Spring 开发，项目若使用 Spring 作为基础，配合 Spring
Security 做权限更加方便，而 Shiro 需要和 Spring 进行整合开发；
2、Spring Security 功能比 Shiro 更加丰富些，例如安全维护方面；
3、Spring Security 社区资源相对比 Shiro 更加丰富；
4、Shiro 的配置和使用比较简单，Spring Security 上手复杂些；
5、Shiro 依赖性低，不需要任何框架和容器，可以独立运行.Spring Security 依赖
Spring 容器；
6、shiro 不仅仅可以使用在 web 中，它可以工作在任何应用环境中。在集群会话时 Shiro
最重要的一个好处或许就是它的会话是独立于容器的。

4.基本功能

1、基本功能点如下图所示

2、功能简介

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

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

5.原理

1、Shiro 架构(Shiro 外部来看)

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

Shiro 架构

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

2、Shiro 架构(Shiro 内部来看)

Shiro 架构
（1）Subject：任何可以与应用交互的“用户”；

（2）SecurityManager ：相当于 SpringMVC 中的 DispatcherServlet；是 Shiro 的心
脏；所有具体的交互都通过 SecurityManager 进行控制；它管理着所有 Subject、且负
责进行认证、授权、会话及缓存的管理。
（3）Authenticator：负责 Subject 认证，是一个扩展点，可以自定义实现；可以使用认
证策略（Authentication Strategy），即什么情况下算用户认证通过了；
（4）Authorizer：授权器、即访问控制器，用来决定主体是否有权限进行相应的操作；即
控制着用户能访问应用中的哪些功能；
（5）Realm：可以有 1 个或多个 Realm，可以认为是安全实体数据源，即用于获取安全实
体的；可以是 JDBC 实现，也可以是内存实现等等；由用户提供；所以一般在应用中都需
要实现自己的 Realm；（6）SessionManager：管理 Session 生命周期的组件；而 Shiro 并不仅仅可以用在 Web
环境，也可以用在如普通的 JavaSE 环境
（7）CacheManager：缓存控制器，来管理如用户、角色、权限等的缓存的；因为这些数据
基本上很少改变，放到缓存中后可以提高访问的性能
（8）Cryptography：密码模块，Shiro 提高了一些常见的加密组件用于如密码加密/解
密。

2.shiro基本使用

1.环境准备

1、Shiro不依赖容器，直接创建maven工程即可

2、添加依赖

<dependency>
   <groupId>org.apache.shiro</groupId>
   <artifactId>shiro-core</artifactId>
   <version>1.9.0</version>
</dependency>
<dependency>
   <groupId>commons-logging</groupId>
   <artifactId>commons-logging</artifactId>
   <version>1.2</version>
</dependency>

2.在类路径下创建ini文件

Shiro 获取权限相关信息可以通过数据库获取，也可以通过 ini 配置文件获取

1、创建ini文件

3.登录认证

1、登录认证概念

（1）身份验证：一般需要提供如身份ID等一些标识信息来表明登录者的身份，如提供
email，用户名/密码来证明。
（2）在shiro中，用户需要提供principals（身份）和credentials（证明）给shiro，从
而应用能验证用户身份：

（3）principals：身份，即主体的标识属性，可以是任何属性，如用户名、邮箱等，唯一
即可。一个主体可以有多个principals，但只有一个Primary principals，一般是用户名/
邮箱/手机号。
（4）credentials：证明/凭证，即只有主体知道的安全值，如密码/数字证书等。
（5）最常见的principals和credentials组合就是用户名/密码

2、登录认证基本流程

（1）收集用户身份/凭证，即如用户名/密码
（2）调用 Subject.login 进行登录，如果失败将得到相应的 AuthenticationException
异常，根据异常提示用户错误信息；否则登录成功
（3）创建自定义的 Realm 类，继承 org.apache.shiro.realm.AuthenticatingRealm类，
实现 doGetAuthenticationInfo() 方法

3、登录认证实例
创建测试类，获取认证对象，进行登录认证，如下：

/**
 * shiro快速入门
 */
public class ShiroRun {
    public static void main(String[] args) {
        //1.初始化获取SecurityManager,从配置文件获取用户信息
        IniSecurityManagerFactory iniSecurityManagerFactory = new IniSecurityManagerFactory("classpath:shiro.ini");
        SecurityManager securityManager = iniSecurityManagerFactory.getInstance();
        SecurityUtils.setSecurityManager(securityManager);
        //2 获取 Subject 对象
        Subject subject = SecurityUtils.getSubject();
        //3 创建 token 对象，web 应用用户名密码从页面传递
        AuthenticationToken token = new UsernamePasswordToken("llp", "123");
        //4 完成登录
        try {
            subject.login(token);
            System.out.println("登录成功");
        } catch (UnknownAccountException e) {
            e.printStackTrace();
            System.out.println("用户不存在");
        } catch (IncorrectCredentialsException e) {
            e.printStackTrace();
            System.out.println("密码错误");
        } catch (AuthenticationException e) {
            e.printStackTrace();
        }
    }
}

4、身份认证流程

（1）首先调用 Subject.login(token) 进行登录，其会自动委托给 SecurityManager
（2）SecurityManager 负责真正的身份验证逻辑；它会委托给 Authenticator 进行身份
验证；
（3）Authenticator 才是真正的身份验证者，Shiro API 中核心的身份认证入口点，此
处可以自定义插入自己的实现；
（4）Authenticator 可能会委托给相应的 AuthenticationStrategy 进行多 Realm 身份
验证，默认 ModularRealmAuthenticator 会调用 AuthenticationStrategy 进行多 Realm
身份验证；
（5） Authenticator 会把相应的 token 传入 Realm，从 Realm 获取身份验证信息，如
果没有返回/抛出异常表示身份验证失败了。此处可以配置多个Realm，将按照相应的顺序
及策略进行访问。

4.角色授权

1、授权概念

（1）授权，也叫访问控制，即在应用中控制谁访问哪些资源（如访问页面/编辑数据/页面
操作等）。在授权中需了解的几个关键对象：主体（Subject）、资源（Resource）、权
限（Permission）、角色（Role）。
（2）主体(Subject)：访问应用的用户，在 Shiro 中使用 Subject 代表该用户。用户只
有授权后才允许访问相应的资源。
（3）资源(Resource)：在应用中用户可以访问的 URL，比如访问 JSP 页面、查看/编辑
某些数据、访问某个业务方法、打印文本等等都是资源。用户只要授权后才能访问。
（4）权限(Permission)：安全策略中的原子授权单位，通过权限我们可以表示在应用中
用户有没有操作某个资源的权力。即权限表示在应用中用户能不能访问某个资源，如：访
问用户列表页面查看/新增/修改/删除用户数据（即很多时候都是CRUD（增查改删）式权
限控制）等。权限代表了用户有没有操作某个资源的权利，即反映在某个资源上的操作允
不允许。
（5）Shiro 支持粗粒度权限（如用户模块的所有权限）和细粒度权限（操作某个用户的权
限，即实例级别的）
（6）角色(Role)：权限的集合，一般情况下会赋予用户角色而不是权限，即这样用户可
以拥有一组权限，赋予权限时比较方便。典型的如：项目经理、技术总监、CTO、开发工
程师等都是角色，不同的角色拥有一组不同的权限

2、授权方式

（1）编程式：通过写if/else 授权代码块完成

（2）注解式：通过在执行的Java方法上放置相应的注解完成，没有权限将抛出相应的异
常

（3）JSP/GSP 标签：在JSP/GSP 页面通过相应的标签完成

3、授权流程

（1）首先调用Subject.isPermitted*/hasRole*接口，其会委托给SecurityManager，而
SecurityManager接着会委托给 Authorizer；

（2）Authorizer是真正的授权者，如果调用如isPermitted(“user:view”)，其首先会通
过PermissionResolver把字符串转换成相应的Permission实例；
（3）在进行授权之前，其会调用相应的Realm获取Subject相应的角色/权限用于匹配传入
的角色/权限；
（4）Authorizer会判断Realm的角色/权限是否和传入的匹配，如果有多个Realm，会委托
给ModularRealmAuthorizer进行循环判断，如果匹配如isPermitted*/hasRole* 会返回
true，否则返回false表示授权失败

4、授权实例

（1）获取角色信息

给shiro.ini增加角色配置

[users]
llp=123,admin
xh=123,admin

给例子添加代码，沟通过hasRole()判断用户是否有指定角色

try {
    subject.login(token);
    System.out.println("登录成功");
    boolean hasRole = subject.hasRole("admin");
    System.out.println("是否拥有此角色:"+hasRole);
}

（2）判断权限信息信息

给shiro.ini增加权限配置

[users]
llp=123,admin
xh=123,admin

[roles]
admin=user:insert,user:select

给例子添加代码，判断用户是否有指定权限

try {
    subject.login(token);
    System.out.println("登录成功");
    boolean hasRole = subject.hasRole("admin");
    System.out.println("是否拥有此角色:"+hasRole);
    boolean[] permitteds = subject.isPermitted("user:insert", "user:delete");
    for (boolean permitted : permitteds) {
        System.out.println("是否拥有此权限："+permitted);
    }
    //也可以用 checkPermission 方法，但没有返回值，没权限抛 AuthenticationException
    subject.checkPermission("user:select");
}

5.Shiro加密

实际系统开发中，一些敏感信息需要进行加密，比如说用户的密码。Shiro 内嵌很多
常用的加密算法，比如 MD5 加密。Shiro 可以很简单的使用信息加密。
1、使用Shiro进行密码加密

/**
 * 使用ShiroMD5加密密码
 * 固定长度32位
 */
public class ShiroMD5 {
    public static void main(String[] args) {
        //密码明文
        String password = "llp123";
        //使用 md5 加密,org.apache.shiro.crypto.hash.Md5Hash
        Md5Hash md5Hash = new Md5Hash(password);
        System.out.println("使用shiroMD5加密后的密码："+md5Hash);
        //带盐的 md5 加密，盐就是在密码明文后拼接新字符串，然后再进行加密
        Md5Hash md5HashSalt = new Md5Hash(password,"salt");
        System.out.println("使用shiroMD5带盐加密后的密码："+md5HashSalt);
        //为了保证安全，避免被破解还可以多次迭代加密，保证数据安全
        System.out.println("使用shiroMD5带盐连续三次加密："+md5HashSalt.toHex());
        //使用父类实现加密
        SimpleHash simpleHash = new SimpleHash("MD5",password,"salt",3);
        System.out.println("父类带盐三次加密："+simpleHash.toHex());
    }
}

6.Shiro 自定义登录认证

Shiro 默认的登录认证是不带加密的，如果想要实现加密认证需要自定义登录认证，自定义 Realm。

1、自定义登录认证

/**
 * 自定义的登录认证方法，Shiro 的 login 方法底层会调用该类的认证方法完成登录认证
 * 需要配置自定义的 realm 生效，在 ini 文件中配置，或 Springboot 中配置
 * 该方法只是获取进行对比的信息，认证逻辑还是按照 Shiro 的底层认证逻辑完成认证
 */
public class MyRealm extends AuthenticatingRealm {
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        //1 获取身份信息
        String principal = authenticationToken.getPrincipal().toString();
        System.out.println("认证用户信息："+principal);
        //2 获取凭证信息
        //2 获取凭证信息
        String password = new String((char[]) authenticationToken.getCredentials());
        System.out.println("用户登录密码："+password);
        //3 获取数据库中存储的用户信息
        if(principal.equals("llp")){
            //3.1 数据库中取出加盐三次迭代的密码
            String pwdMD5 = "07ca00e10899418f0ea4ab92a9d69065";
            //3.2 创建封装了校验逻辑的对象，将要比较的数据给该对象
            AuthenticationInfo info = new SimpleAuthenticationInfo(
                    authenticationToken.getPrincipal(),
                    pwdMD5,
                    ByteSource.Util.bytes("salt"),
                    authenticationToken.getPrincipal().toString());
            return info;

        }
        //4 创建封装校验逻辑对象，封装数据返回
        return null;
    }
}

2、在shiro.ini中添加配置信息

[users]
llp=07ca00e10899418f0ea4ab92a9d69065,admin
xh=07ca00e10899418f0ea4ab92a9d69065,admin

[roles]
admin=user:insert,user:select

[main]
md5CredentialsMatcher=org.apache.shiro.authc.credential.Md5CredentialsMatcher
md5CredentialsMatcher.hashIterations=3

#指定MyRealm
myrealm=com.llp.MyRealm
myrealm.credentialsMatcher=$md5CredentialsMatcher
securityManager.realms=$myrealm

3、运行测试

3.Spring Boot整合Shiro

1.框架整合

1、创建springboot-maven工程

2、添加依赖

<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.2.1.RELEASE</version>
   </parent> <dependencies>
   <dependency>
      <groupId>org.apache.shiro</groupId>
      <artifactId>shiro-spring-boot-web-starter</artifactId>
      <version>1.9.0</version>
   </dependency>

   <!--mybatis-plus-->
   <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.0.5</version>
   </dependency>
   <!--mysql-->
   <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.46</version>
   </dependency>
   <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
   </dependency>
   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-thymeleaf</artifactId>
   </dependency>
</dependencies>

3、添加配置文件

添加配置文件 application.yml，添加基础配置

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/shirodb?characterEncoding=utf-8&useSSL=false
    username: root
    password: root
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8


mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  mapper-locations: classpath:mapper/*.xml



shiro:
  loginUrl: /login

4、添加启动类

@SpringBootApplication
@MapperScan(basePackages="com.llp.shiro.mapper")
public class ShiroApplication {
    public static void main(String[] args) {
        SpringApplication.run(ShiroApplication.class,args);
    }

2.登录认证实现

访问数据库获取用户信息，实现登录认证

1、后端接口服务实现

（1）创建库表

CREATE DATABASE IF NOT EXISTS `shirodb` CHARACTER SET utf8mb4;
USE `shirodb`;

CREATE TABLE `user` (
 `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
 `name` VARCHAR(30) DEFAULT NULL COMMENT '用户名',
 `pwd` VARCHAR(50) DEFAULT NULL COMMENT '密码',
 `rid` BIGINT(20) DEFAULT NULL COMMENT '角色编号',
 PRIMARY KEY (`id`)) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='用户表';
 
 -- 密码123
 INSERT INTO `user`(`id`, `name`, `pwd`, `rid`) VALUES (1, 'llp', '07ca00e10899418f0ea4ab92a9d69065', NULL);
INSERT INTO `user`(`id`, `name`, `pwd`, `rid`) VALUES (2, 'xh', '07ca00e10899418f0ea4ab92a9d69065', NULL);

（2）创建实体

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private String pwd;
    private Integer rid;
}

（3）创建 mapper

@Repository
public interface UserMapper extends BaseMapper<User> {

    
}

（4）创建 service

public interface UserService {
    //用户登录
    User getUserInfoByName(String name);
}

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;

    @Override
    public User getUserInfoByName(String name) {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", name);
        User user = userMapper.selectOne(wrapper);
        return user;
    }
}

（5）自定义realm

package com.llp.shiro.realm;

import com.llp.shiro.entity.User;
import com.llp.shiro.service.UserService;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.util.ByteSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * 自定义realm
 */
@Component
public class MyRealm extends AuthorizingRealm {

    @Autowired
    private UserService userService;

    /**
     * 自定义授权方法
     *
     * @param principalCollection
     * @return
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        return null;
    }

    /**
     * 自定义登录认证方法
     *
     * @param authenticationToken
     * @return
     * @throws AuthenticationException
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        //1 获取用户名
        String userName = authenticationToken.getPrincipal().toString();
        //2 调用业务层取出数据库中存储的用户信息
        User user = userService.getUserInfoByName(userName);
        //3 判断并将数据完成封装
        if (user != null) {
            AuthenticationInfo info = new SimpleAuthenticationInfo(
                    authenticationToken.getPrincipal(),
                    user.getPwd(),
                    //加盐信息，和加密时的加盐信息一致
                    ByteSource.Util.bytes("salt"),
                    authenticationToken.getPrincipal().toString());
            return info;
        }
        return null;
    }
}

（6）编写配置类

@Configuration
public class ShiroConfig {
    @Autowired
    private MyRealm myRealm;

    //配置 SecurityManager
    @Bean
    public DefaultWebSecurityManager defaultWebSecurityManager() {
        //1 创建 defaultWebSecurityManager 对象
        DefaultWebSecurityManager defaultWebSecurityManager = new DefaultWebSecurityManager();
        //2 创建加密对象，并设置相关属性
        HashedCredentialsMatcher matcher = new HashedCredentialsMatcher();
        //2.1 采用 md5 加密
        matcher.setHashAlgorithmName("md5");
        //2.2 迭代加密次数
        matcher.setHashIterations(3);
        //3 将加密对象存储到 myRealm 中
        myRealm.setCredentialsMatcher(matcher);
        //4 将 myRealm 存入 defaultWebSecurityManager 对象
        defaultWebSecurityManager.setRealm(myRealm);
        //5 返回
        return defaultWebSecurityManager;
    }

    //配置 Shiro 内置过滤器拦截范围
    @Bean
    public DefaultShiroFilterChainDefinition
    shiroFilterChainDefinition() {
        DefaultShiroFilterChainDefinition definition = new DefaultShiroFilterChainDefinition();
        //设置不认证可以访问的资源
        definition.addPathDefinition("/doLogin", "anon");
        definition.addPathDefinition("/login", "anon");
        //设置需要进行登录认证的拦截范围
        definition.addPathDefinition("/**", "authc");
        return definition;
    }

}

（7）实现controller

@RestController
public class LoginController {

    @GetMapping("/login")
    @ResponseBody
    public String userLogin(String name, String pwd) {
        //1 获取 Subject 对象
        Subject subject = SecurityUtils.getSubject();
        //2 封装请求数据到 token 对象中
        AuthenticationToken token = new UsernamePasswordToken(name, pwd);
        //3 调用 login 方法进行登录认证
        try {
            subject.login(token);
            return "登录成功";
        } catch (AuthenticationException e) {
            e.printStackTrace();
            System.out.println("登录失败");
            return "登录失败";
        }
    }

}

（8）测试

http://localhost:8080/login?name=llp&pwd=123

http://localhost:8080/login?name=llp&pwd=1235

2、实现前端页面

Shiro整合Thymeleaf

（1）确认依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

（2）添加 login 页面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Shiro登录认证</h1>
<br>
<form action="/myController/userLogin">
    <div>用户名：<input type="text" name="name" value=""></div>
    <div>密码：<input type="password" name="pwd" value=""></div>
    <div>记住用户：<input type="checkbox" name="rememberMe" value="true"></div>
    <div><input type="submit" value="登录"></div>
</form>

</body>
</html>

（3）添加 main 页面

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

<h1>Shiro登录认证后主页面</h1>
<br>
登录用户为：<span th:text="${session.user}"></span>
<br>
<a href="/logout">登出</a>
<br>
</body>

（4）添加 error页面

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org"
      xmlns:shiro="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1 th:text="${errorMsg}"></h1>
</body>
</html>

（5）添加 controller 方法，改造认证方法

@Controller
public class LoginController {

    //跳转login.html登录页面
    @GetMapping("login")
    public String login() {
        return "login";
    }


    @PostMapping("/doLogin")
    public String userLogin(String name, String pwd, HttpSession session, Model model) {
        //1 获取 Subject 对象
        Subject subject = SecurityUtils.getSubject();
        //2 封装请求数据到 token 对象中
        AuthenticationToken token = new UsernamePasswordToken(name, pwd);
        //3 调用 login 方法进行登录认证
        try {
            subject.login(token);
            //登录用户名
            session.setAttribute("user", token.getPrincipal().toString());
            return "main";
        } catch (UnknownAccountException e) {
            System.out.println("用户不存在");
            model.addAttribute("errorMsg","用户不存在");
        } catch (IncorrectCredentialsException e) {
            System.out.println("密码错误");
            model.addAttribute("errorMsg","密码错误");
        } catch (AuthenticationException e) {
            model.addAttribute("errorMsg",e.getMessage());
        }
        return "error";
    }

}

（6）修改配置文件

#指定shiro登录请求地址
shiro:
  loginUrl: /login

（7）修改配置类

//配置 Shiro 内置过滤器拦截范围
@Bean
public DefaultShiroFilterChainDefinition
shiroFilterChainDefinition() {
    DefaultShiroFilterChainDefinition definition = new DefaultShiroFilterChainDefinition();
    //设置不认证可以访问的资源
    definition.addPathDefinition("/doLogin", "anon");
    definition.addPathDefinition("/login", "anon");
    //设置需要进行登录认证的拦截范围
    definition.addPathDefinition("/**", "authc");
    return definition;
}

（8）启动，访问测试

3.多个 realm 的认证策略设置

1、多个realm实现原理

当应用程序配置多个 Realm 时，例如：用户名密码校验、手机号验证码校验等等。
Shiro 的 ModularRealmAuthenticator 会使用内部的 AuthenticationStrategy 组件判断认证是成功还是失败。
AuthenticationStrategy 是一个无状态的组件，它在身份验证尝试中被询问 4 次（这4 次交互所需的任何必要的状态将被作为方法参数）：
（1）在所有 Realm 被调用之前
（2）在调用 Realm 的 getAuthenticationInfo 方法之前
（3）在调用 Realm 的 getAuthenticationInfo 方法之后
（4）在所有 Realm 被调用之后
认证策略的另外一项工作就是聚合所有 Realm 的结果信息封装至一个
AuthenticationInfo 实例中，并将此信息返回，以此作为 Subject 的身份信息。

Shiro 中定义了 3 种认证策略的实现：

AuthenticationStrategy class	描述
AtLeastOneSuccessfulStrategy	只要有一个（或更多）的 Realm 验证成功，那么认证将视为成功
FirstSuccessfulStrategy	第一个 Realm 验证成功，整体认证将视为成功，且后续 Realm 将被忽略
AllSuccessfulStrategy	所有 Realm 成功，认证才视为成功

ModularRealmAuthenticator 内置的认证策略默认实现是
AtLeastOneSuccessfulStrategy 方式。可以通过配置修改策略

2、多个realm代码实现

@Configuration
public class ShiroConfig {
    @Autowired
    private MyRealm myRealm;
        @Autowired
    private MyRealm myRealm2;
    
    //配置 SecurityManager
    @Bean
    public DefaultWebSecurityManager defaultWebSecurityManager() {
        //1 创建 defaultWebSecurityManager 对象
        DefaultWebSecurityManager defaultWebSecurityManager = new DefaultWebSecurityManager();
        //2 创建认证对象，并设置认证策略
        ModularRealmAuthenticator modularRealmAuthenticator = new ModularRealmAuthenticator();
        //所有 Realm 成功，认证才视为成功
        modularRealmAuthenticator.setAuthenticationStrategy(new AllSuccessfulStrategy());
		
        defaultWebSecurityManager.setAuthenticator(modularRealmAuthenticator);
        //3 封装 myRealm 集合
        List<Realm> list = new ArrayList<>();
        list.add(myRealm);
        list.add(myRealm2);

        //4 将 myRealm 存入 defaultWebSecurityManager 对象
        defaultWebSecurityManager.setRealms(list);
        //5 返回
        return defaultWebSecurityManager;
    }
}

4.remember me 功能

Shiro 提供了记住我（RememberMe）的功能，比如访问一些网站时，关闭了浏览器，下次再打开时还是能记住你是谁，下次访问时无需再登录即可访问。

1、基本流程

（1）首先在登录页面选中 RememberMe 然后登录成功；如果是浏览器登录，一般会
把 RememberMe 的 Cookie 写到客户端并保存下来；
（2）关闭浏览器再重新打开；会发现浏览器还是记住你的；
（3）访问一般的网页服务器端，仍然知道你是谁，且能正常访问；
（4）但是，如果我们访问电商平台时，如果要查看我的订单或进行支付时，此时还是需要再进行身份认证的，以确保当前用户还是你。

2、代码实现

（1）修改配置类

@Configuration
public class ShiroConfig {
    @Autowired
    private MyRealm myRealm;

    //配置 SecurityManager
    @Bean
    public DefaultWebSecurityManager defaultWebSecurityManager() {
        //1 创建 defaultWebSecurityManager 对象
        DefaultWebSecurityManager defaultWebSecurityManager = new DefaultWebSecurityManager();
        //2 创建加密对象，并设置相关属性
        HashedCredentialsMatcher matcher = new HashedCredentialsMatcher();
        //2.1 采用 md5 加密
        matcher.setHashAlgorithmName("md5");
        //2.2 迭代加密次数
        matcher.setHashIterations(3);
        //3 将加密对象存储到 myRealm 中
        myRealm.setCredentialsMatcher(matcher);
        //4 将 myRealm 存入 defaultWebSecurityManager 对象
        defaultWebSecurityManager.setRealm(myRealm);
        //4.5 设置 rememberMe
        defaultWebSecurityManager.setRememberMeManager(rememberMeManager());
        //5 返回
        return defaultWebSecurityManager;
    }

    //cookie 属性设置
    public SimpleCookie rememberMeCookie(){
        SimpleCookie cookie = new SimpleCookie("rememberMe");
        //设置跨域
        //cookie.setDomain(domain);
        cookie.setPath("/");
        cookie.setHttpOnly(true);
        cookie.setMaxAge(30*24*60*60);
        return cookie;
    }
    //创建 Shiro 的 cookie 管理对象
    public CookieRememberMeManager rememberMeManager(){
        CookieRememberMeManager cookieRememberMeManager = new
                CookieRememberMeManager();
        cookieRememberMeManager.setCookie(rememberMeCookie());

        cookieRememberMeManager.setCipherKey("1234567890987654".getBytes());
        return cookieRememberMeManager;
    }

    //配置 Shiro 内置过滤器拦截范围
    @Bean
    public DefaultShiroFilterChainDefinition
    shiroFilterChainDefinition() {
        DefaultShiroFilterChainDefinition definition = new DefaultShiroFilterChainDefinition();
        //设置不认证可以访问的资源
        definition.addPathDefinition("/doLogin", "anon");
        definition.addPathDefinition("/login", "anon");
        //设置需要进行登录认证的拦截范围
        definition.addPathDefinition("/**", "authc");
        //添加存在用户的过滤器（rememberMe）
        definition.addPathDefinition("/**","user");
        return definition;
    }

}

（2）修改 controller

@Controller
public class LoginController {

    //跳转login.html登录页面
    @GetMapping("login")
    public String login() {
        return "login";
    }


    @PostMapping("/doLogin")
    public String userLogin(String name, String pwd, HttpSession session, Model model, @RequestParam(defaultValue = "false") boolean rememberMe) {
        //1 获取 Subject 对象
        Subject subject = SecurityUtils.getSubject();
        //2 封装请求数据到 token 对象中
        AuthenticationToken token = new UsernamePasswordToken(name, pwd, rememberMe);
        //3 调用 login 方法进行登录认证
        try {
            subject.login(token);
            //登录用户名
            session.setAttribute("user", token.getPrincipal().toString());
            return "main";
        } catch (UnknownAccountException e) {
            System.out.println("用户不存在");
            model.addAttribute("errorMsg", "用户不存在");
        } catch (IncorrectCredentialsException e) {
            System.out.println("密码错误");
            model.addAttribute("errorMsg", "密码错误");
        } catch (AuthenticationException e) {
            model.addAttribute("errorMsg", e.getMessage());
        }
        return "error";
    }

    //登录认证验证 rememberMe
    @GetMapping("userLoginRm")
    public String userLogin(HttpSession session) {
        session.setAttribute("user", "rememberMe");
        return "main";
    }

}

（3）改造页面 login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Shiro登录认证</h1>
<br>
<form action="/doLogin" method="post">
    <div>用户名：<input type="text" name="name" value=""></div>
    <div>密码：<input type="password" name="pwd" value=""></div>
    <div>记住用户：<input type="checkbox" name="rememberMe" value="true"></div>
    <div><input type="submit" value="登录"></div>
</form>

</body>
</html>

3、测试

（1）通过地址访问 userLoginRm
http://localhost:8080/myController/userLoginRm

过滤器拦截跳回登录页面

（2）登录勾选记住用户

（3）重新访问 userLoginRm

5.用户登录认证后登出

用户登录后，配套的有登出操作。直接通过Shiro过滤器即可实现登出

1、代码实现

（1）修改登录后的 main.html

<br>
<a href="/logout">登出</a>

（2）修改配置类，添加 logout 过滤器

//配置 Shiro 内置过滤器拦截范围
@Bean
public DefaultShiroFilterChainDefinition
shiroFilterChainDefinition() {
    DefaultShiroFilterChainDefinition definition = new DefaultShiroFilterChainDefinition();
    //设置不认证可以访问的资源
    definition.addPathDefinition("/doLogin", "anon");
    definition.addPathDefinition("/login", "anon");
    //配置登出过滤器
    definition.addPathDefinition("/logout","logout");
    //设置需要进行登录认证的拦截范围
    definition.addPathDefinition("/**", "authc");
    //添加存在用户的过滤器（rememberMe）
    definition.addPathDefinition("/**","user");
    return definition;
}

2、测试

（1）通过登录验证

（2）点击“登出”登出系统

登出之后再次访问http://localhost:8080/userLoginRm 是需要再次登录的

6.授权、角色认证

1、授权

用户登录后，需要验证是否具有指定角色指定权限。Shiro也提供了方便的工具进行判
断。
这个工具就是Realm的doGetAuthorizationInfo方法进行判断。触发权限判断的有两种方式

（1）在页面中通过shiro:****属性判断
（2）在接口服务中通过注解@Requires****进行判断 （推荐）

2、后端接口服务注解

通过给接口服务方法添加注解可以实现权限校验，可以加在控制器方法上，也可以加在业务方法上，一般加在控制器方法上。常用注解如下：

（1）@RequiresAuthentication
验证用户是否登录，等同于方法subject.isAuthenticated()

（2）@RequiresUser
验证用户是否被记忆：
登录认证成功subject.isAuthenticated()为true
登录后被记忆subject.isRemembered()为true

（3）@RequiresGuest
验证是否是一个guest的请求，是否是游客的请求
此时subject.getPrincipal()为null

（4）@RequiresRoles
验证subject是否有相应角色，有角色访问方法，没有则会抛出异常
AuthorizationException。
例如：@RequiresRoles(“aRoleName”)
void someMethod();
只有subject有aRoleName角色才能访问方法someMethod()

（5）@RequiresPermissions
验证subject是否有相应权限，有权限访问方法，没有则会抛出异常
AuthorizationException。
例如：@RequiresPermissions (“file:read”,”wite:aFile.txt”)
void someMethod();
subject必须同时含有file:read和wite:aFile.txt权限才能访问方法someMethod()

3、授权验证-没有角色无法访问

（1）添加 controller 方法，并添加验证角色注解

//登录，验证角色
@RequiresRoles("admin")
@GetMapping("userLoginRoles")
@ResponseBody
public String userLoginRoles() {
    System.out.println("登录认证验证角色");
    return "验证角色成功";
}

（2）修改 main.html

<br>
<a shiro:hasRole="admin" href="/userLoginRoles">测试授权-角色验证</a>

（3）修改 MyRealm 方法

/**
 * 自定义授权方法
 *获取当前登录用户权限信息，返回给 Shiro 用来进行授权对比
 * @param principalCollection
 * @return
 */
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    System.out.println("进入自定义授权方法");
    return null;
}

（4）运行测试

http://localhost:8080/userLoginRoles

进入自定义授权方法
2022-10-05 14:08:04.665 ERROR 27044 --- [io-8080-exec-10] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is org.apache.shiro.authz.UnauthorizedException: Subject does not have role [admin]] with root cause

3、授权验证-获取角色进行验证

（1）修改 MyRealm 方法

/**
 * 自定义授权方法
 * 获取当前登录用户权限信息，返回给 Shiro 用来进行授权对比
 *
 * @param principalCollection
 * @return
 */
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    System.out.println("进入自定义授权方法");
    //1 创建对象，存储当前登录的用户的权限和角色
    SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
    //2 存储角色
    info.addRole("admin");
    //返回
    return info;
}

（2）运行测试

（3）确认库表

CREATE TABLE `role` (`id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
 `name` VARCHAR(30) DEFAULT NULL COMMENT '角色名',
 `desc` VARCHAR(50) DEFAULT NULL COMMENT '描述',
 `realname` VARCHAR(20) DEFAULT NULL COMMENT '角色显示名',
 PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='角色表';

CREATE TABLE `role_user` (
 `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
 `uid` BIGINT(20) DEFAULT NULL COMMENT '用户 id',
 `rid` BIGINT(20) DEFAULT NULL COMMENT '角色 id',
 PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='角色用户映射
表';

（4）查询 sql

根据用户名查询对应角色信息
SELECT NAME FROM role WHERE id IN (SELECT rid FROM role_user WHERE  uid=(SELECT id FROM USER WHERE NAME='llp'));

（5）mapper 方法

@Select("SELECT NAME FROM role WHERE id IN (SELECT rid FROM role_user WHERE uid=(SELECT id FROM USER WHERE NAME=#{userName}))")
    List<String> getUserRoleInfoMapper(@Param("userName") String userName);

（6）service 实现

List<String> getUserRoleInfo(String userName);

//获取用户的角色信息
@Override
public List<String> getUserRoleInfo(String userName) {
    return userMapper.getUserRoleInfoMapper(userName);
}

（7）MyRealm 方法改造

/**
 * 自定义授权方法
 * 获取当前登录用户权限信息，返回给 Shiro 用来进行授权对比
 *
 * @param principalCollection
 * @return
 */
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    System.out.println("进入自定义授权方法");
    //获取当前用户身份信息
    String userName = principalCollection.getPrimaryPrincipal().toString();
    //调用接口方法获取用户的角色信息
    List<String> roles = userService.getUserRoleInfo(userName);
    System.out.println("当前用户角色信息：" + roles);
    //创建对象，存储当前登录的用户的权限和角色
    SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
    //存储角色
    info.addRoles(roles);
    //返回
    return info;
}

（8）启动登录测试

4、授权验证-获取权限进行验证

获取权限验证和获取角色相类似
（1）确认库表

CREATE TABLE `permissions` (
 `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
 `name` VARCHAR(30) DEFAULT NULL COMMENT '权限名',
 `info` VARCHAR(30) DEFAULT NULL COMMENT '权限信息',
 `desc` VARCHAR(50) DEFAULT NULL COMMENT '描述',
 PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='权限表';

CREATE TABLE `role_ps` (
 `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
 `rid` BIGINT(20) DEFAULT NULL COMMENT '角色 id',
 `pid` BIGINT(20) DEFAULT NULL COMMENT '权限 id',
 PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='角色权限映射
表';

（2）查询 sql

-- 根据角色名查询对应权限信息
SELECT info FROM permissions WHERE id IN (SELECT pid FROM role_ps WHERE rid IN (SELECT id FROM role WHERE NAME IN('admin','userMag')));

（3）mapper 方法

@Select({
            "<script>",
            "select info FROM permissions WHERE id IN ",
            "(SELECT pid FROM role_ps WHERE rid IN (",
            "SELECT id FROM role WHERE NAME IN ",
            "<foreach collection='roles' item='name' open='(' separator=',' close=')'>",
            "#{name}",
            "</foreach>",
            "))",
            "</script>"
    })
    List<String> getUserPermissionInfoMapper(@Param("roles")List<String> roles);

（4）service 实现

List<String> getUserPermissionInfo(List<String> roles);

//获取用户角色的权限信息
@Override
public List<String> getUserPermissionInfo(List<String> roles) {
    return userMapper.getUserPermissionInfoMapper(roles);
}

（5）MyRealm 方法改造

/**
 * 自定义授权方法
 * 获取当前登录用户权限信息，返回给 Shiro 用来进行授权对比
 *
 * @param principalCollection
 * @return
 */
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
    System.out.println("进入自定义授权方法");
    //获取当前用户身份信息
    String userName = principalCollection.getPrimaryPrincipal().toString();
    //调用接口方法获取用户的角色信息
    List<String> roles = userService.getUserRoleInfo(userName);
    System.out.println("当前用户角色信息："+roles);
    //调用接口方法获取用户角色的权限信息
    List<String> permissions = userService.getUserPermissionInfo(roles);
    System.out.println("当前用户权限信息："+permissions);
    //创建对象，存储当前登录的用户的权限和角色
    SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
    //存储角色
    info.addRoles(roles);
    //存储权限信息
    info.addStringPermissions(permissions);
    //返回
    return info;
}

（6）添加 controller 方法

//登录认证验证权限
@RequiresPermissions("user:delete")
@GetMapping("userPermissions")
@ResponseBody
public String userLoginPermissions() {
    System.out.println("登录认证验证权限");
    return "验证权限成功";
}

（7）改造 main.html

<br>
<a shiro:hasPermission="user:delete" href="/userPermissions">测试授权-权限验证</a>

（8）启动登录测试

5、授权验证-异常处理

（1）创建认证异常处理类，使用@ControllerAdvice 加@ExceptionHandler 实现特殊异常处理。

@ControllerAdvice
public class PermissionsException {
    @ResponseBody
    @ExceptionHandler(UnauthorizedException.class)
    public String unauthorizedException(Exception e){
        return "无权限";
    }

    @ResponseBody
    @ExceptionHandler(AuthorizationException.class)
    public String authorizationException(Exception e){
        return "权限认证失败";
    }

}

改在登录方法

@PostMapping("/doLogin")
public String userLogin(String name, String pwd, HttpSession session, Model model, @RequestParam(defaultValue = "false") boolean rememberMe) {
    //1 获取 Subject 对象
    Subject subject = SecurityUtils.getSubject();
    //2 封装请求数据到 token 对象中
    AuthenticationToken token = new UsernamePasswordToken(name, pwd, rememberMe);
    //3 调用 login 方法进行登录认证
    subject.login(token);
    //登录用户名
    session.setAttribute("user", token.getPrincipal().toString());
    return "main";
}

（2）启动运行，用ls登录测试。

7.会话管理

1、SessionManager
会话管理器，负责创建和管理用户的会话（Session）生命周期，它能够在任何环境中
在本地管理用户会话，即使没有Web/Servlet/EJB容器，也一样可以保存会话。默认情况
下，Shiro会检测当前环境中现有的会话机制（比如Servlet容器）进行适配，如果没有
（比如独立应用程序或者非Web环境），它将会使用内置的企业会话管理器来提供相应的会
话管理服务，其中还涉及一个名为SessionDAO的对象。SessionDAO负责Session的持久化操
作（CRUD），允许Session数据写入到后端持久化数据库。

2、会话管理实现
SessionManager由SecurityManager管理。Shiro提供了三种实现

（1） DefaultSessionManager：用于JavaSE环境
（2） ServletContainerSessionManager：用于web环境，直接使用Servlet容器的会话
（3） DefaultWebSessionManager：用于web环境，自己维护会话（不使用Servlet容器的
会话管理）

3、获得session方式

（1）实现
Session session = SecurityUtils.getSubject().getSession();
session.setAttribute(“key”,”value”)
（2）说明
Controller 中的 request，在 shiro 过滤器中的 doFilerInternal 方法，被包装成
ShiroHttpServletRequest。
SecurityManager 和 SessionManager 会话管理器决定 session 来源于 ServletRequest
还是由 Shiro 管理的会话。
无论是通过 request.getSession 或 subject.getSession 获取到 session，操作
session，两者都是等价的。

标题：SpringBoot整合Shiro
作者：llp
地址：https://llinp.cn/articles/2022/10/05/1664952924871.html