SpringMVC整合Shiro权限框架

女爷i 2022-06-01 11:11 235阅读 0赞

最近在学习Shiro，首先非常感谢开涛大神的《[跟我学Shiro][Shiro]》系列，在我学习的过程中发挥了很大的指导作用。学习一个新的东西首先就是做一个demo，多看不如多敲，只有在实践中才能发现自己的欠缺，下面记录下来我整合shiro的过程。如果有不足之处，还望各位看官多多指出。

**一、基本名词解释**

Apache Shiro是一个强大易用的Java安全框架。它可以帮助我们完成：认证、授权、加密、会话管理、与Web集成、缓存、单点登录等等，而且它的API也十分简洁易用，所以现在有很多人都在使用它。它的基本能功能点如图所示：

![Center][]

从图上我们可以看出Shiro的四大核心功能：

Authentication(身份验证)：简称为“登录”，即证明用户是谁。  
Authorization(授权)：访问控制的过程，即决定是否有权限去访问受保护的资源。  
Session Management(会话管理)：管理用户特定的会话，即使在非 Web 或 EJB 应用程序。  
Cryptography(加密)：通过使用加密算法保持数据安全

我们同时也可以看看Shiro的架构长什么样子：

![Center 1][]

同样的虚线框框圈着的是Shiro3大核心组件：

Subject ：正与系统进行交互的人，或某一个第三方服务。所有 Subject  实例都被绑定到（且这是必须的）一个SecurityManager 上。  
SecurityManager：Shiro 架构的心脏，用来协调内部各安全组件，管理内部组件实例，并通过它来提供安全管理的各种服务。当 Shiro 与一个 Subject  进行交互时，实质上是幕后的 SecurityManager  处理所有繁重的 Subject 安全操作。  
Realms ：本质上是一个特定安全的 DAO。当配置 Shiro  时，必须指定至少一个 Realm  用来进行身份验证和/或授权。Shiro 提供了多种可用的 Realms 来获取安全相关的数据。如关系数据库(JDBC)，INI 及属性文件等。可以定义自己 Realm  实现来代表自定义的数据源。

以上是些基本的名称解释。如需要查看更详细的请参考开涛大神的博客。

**二、准备工作**

整合程序沿用之前的例子[Maven+spring+Spring MVC+MyBatis+MySQL][Maven_spring_Spring MVC_MyBatis_MySQL]整合SSM框架，现在我们需要在此基础上继续整合进Shiro。

**三、开始整合**

1.加入jar包

整合demo用的是maven对依赖进行管理。我们需要在pom.xml里加上配置：

**\[html\]**  [view plain][]  [copy][view plain]

1.    <dependency>  
2.     <groupId>com.alibaba</groupId>  
3.     <artifactId>fastjson</artifactId>  
4.     <version>1.1.32</version>  
5. </dependency>  
6.     <dependency>  
7.     <groupId>org.apache.shiro</groupId>  
8.     <artifactId>shiro-core</artifactId>  
9.     <version>1.2.2</version>  
10. </dependency>  
11. <dependency>  
12.     <groupId>org.apache.shiro</groupId>  
13.     <artifactId>shiro-web</artifactId>  
14.     <version>1.2.2</version>  
15. </dependency>  
16. <dependency>  
17.     <groupId>org.apache.shiro</groupId>  
18.     <artifactId>shiro-spring</artifactId>  
19.     <version>1.2.2</version>  
20. </dependency>  
21. <dependency>  
22.     <groupId>org.apache.shiro</groupId>  
23.     <artifactId>shiro-ehcache</artifactId>  
24.     <version>1.2.2</version>  
25. </dependency>

里面我加入了阿里的fastjson。我用fastjson替换了jackson（理由：没有什么理由，就是喜欢用了.....）

2.Spring-mvc.xml的配置

这是替换掉jackson的配置

**\[html\]**  [view plain][]  [copy][view plain]

1. <mvc:annotation-driven>  
2.         <mvc:message-converters>  
3.             <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />  
4.             <bean class="org.springframework.http.converter.FormHttpMessageConverter" />  
5.             <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />  
6.               
7.             <bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter" />  
8.         </mvc:message-converters>  
9.     </mvc:annotation-driven>  
10.     <mvc:default-servlet-handler />   
11.       
12.   
13.       
14.       
15.     <bean  
16.         class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
17.         <property name="messageConverters">  
18.             <list>  
19.                 <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>   
20.                 <ref bean="fastJsonHttpMessageConverter" />  
21.       
24.             </list>  
25.         </property>  
26.     </bean>  
27.       
30.       
31.     <bean id="fastJsonHttpMessageConverter" class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">  
32.                 <property name="supportedMediaTypes">  
33.                     <list>  
34.                         <value>text/html;charset=UTF\-8</value>  
35.                         <value>application/json</value>  
36.                     </list>  
37.                 </property>  
38.                 <property name="features">  
39.                     <list>  
40.                         <value>WriteMapNullValue</value>  
41.                         <value>QuoteFieldNames</value>  
42.                     </list>  
43.                 </property>  
44.       </bean>

3.首先先配置Shiro Filter（web.xml）

**\[html\]**  [view plain][]  [copy][view plain]

1.   
2.       <filter>  
3.       <description>shiro 权限拦截</description>  
4.       <filter-name>shiroFilter</filter-name>  
5.       <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>  
6.       <init-param>  
7.           <param-name>targetFilterLifecycle</param-name>  
8.           <param-value>true</param-value>  
9.       </init-param>  
10.       </filter>  
11.       <filter-mapping>  
12.           <filter-name>shiroFilter</filter-name>  
13.           <url-pattern>/\*</url-pattern>  
14.       </filter-mapping>

4.创建Shiro的配置文件spring-shiro(注：这边统一起名为spring-\*.xml，然后可以在配置contextConfigLocation时使用通配符了)

**\[html\]**  [view plain][]  [copy][view plain]

1.         <?xml version="1.0" encoding="UTF-8"?>  
2.         <beans xmlns="http://www.springframework.org/schema/beans"  
3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.         xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd">  
5.           
6.         <bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">  
7.           
8.         <property name="securityManager" ref="securityManager"/>  
9.           
10.         <property name="loginUrl" value="/index.jsp"/>  
11.           
12.         <property name="successUrl" value="/jsp/success.jsp"/>  
13.         <span style="white-space:pre">    <property name="unauthorizedUrl" value="/jsp/unauthorized.jsp"/>  
14.           
15.         <property name="filterChainDefinitions">  
16.         <value>  
17.               /index.jsp=anon  
18.               /jsp/success.jsp=anon  
19.               /jsp/fail.jsp=anon  
20.               /jsp/user.jsp = roles\[user\]  
21.               /jsp/admin.jsp = roles\[admin\]  
22.               /logout = logout  
23.         </value>  
24.         </property>  
25.         </bean>  
26.   
27.           
28.         <bean id="cacheManager" class="org.apache.shiro.cache.ehcache.EhCacheManager">  
29.            
30.              <property name="cacheManagerConfigFile" value="classpath:ehcache-shiro.xml"/>   
31.         </bean>  
32.           
33.         <bean id="myRealm" class="com.gray.base.shiro.ShiroDbRealm">  
34.              <property name="userService" ref="userService" />  
35.          </bean>  
36.         <bean id="userService" class="com.gray.user.service.impl.UserServiceImpl" />  
37.           
38.         <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">  
39.             <property name="cacheManager" ref="cacheManager"/>   
40.              <property name="realm" ref="myRealm"/>   
41.              <property name="sessionMode" value="native">  
42.              </property>  
43.        </bean>  
44.          
45.         <bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor"/>  
46.        </beans>

5.数据库及页面设计好了。以上就是所有整合Shiro所需要配置的东西，下面我们开始写程序，为了方便，数据库我沿用之前的user表，将它进行了小小的改造，在实际项目中 对角色和权限的控制需要在定义多张表的。helloworld程序就将就着用了。sql语句如下：CREATE TABLE \`user\` ( \`username\` varchar(40) NOT NULL, \`password\` varchar(40) NOT NULL, \`age\` int(3) DEFAULT NULL, \`name\` varchar(40) DEFAULT NULL, \`role\` varchar(40) DEFAULT NULL, PRIMARY KEY (\`username\`)) ENGINE=InnoDB DEFAULT CHARSET=utf8; 表结构定义完后需要写实体类，这里就不贴代码了。jsp页面如图所示：  ![Center 2][]success.jsp 在这里我加入了Shiro的标签来控制页面的显示。其他的jsp就不一一列出代码了。

**\[html\]**  [view plain][]  [copy][view plain]

1. <%@ page language="java" contentType="text/html; charset=utf-8"pageEncoding="utf-8"%>  
2. <%@ taglib prefix="shiro" uri="http://shiro.apache.org/tags" %>  
3.   
4. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
5. <html>  
6. <head>  
7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  
8. <title></title>  
9. </head>  
10. <body>  
11. $\{successMsg \} Welcome!  <shiro:principal/>  
12.        
13.       
14.     <shiro:hasAnyRoles name="user">  
15.         <a href="/jsp/user.jsp">User Page</a>  
16.     </shiro:hasAnyRoles>  
17.       
18.        
19.       
20.     <shiro:hasAnyRoles name="admin">  
21.         <a href="/jsp/admin.jsp">Admin Page</a>  
22.     </shiro:hasAnyRoles>  
23.       
24.        
25.     <a href="../test/logout.do">Logout</a>  
26. </body>  
27. </html>

6.后台代码的编写  
6.1 Controller层的编写  
这次整合我么主要要实现登陆和登出功能，因此controller层我们这样写：

**\[java\]**  [view plain][]  [copy][view plain]

1.  package com.gray.user.controller;  
2.    
3.  import java.io.IOException;  
4.    
5.  import javax.servlet.http.HttpServletRequest;  
6.  import javax.servlet.http.HttpServletResponse;  
7.    
8.  import org.apache.shiro.SecurityUtils;  
9.  import org.apache.shiro.authc.AuthenticationException;  
10. import org.apache.shiro.authc.IncorrectCredentialsException;  
11. import org.apache.shiro.authc.UnknownAccountException;  
12. import org.apache.shiro.authc.UsernamePasswordToken;  
13. import org.apache.shiro.subject.Subject;  
14. import org.springframework.beans.factory.annotation.Autowired;  
15. import org.springframework.stereotype.Controller;  
16. import org.springframework.ui.Model;  
17. import org.springframework.web.bind.annotation.RequestMapping;  
18.   
19. import com.gray.user.entity.User;  
20. import com.gray.user.service.impl.UserServiceImpl;  
21.   
22. @Controller  
23. @RequestMapping("/test")   
24. public class LoginController \{  
25.     @Autowired  
26.     private UserServiceImpl userService;  
27.   
28. @RequestMapping("/dologin.do") //url  
29. public String dologin(User user, Model model)\{  
30.     String info = loginUser(user);  
31.     if (!"SUCC".equals(info)) \{  
32.         model.addAttribute("failMsg", "用户不存在或密码错误！");  
33.         return "/jsp/fail";  
34.     \}else\{  
35.         model.addAttribute("successMsg", "登陆成功！");//返回到页面说夹带的参数  
36.         model.addAttribute("name", user.getUsername());  
37.         return "/jsp/success";//返回的页面  
38.     \}  
39.   \}  
40.   
41. @RequestMapping("/logout.do")  
42. public void logout(HttpServletRequest request,HttpServletResponse response) throws IOException\{  
43.     Subject subject = SecurityUtils.getSubject();  
44.     if (subject != null) \{  
45.         try\{  
46.             subject.logout();  
47.         \}catch(Exception ex)\{  
48.         \}  
49.     \}  
50.     response.sendRedirect("/index.jsp");  
51. \}  
52.   
53. private String loginUser(User user) \{  
54.         if (isRelogin(user)) return "SUCC"; // 如果已经登陆，无需重新登录  
55.           
56.         return shiroLogin(user); // 调用shiro的登陆验证  
57. \}  
58. private String shiroLogin(User user) \{  
59.         // 组装token，包括客户公司名称、简称、客户编号、用户名称；密码  
60.     UsernamePasswordToken token = new UsernamePasswordToken(user.getUsername(), user.getPassword().toCharArray(), null);   
61.     token.setRememberMe(true);  
62.       
63.     // shiro登陆验证  
64.     try \{  
65.         SecurityUtils.getSubject().login(token);  
66.     \} catch (UnknownAccountException ex) \{  
67.         return "用户不存在或者密码错误！";  
68.     \} catch (IncorrectCredentialsException ex) \{  
69.         return "用户不存在或者密码错误！";  
70.     \} catch (AuthenticationException ex) \{  
71.         return ex.getMessage(); // 自定义报错信息  
72.     \} catch (Exception ex) \{  
73.         ex.printStackTrace();  
74.         return "内部错误，请重试！";  
75.     \}  
76.     return "SUCC";  
77. \}  
78.   
79. private boolean isRelogin(User user) \{  
80.     Subject us = SecurityUtils.getSubject();  
81.         if (us.isAuthenticated()) \{  
82.            return true; // 参数未改变，无需重新登录，默认为已经登录成功  
83.         \}  
84.         return false; // 需要重新登陆  
85. \}  
86. \}

6.2 实现自定义Realm   
shiro从Realm获取安全数据，也就是说SecurityManager要验证身份，它需要从Realm获取相应的用户进行比较以确定用户的身份是否合法；我们可以把Realm看作是DataSource，安全数据源。实现自定义Realm主要是继承AuthrizingRealm这个父类，重写doGetAuthrizationInfo和doGetAuthenticationInfo这两个方法，其中doGetAuthenticationInfo是用来验证用户合法性的，根据输入的用户信息从数据库中查出用户，根据用户情况抛出不同的异常。doGetAuthrizationInfo是对当前用的用户进行授权的。在这里我把角色写死了。在实际项目开发中应该是在表中做权限和角色的定义再从数据库中查出一个集合然后迭代授权。 具体实现代码如下：

**\[java\]**  [view plain][]  [copy][view plain]

1.  package com.gray.base.shiro;  
2.     
3.  import org.apache.shiro.SecurityUtils;  
4.  import org.apache.shiro.authc.AuthenticationException;  
5.  import org.apache.shiro.authc.AuthenticationInfo;  
6.  import org.apache.shiro.authc.AuthenticationToken;  
7.  import org.apache.shiro.authc.SimpleAuthenticationInfo;  
8.  import org.apache.shiro.authc.UsernamePasswordToken;  
9.  import org.apache.shiro.authz.AuthorizationInfo;  
10. import org.apache.shiro.authz.SimpleAuthorizationInfo;  
11. import org.apache.shiro.realm.AuthorizingRealm;  
12. import org.apache.shiro.session.Session;  
13. import org.apache.shiro.subject.PrincipalCollection;  
14. import org.springframework.beans.factory.annotation.Autowired;  
15.   
16. import com.gray.user.entity.User;  
17. import com.gray.user.service.impl.UserServiceImpl;  
18.   
19. public class ShiroDbRealm extends AuthorizingRealm \{  
20.     @Autowired  
21.     private UserServiceImpl userService;  
22.     public static final String SESSION\_USER\_KEY = "gray";  
23.   
24.     /\*\* 
25.      \* 授权查询回调函数, 进行鉴权但缓存中无用户的授权信息时调用,负责在应用程序中决定用户的访问控制的方法 
26.      \*/  
27.     @Override  
28.     protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection arg0) \{  
29.         User user = (User) SecurityUtils.getSubject().getSession().getAttribute(ShiroDbRealm.SESSION\_USER\_KEY);  
30.         SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();  
31.         info.addRole(user.getRole().trim());  
32.         return info;  
33.     \}  
34.   
35.     /\*\* 
36.      \* 认证回调函数，登录信息和用户验证信息验证 
37.      \*/  
38.     @Override  
39.     protected AuthenticationInfo doGetAuthenticationInfo(  
40.             AuthenticationToken authcToken) throws AuthenticationException \{  
41.         // 把token转换成User对象  
42.         User userLogin = tokenToUser((UsernamePasswordToken) authcToken);  
43.         // 验证用户是否可以登录  
44.         User ui = userService.doUserLogin(userLogin);  
45.         if(ui == null)  
46.             return null; // 异常处理，找不到数据  
47.         // 设置session  
48.         Session session = SecurityUtils.getSubject().getSession();  
49.         session.setAttribute(ShiroDbRealm.SESSION\_USER\_KEY, ui);   
50.         //当前 Realm 的 name  
51.         String realmName = this.getName();  
52.         //登陆的主要信息: 可以是一个实体类的对象, 但该实体类的对象一定是根据 token 的 username 查询得到的.  
53. //      Object principal = ui.getUsername();  
54.         Object principal = authcToken.getPrincipal();  
55.         return new SimpleAuthenticationInfo(principal, userLogin.getPassword(), realmName);  
56.     \}  
57.   
58.     private User tokenToUser(UsernamePasswordToken authcToken) \{  
59.         User user = new User();  
60.         user.setUsername(authcToken.getUsername());  
61.         user.setPassword(String.valueOf(authcToken.getPassword()));  
62.         return user;  
63.     \}  
64.   
65.     //一定要写getset方法  
66.     public UserServiceImpl getUserService() \{  
67.         return userService;  
68.     \}  
69.   
70.     public void setUserService(UserServiceImpl userService) \{  
71.         this.userService = userService;  
72.     \}  
73. \}

在这里我们要注意的是用 注解没办法注入我们要的service，一定要写getset方法，不然会报错（网上的解决办法挺有道理的但是试过没效果。。。。）。   
具体的serviceImpl的实现我就不写出来了，数据库的查询我相信大家都会（默认你们都会）。随后如果有需要我会把整合代码放上来。  
最后贴几张测试图：  
登陆界面：  
![Center 3][]  
以管理员角色的账号登陆：  
![Center 4][]  
AdminPage：  
![Center 5][]  
以普通用户角色的账号登陆：  
![Center 6][]  
UserPage：  
![Center 7][]  
当你以普通用户登录却想访问adminpage时：  
![Center 8][]  
登陆失败：  
![Center 9][]  
最后登出点击logout返回登陆主界面。  
以上就是整合Shiro的所有过程，当然在实际项目中不会那么简单但我觉得原理也是差不多的。学无止境，最后再次感谢网上提供资料的各位大神。

[Shiro]: http://jinnianshilongnian.iteye.com/category/305053
[Center]: /images/20220601/e586ef1353dd4c8faea7298d3d3b736a.png
[Center 1]: /images/20220601/f783c688acbd40adbdbdeb9634720615.png
[Maven_spring_Spring MVC_MyBatis_MySQL]: http://blog.csdn.net/donggua3694857/article/details/51874011
[view plain]: http://blog.csdn.net/donggua3694857/article/details/52157313#
[Center 2]: /images/20220601/0ddf845fab1741329f6efe9d470199ae.png
[Center 3]: /images/20220601/a377f65dd1f54537af62e0904d0d012f.png
[Center 4]: /images/20220601/a30408e4bace4cf6b1c96b5ea8295990.png
[Center 5]: /images/20220601/eb2f183a1407405cb029954e5e23add4.png
[Center 6]: /images/20220601/abd1c63e517b4aebb7e7295a6ee2bc33.png
[Center 7]: /images/20220601/b20f349c178d472d832620e3be93a580.png
[Center 8]: /images/20220601/8918979186664c3f94083f9c5d897e2b.png
[Center 9]: /images/20220601/df54a098f72e4f6c8ac3ea660cbdc505.png