Servlet过滤器简介
Web应用中可以使用过滤器对所有的访问和请求进行处理,Servlet过滤器处于客户端和目标资源的中间层。当服务器收到一个客户端请求,首先判断该请求是否与过滤器对象相关联,若是,则将该请求交由过滤器进行处理。处理完毕后,交给其他业务。
当所有业务处理完毕,需要将响应返回客户端时,容器同样会将响应交给过滤器进行处理,过滤器处理完毕后发回客户端。
注意,过滤器可能不止一个,如字符编码过滤器,IP访问过滤器等。容器会首先将客户端请求交给第一个过滤器处理,然后交给下一级过滤器,依此类推。返回时,从最后一级过滤器开始向前传递,最后由第一级过滤器将响应发回客户端。
过滤器代码结构
和Servlet相似,要使一个对象成为一个过滤器需要实现Filter接口。Filter API主要涉及三个接口:
- Fileter 所有过滤器对象均要实现该接口
- FilterChain 主要用于将请求或响应传递给下一过滤器对象,该接口由容器实现
- FilterConfig 用于获取初始化参数信息,该接口由容器实现
过滤器代码结构如下:
import javax.servlet.*;
import java.io.IOException;
public class FilterEg implements Filter {
//过滤器初始化。每个过滤器实例,该方法只在初始化时调用一次。类似Servlet的init()
public void init(FilterConfig config) throws ServletException {
}
//处理请求/响应的具体方法。类似Servlet的service()
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
//调用FilterChain接口的doFilter方法,将请求/响应传递给下一过滤器
chain.doFilter(request, response);
}
//类似Servlet的destroy()方法
public void destroy() {
}
}
拦截指定IP的过滤器
过滤器代码
首先按照过滤器的代码结构编写如下过滤器代码:
IPFilter.java
pacakge filter
import javax.servlet.*;
import java.io.IOException;
import java.io.PrintWriter;
public class IPFilter implements Filter {
protected FilterConfig config;
protected String IP;
//初始化操作。
public void init(FilterConfig config) throws ServletException {
this.config = config;
//读取需要被限制的IP信息。
IP = config.getInitParameter("IP");
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
//读取客户端IP信息
String remoteIP = request.getRemoteAddr();
//判断客户端IP是否与被限制IP匹配
if(remoteIP.equals(IP)) {
response.setCharacterEncoding("gb2312");
PrintWriter out = response.getWriter();
out.print("<p style="text-align:center; font-size:25">IP限制!</p>");
}else {
//通过IP验证,请求转发下一级
chain.doFilter(request, response);
}
}
public void destroy() {
}
}
过滤器配置
和Servlet类似,过滤器使用前需要进行配置。上面代码中限制IP的信息就是在这里读取的。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<filter>
<filter-name>IPFilter</filter-name>
<filter-class>filter.IPFilter</filter-class>
<init-param>
<param-name>IP</param-name>
<param-value>127.0.0.1</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>IPFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
filter-name,filter-class均与Servlet配置类似,具体含义可以参考一个简单的Servlet程序中的xml配置。
9~12行设置初始化参数,代码中init()方法就是读取这里的IP参数。这里把IP设为127.0.0.1来演示过滤本机的访问。
16行,指明过滤器对哪些访问路径有效,/*表明对所有请求有效。
程序部署运行
不妨用新手推荐JSP+JavaBean+Servlet MVC模式用户注册模块中的代码。给注册模块加上一个IP过滤器。
在webapps\reg\WEB-INF\classes目录下新建filter文件夹。将上面的IPFilter.java编译放入filter文件夹中。
在\WEB-INF\路径下的web.xml中加入过滤器的配置:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<servlet>
<servlet-name>SignInServlet</servlet-name>
<servlet-class>service.SignInServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>SignInServlet</servlet-name>
<url-pattern>/RegServlet</url-pattern>
</servlet-mapping>
<filter>
<filter-name>IPFilter</filter-name>
<filter-class>filter.IPFilter</filter-class>
<init-param>
<param-name>IP</param-name>
<param-value>127.0.0.1</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>IPFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
15~26行为我们加入的过滤器配置。
好了,接下来运行Tomcat,打开浏览器输入
http://localhost:8080/reg/reg.jsp
得到以下页面:
过滤器拦截了我们本机的IP。
接下来在web.xml文件中,将<param-value>127.0.0.1</param-value>
中的IP改成另外的地址。
重启服务器,打开浏览器输入
http://localhost:8080/reg/reg.jsp
页面恢复正常: