---
title: Shiro学习
author: TianZD
top: true
cover: true
toc: true
mathjax: false
summary: Shiro学习笔记,粗略学了一下,没有参考价值
tags:
- Shiro
- java
- 学习笔记
categories:
- java
reprintPolicy: cc_by
abbrlink: c0a48af9
date: 2022-04-29 10:50:23
coverImg:
img:
password:
---
---
title: shiro
tags: java
notebook: JAVA
---
# 1、Shiro简介
## 1.1、Shiro 是什么?
* Apache Shiro 是 Java 的一个安全(权限)框架。
* Shiro 可以非常容易的开发出足够好的应用,其不仅可以用在 JavaSE 环境,也可以用在 JavaEE 环境。
* Shiro 可以完成:认证、授权、加密、会话管理、与Web 集成、缓存等。
* 下载地址
* 官网:http://shiro.apache.org/
* github:https://github.com/apache/shiro
## 1.2、有哪些功能?
[![image-20200729114647110](https://camo.githubusercontent.com/39792d7499fb7656be26a3573d232e7932aa10e43d2950cc47f3d1f53de77554/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343634373131302e706e67)](https://camo.githubusercontent.com/39792d7499fb7656be26a3573d232e7932aa10e43d2950cc47f3d1f53de77554/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343634373131302e706e67)
* Authentication:身份认证/登录,验证用户是不是拥有相应的身份
* Authorization:授权,即权限验证,验证某个已认证的用户是否拥有某个权限;即判断用户是否能进行什么操作,如:验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限
* Session Management:会话管理,即用户登录后就是一次会话,在没有退出之前,它的所有信息都在会话中;会话可以是普通JavaSE环境,也可以是Web 环境的
* Cryptography:加密,保护数据的安全性,如密码加密存储到数据库,而不是明文存储
* Web Support:Web 支持,可以非常容易的集成到Web 环境
* Caching:缓存,比如用户登录后,其用户信息、拥有的角色/权限不必每次去查,这样可以提高效率
* Concurrency:Shiro支持多线程应用的并发验证,即如在一个线程中开启另一个线程,能把权限自动传播过去
* Testing:提供测试支持
* "Run As":允许一个用户假装为另一个用户(如果他们允许)的身份进行访问
* Remember Me:记住我,这个是非常常见的功能,即一次登录后,下次再来的话不用登录了
## 1.3、Shiro架构(外部)
从外部来看Shiro,即从应用程序角度的来观察如何使用Shiro完成工作
[![image-20200729114702566](https://camo.githubusercontent.com/e34dd392bfaaa048ccc5967d91a82e0eb538cdec6fdbfd602817f3a9e890fc70/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343730323536362e706e67)](https://camo.githubusercontent.com/e34dd392bfaaa048ccc5967d91a82e0eb538cdec6fdbfd602817f3a9e890fc70/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343730323536362e706e67)
* Subject:应用代码直接交互的对象是Subject,也就是说Shiro的对外API 核心就是Subject。Subject 代表了当前“用户”,这个用户不一定是一个具体的人,与当前应用交互的任何东西都是Subject,如网络爬虫,机器人等;与Subject 的所有交互都会委托给SecurityManager;Subject 其实是一个门面,SecurityManager才是实际的执行者
* SecurityManager:安全管理器;即所有与安全有关的操作都会与SecurityManager交互;且其管理着所有Subject;可以看出它是Shiro的核心,它负责与Shiro的其他组件进行交互,它相当于SpringMVC中DispatcherServlet的角色
* Realm:Shiro从Realm 获取安全数据(如用户、角色、权限),就是说SecurityManager要验证用户身份,那么它需要从Realm 获取相应的用户进行比较以确定用户身份是否合法;也需要从Realm 得到用户相应的角色/权限进行验证用户是否能进行操作;可以把Realm 看成DataSource
## 1.4、Shiro架构(内部)
[![image-20200729114720578](https://camo.githubusercontent.com/3c0eb32912aa456b96172a990316de48563666257f2b5bcb7889df7af26e4419/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343732303537382e706e67)](https://camo.githubusercontent.com/3c0eb32912aa456b96172a990316de48563666257f2b5bcb7889df7af26e4419/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131343732303537382e706e67)
* Subject:任何可以与应用交互的“用户”;
* SecurityManager:相当于SpringMVC中的DispatcherServlet;是Shiro的心脏;所有具体的交互都通过SecurityManager进行控制;它管理着所有Subject、且负责进行认证、授权、会话及缓存的管理。
* Authenticator:负责Subject 认证,是一个扩展点,可以自定义实现;可以使用认证策略(Authentication Strategy),即什么情况下算用户认证通过了;
* Authorizer:授权器、即访问控制器,用来决定主体是否有权限进行相应的操作;即控制着用户能访问应用中的哪些功能;
* Realm:可以有1 个或多个Realm,可以认为是安全实体数据源,即用于获取安全实体的;可以是JDBC 实现,也可以是内存实现等等;由用户提供;所以一般在应用中都需要实现自己的Realm;
* SessionManager:管理Session 生命周期的组件;而Shiro并不仅仅可以用在Web 环境,也可以用在如普通的JavaSE环境 CacheManager:缓存控制器,来管理如用户、角色、权限等的缓存的;因为这些数据基本上很少改变,放到缓存中后可以提高访问的性能
* Cryptography:密码模块,Shiro提高了一些常见的加密组件用于如密码加密/解密。
# 2、Hello World
## 2.1、快速实践
* 查看官方文档:http://shiro.apache.org/tutorial.html
* 官方的quickstart : https://github.com/apache/shiro/tree/master/samples/quickstart/
[![image-20200729115148574](https://camo.githubusercontent.com/f8297239e27c6e9dac7cba9c91042bd0276075bc593e48a36dcaf90e85cf49ef/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131353134383537342e706e67)](https://camo.githubusercontent.com/f8297239e27c6e9dac7cba9c91042bd0276075bc593e48a36dcaf90e85cf49ef/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393131353134383537342e706e67)
1. 创建一个maven父工程,用来学习Shiro,删掉不必要的部分
2. 创建一个普通的Maven子工程:hell-shiro
[![image-20200729120114648](https://camo.githubusercontent.com/304172a69b541dc5d1019428828b8549f1b9f21d1911640cc6552ab0f96b9481/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393132303131343634382e706e67)](https://camo.githubusercontent.com/304172a69b541dc5d1019428828b8549f1b9f21d1911640cc6552ab0f96b9481/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393132303131343634382e706e67)
3. 根据[官方文档](https://github.com/apache/shiro/blob/master/samples/quickstart/pom.xml),我们导入Shiro的依赖
[![image-20200729120207730](https://camo.githubusercontent.com/0465f0a1e9d59c306b118c89f971feac1805f79ac5d6349a4f7e16e8883493e7/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393132303230373733302e706e67)](https://camo.githubusercontent.com/0465f0a1e9d59c306b118c89f971feac1805f79ac5d6349a4f7e16e8883493e7/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393132303230373733302e706e67)
[版本号点击这里](https://mvnrepository.com/artifact/org.apache.shiro/shiro-core)
```
org.apache.shiroshiro-core1.5.3org.slf4jjcl-over-slf4j1.7.26org.slf4jslf4j-log4j121.7.26log4jlog4j1.2.17
```
4. 相关配置文件
* log4j.properties——[官网](https://github.com/apache/shiro/blob/master/samples/quickstart/src/main/resources/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
```
* shiro.ini——[官网](https://github.com/apache/shiro/blob/master/samples/quickstart/src/main/resources/shiro.ini)
```
[users]
# user 'root' with password 'secret' and the 'admin' role
root = secret, admin
# user 'guest' with the password 'guest' and the 'guest' role
guest = guest, guest
# user 'presidentskroob' with password '12345' ("That's the same combination on
# my luggage!!!" ;)), and role 'president'
presidentskroob = 12345, president
# user 'darkhelmet' with password 'ludicrousspeed' and roles 'darklord' and 'schwartz'
darkhelmet = ludicrousspeed, darklord, schwartz
# user 'lonestarr' with password 'vespa' and roles 'goodguy' and 'schwartz'
lonestarr = vespa, goodguy, schwartz
# -----------------------------------------------------------------------------
# Roles with assigned permissions
#
# Each line conforms to the format defined in the
# org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions JavaDoc
# -----------------------------------------------------------------------------
[roles]
# 'admin' role has all permissions, indicated by the wildcard '*'
admin = *
# The 'schwartz' role can do anything (*) with any lightsaber:
schwartz = lightsaber:*
# The 'goodguy' role is allowed to 'drive' (action) the winnebago (type) with
# license plate 'eagle5' (instance specific id)
goodguy = winnebago:drive:eagle5
```
* 启动类 Quickstart——[官网](https://github.com/apache/shiro/blob/master/samples/quickstart/src/main/java/Quickstart.java)
```
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
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.
* 简单入门Shiro使用API
*
* @since 0.9 RC2
*/
public class Quickstart {
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:
// Use the shiro.ini file at the root of the classpath
// (file: and url: prefixes load from files and urls respectively):
// 读取配置文件:
Factory 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.
SecurityUtils.setSecurityManager(securityManager);
// Now that a simple Shiro environment is set up, let's see what you can do:
// get the currently executing user:
// 获取当前的用户对象 Subject
Subject currentUser = SecurityUtils.getSubject();
// Do some stuff with a Session (no need for a web or EJB container!!!)
//通过当前用户拿到Shiro的Session 可以脱离web存值取值
Session session = currentUser.getSession();
session.setAttribute("someKey", "aValue");
String value = (String) session.getAttribute("someKey");
if (value.equals("aValue")) {
log.info("Retrieved the correct value! [" + value + "]");
}
// let's login the current user so we can check against roles and permissions:
//判断当前的用户是否被认证
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);
}
}
```
[![image-20200729130649625](https://camo.githubusercontent.com/3e9d7c61a23719bee5050d36fe1b7b78b367c725c78cceb7e3257223cec104d8/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393133303634393632352e706e67)](https://camo.githubusercontent.com/3e9d7c61a23719bee5050d36fe1b7b78b367c725c78cceb7e3257223cec104d8/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393133303634393632352e706e67)
* Spring Secutrry都有~(只是换了个名字)
```
// 获取当前的用户对象 Subject
Subject currentUser = SecurityUtils.getSubject();
Session session = currentUser.getSession();
currentUser.isAuthenticated()
currentUser.getPrincipal()
currentUser.hasRole("schwartz")
currentUser.isPermitted("lightsaber:wield")
currentUser.logout();
```
# 3、SpringBoot集成
## 3.1、SpringBoot整合Shiro环境搭建
1. 新建一个项目或模块,勾选依赖
[![image-20200729174715011](https://camo.githubusercontent.com/98ca792576cb060f2f278b236c3887867ea62c4c8fbff32d7fe51db60841b562/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393137343731353031312e706e67)](https://camo.githubusercontent.com/98ca792576cb060f2f278b236c3887867ea62c4c8fbff32d7fe51db60841b562/68747470733a2f2f67697465652e636f6d2f6c7a685f67697465652f737072696e67626f6f745f696d6167652f7261772f6d61737465722f696d672f696d6167652d32303230303732393137343731353031312e706e67)
pom.xml
```
org.springframework.bootspring-boot-starter-thymeleaforg.springframework.bootspring-boot-starter-weborg.springframework.bootspring-boot-starter-testtestorg.junit.vintagejunit-vintage-engine
```
2. 测试环境是否正常
* 新建一个controller页面
```
@Controller
public class MyController {
@RequestMapping({"/","/index"})
public String toIndex(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";
}
}
```
* 新建一个index.html页面
```
首页