社区首页 >专栏 >Shiro 实战(四) - 过滤器机制1 简介2 过滤器链

Shiro 实战(四) - 过滤器机制1 简介2 过滤器链

JavaEdge

发布于 2018-12-04 01:32:29

2.5K00

代码可运行

文章被收录于专栏：JavaEdgeJavaEdge

运行总次数：0

代码可运行

1 简介

Shiro使用了与Servlet一样的Filter接口进行扩展

Shiro拦截器的基础类图

1.1 NameableFilter

NameableFilter给Filter起个名字，如果没有设置默认就是FilterName 当我们组装拦截器链时会根据这个名字找到相应的拦截器实例

1.2 OncePerRequestFilter

用于防止多次执行Filter,也就是说一次请求只会走一次拦截器链 enabled属性:是否开启该拦截器，默认enabled=true表开启

1.3 ShiroFilter

整个Shiro的入口点，用于拦截需要安全控制的请求进行处理

1.4 AdviceFilter

提供AOP风格的支持，类似于SpringMVC中的Interceptor

preHandler：类AOP前置增强在拦截器链执行之前执行；如果返回true则继续拦截器链否则中断后续的拦截器链的执行直接返回进行预处理（如基于表单的身份验证、授权）
postHandle：类AOP后置返回增强在拦截器链执行完成后执行进行后处理（如记录执行时间之类的）；
afterCompletion：类AOP后置最终增强不管有没有异常都会执行可以进行清理资源（如解除Subject与线程的绑定之类的）

1.5 PathMatchingFilter

提供基于Ant风格的请求路径匹配功能及拦截器参数解析的功能，如roles[admin,user]自动根据,分割解析到一个路径参数配置并绑定到相应的路径

pathsMatch

用于path与请求路径进行匹配的方法,如果匹配返回true

onPreHandle(待探讨)

在preHandle中，当pathsMatch匹配一个路径后，会调用onPreHandler方法并将路径绑定参数配置传给mappedValue；然后可以在这个方法中进行一些验证（如角色授权），如果验证失败可以返回false中断流程；默认返回true；也就是说子类可以只实现onPreHandle即可，无须实现preHandle。如果没有path与请求路径匹配，默认是通过的（即preHandle返回true）

1.6 AccessControlFilter

提供访问控制的基础功能；比如是否允许访问/当访问拒绝时如何处理等

isAccessAllowed

表是否允许访问；mappedValue就是[urls]配置中拦截器参数部分，如果允许访问返回true，否则false

onAccessDenied

表当访问拒绝时是否已经处理如果返回true表示需要继续处理如果返回false表示该拦截器实例已经处理了，直接返回即可

onPreHandle会自动调用这两个方法决定是否继续处理

AccessControlFilter还提供了如下方法用于处理如登录成功后/重定向到上一个请求

void setLoginUrl(String loginUrl) //身份验证时使用，默认/login.jsp  
String getLoginUrl()  
Subject getSubject(ServletRequest request, ServletResponse response) //获取Subject实例  
boolean isLoginRequest(ServletRequest request, ServletResponse response)//当前请求是否是登录请求  
void saveRequestAndRedirectToLogin(ServletRequest request, ServletResponse response) throws IOException //将当前请求保存起来并重定向到登录页面  
void saveRequest(ServletRequest request) //将请求保存起来，如登录成功后再重定向回该请求  
void redirectToLogin(ServletRequest request, ServletResponse response) //重定向到登录页面

比如基于表单的身份验证就需要使用这些功能

到此基本的拦截器完结若我们想进行访问控制就可以继承AccessControlFilter 若我们要添加一些通用数据我们可以直接继承PathMatchingFilter

2 过滤器链

2.1 简介

Shiro对Servlet容器的FilterChain进行了代理，即ShiroFilter在继续Servlet容器的Filter链的执行之前，通过ProxiedFilterChain对Servlet容器的FilterChain进行了代理 即先走Shiro自己的Filter体系,然后才会委托给Servlet容器的FilterChain进行Servlet容器级别的Filter链执行 Shiro的ProxiedFilterChain执行流程

先执行Shiro自己的Filter链
再执行Servlet容器的Filter链（即原始的Filter）

而ProxiedFilterChain是通过FilterChainResolver根据配置文件中[urls]部分是否与请求的URL是否匹配解析得到的

即传入原始的chain得到一个代理的chain

Shiro内部提供了一个路径匹配的FilterChainResolver实现：PathMatchingFilterChainResolver 其根据[urls]中配置的url模式（默认Ant风格）即根据过滤器链和请求的url是否匹配来解析得到配置的过滤器链而PathMatchingFilterChainResolver内部通过FilterChainManager

维护过滤器链比如DefaultFilterChainManager

维护着url模式与过滤器链的关系因此我们可以通过FilterChainManager进行动态动态增加url模式与过滤器链的关系

DefaultFilterChainManager会默认添加org.apache.shiro.web.filter.mgt.DefaultFilter中声明的过滤器

2.2 注册自定义拦截器

IniSecurityManagerFactory/WebIniSecurityManagerFactory在启动时会自动扫描ini配置文件中的[filters]/[main]部分并注册这些拦截器到DefaultFilterChainManager 且创建相应的url模式与其拦截器关系链

如果想自定义FilterChainResolver，可以通过实现WebEnvironment接口完成

public class MyIniWebEnvironment extends IniWebEnvironment {  
    @Override  
    protected FilterChainResolver createFilterChainResolver() {  
        //在此处扩展自己的FilterChainResolver  
        return super.createFilterChainResolver();  
    }  
}

FilterChain之间的关系。如果想动态实现url-拦截器的注册，就可以通过实现此处的FilterChainResolver来完成，比如：

//1、创建FilterChainResolver  
PathMatchingFilterChainResolver filterChainResolver =  
        new PathMatchingFilterChainResolver();  
//2、创建FilterChainManager  
DefaultFilterChainManager filterChainManager = new DefaultFilterChainManager();  
//3、注册Filter  
for(DefaultFilter filter : DefaultFilter.values()) {  
    filterChainManager.addFilter(  
        filter.name(), (Filter) ClassUtils.newInstance(filter.getFilterClass()));  
}  
//4、注册URL-Filter的映射关系  
filterChainManager.addToChain("/login.jsp", "authc");  
filterChainManager.addToChain("/unauthorized.jsp", "anon");  
filterChainManager.addToChain("/**", "authc");  
filterChainManager.addToChain("/**", "roles", "admin");  
  
//5、设置Filter的属性  
FormAuthenticationFilter authcFilter =  
         (FormAuthenticationFilter)filterChainManager.getFilter("authc");  
authcFilter.setLoginUrl("/login.jsp");  
RolesAuthorizationFilter rolesFilter =  
          (RolesAuthorizationFilter)filterChainManager.getFilter("roles");  
rolesFilter.setUnauthorizedUrl("/unauthorized.jsp");  
  
filterChainResolver.setFilterChainManager(filterChainManager);  
return filterChainResolver;

此处自己去实现注册filter，及url模式与filter之间的映射关系可以通过定制FilterChainResolver或FilterChainManager来完成诸如动态URL匹配的实现

然后再web.xml中进行如下配置Environment

<context-param>  
<param-name>shiroEnvironmentClass</param-name> <param-value>com.github.zhangkaitao.shiro.chapter8.web.env.MyIniWebEnvironment</param-value>  
</context-param>

2.3 自定义过滤器

通过自定义自己的过滤器可以扩展一些功能，诸如动态url-角色/权限访问控制的实现、根据Subject身份信息获取用户信息绑定到Request（即设置通用数据）、验证码验证、在线用户信息的保存等等，因为其本质就是一个Filter；所以Filter能做的它就能做

2.3.1 扩展OncePerRequestFilter

OncePerRequestFilter保证一次请求只调用一次doFilterInternal，即如内部的forward不会再多执行一次doFilterInternal：

public class MyOncePerRequestFilter extends OncePerRequestFilter {  
    @Override  
    protected void doFilterInternal(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {  
        System.out.println("=========once per request filter"); 
        chain.doFilter(request, response);  
    }  
}

然后再shiro.ini配置文件中

[main]  
myFilter1=com.sss.web.filter.MyOncePerRequestFilter  
#[filters]  
#myFilter1=com.sss.web.filter.MyOncePerRequestFilter  
[urls]  
/**=myFilter1