02认识Filter

数据产品小lee

于 2017-12-22 01:34:53 发布

阅读量194

点赞数

分类专栏： JavaWeb 文章标签： java web servlet

本文链接：https://blog.csdn.net/le__lee/article/details/78869122

版权

JavaWeb 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

文章目录

Filter作用是什么？

提高代码复用性，减少重复编码。
对request,response进行一些公用的过滤。
在一个web应用中，每个web组件（比如Servlet）都响应特定的用户请求。在web.xml中设置的url-pattern就是映射服务。
比如：有几个servlet，在调用servlet服务之前，都需要对用户权限进行检查，有权限才能访问。那么，检查权限这个动作，就可以抽出来。
同理，在返回response之前，也可以对response进行过滤处理，筛除敏感词汇等。

比如：
1. 过滤某些ip，禁止登录系统。过滤某些用户。
2. 过滤某些敏感文字。将文字进行替换，编码的替换，解决乱码的问题。

Filter接口定义了哪些方法？

init(FilterConfig config)
创建Filter对象的时候，调用这个方法，Filter对象可以从FilterConfig对象中（这个对象通过web.xml读取配置信息）获取配置信息，比如：禁止哪些IP登录。
doFilter(ServletRequest request, ServletResponse response)
这个方法，就是实际的过滤方法啦，有点类似于Servlet的service方法，是我们定义实际过滤操作的地方。
destroy()
Servlet容器在销毁过滤器对象之前，调用这个方法，释放掉过滤器占用的资源。

Filter的生命周期

1. 初始化。Web应用启动的时候，创建FilterConfig对象，以及Filter对象，调用init方法。我理解是在servlet初始化之前，初始化Filter。
2. 运行时。当用户请求的URL与过滤器映射的URL匹配的时候，Servlet容器会先调用Filter的doFilter方法。
3. 销毁。Web应用终止的时候，Servlet容器先调用destroy方法，完了再销毁Filter对象。

Filter的简单例子

这个NoteFilter就是过滤登录系统的ip,实现了一个用户黑名单。

项目结构
这里写图片描述

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" 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>NoteFilter</filter-name>
    <filter-class>com.neo.NoteFilter</filter-class>
    <init-param>
      <param-name>ipblock</param-name>
      <param-value>192.0</param-value>
    </init-param>
    <init-param>
      <param-name>blackList</param-name>
      <param-value>捣蛋鬼</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>NoteFilter</filter-name>
    <url-pattern>/note</url-pattern>
  </filter-mapping>
  
  <welcome-file-list>
  	<url-pattern>/note</url-pattern>
  </welcome-file-list>
</web-app>

NoteFilter

package com.neo;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
/**
 * Web应用启动时，Servlet容器先创建包含了过滤器配置信息的FilterConfig对象，然后创建Filter对象，接着调用Filter对象的init方法
 * @author lile
 *
 */
public class NoteFilter implements Filter{
	
	private FilterConfig config = null;
	private String blackList = null;
	private String ipblock = null;
	
	
	@Override
	/**
	 * @param config 通过config参数可以读取web.xml文件中为Filter配置的初始化参数
	 */
	public void init(FilterConfig config) throws ServletException {
		this.config = config;
		
		//读取ipblock初始化参数
		ipblock = config.getInitParameter("ipblock");
		
		//读取blackList初始化参数
		blackList = config.getInitParameter("blackList");
	}
	
	@Override
	/**
	 * 这个方法完成实际的过滤操作。
	 * 当用户请求访问的URL与为过滤器映射的URL匹配时，Servlet容器将先调用过滤器的doFilter方法。
	 * FilterChain参数用于访问后续过滤器或者web组件:如果是后续过滤器处理，相当于是调用后续过滤器的doFilter方法
	 */
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		System.out.println("NoteFilter:doFilter()");
		
		if (!checkRemoteIp(request, response)) {
			return;
		}
		
		if (!checkUsername(request, response)) {
			return;
		}
		
		long before = System.currentTimeMillis();
		
		config.getServletContext().log("NoteFilter: before call chain.doFilter()");
		//将请求转发给后续的过滤器或者web组件
		chain.doFilter(request, response);
		
		config.getServletContext().log("NoteFilter: after call chain.doFilter()");
		long after = System.currentTimeMillis();
		
		String name = "";
		if ( request instanceof HttpServletRequest){
			name = ((HttpServletRequest) request).getRequestURI();
		}
		config.getServletContext().log("NoteFilter:"+name+":"+(after-before)+"ms");
	}
	
	private boolean checkUsername(ServletRequest request, ServletResponse response) throws IOException {
		String username = request.getParameter("username");
		if (username!= null && username.equals("neo")) {
			response.setContentType("text/html;charset=utf-8");
			PrintWriter out = response.getWriter();
			out.print("<h1>您没权限访问</h1>");
			out.flush();
			return false;
		}
		return true;
	}

	@Override
	/**
	 * Servlet容器在销毁过滤器对象前，调用该方法，释放过滤器占用的资源
	 */
	public void destroy() {
		System.out.println("NoteFilter: destroy()");
		this.config = null;
	}
	
	private boolean checkRemoteIp(ServletRequest request, ServletResponse response) throws IOException {
		String addr = request.getRemoteAddr();
		if (addr.indexOf(ipblock) != -1) {
			response.setContentType("text/html; charset=utf-8"); 
			PrintWriter out = response.getWriter();
			out.println("<h1>对不起，服务器无法为你提供服务.</h1>");
			out.flush();
			return false;
		} else {
			return true;
		}
	}
}

NoteServlet

package com.neo;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Servlet implementation class NoteServlet
 */
@WebServlet(description = "testForFilter", urlPatterns = { "/note" })
public class NoteServlet extends HttpServlet {
	private static final long serialVersionUID = 1L;

	/**
	 * @see HttpServlet#service(HttpServletRequest request, HttpServletResponse response)
	 */
	protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		System.out.print("NoteServlet: service()");
		response.setContentType("text/html,charset=utf-8"); 
		ServletOutputStream out = response.getOutputStream();
		out.println("<html>");
		out.println("<head><title>note</title></head>");
		out.println("<body>");
		String username = request.getParameter("username");
		String content = request.getParameter("content");
		if (username != null) {
			username = new String(username.getBytes("ISO-8859-1"),"utf-8");
		}
		if (content != null) {
			content = new String(content.getBytes("ISO-8859-1"),"utf-8");
		}
		if (content != null && !content.equals("")) {
			out.println("<p>"+username+" 's message is :"+content+"</p>");
		}
		out.println("<form action ="+request.getContextPath()+"/note method=POST");
		out.println("<b>username:</br>");
		out.println("<input type=text size=10 name=username><br>");
		out.println("<b>note:</b><br>");
		out.println("<textarea name=content row=5 cols=20></textarea><br><br>");
		out.println("<input type=submit value=submit>");
		out.println("</form>");
		out.println("</body></html>");
	}

}

以下是启动应用以后的日志控制台输出，最后一行是用的一个禁止的ip登录，可以看到直接返回了。

NoteFilter:doFilter()
十二月 19, 2017 11:12:31 上午 org.apache.catalina.core.ApplicationContext log
信息: NoteFilter: before call chain.doFilter()
NoteServlet: service()十二月 19, 2017 11:12:31 上午 org.apache.catalina.core.ApplicationContext log
信息: NoteFilter: after call chain.doFilter()
十二月 19, 2017 11:12:31 上午 org.apache.catalina.core.ApplicationContext log
信息: NoteFilter:/Demo_Filter/note:2ms