Servlet 编写过滤器，Servlet 异常处理

Servlet 编写过滤器

 

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

详细说明：

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器用途：

在客户端的请求访问后端资源之前，拦截这些请求。

在服务器的响应发送回客户端之前，处理这些响应。

使用说明：

当 Web 容器启动 Web 应用程序时，它会为您在部署描述符中声明的每一个过滤器创建一个实例。

Filter的执行顺序与在web.xml配置文件中的配置顺序一致，一般把Filter配置在所有的Servlet之前。

Servlet 过滤器方法

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法：

方法 & 描述

public void doFilter (ServletRequest, ServletResponse, FilterChain)

该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。

public void init(FilterConfig filterConfig)

web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

public void destroy()

Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

过滤器流程：

 

请求 ----> 匹配过滤器 -->doFilter() --->  servlet响应前的过滤     chain链（servlet响应）  --->servlet的响应后的过滤

package cn.sxt;

import java.io.IOException;

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



/**
 * Servlet implementation class lianxi1
 */
@WebServlet("/lianxi1")
public class lianxi1 extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    /**
     * @see HttpServlet#HttpServlet()
     */
    public lianxi1() {
        super();
        // TODO Auto-generated constructor stub
    }

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.setContentType("text/html");
        response.getWriter().append("Served at: ").append(request.getContextPath());
        response.getWriter().println("<h1>你好</h1>");
        System.out.println("doget");
    
    }

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        doGet(request, response);
    }

}

package cn.sxt;

import java.io.IOException;
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.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;

/**
 * Servlet Filter implementation class Lianxi1Filter
 */
//注解方式配置：
@WebFilter(servletNames = { "lianxi1" },
urlPatterns= {"*"},
initParams= {
        @WebInitParam(name="charset",value="UTF-8"),
        @WebInitParam(name="userType",value="VIP")
        })
public class Lianxi1Filter implements Filter {

    /**
     * Default constructor. 
     */
    public Lianxi1Filter() {
        // TODO Auto-generated constructor stub
    }

    /**
     * @see Filter#destroy()
     */
    public void destroy() {
        // TODO Auto-generated method stub
    }

    /**
     * @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // TODO Auto-generated method stub
        // place your code here
        //编码过滤
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        System.out.println("charsetfilter");
        
        
        //主要以这个分响应前后，这个是调doget方法
        // pass the request along the filter chain
        chain.doFilter(request, response);
        System.out.println("charsetFilterAfter");
    }

    /**
     * @see Filter#init(FilterConfig)
     */
    public void init(FilterConfig fConfig) throws ServletException {
        // TODO Auto-generated method stub
    }

}

注解方式配置：

 

@WebFilter(filterName = "loginFilter",   

    urlPatterns = "/*",   

    initParams = {  

            @WebInitParam(name = "loginUI", value = "/home/loginUI"),  

            @WebInitParam(name = "loginProcess", value = "home/login"),  

            @WebInitParam(name = "encoding", value = "utf-8")  

}) 

 

FilterConfig 使用

Filter 的 init 方法中提供了一个 FilterConfig 对象。

如 web.xml 文件配置如下：

<filter>

    <filter-name>LogFilter</filter-name>

    <filter-class>com.sxt.test.LogFilter</filter-class>

    <init-param>

        <param-name>Site</param-name>

        <param-value>sxt教程</param-value>

</init-param>

 </filter>

在 init 方法使用 FilterConfig 对象获取参数：

public void  init(FilterConfig config) throws ServletException {

    // 获取初始化参数

    String site = config.getInitParameter("Site");

    // 输出初始化参数

    System.out.println("网站名称: " + site);

}

web.xml配置各节点说明

<filter>指定一个过滤器。

<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。

<filter-class>元素用于指定过滤器的完整的限定类名。

<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。

在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径

<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字

<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)

<servlet-name>指定过滤器所拦截的Servlet名称。

<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。

<dispatcher>子元素可以设置的值及其意义

Servlet 异常处理

 

使用场景：

当一个 Servlet 抛出一个异常时，Web 容器在使用了 exception-type 元素的 web.xml 中搜索与抛出异常类型相匹配的配置。web.xml 中使用 error-page 元素来指定对特定异常 或 HTTP 状态码 作出相应的 Servlet 调用。

web.xml 配置

假设，有一个 ErrorHandler 的 Servlet 在任何已定义的异常或错误出现时被调用。以下将是在 web.xml 中创建的项。

 

<!-- servlet 定义 -->

<servlet>

        <servlet-name>ErrorHandler</servlet-name>

        <servlet-class>ErrorHandler</servlet-class>

</servlet>

<!-- servlet 映射 -->

<servlet-mapping>

        <servlet-name>ErrorHandler</servlet-name>

        <url-pattern>/ErrorHandler</url-pattern>

</servlet-mapping>

 

<!-- error-code 相关的错误页面 -->

<error-page>

    <error-code>404</error-code>

    <location>/ErrorHandler</location>

</error-page>

<error-page>

    <error-code>403</error-code>

    <location>/ErrorHandler</location>

</error-page>

 

<!-- exception-type 相关的错误页面 -->

<error-page>

    <exception-type>

          javax.servlet.ServletException

    </exception-type >

    <location>/ErrorHandler</location>

</error-page>

 

<error-page>

    <exception-type>java.io.IOException</exception-type >

    <location>/ErrorHandler</location>

</error-page>

 

如果您想对所有的异常有一个通用的错误处理程序，那么应该定义下面的 error-page，而不是为每个异常定义单独的 error-page 元素：

 

<error-page>

    <exception-type>java.lang.Throwable</exception-type >

    <location>/ErrorHandler</location>

</error-page>

在 web.xml 文件中添加如下配置来处理异常：

<?xml version="1.0" encoding="UTF-8"?>  

<web-app>  

<servlet>

        <servlet-name>ErrorHandler</servlet-name>

        <servlet-class>com.sxt.test.ErrorHandler</servlet-class>

</servlet>

<!-- servlet mappings -->

<servlet-mapping>

        <servlet-name>ErrorHandler</servlet-name>

        <url-pattern>/TomcatTest/ErrorHandler</url-pattern>

</servlet-mapping>

<error-page>

    <error-code>404</error-code>

    <location>/TomcatTest/ErrorHandler</location>

</error-page>

<error-page>

    <exception-type>java.lang.Throwable</exception-type >

    <location>/ErrorHandler</location>

</error-page>

</web-app>  

现在，尝试使用一个会产生异常的 Servlet，或者输入一个错误的 URL，这将触发 Web 容器调用 ErrorHandler 的 Servlet，并显示适当的消息。

package cn.sxt;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

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



/**
 * Servlet implementation class lianxi2
 */
@WebServlet("/lianxi2")
public class lianxi2 extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    /**
     * @see HttpServlet#HttpServlet()
     */
    public lianxi2() {
        super();
        // TODO Auto-generated constructor stub
    }

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.getWriter().append("Served at: ").append(request.getContextPath());
     null.length = 0 ;
    }//异常

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        doGet(request, response);
    }

}

package cn.sxt;

import java.io.IOException;

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




/**
 * Servlet implementation class lianxi1
 */
@WebServlet("/lianxi1")
public class lianxi1 extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    /**
     * @see HttpServlet#HttpServlet()
     */
    public lianxi1() {
        super();
        // TODO Auto-generated constructor stub
    }

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        //404异常页面
        response.getWriter().append("Served at: ").append(request.getContextPath());
        response.getWriter().println("<h1>404</h1>");
    
    
    }

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        doGet(request, response);
    }

}

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  <display-name>hello3</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <!-- error-code 相关的错误页面  异常处理-->

<error-page>

    <error-code>404</error-code>

    <location>/lianxi1</location>

</error-page>

<error-page>

    <exception-type>java.lang.Throwable</exception-type >

    <location>/lianxi1</location>

</error-page>

 
</web-app>