Shiro 基础教程

小鱼儿 2022-05-15 02:47 199阅读 0赞

## 一、前言 ##

Apache Shiro 是 Java 的一个安全框架。功能强大，使用简单的Java安全框架，它为开发人员提供一个直观而全面的认证，授权，加密及会话管理的解决方案。

## 二、介绍 ##

### 2.1 功能特点 ###

Shiro 包含 10 个内容，如下图：

![image][]

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：记住我，这个是非常常见的功能，即一次登录后，下次再来的话不用登录了。

### 2.2 运行原理 ###

Shiro 运行原理图1（应用程序角度）如下：

![image][image 1]

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

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

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

Shiro 运行原理图2（Shiro 内部架构角度）如下：

![image][image 2]

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

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

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

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

5) Realm：可以有1个或多个 Realm，可以认为是安全实体数据源，即用于获取安全实体的。它可以是 JDBC 实现，也可以是 LDAP 实现，或者内存实现等。

6) SessionManager：如果写过 Servlet 就应该知道 Session 的概念，Session 需要有人去管理它的生命周期，这个组件就是 SessionManager。而 Shiro 并不仅仅可以用在 Web 环境，也可以用在如普通的 JavaSE 环境。

7) SessionDAO：DAO 大家都用过，数据访问对象，用于会话的 CRUD。我们可以自定义 SessionDAO 的实现，控制 session 存储的位置。如通过 JDBC 写到数据库或通过 jedis 写入 redis 中。另外 SessionDAO 中可以使用 Cache 进行缓存，以提高性能。

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

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

### 2.3 过滤器 ###

当 Shiro 被运用到 web 项目时，Shiro 会自动创建一些默认的过滤器对客户端请求进行过滤。以下是 Shiro 提供的过滤器：

<table> 
 <thead> 
  <tr> 
   <th>过滤器简称</th> 
   <th>对应的 Java 类</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>anon</td> 
   <td>org.apache.shiro.web.filter.authc.AnonymousFilter</td> 
  </tr> 
  <tr> 
   <td>authc</td> 
   <td>org.apache.shiro.web.filter.authc.FormAuthenticationFilter</td> 
  </tr> 
  <tr> 
   <td>authcBasic</td> 
   <td>org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter</td> 
  </tr> 
  <tr> 
   <td>perms</td> 
   <td>org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>org.apache.shiro.web.filter.authz.PortFilter</td> 
  </tr> 
  <tr> 
   <td>rest</td> 
   <td>org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter</td> 
  </tr> 
  <tr> 
   <td>roles</td> 
   <td>org.apache.shiro.web.filter.authz.RolesAuthorizationFilter</td> 
  </tr> 
  <tr> 
   <td>ssl</td> 
   <td>org.apache.shiro.web.filter.authz.SslFilter</td> 
  </tr> 
  <tr> 
   <td>user</td> 
   <td>org.apache.shiro.web.filter.authc.UserFilter</td> 
  </tr> 
  <tr> 
   <td>logout</td> 
   <td>org.apache.shiro.web.filter.authc.LogoutFilter</td> 
  </tr> 
  <tr> 
   <td>noSessionCreation</td> 
   <td>org.apache.shiro.web.filter.session.NoSessionCreationFilter</td> 
  </tr> 
 </tbody> 
</table>

解释：

1.  `/admins/**=anon # 表示该 uri 可以匿名访问`
2.  `/admins/**=auth # 表示该 uri 需要认证才能访问`
3.  `/admins/**=authcBasic # 表示该 uri 需要 httpBasic 认证`
4.  `/admins/**=perms[user:add:*] # 表示该 uri 需要认证用户拥有 user:add:* 权限才能访问`
5.  `/admins/**=port[8081] # 表示该 uri 需要使用 8081 端口`
6.  `/admins/**=rest[user] # 相当于 /admins/**=perms[user:method]，其中，method 表示 get、post、delete 等`
7.  `/admins/**=roles[admin] # 表示该 uri 需要认证用户拥有 admin 角色才能访问`
8.  `/admins/**=ssl # 表示该 uri 需要使用 https 协议`
9.  `/admins/**=user # 表示该 uri 需要认证或通过记住我认证才能访问`
10. `/logout=logout # 表示注销,可以当作固定配置`

**注意：**

anon，authcBasic，auchc，user 是认证过滤器。

perms，roles，ssl，rest，port 是授权过滤器。

## 三、基础入门 ##

### 3.1 添加依赖 ###

1.  `<dependency>`
2.  `<groupId>commons-logging</groupId>`
3.  `<artifactId>commons-logging</artifactId>`
4.  `<version>1.1.3</version>`
5.  `</dependency>`
6.   
7.  `<dependency>`
8.  `<groupId>org.apache.shiro</groupId>`
9.  `<artifactId>shiro-core</artifactId>`
10. `<version>1.4.0</version>`
11. `</dependency>`

### 3.2 配置文件 ###

在 src/main/resources 目录下创建名为 shiro.ini 的配置文件，内容如下：

1.  `[users]`
2.  `# admin=admin 分别表示账号和密码，administrator 表示逗号前边的账号拥有 administrator 这个角色。`
3.  `admin=admin,administrator`
4.  `zhangsan=zhangsan,manager`
5.  `lisi=lisi,guest`
6.   
7.  `[roles]`
8.  `# administrator 表示角色名称，* 表示这个角色拥有所有权限`
9.  `administrator=*`
10. `manager=user:*,department:*`
11. `guest=user:query,department:query`

其中，每个用户可以拥有多个角色，通过逗号分隔。每个角色可以拥有多个权限，同样通过逗号分隔。

### 3.3 编码 ###

1.  `public class ShiroTest {`
2.   
3.  `@Test`
4.  `public void test() {`
5.   
6.  `// 读取 shiro.ini 文件内容`
7.  `Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");`
8.  `SecurityManager securityManager = factory.getInstance();`
9.  `SecurityUtils.setSecurityManager(securityManager);`
10.  
11. `Subject currentUser = SecurityUtils.getSubject();`
12.  
13. `Session session = currentUser.getSession();`
14. `session.setAttribute("someKey", "aValue");`
15. `String value = (String) session.getAttribute("someKey");`
16. `if (value.equals("aValue")) {`
17. `System.out.println("someKey 的值：" + value);`
18. `}`
19.  
20. `// 登陆`
21. `UsernamePasswordToken token = new UsernamePasswordToken("zhangsan", "zhangsan");`
22. `token.setRememberMe(true);`
23. `try {`
24. `currentUser.login(token);`
25. `} catch (UnknownAccountException uae) {`
26. `System.out.println("用户名不存在:" + token.getPrincipal());`
27. `} catch (IncorrectCredentialsException ice) {`
28. `System.out.println("账户密码 " + token.getPrincipal() + " 不正确!");`
29. `} catch (LockedAccountException lae) {`
30. `System.out.println("用户名 " + token.getPrincipal() + " 被锁定 !");`
31. `}`
32.  
33. `// 认证成功后`
34. `if (currentUser.isAuthenticated()) {`
35.  
36. `System.out.println("用户 " + currentUser.getPrincipal() + " 登陆成功！");`
37.  
38. `//测试角色`
39. `System.out.println("是否拥有 manager 角色：" + currentUser.hasRole("manager"));`
40.  
41. `//测试权限`
42. `System.out.println("是否拥有 user:create 权限" + currentUser.isPermitted("user:create"));`
43.  
44. `//退出`
45. `currentUser.logout();`
46. `}`
47.  
48. `}`
49. `}`

打印结果：

1.  `someKey 的值：aValue`
2.  `用户 zhangsan 登陆成功！`
3.  `是否拥有 manager 角色：true`
4.  `是否拥有 user:create 权限true`

在项目的**后端代码**中，我们可以通过 Subject 对象检测出当前登录用户的认证状态和授权信息，以下是 Subject 对象认证和授权相关的方法列表：

![image][image 3]

如果开发者不想使用代码进行用户进行授权校验等操作，那么可以使用注解代替。

在使用 Shiro 的注解之前，请确保项目中已经添加支持 AOP 功能的相关 jar 包。常用注解如下：

1.  `@RequiresRoles( "manager" ) # 角色校验`
2.  `public String save() {`
3.  `//...`
4.  `}`
5.  `@RequiresPermissions("user:manage") # 权限检验`
6.  `public String delete() {`
7.  `//...`
8.  `}`

当客户端发送请求后，系统会使用 AOP 生成请求目标的代理类来解析注解，然后判断当前请求的用户是否拥有权限访问。

在项目的**前端代码**中，如果使用的是 JSP 模板，我们就可以使用 Shiro 提供的标签对页面元素的展示进行控制。

例如：

1.  `<%@ taglib prefix="shiro" uri=http://shiro.apache.org/tags %>`
2.  `<html>`
3.  `<body>`
4.  `<shiro:hasPermission name="user:manage">`
5.  `<a href="manageUsers.jsp">`
6.  `点击进入管理界面`
7.  `</a>`
8.  `</shiro:hasPermission>`
9.  `<shiro:lacksPermission name="user:manage">`
10. `没有管理权限`
11. `</shiro:lacksPermission>`
12. `</body>`
13. `</html>`

其中，user:manage 对应 shiro.ini 文件中\[roles\]下边的设置。

## 四、自定义 Realm ##

上边的程序使用的是 Shiro 自带的 IniRealm，而 IniRealm 从 ini 配置文件中读取用户的信息，**大部分情况下需要从系统的数据库中读取用户信息，所以需要自定义 realm**。

Shiro 为我们提供了如下 Realm:

![image][image 4]

其中，最基础的是 Realm 接口，CachingRealm 负责缓存处理，AuthenticationRealm 负责认证，AuthorizingRealm负责授权，通常自定义的 realm 继承 **AuthorizingRealm**。

自定义 Realm：

1.  `public class CustomRealm extends AuthorizingRealm {`
2.   
3.  `/**`
4.  `* 认证`
5.  `*/`
6.  `@Override`
7.  `protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {`
8.  `// 从 token 中获取用户身份信息`
9.  `String username = (String) token.getPrincipal();`
10. `// 通过 username 从数据库中查询`
11.  
12. `// 如果查询不到则返回 null`
13. `if(!username.equals("zhangsan")){//这里模拟查询不到`
14. `return null;`
15. `}`
16.  
17. `//获取从数据库查询出来的用户密码`
18. `String dbPassword = "zhangsan";//这里使用静态数据模拟`
19.  
20. `//返回认证信息由父类 AuthenticatingRealm 进行认证`
21. `SimpleAuthenticationInfo simpleAuthenticationInfo = new SimpleAuthenticationInfo(username, dbPassword, getName());`
22.  
23. `return simpleAuthenticationInfo;`
24. `}`
25.  
26. `/**`
27. `* 授权`
28. `*/`
29. `@Override`
30. `protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {`
31. `// 获取身份信息`
32. `String username = (String) principals.getPrimaryPrincipal();`
33. `// 根据身份信息从数据库中查询权限数据`
34. `// 这里使用静态数据模拟`
35. `List<String> permissions = new ArrayList<String>();`
36. `permissions.add("user:*");`
37. `permissions.add("department:*");`
38.  
39. `// 将权限信息封闭为AuthorizationInfo`
40. `SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();`
41. `// 模拟数据，添加 manager 角色`
42. `simpleAuthorizationInfo.addRole("manager");`
43.  
44. `for(String permission:permissions){`
45. `simpleAuthorizationInfo.addStringPermission(permission);`
46. `}`
47.  
48. `return simpleAuthorizationInfo;`
49. `}`
50.  
51. `}`

在 src/main/resources 目录下创建 shiro-realm.ini 文件，内容如下：

1.  `[main]`
2.  `#自定义 realm`
3.  `customRealm=com.light.shiroTest.realm.CustomRealm`
4.  `#将realm设置到securityManager`
5.  `securityManager.realms=$customRealm`

将测试类中，shiro.ini 改成 shiro-realm.ini 后执行，结果如下：

1.  `someKey 的值：aValue`
2.  `用户 zhangsan 登陆成功！`
3.  `是否拥有 manager 角色：true`
4.  `是否拥有 user:create 权限true`

## 五、与 Spring 整合 ##

由于项目设计思路不同，整合 Shiro 框架时的设置也会有所不同，因此下边只列出部分通用的代码。

### 5.1 添加依赖 ###

1.  `<dependency>`
2.  `<groupId>org.apache.shiro</groupId>`
3.  `<artifactId>shiro-core</artifactId>`
4.  `<version>1.4.0</version>`
5.  `</dependency>`
6.  `<dependency>`
7.  `<groupId>org.apache.shiro</groupId>`
8.  `<artifactId>shiro-spring</artifactId>`
9.  `<version>1.4.0</version>`
10. `</dependency>`

### 5.2 配置文件 ###

web.xml ：

1.  `<filter>`
2.  `<filter-name>shiroFilter</filter-name>`
3.  `<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>`
4.  `<init-param>`
5.  `<param-name>targetFilterLifecycle</param-name>`
6.  `<param-value>true</param-value>`
7.  `</init-param>`
8.  `</filter>`
9.   
10. `<filter-mapping>`
11. `<filter-name>shiroFilter</filter-name>`
12. `<url-pattern>/*</url-pattern>`
13. `</filter-mapping>`

application-shiro.xml：

1.  `<bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">`
2.  ``
3.  `<property name="securityManager" ref="securityManager"/>`
4.  ``
5.  `<property name="loginUrl" value="/login.jsp"/>`
6.  `<property name="successUrl" value="/home.jsp"/>`
7.  `<property name="unauthorizedUrl" value="/unauthorized.jsp"/>`
8.  `<property name="filterChainDefinitions">`
9.  `<value>`
10. ``
11. `/resources/** = anon`
12. `/login = anon`
13. ``
14. `/** = authc`
15. `</value>`
16. `</property>`
17. `</bean>`
18.  
19. ``
20. `<bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">`
21. `<property name="realm" ref="customRealm" />`
22. `</bean>`
23.  
24. ``
25. `<bean id="customRealm" class="com.light.ac.web.realm.CustomRealm"></bean>`
26.  
27. ``
28. `<bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor" />`

其中，application-shiro.xml 中的 shiroFilter 名字和 web.xml 文件中的 shiroFilter是对应的，必须一致。

anon 和 authc 对应上文提到的过滤器。

CustomRealm 类：

1.  `public class CustomRealm extends AuthorizingRealm {`
2.   
3.  `@Autowired`
4.  `private UserService userService;`
5.   
6.  `@Autowired`
7.  `private PermissionService permissionService;`
8.   
9.  `/**`
10. `* 认证`
11. `*/`
12. `@Override`
13. `protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {`
14. `// 获取用户名`
15. `String userName = (String) token.getPrincipal();`
16. `// 通过用户名获取用户对象`
17. `User user = this.userService.findUserByUserName(userName);`
18.  
19. `if (user == null) {`
20. `return null;`
21. `}`
22.  
23. `// 通过 userId 获取该用户拥有的所有权限，返回值根据自己需求编写，并非固定值。`
24. `Map<String,List<Permission>> permissionMap = this.permissionService.getPermissionMapByUserId(user.getId());`
25.  
26. `// （目录+菜单，分层级，用于前端 jsp 遍历）`
27. `user.setMenuList(permissionMap.get("menuList"));`
28. `// （目录+菜单+按钮，用于后端权限判断）`
29. `user.setPermissionList(permissionMap.get("permissionList"));`
30.  
31. `SimpleAuthenticationInfo info = new SimpleAuthenticationInfo(user,user.getPassword(),this.getName());`
32.  
33. `return info;`
34. `}`
35.  
36. `/**`
37. `* 授权`
38. `*/`
39. `@Override`
40. `protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {`
41. `User user = (User) principals.getPrimaryPrincipal();`
42.  
43. `SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();`
44.  
45. `// （目录+菜单+按钮，用于后端权限判断）`
46. `List<Permission> permissionList = user.getPermissionList();`
47.  
48. `for (Permission permission : permissionList) {`
49. `if (StringUtil.isNotEmpty(permission.getCode())) {`
50. `info.addStringPermission(permission.getCode());`
51. `}`
52. `}`
53.  
54. `return info;`
55. `}`
56. `}`

具体代码可以根据下文提供的源码地址进行下载查看。

## 六、源码下载 ##

[authority-control-shiro][]

## 七、参考资料 ##

*  [http://shiro.apache.org/documentation.html][http_shiro.apache.org_documentation.html] 官方文档

[image]: /images/20220515/8cb3095c7d2241ab9f73dcf5e349db26.png
[image 1]: /images/20220515/a9ff309cd4f94cfcbbdf50259759f691.png
[image 2]: /images/20220515/cd2c9e67e15448c39ec401d1db025512.png
[image 3]: /images/20220515/13a27cd129f94d43805ca1964ab17a86.png
[image 4]: /images/20220515/c2340fddf90b47d7af575a977f480ba5.png
[authority-control-shiro]: https://github.com/moonlightL/authority-control
[http_shiro.apache.org_documentation.html]: http://shiro.apache.org/documentation.html