Shiro框架
- 1、Shiro简介
- 2、HelloWorld
  - 2.2、快速实战
——————————————————————————————————————-
Roles with assigned permissions
roleName = perm1, perm2, …, permN
——————————————————————————————————————-
- 3、SpringBoot整合Shiro

Shiro框架

1、Shiro简介

1.1、什么是Shiro?

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

SpringBoot整合Shiro框架 - 图1

1.2、有哪些功能？

SpringBoot整合Shiro框架 - 图2

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

1.3、Shiro架构（外部）

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

SpringBoot整合Shiro框架 - 图3

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

1.4、Shiro架构（内部）

SpringBoot整合Shiro框架 - 图4

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

2、HelloWorld

2.2、快速实战

查看官网文档：http://shiro.apache.org/tutorial.html

官方的quickstart:https://github.com/apache/shiro/tree/master/samples/quickstart/

创建一个maven父工程，用于学习Shiro,删掉不必要的东西
创建一个普通的Maven子工程：shiro-01-helloworld

根据官方文档，我们来导入Shiro的依赖

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

配置文件
shiro.ini ```ini [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


<br />log4j.properties
```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

Quickstart ```java 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; /*
- Simple Quickstart application showing how to use Shiro’s API. *
- @since 0.9 RC2 */ public class Quickstart {
  
  //使用log来输出 private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);

public static void main(String[] args) {
    // The easiest way to create a Shiro SecurityManager with configured
    // realms, users, roles and permissions is to use the simple INI config.
    // We'll do that by using a factory that can ingest a .ini file and
    // return a SecurityManager instance:
    //创建带有配置的Shiro SecurityManager的最简单方法
    //领域，用户，角色和权限是使用简单的INI配置。
    //我们将使用可提取.ini文件的工厂来完成此操作，
    //返回一个SecurityManager实例：
    // Use the shiro.ini file at the root of the classpath
    // (file: and url: prefixes load from files and urls respectively):
    //在类路径的根目录下使用shiro.ini文件
    //（file：和url：前缀分别从文件和url加载）：
    Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
    SecurityManager securityManager = factory.getInstance();
    // for this simple example quickstart, make the SecurityManager
    // accessible as a JVM singleton.  Most applications wouldn't do this
    // and instead rely on their container configuration or web.xml for
    // webapps.  That is outside the scope of this simple quickstart, so
    // we'll just do the bare minimum so you can continue to get a feel
    // for things.
    //对于这个简单的示例快速入门，请使SecurityManager
    //作为JVM 单例 访问。大多数应用程序都不会这样做
    //，而是依靠其容器配置或web.xml进行
    // webapps。这超出了此简单快速入门的范围，因此
    //我们只做最低限度的工作，所以您可以继续感受一下
    // 为了这些事。
    SecurityUtils.setSecurityManager(securityManager);
    // Now that a simple Shiro environment is set up, let's see what you can do:
    //获取当前正在用户对象Subject：
    Subject currentUser = SecurityUtils.getSubject();
    //通过当前用户获取Session
    Session session = currentUser.getSession();
    session.setAttribute("someKey", "aValue");
    String value = (String) session.getAttribute("someKey");
    if (value.equals("aValue")) {
        log.info("Subject===>session [" + 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.");
    //test a role:
    // 测试角色
    if (currentUser.hasRole("schwartz")) {
        log.info("May the Schwartz be with you!");
    } else {
        log.info("Hello, mere mortal.");
    }
    //test a typed permission (not instance-level)
    // 测试输入的权限 粗粒度权限
    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.");
    }
    //a (very powerful) Instance Level permission:
    // 细粒度权限
    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);
}

}


```java
 //获取当前正在用户对象Subject：
Subject currentUser = SecurityUtils.getSubject();
//通过当前用户获取Session
Session session = currentUser.getSession();
 //用户认证
currentUser.isAuthenticated();
//获取当前用户认证码，(可以存储信息)
currentUser.getPrincipal();
//用户——>角色
currentUser.hasRole("schwartz");
//角色权限
currentUser.isPermitted("lightsaber:wield");
//注销
currentUser.logout();

3、SpringBoot整合Shiro

3.1、环境搭建

1、导入依赖

<!--shiro整合spring-->
 <dependency>
     <groupId>org.apache.shiro</groupId>
     <artifactId>shiro-spring</artifactId>
     <version>1.4.1</version>
</dependency>
<!--thymeleaf模板-->
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf-spring5</artifactId>
</dependency>
<dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-java8time</artifactId>
</dependency>

2、编写Config配置类

//自定义Realm
public class UserRealm extends AuthorizingRealm {
    //授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("==执行了授权==");
        return null;
    }
    //认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("==执行了认证==");
        return null;
    }
}

@Configuration
public class ShiroConfig {
    //ShiroFilterFactoryBean:3
    @Bean
    public ShiroFilterFactoryBean getShiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {
        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        //设置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);
        return bean;
    }
    //DefaultWebSecurityManager:2
    @Bean(name = "securityManager")
    public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        //关联Realm
        securityManager.setRealm(userRealm());
        return securityManager;
    }
    //创建realm对象, 需要自定义类:1
    @Bean
    public UserRealm userRealm() {
        return new UserRealm();
    }
}

页面跳转

@Controller
public class MyController {
    @RequestMapping({"/","index"})
    public String index(Model model) {
        model.addAttribute("msg","hello,Shiro");
        return "index";
    }
     @RequestMapping("/user/add")
    public String add() {
        return "user/add";
    }
    @RequestMapping("/user/update")
    public String update() {
        return "user/update";
    }
}

3.2、登录拦截

增加配置

//添加shiro的内置过滤器
/*
    anon:无需认证就可以访问
    authc:必须认证了才能让问
    user:必须拥有记住我功能才能用
    perms:拥有对某个资源的权限才能访问
    role:拥有某个角色权限才能访问
*/
/*
    filterMap.put("/user/add","authc");
    filterMap.put("/user/update","authc");
*/
//登录拦截
Map<String, String> filterMap = new LinkedHashMap<>();
filterMap.put("/user/*","authc");
bean.setFilterChainDefinitionMap(filterMap);
//设置登录请求
bean.setLoginUrl("/toLogin");

跳转

@RequestMapping("/toLogin")
public String toLogin() {
    return "login";
}

3.3、用户认证

增加用户判断

@RequestMapping("/login")
public String login(String username, String password, Model model) {
    //获取当前用户
    Subject subject = SecurityUtils.getSubject();
    //封装用户登录数据
    UsernamePasswordToken token = new UsernamePasswordToken(username, password);
    try {
        //执行登录方法
        subject.login(token);
        return "index";
    } catch (UnknownAccountException e) {
        //用户名不存在
        model.addAttribute("msg","用户名错误");
        return "login";
    } catch (IncorrectCredentialsException e) {
        //密码不正确
        model.addAttribute("msg","密码错误");
        return "login";
    }
}

给UserRealm增加新的配置

//认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
    System.out.println("==执行了认证==");
    //用户名,密码 数据中取
    String name="root";
    String password="root";
    UsernamePasswordToken userToken = (UsernamePasswordToken) token;
    if (!userToken.getUsername().equals(name)) {
        //抛出异常  UnknownAccountException
        return null;
    }
    //密码认证Shiro做
    return new SimpleAuthenticationInfo("",password,"");
}

3.4、整合Mybatis

导入依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.10</version>
</dependency>
<!--
    Subject用户
    SecurityManager 管理所有用户
    Realm连接数据
 -->
<!--连接mysql-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--druid-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.12</version>
</dependency>
<!--mybatis-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>
<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置application.yml 数据库和mybatis

spring:
  datasource:
    username: root
    password: 123456
    #?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/mybatisK?useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    #Spring Boot 默认是不注入这些属性值的，需要自己绑定
    #druid 数据源专有配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    #配置监控统计拦截的filters，stat:监控统计、log4j：日志记录、wall：防御sql注入
    #如果允许时报错  java.lang.ClassNotFoundException: org.apache.log4j.Priority
    #则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4j
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
# 整合 mybatis
mybatis:
  type-aliases-package: cn.dafran.pojo
  mapper-locations: classpath:mapper/*.xml
#  #缓存
#  thymeleaf:
#    cache: false
#
#  #我们的配置文件的真实位置
#  messages:
#    basename: i18n.login
#
#  mvc:
#    #时间日期格式化
#    date-format: yyyy-MM-dd
#    #是否开启默认图标
#    favicon:
#      enabled: false
#
#

修改UserRealm配置

@Autowired
UserServiceImpl userService;
//认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
    System.out.println("==执行了认证==");
    UsernamePasswordToken userToken = (UsernamePasswordToken) token;
    //连接真实数据库
    User user = userService.queryUserByName(userToken.getUsername());
    if (user == null) {
        return null;
    }
    //密码认证Shiro做
    return new SimpleAuthenticationInfo("",user.getPwd(),"");
}

编写pojo、dao、service

3.5、请求授权实现

增加权限配置

ShiroConfig

public ShiroFilterFactoryBean getShiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {
    //授权,正常的情况下，没有授权会跳转到未授权页面
    filterMap.put("/user/add","perms[user:add]");
    filterMap.put("/user/update","perms[user:update]");
    filterMap.put("/user/*","authc");
    bean.setFilterChainDefinitionMap(filterMap);
    //设置登录请求
    bean.setLoginUrl("/toLogin");
    //设置未授权页面
    bean.setUnauthorizedUrl("/noauth");
}

Controller增加

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

修改Realm

public class UserRealm extends AuthorizingRealm {
    @Autowired
    UserServiceImpl userService;
    //授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("==执行了授权==");
        //SimpleAuthenticationInfo
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        //增加权限
        /*info.addStringPermission("user:add");*/
        Subject subject = SecurityUtils.getSubject();
        User currentUser = (User) subject.getPrincipal();   //拿到user对象
        //设置当前用户对象
        info.addStringPermission(currentUser.getPerms());
        return info;
    }
    //认证
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        System.out.println("==执行了认证==");
        UsernamePasswordToken userToken = (UsernamePasswordToken) token;
        //连接真实数据库
        User user = userService.queryUserByName(userToken.getUsername());
        if (user == null) {
            return null;
        }
        return new SimpleAuthenticationInfo(user,user.getPwd(),"");
    }
}

3.6、整合Thymelafe

导入依赖

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

ShiroConfig 增加配置

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

验证session

//认证
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
    System.out.println("==执行了认证==");
    UsernamePasswordToken userToken = (UsernamePasswordToken) token;
    //连接真实数据库
    User user = userService.queryUserByName(userToken.getUsername());
    if (user == null) {
        return null;
    }
    /*//加密方式
    String hashAlgorithmName = "MD5";
    ByteSource credential = ByteSource.Util.bytes(user.getPwd());
    String realpwd=user.getPwd();
    //密码认证Shiro做*/
    /*判断是否有用户*/
    Subject currentSubject = SecurityUtils.getSubject();
    Session session = currentSubject.getSession();
    session.setAttribute("loginUser",user);
    return new SimpleAuthenticationInfo(user,user.getPwd(),"");
}

修改页面

<div shiro:hasPermission="user:add">
    <a th:href="@{/user/add}">add</a>|
</div>
<div shiro:hasPermission="user:update">
    <a th:href="@{/user/update}">update</a>
</div>

<div th:if="${session.loginUser==null}">
    <a th:href="@{/toLogin}">登录</a>
</div>