Shiro学习（12）与Spring集成

亦凉 2022-07-26 04:26 195阅读 0赞

Shiro的组件都是JavaBean/POJO式的组件，所以非常容易使用Spring进行组件管理，可以非常方便的从ini配置迁移到Spring进行管理，且支持JavaSE应用及Web应用的集成。

在示例之前，需要导入shiro-spring及spring-context依赖，具体请参考pom.xml。  
spring-beans.xml配置文件提供了基础组件如DataSource、DAO、Service组件的配置。

**JavaSE应用**

spring-shiro.xml提供了普通JavaSE独立应用的Spring配置：  
Java代码

<bean id="cacheManager" class="org.apache.shiro.cache.ehcache.EhCacheManager">  
        <property name="cacheManagerConfigFile" value="classpath:ehcache.xml"/>  
    </bean>  
    
      
    <bean id="credentialsMatcher" class=" com.github.zhangkaitao.shiro.chapter12.credentials.RetryLimitHashedCredentialsMatcher">  
        <constructor-arg ref="cacheManager"/>  
        <property name="hashAlgorithmName" value="md5"/>  
        <property name="hashIterations" value="2"/>  
        <property name="storedCredentialsHexEncoded" value="true"/>  
    </bean>  
    
      
    <bean id="userRealm" class="com.github.zhangkaitao.shiro.chapter12.realm.UserRealm">  
        <property name="userService" ref="userService"/>  
        <property name="credentialsMatcher" ref="credentialsMatcher"/>  
        <property name="cachingEnabled" value="true"/>  
        <property name="authenticationCachingEnabled" value="true"/>  
        <property name="authenticationCacheName" value="authenticationCache"/>  
        <property name="authorizationCachingEnabled" value="true"/>  
        <property name="authorizationCacheName" value="authorizationCache"/>  
    </bean>  
      
    <bean id="sessionIdGenerator" class="org.apache.shiro.session.mgt.eis.JavaUuidSessionIdGenerator"/>  
      
    <bean id="sessionDAO" class="org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO">  
        <property name="activeSessionsCacheName" value="shiro-activeSessionCache"/>  
        <property name="sessionIdGenerator" ref="sessionIdGenerator"/>  
    </bean>  
      
    <bean id="sessionValidationScheduler" class="org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler">  
        <property name="sessionValidationInterval" value="1800000"/>  
        <property name="sessionManager" ref="sessionManager"/>  
    </bean>  
      
    <bean id="sessionManager" class="org.apache.shiro.session.mgt.DefaultSessionManager">  
        <property name="globalSessionTimeout" value="1800000"/>  
        <property name="deleteInvalidSessions" value="true"/>  
        <property name="sessionValidationSchedulerEnabled" value="true"/>  
       <property name="sessionValidationScheduler" ref="sessionValidationScheduler"/>  
        <property name="sessionDAO" ref="sessionDAO"/>  
    </bean>  
      
    <bean id="securityManager" class="org.apache.shiro.mgt.DefaultSecurityManager">  
        <property name="realms">  
            <list><ref bean="userRealm"/></list>  
        </property>  
        <property name="sessionManager" ref="sessionManager"/>  
        <property name="cacheManager" ref="cacheManager"/>  
    </bean>  
      
    <bean class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">  
    <property name="staticMethod" value="org.apache.shiro.SecurityUtils.setSecurityManager"/>  
        <property name="arguments" ref="securityManager"/>  
    </bean>  
      
    <bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor"/>

可以看出，只要把之前的ini配置翻译为此处的spring xml配置方式即可，无须多解释。LifecycleBeanPostProcessor用于在实现了Initializable接口的Shiro bean初始化时调用Initializable接口回调，在实现了Destroyable接口的Shiro bean销毁时调用 Destroyable接口回调。如UserRealm就实现了Initializable，而DefaultSecurityManager实现了Destroyable。具体可以查看它们的继承关系。

测试用例请参考com.github.zhangkaitao.shiro.chapter12.ShiroTest。

**Web应用**  
Web应用和普通JavaSE应用的某些配置是类似的，此处只提供一些不一样的配置，详细配置可以参考spring-shiro-web.xml。  
Java代码

<bean id="sessionIdCookie" class="org.apache.shiro.web.servlet.SimpleCookie">  
        <constructor-arg value="sid"/>  
        <property name="httpOnly" value="true"/>  
        <property name="maxAge" value="180000"/>  
    </bean>  
      
    <bean id="sessionManager" class="org.apache.shiro.web.session.mgt.DefaultWebSessionManager">  
        <property name="globalSessionTimeout" value="1800000"/>  
        <property name="deleteInvalidSessions" value="true"/>  
        <property name="sessionValidationSchedulerEnabled" value="true"/>  
        <property name="sessionValidationScheduler" ref="sessionValidationScheduler"/>  
        <property name="sessionDAO" ref="sessionDAO"/>  
        <property name="sessionIdCookieEnabled" value="true"/>  
        <property name="sessionIdCookie" ref="sessionIdCookie"/>  
    </bean>  
      
    <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">  
    <property name="realm" ref="userRealm"/>  
        <property name="sessionManager" ref="sessionManager"/>  
        <property name="cacheManager" ref="cacheManager"/>  
    </bean>

1、sessionIdCookie是用于生产Session ID Cookie的模板；  
2、会话管理器使用用于web环境的DefaultWebSessionManager；  
3、安全管理器使用用于web环境的DefaultWebSecurityManager。

Java代码

<bean id="formAuthenticationFilter" class="org.apache.shiro.web.filter.authc.FormAuthenticationFilter">  
        <property name="usernameParam" value="username"/>  
        <property name="passwordParam" value="password"/>  
        <property name="loginUrl" value="/login.jsp"/>  
    </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="filters">  
            <util:map>  
                <entry key="authc" value-ref="formAuthenticationFilter"/>  
            </util:map>  
        </property>  
        <property name="filterChainDefinitions">  
            <value>  
                /index.jsp = anon  
                /unauthorized.jsp = anon  
                /login.jsp = authc  
                /logout = logout  
                /** = user  
            </value>  
        </property>  
    </bean>

1、formAuthenticationFilter为基于Form表单的身份验证过滤器；此处可以再添加自己的Filter bean定义；  
2、shiroFilter：此处使用ShiroFilterFactoryBean来创建ShiroFilter过滤器；filters属性用于定义自己的过滤器，即ini配置中的\[filters\]部分；filterChainDefinitions用于声明url和filter的关系，即ini配置中的\[urls\]部分。

接着需要在web.xml中进行如下配置：  
Java代码

<context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>  
            classpath:spring-beans.xml,  
            classpath:spring-shiro-web.xml  
        </param-value>  
    </context-param>  
    <listener>  
       <listener-class>  
    org.springframework.web.context.ContextLoaderListener  
    </listener-class>  
    </listener>

通过ContextLoaderListener加载contextConfigLocation指定的Spring配置文件。

Java代码

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

DelegatingFilterProxy会自动到Spring容器中查找名字为shiroFilter的bean并把filter请求交给它处理。

其他配置请参考源代码。

**Shiro权限注解**  
Shiro提供了相应的注解用于权限控制，如果使用这些注解就需要使用AOP的功能来进行判断，如Spring AOP；Shiro提供了Spring AOP集成用于权限注解的解析和验证。  
为了测试，此处使用了Spring MVC来测试Shiro注解，当然Shiro注解不仅仅可以在web环境使用，在独立的JavaSE中也是可以用的，此处只是以web为例了。

在spring-mvc.xml配置文件添加Shiro Spring AOP权限注解的支持：  
Java代码

<aop:config proxy-target-class="true"></aop:config>  
    <bean class=" org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor">  
        <property name="securityManager" ref="securityManager"/>  
    </bean>

如上配置用于开启Shiro Spring AOP权限注解的支持；表示代理类。

接着就可以在相应的控制器（AnnotationController）中使用如下方式进行注解：  
Java代码

@RequiresRoles("admin")  
    @RequestMapping("/hello2")  
    public String hello2() {  
        return "success";  
    }

访问hello2方法的前提是当前用户有admin角色。

当验证失败，其会抛出UnauthorizedException异常，此时可以使用Spring的ExceptionHandler（DefaultExceptionHandler）来进行拦截处理：  
Java代码

@ExceptionHandler({UnauthorizedException.class})  
    @ResponseStatus(HttpStatus.UNAUTHORIZED)  
    public ModelAndView processUnauthenticatedException(NativeWebRequest request, UnauthorizedException e) {  
        ModelAndView mv = new ModelAndView();  
        mv.addObject("exception", e);  
        mv.setViewName("unauthorized");  
        return mv;  
    }

如果集成Struts2，需要注意《Shiro+Struts2+Spring3 加上@RequiresPermissions 后@Autowired失效》问题：  
[http://jinnianshilongnian.iteye.com/blog/1850425][http_jinnianshilongnian.iteye.com_blog_1850425]

**权限注解**  
Java代码

@RequiresAuthentication

表示当前Subject已经通过login进行了身份验证；即Subject. isAuthenticated()返回true。

Java代码

@RequiresUser

表示当前Subject已经身份验证或者通过记住我登录的。

Java代码

@RequiresGuest

表示当前Subject没有身份验证或通过记住我登录过，即是游客身份。

Java代码

@RequiresRoles(value={“admin”, “user”}, logical= Logical.AND)

表示当前Subject需要角色admin和user。

Java代码

@RequiresPermissions (value={“user:a”, “user:b”}, logical= Logical.OR)

表示当前Subject需要权限user:a或user:b。

示例源代码：[https://github.com/zhangkaitao/shiro-example][https_github.com_zhangkaitao_shiro-example]

[http_jinnianshilongnian.iteye.com_blog_1850425]: http://jinnianshilongnian.iteye.com/blog/1850425
[https_github.com_zhangkaitao_shiro-example]: https://github.com/zhangkaitao/shiro-example