Java Servlet(五)：GenericServlet与Servlet、HttpServlet之间的关系(jdk7+tomcat7+eclipse)

本篇主要记录下，对GenericServlet的作用理解，及其与Servlet/HttpServlet之间的关系。

• 示例完成业务：

1、新建一个login.jsp页面，要求改页面能输入username,password，login.jsp提交页面，对应的处理servlet为LoginServlet；

2、在J2EE环境下，新建一个Dynamic Web Project工程，之后给该工程创建一个LoginServlet servlet类;

3、LoginServlet 完成业务为，获取全局初始化参数信息：username,password的值，那这两个值与从login.jsp页面获取到的值就行对比，如果context-param:username=form:username且context-param:password=form:password，则向客户端返回：

context-param:username:xxx

context-param:password:yyy

form:username:xxx

form:password:yyy

ok!

否则，返回：

context-param:username:xxx

context-param:password:yyy

form:username:xx

form:password:zzz

error!

思路：以前我们都是要写LoginServlet实现Servlet接口类的函数，那现在我们想把LoginServlet代码变得更简洁，我们把一些不常用的代码放在一个抽象Servlet类中，我们的LoginServlet来继承该抽象Servlet类。

1、定义一个MyGenericServlet类，并将该类实现Servlet接口：

public abstract class MyGenericServlet implements Servlet{
    private ServletConfig servletConfig;

    public MyGenericServlet() {        
    }

    @Override
    public void destroy() {        
    }

    @Override
    public ServletConfig getServletConfig() {
        return this.servletConfig;
    }

    @Override
    public String getServletInfo() {
        return "";
    }

    @Override
    public void init(ServletConfig servletConfig) throws ServletException {
        this.servletConfig = servletConfig;
        this.init();
    }

    public void init() throws ServletException {
    }

    @Override
    public abstract void service(ServletRequest request, ServletResponse response) throws ServletException, IOException;
}

2、把service方法修改为一个抽象函数，因为不管哪个继承该类的servlet类都要进行与客户端进行交互（接收客户端信息，响应客户端信息），而service方法是servlet与客户端进行交互的唯一生命周期方法。

3、如果把service方法变为抽象类，我们必须要把这个类变为一个抽象类。

4、为了让子类LoginServlet更好的使用上下文函数，我们实现了getServletConfig()方法：定义一个局部变量，并在init(ServletConfig servletConfig)方法中给该局部变量赋值，这样我们就可以在getServletConfig()中返回这个局部变量即可。

备注：为什么我们要实现servletConfig()方法呢？------在我们业务中提到我们要获取web.xml的全局初始化参数信息，那么我们必须找到ServletContext对象，而找到ServletContext对象，在servlet交互过程中，我们可以通过ServletConfig的getServletContext（）方法获取ServletContext对象。

5、添加一个init()函数，为什么添加呢？

比如说我在LoginServlet中要对servlet初始化时，进行一些工作，那么我就会覆盖init(ServletConfig servletConfig)方法，如果这是我又不知道父类干了什么工作，就想当然的把父类实现给注释掉：

    
@Override
public void init(ServletConfig servletConfig) throws ServletException {    
    //super.init(servletConfig);
}

这是在运行程序就会抛出 一个空指针异常。

因为如果覆盖了父类的init(ServletConfig servletConfig)方法时，把supper.init(servletConfig)给注释了，那么在父类的init(ServletConfig servletConfig)函数中的给局部变量servletConfig赋值部分就不会执行了，那么当我们使用ServletConfig对象（调用getServletConfig（）方法获取到的）时，就会抛出空指针错误。

为了避免这种情况，我们就自定义了一个init()方法，让MyGenericServlet的init(ServletConfig servletConfig)方法调用它，当子类需要在初始化时做的事情，就可以通过覆盖init()方法使用。

6、从上边业务上来说我们能推断出在LoginServlet的service(ServletRequest request,ServletResponse response)方法中，获取全局初始化参数时，需要这样写：

ServletContext servletContext=getServletConfig().getServletContext();
String username=servletContext.getInitParameter("username");
String password=servletContext.getInitParameter("password");

那如果是获取servlet局部初始化变量时，我们需要这样写：

String username=getServletConfig().getInitParameter("username");
String password=getServletConfig().getInitParameter("password");

那么，如果我们让抽象类MyGenericServlet实现接口ServletConfig，我们是不是在LoginServlet中就可以这样获取局部初始化变量：

String username=this.getInitParameter("username");
String password=this.getInitParameter("password");

这样代码是不是会更简洁呢.

因此我们修改后的MyGenericServlet类，是这个样子：

package com.dx.hiservlet;

import java.io.IOException;
import java.util.Enumeration;

import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public abstract class MyGenericServlet implements Servlet,ServletConfig {
    private ServletConfig servletConfig;

    public MyGenericServlet() {        
    }

    @Override
    public void destroy() {        
    }

    @Override
    public ServletConfig getServletConfig() {
        return this.servletConfig;
    }

    @Override
    public String getServletInfo() {
        return "";
    }

    @Override
    public void init(ServletConfig servletConfig) throws ServletException {
        this.servletConfig = servletConfig;
        this.init();
    }

    public void init() throws ServletException {
    }

    @Override
    public abstract void service(ServletRequest request, ServletResponse response) throws ServletException, IOException;

    @Override
    public String getInitParameter(String arg0) {
        return this.getServletConfig().getInitParameter(arg0);
    }

    @Override
    public Enumeration<String> getInitParameterNames() {
        return this.getServletConfig().getInitParameterNames();
    }

    @Override
    public ServletContext getServletContext() {
        return this.getServletConfig().getServletContext();
    }

    @Override
    public String getServletName() {
        return this.getServletConfig().getServletName();
    }

}

login.jsp：

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
    <form action="LoginServlet" method="POST">
        username:<input type="text" name="username" /> 
        <br /> 
        password:<input    type="text" name="password" /> 
        <br /> 
        <input type="submit" value="submit" />
    </form>
</body>
</html>

LoginServlet类

package com.dx.hiservlet;

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

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class LoginServlet extends MyGenericServlet {
    public LoginServlet() {
    }
    
    @Override
    public void init() {
        System.out.println("init....");
    }

    @Override
    public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        String username = servletContext.getInitParameter("username");
        String password = servletContext.getInitParameter("password");

        String formUserName = request.getParameter("username");
        String formPassword = request.getParameter("password");

        PrintWriter writer = response.getWriter();
        
        writer.println("context-param:username:"+username);
        writer.println("context-param:password:"+password);
        
        writer.println("form:username:"+formUserName);
        writer.println("form:password:"+formPassword);
        
        if (username.equals(formUserName) && password.equals(formPassword)) {
            writer.println("ok!");
        } else {            
            writer.println("error!");
        }
    }

}

web.xml配置映射，全局初始化参数“：

<?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">
    <context-param>
        <param-name>username</param-name>
        <param-value>111</param-value>
    </context-param>
    <context-param>
        <param-name>password</param-name>
        <param-value>111</param-value>
    </context-param>

    <servlet>
        <servlet-name>loginServlet</servlet-name>
        <servlet-class>com.dx.hiservlet.LoginServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>loginServlet</servlet-name>
        <url-pattern>/LoginServlet</url-pattern>
    </servlet-mapping>

</web-app>

测试地址：http://localhost:8080/MyGenericServlet001/login.jsp

我们为什么定义一个这样的MyGenericServlet呢，目的是为了学习GenericServlet，从GenericServlet源代码中，我们可以发现我们上边写的这个MyGenericServlet与GenericServlet基本相同，我们把LoginServlet继承类改为GenericServlet，运行结果一样。

那么GenericServlet与Servlet之间的关系，相信我们都清楚了，那么GenericServlet与HttpServlet之间是什么关系呢？

我们去查看下HttpServlet的源代码：

public abstract class HttpServlet extends GenericServlet  
  implements Serializable  
{  
。。。
}

但从Servlet API上来看，HttpServlet要比Servlet,GenricServlet内容更多，具有大量http相关的信息。

具体细节，请参考Servlet Api.