1、nameablefilter
nameablefilter给filter起个名字,如果没有设置默认就是filtername;还记得之前的如authc吗?当我们组装拦截器链时会根据这个名字找到相应的拦截器实例;
2、onceperrequestfilter
onceperrequestfilter用于防止多次执行filter的;也就是说一次请求只会走一次拦截器链;另外提供enabled属性,表示是否开启该拦截器实例,默认enabled=true表示开启,如果不想让某个拦截器工作,可以设置为false即可。
3、shirofilter
shirofilter是整个shiro的入口点,用于拦截需要安全控制的请求进行处理,这个之前已经用过了。
4、advicefilter
advicefilter提供了aop风格的支持,类似于springmvc中的interceptor:
boolean prehandle(servletrequest request, servletresponse response) throws exception
void posthandle(servletrequest request, servletresponse response) throws exception
void aftercompletion(servletrequest request, servletresponse response, exception exception) throws exception;
prehandler:类似于aop中的前置增强;在拦截器链执行之前执行;如果返回true则继续拦截器链;否则中断后续的拦截器链的执行直接返回;进行预处理(如基于表单的身份验证、授权)
posthandle:类似于aop中的后置返回增强;在拦截器链执行完成后执行;进行后处理(如记录执行时间之类的);
aftercompletion:类似于aop中的后置最终增强;即不管有没有异常都会执行;可以进行清理资源(如接触subject与线程的绑定之类的);
5、pathmatchingfilter
pathmatchingfilter提供了基于ant风格的请求路径匹配功能及拦截器参数解析的功能,如“roles[admin,user]”自动根据“,”分割解析到一个路径参数配置并绑定到相应的路径:
boolean pathsmatch(string path, servletrequest request)
boolean onprehandle(servletrequest request, servletresponse response, object mappedvalue) throws exception
pathsmatch:该方法用于path与请求路径进行匹配的方法;如果匹配返回true;
onprehandle:在prehandle中,当pathsmatch匹配一个路径后,会调用opprehandler方法并将路径绑定参数配置传给mappedvalue;然后可以在这个方法中进行一些验证(如角色授权),如果验证失败可以返回false中断流程;默认返回true;也就是说子类可以只实现onprehandle即可,无须实现prehandle。如果没有path与请求路径匹配,默认是通过的(即prehandle返回true)。
6、accesscontrolfilter
accesscontrolfilter提供了访问控制的基础功能;比如是否允许访问/当访问拒绝时如何处理等:
abstract boolean isaccessallowed(servletrequest request, servletresponse response, object mappedvalue) throws exception;
boolean onaccessdenied(servletrequest request, servletresponse response, object mappedvalue) throws exception;
abstract boolean onaccessdenied(servletrequest request, servletresponse response) throws exception;
isaccessallowed:表示是否允许访问;mappedvalue就是[urls]配置中拦截器参数部分,如果允许访问返回true,否则false;
onaccessdenied:表示当访问拒绝时是否已经处理了;如果返回true表示需要继续处理;如果返回false表示该拦截器实例已经处理了,将直接返回即可。
onprehandle会自动调用这两个方法决定是否继续处理:
boolean onprehandle(servletrequest request, servletresponse response, object mappedvalue) throws exception {
return isaccessallowed(request, response, mappedvalue) || onaccessdenied(request, response, mappedvalue);
}
另外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。
shiro对servlet容器的filterchain进行了代理,即shirofilter在继续servlet容器的filter链的执行之前,通过proxiedfilterchain对servlet容器的filterchain进行了代理;即先走shiro自己的filter体系,然后才会委托给servlet容器的filterchain进行servlet容器级别的filter链执行;shiro的proxiedfilterchain执行流程:1、先执行shiro自己的filter链;2、再执行servlet容器的filter链(即原始的filter)。
而proxiedfilterchain是通过filterchainresolver根据配置文件中[urls]部分是否与请求的url是否匹配解析得到的。
filterchain getchain(servletrequest request, servletresponse response, filterchain originalchain);
即传入原始的chain得到一个代理的chain。
shiro内部提供了一个路径匹配的filterchainresolver实现:pathmatchingfilterchainresolver,其根据[urls]中配置的url模式(默认ant风格)=拦截器链和请求的url是否匹配来解析得到配置的拦截器链的;而pathmatchingfilterchainresolver内部通过filterchainmanager维护着拦截器链,比如defaultfilterchainmanager实现维护着url模式与拦截器链的关系。因此我们可以通过filterchainmanager进行动态动态增加url模式与拦截器链的关系。
defaultfilterchainmanager会默认添加org.apache.shiro.web.filter.mgt.defaultfilter中声明的拦截器:
public enum defaultfilter {
anon(anonymousfilter.class),
authc(formauthenticationfilter.class),
authcbasic(basichttpauthenticationfilter.class),
logout(logoutfilter.class),
nosessioncreation(nosessioncreationfilter.class),
perms(permissionsauthorizationfilter.class),
port(portfilter.class),
rest(httpmethodpermissionfilter.class),
roles(rolesauthorizationfilter.class),
ssl(sslfilter.class),
user(userfilter.class);
下一节会介绍这些拦截器的作用。
如果要注册自定义拦截器,inisecuritymanagerfactory/webinisecuritymanagerfactory在启动时会自动扫描ini配置文件中的[filters]/[main]部分并注册这些拦截器到defaultfilterchainmanager;且创建相应的url模式与其拦截器关系链。如果使用spring后续章节会介绍如果注册自定义拦截器。
如果想自定义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>
通过自定义自己的拦截器可以扩展一些功能,诸如动态url-角色/权限访问控制的实现、根据subject身份信息获取用户信息绑定到request(即设置通用数据)、验证码验证、在线用户信息的保存等等,因为其本质就是一个filter;所以filter能做的它就能做。
对于filter的介绍请参考《servlet规范》中的filter部分:
1、扩展onceperrequestfilter
onceperrequestfilter保证一次请求只调用一次dofilterinternal,即如内部的forward不会再多执行一次dofilterinternal:
public class myonceperrequestfilter extends onceperrequestfilter {
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.github.zhangkaitao.shiro.chapter8.web.filter.myonceperrequestfilter
#[filters]
#myfilter1=com.github.zhangkaitao.shiro.chapter8.web.filter.myonceperrequestfilter
[urls]
/**=myfilter1
filter可以在[main]或[filters]部分注册,然后在[urls]部分配置url与filter的映射关系即可。
2、扩展advicefilter
advicefilter提供了aop的功能,其实现和springmvc中的interceptor思想一样:具体可参考我的springmvc教程中的处理器拦截器部分:
<a target="_blank" href="http://www.iteye.com/blogs/subjects/kaitao-springmvc">http://www.iteye.com/blogs/subjects/kaitao-springmvc</a>
public class myadvicefilter extends advicefilter {
protected boolean prehandle(servletrequest request, servletresponse response) throws exception {
system.out.println("====预处理/前置处理");
return true;//返回false将中断后续拦截器链的执行
protected void posthandle(servletrequest request, servletresponse response) throws exception {
system.out.println("====后处理/后置返回处理");
public void aftercompletion(servletrequest request, servletresponse response, exception exception) throws exception {
system.out.println("====完成处理/后置最终处理");
prehandle:进行请求的预处理,然后根据返回值决定是否继续处理(true:继续过滤器链);可以通过它实现权限控制;
posthandle:执行完拦截器链之后正常返回后执行;
aftercompletion:不管最后有没有异常,aftercompletion都会执行,完成如清理资源功能。
然后在shiro.ini中进行如下配置:
[filters]
myfilter2=com.github.zhangkaitao.shiro.chapter8.web.filter.myadvicefilter
/**=myfilter1,myfilter2
该过滤器的具体使用可参考我的springmvc教程中的处理器拦截器部分。
3、pathmatchingfilter
pathmatchingfilter继承了advicefilter,提供了url模式过滤的功能,如果需要对指定的请求进行处理,可以扩展pathmatchingfilter:
public class mypathmatchingfilter extends pathmatchingfilter {
protected boolean onprehandle(servletrequest request, servletresponse response, object mappedvalue) throws exception {
system.out.println("url matches,config is " + arrays.tostring((string[])mappedvalue));
return true;
prehandle:会进行url模式与请求url进行匹配,如果匹配会调用onprehandle;如果没有配置url模式/没有url模式匹配,默认直接返回true;
onprehandle:如果url模式与请求url匹配,那么会执行onprehandle,并把该拦截器配置的参数传入。默认什么不处理直接返回true。
然后在shiro.ini中进行如下配置:
myfilter3=com.github.zhangkaitao.shiro.chapter8.web.filter.mypathmatchingfilter
/**= myfilter3[config]
/**就是注册给pathmatchingfilter的url模式,config就是拦截器的配置参数,多个之间逗号分隔,onprehandle使用mappedvalue接收参数值。
4、扩展accesscontrolfilter
accesscontrolfilter继承了pathmatchingfilter,并扩展了了两个方法:
public boolean onprehandle(servletrequest request, servletresponse response, object mappedvalue) throws exception {
return isaccessallowed(request, response, mappedvalue)
|| onaccessdenied(request, response, mappedvalue);
isaccessallowed:即是否允许访问,返回true表示允许;
onaccessdenied:表示访问拒绝时是否自己处理,如果返回true表示自己不处理且继续拦截器链执行,返回false表示自己已经处理了(比如重定向到另一个页面)。
public class myaccesscontrolfilter extends accesscontrolfilter {
protected boolean isaccessallowed(servletrequest request, servletresponse response, object mappedvalue) throws exception {
system.out.println("access allowed");
return true;
protected boolean onaccessdenied(servletrequest request, servletresponse response) throws exception {
system.out.println("访问拒绝也不自己处理,继续拦截器链的执行");
myfilter4=com.github.zhangkaitao.shiro.chapter8.web.filter.myaccesscontrolfilter
/**=myfilter4
5、基于表单登录拦截器
之前我们已经使用过shiro内置的基于表单登录的拦截器了,此处自己做一个类似的基于表单登录的拦截器。
public class formloginfilter extends pathmatchingfilter {
private string loginurl = "/login.jsp";
private string successurl = "/";
if(securityutils.getsubject().isauthenticated()) {
return true;//已经登录过
}
httpservletrequest req = (httpservletrequest) request;
httpservletresponse resp = (httpservletresponse) response;
if(isloginrequest(req)) {
if("post".equalsignorecase(req.getmethod())) {//form表单提交
boolean loginsuccess = login(req); //登录
if(loginsuccess) {
return redirecttosuccessurl(req, resp);
}
}
return true;//继续过滤器链
} else {//保存当前地址并重定向到登录界面
saverequestandredirecttologin(req, resp);
return false;
private boolean redirecttosuccessurl(httpservletrequest req, httpservletresponse resp) throws ioexception {
webutils.redirecttosavedrequest(req, resp, successurl);
return false;
private void saverequestandredirecttologin(httpservletrequest req, httpservletresponse resp) throws ioexception {
webutils.saverequest(req);
webutils.issueredirect(req, resp, loginurl);
private boolean login(httpservletrequest req) {
string username = req.getparameter("username");
string password = req.getparameter("password");
try {
securityutils.getsubject().login(new usernamepasswordtoken(username, password));
} catch (exception e) {
req.setattribute("shirologinfailure", e.getclass());
private boolean isloginrequest(httpservletrequest req) {
return pathsmatch(loginurl, webutils.getpathwithinapplication(req));
onprehandle主要流程:
1、首先判断是否已经登录过了,如果已经登录过了继续拦截器链即可;
2、如果没有登录,看看是否是登录请求,如果是get方法的登录页面请求,则继续拦截器链(到请求页面),否则如果是get方法的其他页面请求则保存当前请求并重定向到登录页面;
3、如果是post方法的登录页面表单提交请求,则收集用户名/密码登录即可,如果失败了保存错误消息到“shirologinfailure”并返回到登录页面;
4、如果登录成功了,且之前有保存的请求,则重定向到之前的这个请求,否则到默认的成功页面。
shiro.ini配置
formlogin=com.github.zhangkaitao.shiro.chapter8.web.filter.formloginfilter
/test.jsp=formlogin
/login.jsp=formlogin
启动服务器输入http://localhost:8080/chapter8/test.jsp测试时,会自动跳转到登录页面,登录成功后又会跳回到test.jsp页面。
此处可以通过继承authenticatingfilter实现,其提供了很多登录相关的基础代码。另外可以参考shiro内嵌的formauthenticationfilter的源码,思路是一样的。
6、任意角色授权拦截器
shiro提供roles拦截器,其验证用户拥有所有角色,没有提供验证用户拥有任意角色的拦截器。
public class anyrolesfilter extends accesscontrolfilter {
private string unauthorizedurl = "/unauthorized.jsp";
string[] roles = (string[])mappedvalue;
if(roles == null) {
return true;//如果没有设置角色参数,默认成功
for(string role : roles) {
if(getsubject(request, response).hasrole(role)) {
return true;
return false;//跳到onaccessdenied处理
subject subject = getsubject(request, response);
if (subject.getprincipal() == null) {//表示没有登录,重定向到登录页面
saverequest(request);
webutils.issueredirect(request, response, loginurl);
} else {
if (stringutils.hastext(unauthorizedurl)) {//如果有未授权页面跳转过去
webutils.issueredirect(request, response, unauthorizedurl);
} else {//否则返回401未授权状态码
webutils.tohttp(response).senderror(httpservletresponse.sc_unauthorized);
流程:
1、首先判断用户有没有任意角色,如果没有返回false,将到onaccessdenied进行处理;
2、如果用户没有角色,接着判断用户有没有登录,如果没有登录先重定向到登录;
3、如果用户没有角色且设置了未授权页面(unauthorizedurl),那么重定向到未授权页面;否则直接返回401未授权错误码。
anyroles=com.github.zhangkaitao.shiro.chapter8.web.filter.anyrolesfilter
/test.jsp=formlogin,anyroles[admin,user]
此处可以继承authorizationfilter实现,其提供了授权相关的基础代码。另外可以参考shiro内嵌的rolesauthorizationfilter的源码,只是实现hasallroles逻辑。
shiro内置了很多默认的拦截器,比如身份验证、授权等相关的。默认拦截器可以参考org.apache.shiro.web.filter.mgt.defaultfilter中的枚举拦截器:
默认拦截器名
拦截器类
说明(括号里的表示默认值)
身份验证相关的
authc
org.apache.shiro.web.filter.authc
.formauthenticationfilter
基于表单的拦截器;如“/**=authc”,如果没有登录会跳到相应的登录页面登录;主要属性:usernameparam:表单提交的用户名参数名( username); passwordparam:表单提交的密码参数名(password); remembermeparam:表单提交的密码参数名(rememberme); loginurl:登录页面地址(/login.jsp);successurl:登录成功后的默认重定向地址; failurekeyattribute:登录失败后错误信息存储key(shirologinfailure);
authcbasic
.basichttpauthenticationfilter
basic http身份验证拦截器,主要属性: applicationname:弹出登录框显示的信息(application);
logout
.logoutfilter
退出拦截器,主要属性:redirecturl:退出成功后重定向的地址(/);示例“/logout=logout”
user
.userfilter
用户拦截器,用户已经身份验证/记住我登录的都可;示例“/**=user”
anon
.anonymousfilter
匿名拦截器,即不需要登录即可访问;一般用于静态资源过滤;示例“/static/**=anon”
授权相关的
roles
org.apache.shiro.web.filter.authz
.rolesauthorizationfilter
角色授权拦截器,验证用户是否拥有所有角色;主要属性: loginurl:登录页面地址(/login.jsp);unauthorizedurl:未授权后重定向的地址;示例“/admin/**=roles[admin]”
perms
.permissionsauthorizationfilter
权限授权拦截器,验证用户是否拥有所有权限;属性和roles一样;示例“/user/**=perms["user:create"]”
port
.portfilter
端口拦截器,主要属性:port(80):可以通过的端口;示例“/test= port[80]”,如果用户访问该页面是非80,将自动将请求端口改为80并重定向到该80端口,其他路径/参数等都一样
rest
.httpmethodpermissionfilter
rest风格拦截器,自动根据请求方法构建权限字符串(get=read, post=create,put=update,delete=delete,head=read,trace=read,options=read, mkcol=create)构建权限字符串;示例“/users=rest[user]”,会自动拼出“user:read,user:create,user:update,user:delete”权限字符串进行权限匹配(所有都得匹配,ispermittedall);
ssl
.sslfilter
ssl拦截器,只有请求协议是https才能通过;否则自动跳转会https端口(443);其他和port拦截器一样;
其他
nosessioncreation
org.apache.shiro.web.filter.session
.nosessioncreationfilter
不创建会话拦截器,调用 subject.getsession(false)不会有什么问题,但是如果 subject.getsession(true)将抛出 disabledsessionexception异常;
另外还提供了一个org.apache.shiro.web.filter.authz.hostfilter,即主机拦截器,比如其提供了属性:authorizedips:已授权的ip地址,deniedips:表示拒绝的ip地址;不过目前还没有完全实现,不可用。
这些默认的拦截器会自动注册,可以直接在ini配置文件中通过“拦截器名.属性”设置其属性:
perms.unauthorizedurl=/unauthorized
另外如果某个拦截器不想使用了可以直接通过如下配置直接禁用:
perms.enabled=false