【Shiro】Apache Shiro架构之实际运用（整合到Spring中)

骑猪看日落 2022-09-22 12:57 207阅读 0赞

欢迎关注我新搭建的博客：[http://www.itcodai.com/][http_www.itcodai.com]

> Shiro系列文章：  
> [【Shiro】Apache Shiro架构之身份认证（Authentication）][Shiro_Apache Shiro_Authentication]  
> [【Shiro】Apache Shiro架构之权限认证（Authorization）][Shiro_Apache Shiro_Authorization]  
> [【Shiro】Apache Shiro架构之集成web][Shiro_Apache Shiro_web]  
> [【Shiro】Apache Shiro架构之自定义realm][Shiro_Apache Shiro_realm]

> 写在前面：前面陆陆续续对Shiro的使用做了一些总结，如题，这篇博文主要是总结一下如何将Shiro运用到实际项目中，也就是将Shiro整到Spring中进行开发。后来想想既然要整，就索性把SpringMVC和MyBatis也整进去吧，整个比较完整的，也能帮助更多的初学者。所以本文实际是将Shiro整到SSM中（基于maven）。

其实Shiro整合到Spring中并没有想象的那么困难，整到Spring中后，我们自定义的realm啊、securityManager啊等等都会交给spring去管理了，包括我们需要指定哪些url需要做什么样的验证，都是交给spring，也就是说，完全可以摆脱原来的那个.ini配置文件了，会觉得非常清爽，非常有逻辑。好了，下面开始整，Shiro部分参考了它的官方文档：[http://shiro.apache.org/spring.html][http_shiro.apache.org_spring.html]。

## **1. 整个工程目录结构** ##

首先看一下整个工程的目录结构，先在宏观上对整体有个把握。  
![工程目录][20160630091951550]

## **2. 配置文件** ##

首先来完成一些配置文件，先从pom.xml开始，我已经用注释将它们归归类了，很清晰。

### **2.1 pom.xml** ###

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>demo.shiro</groupId>
      <artifactId>ShiroSpring</artifactId>
      <packaging>war</packaging>
      <version>0.0.1-SNAPSHOT</version>
      <name>ShiroSpring Maven Webapp</name>
      <url>http://maven.apache.org</url>
      <dependencies>
        
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.2.5</version>
        </dependency>
        
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-web</artifactId>
            <version>1.2.5</version>
        </dependency>
        
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-spring</artifactId>
            <version>1.2.5</version>
        </dependency>
    
    
        
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>
        
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>javax.servlet.jsp-api</artifactId>
            <version>2.3.1</version>
        </dependency>
        
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
        
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.21</version>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>   
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
        <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>4.3.0.RELEASE</version>
        </dependency>
    
        
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.0</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.0</version>
        </dependency>
    
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>
    
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.12</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
      <build>
        <finalName>ShiroSpring</finalName>
      </build>
    </project>

### **2.2 log4j.properties** ###

这个文件，我都是直接从官方拷贝过来的，也贴一下：

log4j.rootLogger=DEBUG, Console  
    
    #Console 
    log4j.appender.Console=org.apache.log4j.ConsoleAppender  
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout  
    log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n  
    
    log4j.logger.java.sql.ResultSet=INFO  
    log4j.logger.org.apache=INFO  
    log4j.logger.java.sql.Connection=DEBUG  
    log4j.logger.java.sql.Statement=DEBUG  
    log4j.logger.java.sql.PreparedStatement=DEBUG

### **2.3 web.xml** ###

接下来在web.xml中添加Spring监听器、Shiro过滤器和SpringMVC支持：

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
      <display-name>ShiroSpring</display-name>
      <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
      </welcome-file-list>
    
      
      <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
      </listener>
      <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:applicationContext.xml</param-value>
      </context-param>
    
      
      <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
      </servlet>
      <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <url-pattern>*.do</url-pattern>
      </servlet-mapping>
    
      
      <filter>
        <filter-name>shiroFilter</filter-name>
        <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
        <init-param>
            
            <param-name>targetFilterLifecycle</param-name>
            <param-value>true</param-value>
        </init-param>
      </filter>
      <filter-mapping>
        <filter-name>shiroFilter</filter-name>
        <url-pattern>/*</url-pattern>
      </filter-mapping>
    
      
      <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <async-supported>true</async-supported>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
      </filter>
      <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
      </filter-mapping>
    </web-app>

### **2.4 applicationContext.xml** ###

这是整个工程的核心配置文件，先看一下配置，我再做一些分析。

<?xml version="1.0" encoding="UTF-8"?>    
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx" xsi:schemaLocation=" http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">    
    
        
        <context:component-scan base-package="demo.service" />
    
        
        <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
            <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/db_shiro"/>
            <property name="username" value="root"/>
            <property name="password" value="root"/>
        </bean>
    
        
        <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
            <property name="dataSource" ref="dataSource" />
            
            <property name="mapperLocations" value="classpath:demo/mappers/*.xml"></property>
            
            <property name="configLocation" value="classpath:mybatis-config.xml"></property>
        </bean>
    
        
        <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
            <property name="basePackage" value="demo.dao" />
            <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
        </bean>
    
        
        <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
            <property name="dataSource" ref="dataSource" />
        </bean>
    
        
        <bean id="myRealm" class="demo.realm.MyRealm"/>  
    
        
        <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">  
          <property name="realm" ref="myRealm"/>  
        </bean>  
    
        
        <bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">  
              
            <property name="securityManager" ref="securityManager"/>
              
            <property name="loginUrl" value="/login.jsp"/>
              
            <property name="unauthorizedUrl" value="/unauthorized.jsp"/>  
              
            <property name="filterChainDefinitions">  
                <value>  
                    /login=anon
                    /user/admin*=authc
                    /user/student*/**=roles[teacher]
                    /user/teacher*/**=perms["user:create"]
                </value>  
            </property>
        </bean>  
    
          
        <bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor"/>  
    
        
        <bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" depends-on="lifecycleBeanPostProcessor"/>  
            <bean class="org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor">  
          <property name="securityManager" ref="securityManager"/>  
        </bean>  
    
          
        <tx:advice id="txAdvice" transaction-manager="transactionManager">  
              
            <tx:attributes>  
                <tx:method name="insert*" propagation="REQUIRED" />  
                <tx:method name="update*" propagation="REQUIRED" />  
                <tx:method name="edit*" propagation="REQUIRED" />  
                <tx:method name="save*" propagation="REQUIRED" />  
                <tx:method name="add*" propagation="REQUIRED" />  
                <tx:method name="new*" propagation="REQUIRED" />  
                <tx:method name="set*" propagation="REQUIRED" />  
                <tx:method name="remove*" propagation="REQUIRED" />  
                <tx:method name="delete*" propagation="REQUIRED" />  
                <tx:method name="change*" propagation="REQUIRED" />  
                <tx:method name="check*" propagation="REQUIRED" />  
                <tx:method name="get*" propagation="REQUIRED" read-only="true" />  
                <tx:method name="find*" propagation="REQUIRED" read-only="true" />  
                <tx:method name="load*" propagation="REQUIRED" read-only="true" />  
                <tx:method name="*" propagation="REQUIRED" read-only="true" />  
            </tx:attributes>  
        </tx:advice>  
    
          
        <aop:config>  
            <aop:pointcut id="serviceOperation" expression="execution(* demo.service.*.*(..))" />  
            <aop:advisor advice-ref="txAdvice" pointcut-ref="serviceOperation" />  
        </aop:config>         
    </beans>

spring的配置文件中，我主要来说明一下shiro这一部分，因为其他部分都一样，扫描bean，配置数据源相关的，配置事务等等。我把上面shiro部分截图下来了：  
![shiro][]  
　　从这部分的配置可以看出，其实就是和上一节中在.ini文件中配置的一样的，只不过现在换成让spring去管理了，也很好理解，当然这里自定义的MyRealm还没写，因为MyRealm中需要有关于数据库的操作，所以下面先把mybatis部分整合好（其实加上MyRealm，shiro部分已经整合完了~）。

## **3. 整合MyBatis** ##

### **3.1 全局配置文件** ###

首先配置一下mybatis的全局配置文件mybatis-config.xml，因为数据源啥的都交给spring管理了，所以全局配置文件就比较清爽了，当然还有一些设置上的东西，就不配置了，这个要看具体实际中使用的时候在配置。

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        
        <typeAliases>
            <package name="demo.entity"/>
        </typeAliases>
    </configura

### **3.2 配置mapper映射文件** ###

配置一下UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="demo.dao.UserDao">
    
    
        <select id="getByUsername" parameterType="String" resultType="User">
            select * from t_user where username=#{username}
        </select>
    
        <select id="getRoles" parameterType="String" resultType="String">
            select r.rolename from t_user u,t_role r where u.role_id=r.id and u.username=#{username}
        </select>
    
        <select id="getPermissions" parameterType="String" resultType="String">
            select p.permissionname from t_user u,t_role r,t_permission p where u.role_id=r.id and p.role_id=r.id and u.username=#{username}
        </select>
    
    </mapper>

由配置可知，我们指定的是demo.dao.UserDao这个类，扫描mapper类是交给spring管理的，所以mapper接口可以不用和mapper映射文件同名且放到同一目录下，如果是交给mybatis管理我测试过是需要这么做的，在我之前mybatis的博文中也有提到这些。接下来就是写dao接口了（其实就是mapper映射文件对应的mapper接口）。

### **3.3 mapper接口** ###

public interface UserDao { 
    
        public User getByUsername(String username);
    
        public Set<String> getRoles(String username);
    
        public Set<String> getPermissions(String username);
    }

只需要写接口即可，不需要写实现，spring的配置文件中会去扫描mapper，会自动创建一个代理对象来执行相应的方法，要注意的是这个接口中的方法名要和上面mapper映射文件中的id号一样的，否则是无法映射到具体的statement上面的，会报错的。

### **3.4 po类** ###

这里就写一个简单的User类，数据库中的存储信息可以参考上一篇博文，跟那边一样的。

public class User { 
    
        private Integer id;
        private String username;
        private String password;
        //省略get set方法
    }

### **3.5 完成service** ###

顺带着把service层也完善了，这里我就写实现类了，接口就不写了。

@Service("userService")
    public class UserServiceImpl implements UserService{ 
    
        @Resource
        private UserDao userDao;
    
        public User getByUsername(String username) {
            return userDao.getByUsername(username);
        }
    
        public Set<String> getRoles(String username) {
            return userDao.getRoles(username);
        }
    
        public Set<String> getPermissions(String username) {
            return userDao.getPermissions(username);
        }
    
    }

在service的实现类中，注入刚刚写好的dao接口即可调用其中的方法了，使用的是spring自动创建的代理对象去执行的。

## **4 整合SpringMVC** ##

### **4.1 配置文件** ###

上面的工作做完了后，其实需要写一个测试程序来测试一下能否正确访问数据库，因为整合必须步步为营。由于这个比较简单，我就不写测试程序了。因为前面web.xml配置中已经加入springmvc的支持了，所以这里直接写一下spring-mvc.xml配置文件即可：

我这里只配置了扫描包，没有配映射器和适配器，也没有写那个`<mvc:annotation-driven></mvc:annotation-driven>`注解驱动，也是可以执行的，我在网上没查到原因，也没去看源码，我的猜测是springmvc中可能有默认的映射器和适配器。如果有看过源码的朋友，请不吝赐教。

### **4.2 完成controller** ###

配置好了后，就完成controller了，一个controller即可，因为一个controller中可以写很多方法。

@Controller
    @RequestMapping("/user")
    public class UserController { 
    
        //用户登录
        @RequestMapping("/login")
        public String login(User user, HttpServletRequest request) {
            Subject subject = SecurityUtils.getSubject();
            UsernamePasswordToken token = new UsernamePasswordToken(user.getUsername(), user.getPassword());
            try{
                subject.login(token);//会跳到我们自定义的realm中
                request.getSession().setAttribute("user", user);
                return "success";
            }catch(Exception e){
                e.printStackTrace();
                request.getSession().setAttribute("user", user);
                request.setAttribute("error", "用户名或密码错误！");
                return "login";
            }
        }
    
        @RequestMapping("/logout")
        public String logout(HttpServletRequest request) {
            request.getSession().invalidate();
            return "index";
        }   
    
        @RequestMapping("/admin")
        public String admin(HttpServletRequest request) {
            return "success";
        }
    
        @RequestMapping("/student")
        public String student(HttpServletRequest request) {
            return "success";
        }   
    
        @RequestMapping("/teacher")
        public String teacher(HttpServletRequest request) {
            return "success";
        }   
    }

### **4.2 完成自定义realm** ###

终于可以写自己的realm了，上面用户登录会执行一个`subject.login(token);`这里会跳转到我们自定义的realm中，接下来就来定义一下我们自己的realm，由于这里是和mybatis整合了，所以不需要原来的那个DbUtil去连接数据库了，直接使用mybatis中的mapper接口，也就是上面我们写的dao。

public class MyRealm extends AuthorizingRealm { 
    
        @Resource
        private UserService userService;
    
        // 为当前登陆成功的用户授予权限和角色，已经登陆成功了
        @Override
        protected AuthorizationInfo doGetAuthorizationInfo(
                PrincipalCollection principals) {
            String username = (String) principals.getPrimaryPrincipal(); //获取用户名
            SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
            authorizationInfo.setRoles(userService.getRoles(username));
            authorizationInfo.setStringPermissions(userService.getPermissions(username));
            return authorizationInfo;
        }
    
        // 验证当前登录的用户，获取认证信息
        @Override
        protected AuthenticationInfo doGetAuthenticationInfo(
                AuthenticationToken token) throws AuthenticationException {
            String username = (String) token.getPrincipal(); // 获取用户名
            User user = userService.getByUsername(username);
            if(user != null) {
                AuthenticationInfo authcInfo = new SimpleAuthenticationInfo(user.getUsername(), user.getPassword(), "myRealm");
                return authcInfo;
            } else {
                return null;
            }       
        }
    }

这个自定义realm的原理和上一节是一样的，只不过这里使用注入的是service，然后service中使用的是dao接口中的方法去操作数据库。

## **5. 几个jsp页面** ##

接下来就剩几个jsp页面了，我简单弄一下：

<body>
        <form action="${pageContext.request.contextPath }/user/login.do" method="post">
            username:<input type="text" name="username"/><br>
            password:<input type="password" name="password"/><br>
            <input type="submit" value="登陆">${error }
        </form>
    </body>
    
    
    <body>
         欢迎你${user.username }
         <a href="${pageContext.request.contextPath }/user/logout.do">退出</a>
    </body>
    
    
    <body>
         认证未通过，或者权限不足
         <a href="${pageContext.request.contextPath }/user/logout.do">退出</a>
    </body>

## **6. 测试** ##

根据spring的配置文件中对shiro的url拦截配置，我们首先请求：[http://localhost:8080/ShiroSpring/user/admin.do][http_localhost_8080_ShiroSpring_user_admin.do]来测试身份认证，然后会跳转到登录页面让我们登陆，登陆成功后，再次请求这个url就会进入success.jsp页面了。  
　　再测试角色和权限认证，可以先后输入[http://localhost:8080/ShiroSpring/user/student.do][http_localhost_8080_ShiroSpring_user_student.do]来测试角色认证，输入[http://localhost:8080/ShiroSpring/user/teacher.do][http_localhost_8080_ShiroSpring_user_teacher.do]来测试权限认证。通过登陆不同的用户去测试即可。  
　　【注】：如果需要源码可以给我留言或私信，我就不上传了。  
　　【更新】：没想到要源码的人太多了，我放到下载频道了。大家自行下载去吧~别忘了点个赞哈~[下载地址][Link 1]

文末福利：“程序员私房菜”，一个有温度的公众号~  
![程序员私房菜][70]

--------------------

—–乐于分享，共同进步！  
—–我的博客主页：[http://blog.csdn.net/eson\_15][http_blog.csdn.net_eson_15]

[http_www.itcodai.com]: http://www.itcodai.com/
[Shiro_Apache Shiro_Authentication]: http://blog.csdn.net/eson_15/article/details/51770685
[Shiro_Apache Shiro_Authorization]: http://blog.csdn.net/eson_15/article/details/51774007
[Shiro_Apache Shiro_web]: http://blog.csdn.net/eson_15/article/details/51775630
[Shiro_Apache Shiro_realm]: http://blog.csdn.net/eson_15/article/details/51779271
[http_shiro.apache.org_spring.html]: http://shiro.apache.org/spring.html
[20160630091951550]: /images/20220721/3019791b9fa942f1b43229739b44e57b.png
[shiro]: /images/20220721/ffce7f468ca54316b6965e3ccd79b04d.png
[http_localhost_8080_ShiroSpring_user_admin.do]: http://localhost:8080/ShiroSpring/user/admin.do
[http_localhost_8080_ShiroSpring_user_student.do]: http://localhost:8080/ShiroSpring/user/student.do
[http_localhost_8080_ShiroSpring_user_teacher.do]: http://localhost:8080/ShiroSpring/user/teacher.do
[Link 1]: http://download.csdn.net/detail/eson_15/9790981
[70]: /images/20220721/f506098206d24300afb90c822b095042.png
[http_blog.csdn.net_eson_15]: http://blog.csdn.net/eson_15