学步园

了解servlet的功能；了解servlet的生命周期；了解servlet的API；掌握创建并发布HttpServlet的方法；理解ServletContext与JavaWeb应用的关系

1、Servlet简介

    - Java Servlet是和平台无关的服务器端组件，它运行在Servlet容器中，Servlet容器负责Servlet和客户的通信以及调用Servlet的方法，Servlet和客户的通信采用“请求/响应”的模式。
    - Servlet可完成如下功能：创建并返回基于客户请求的动态HTML页面；创建可嵌入到现有HTML页面中的部分HTML页面（HTML片段）；与其他服务器资源（如数据库或基于Java的应用程序）进行通信。
    - Servlet的框架是由两个Java包组成：javax.servlet包：定义了所有的Servlet类都必须实现或扩展的通用接口和类；javax.servlet.http包：定义了采用HTTP协议通信的HttpServlet类。
    - Servlet API：servlet的框架的核心是javax.servlet.Servlet接口，所有的Servlet都必须实现这一接口。在Servlet接口中定义了五个方法，其中有三个方法代表了Servlet的生命周期：init方法——负责初始化Servlet对象；service方法——负责响应客户的请求；destroy方法——当Servlet对象退出生命周期时，负责释放占用的资源。

2、每一个servlet都必须要实现servlet接口，genericServlet是个通用的、不特定于任何协议的servlet，他实现了Servlet接口，而HttpServlet继承于GenericServlet，因此HttpServlet也实现了Servlet接口，所以我们定义的servlet只需要继承HttpServlet父类即可

      Servlet接口中定义了一个service方法，HttpServlet对该方法进行了实现，实现方式就是将ServletRequest与ServletResponse转换为HttpServletRequest与HttpServletResponse ，   转换完毕后，会调用HttpServlet类中自己定义的service方法。 

      在该service方法中，首先获取到请求的方法名，然后根据方法名调用对用的doxxx方法，比如说请求方法为GET，那么就去调用doGet方法，请求方法为POST，就调用doPost方法 

      在HttpServlet类中所提供的doGET、doPOST等方法都是直接返回错误信息，所以我们需要在自己定义的Servlet中override这些方法。

举例：

import java.io.IOException;

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

public class ServiceServlet extends HttpServlet
{
	@Override
	protected void service(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		String username = req.getParameter("username");
		String password = req.getParameter("password");
		
		System.out.println(username + "=" + password);
	}
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		String username = req.getParameter("username");
		String password = req.getParameter("password");
		System.out.println("doget invoke!");
		System.out.println(username + "=" + password);
	}
}

上面的例子，我们在调用时，只执行了service方法，因为我们重写了service方法，所以不会执行doget或doPOST等其他方法。

3、了解一下HttpServlet源代码，其中的service方法有两个，分别如下：

protected void service(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {

        String method = req.getMethod();

        if (method.equals(METHOD_GET)) {
            long lastModified = getLastModified(req);
            if (lastModified == -1) {
                // servlet doesn't support if-modified-since, no reason
                // to go through further expensive logic
                doGet(req, resp);
            } else {
                long ifModifiedSince = req.getDateHeader(HEADER_IFMODSINCE);
                if (ifModifiedSince < (lastModified / 1000 * 1000)) {
                    // If the servlet mod time is later, call doGet()
                    // Round down to the nearest second for a proper compare
                    // A ifModifiedSince of -1 will always be less
                    maybeSetLastModified(resp, lastModified);
                    doGet(req, resp);
                } else {
                    resp.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                }
            }

        } else if (method.equals(METHOD_HEAD)) {
            long lastModified = getLastModified(req);
            maybeSetLastModified(resp, lastModified);
            doHead(req, resp);

        } else if (method.equals(METHOD_POST)) {
            doPost(req, resp);
            
        } else if (method.equals(METHOD_PUT)) {
            doPut(req, resp);        
            
        } else if (method.equals(METHOD_DELETE)) {
            doDelete(req, resp);
            
        } else if (method.equals(METHOD_OPTIONS)) {
            doOptions(req,resp);
            
        } else if (method.equals(METHOD_TRACE)) {
            doTrace(req,resp);
            
        } else {
            //
            // Note that this means NO servlet supports whatever
            // method was requested, anywhere on this server.
            //

            String errMsg = lStrings.getString("http.method_not_implemented");
            Object[] errArgs = new Object[1];
            errArgs[0] = method;
            errMsg = MessageFormat.format(errMsg, errArgs);
            
            resp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED, errMsg);
        }
    }

public void service(ServletRequest req, ServletResponse res)
        throws ServletException, IOException {

        HttpServletRequest  request;
        HttpServletResponse response;
        
        try {
            request = (HttpServletRequest) req;
            response = (HttpServletResponse) res;
        } catch (ClassCastException e) {
            throw new ServletException("non-HTTP request or response");
        }
        service(request, response);
    }
}

对于public void service(ServletRequest req, ServletResponse res)这个方法来自于Servlet接口的方法，它的参数是通用的ServletRequest和ServletResponse，因为对于tomcat应用来说，都是基于HTTP的请求响应，所以强制转换为HttpServletRequest和HttpServletResponse，然后调用protected void service(HttpServletRequest req, HttpServletResponse
resp)这个方法，这个方法是HttpServlet特有的，它来完成具体的请求操作，通过源代码我们可以看出，它的作用就是根据HTTP请求的不同，调用相对应的doXXX方法，所以，如果我们重写了service方法，并且我们没有去调用其他doXXX方法，则doXXX方法就不会执行，就如上例一样，doGET方法不会执行，只执行了service方法中的打印功能。

再看一下doGET方法和doPOST方法：

 protected void doGet(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException
    {
        String protocol = req.getProtocol();
        String msg = lStrings.getString("http.method_get_not_supported");
        if (protocol.endsWith("1.1")) {
            resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, msg);
        } else {
            resp.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
        }
    }


protected void doPost(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {

        String protocol = req.getProtocol();
        String msg = lStrings.getString("http.method_post_not_supported");
        if (protocol.endsWith("1.1")) {
            resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, msg);
        } else {
            resp.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
        }
    }

可以看出，如果我们不重写doGET和doPOST方法，则直接发送错误信息。

tomcat对于request等的底层实现是使用了map来操作的setAttribute、getAttribute就是集合Map的存入和取出操作。

4、Servlet核心API之间的关系UML图：

如果你的Servlet类扩展了HttpServlet类，你通常不必实现service方法，因为HttpServlet类已经实现了service方法，该方法就是上面源代码中的protected void service(HttpServletRequest req, HttpServletResponse resp)方法；在HttpServlet的service方法中，首先从HttpServletRequest对象中获取HTTP请求方式的信息，然后再根据请求方式调用相应的方法。

ServletRequest接口中封装了客户请求信息，如客户请求方式、参数名和参数值、客户端正在使用的协议，以及发送客户请求的远程主机信息等。ServletRequest接口还为Servlet提供了直接以二进制方式读取客户请求数据流的ServletInputStream(文件上传)；ServletRequest的子类可以为Servlet提供更多的和特定协议相关的数据。例如：HttpServletRequest提供了读取HTTP Head信息的方法。ServletOutputStream用于文件下载

ServletRequest接口的主要方法：
- getAttribute   根据参数给定的属性名返回属性值
- getContentType 返回客户请求数据的MIME类型
- getInputStream 返回以二进制方式直接读取客户请求数据的输入流
- getParameter 根据给定的参数名返回参数值
- getRemoteAddr 返回远程客户主机的IP地址
- getRemoteHost 返回远程客户主机名
- getRemotePort  返回远程客户主机的端口

MIME类型可以在tomcat的WEB.xml中查看

ServletResponse接口为Servlet提供了返回响应结果的方法。它允许Servlet设置返回数据的长度和MIME类型，并且提供输出流ServletOutputStream；ServletResponse子类可以提供更多和特定协议相关的方法。例如：HttpServletResponse提供设定HTTP Head信息的方法。

ServletResponse接口的主要方法：
- getOutputStream 返回可以向客户端发送二进制数据的输出流对象ServletOutputStream
- getWriter 返回可以向客户端发送字符数据的PrintWriter对象
- getCharacterEncoding 返回Servlet发送的响应数据的字符编码
- getContentType 返回Servlet发送的响应数据的MIME类型
- setContentType 设置Servlet发送的响应数据的MIME类型

5、Servlet的初始化阶段

在下列时刻Servlet容器装载Servlet：
- Servlet容器启动时自动装载某些Servlet
- 在Servlet容器启动后，客户首次向Servlet发送请求
- Servlet的类文件被更新后，重新装载Servlet

Servlet被装载后，Servlet容器创建一个Servlet实例并且调用Servlet的init（）方法进行初始化。在Servlet的整个生命周期中，init方法只会被调用一次。

import java.io.IOException;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class InitServlet extends HttpServlet
{
	@Override
	public void init(ServletConfig config) throws ServletException
	{
		System.out.println("init invoke!");
	}
	
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		System.out.println("doget invoke!");
	}
}

对于这个servlet只有在第一次访问时调用init（）方法，即第一次访问时打印出init invoke，再访问时，只打印doget invoke。

关于Servlet的在容器启动时自动装载，需要在web.xml文件中<servlet></servlet>做如下配置：

<servlet>
    <servlet-name>InitServlet</servlet-name>
    <servlet-class>com.cdtax.servlet.InitServlet</servlet-class>
    <load-on-startup>10</load-on-startup>
  </servlet>

主要就是加上了<load-on-startup>标签，内容为一个数字，表明服务器启动时自动加载，并且如果有多个加载项，按照数字顺序加载。

6、Servlet的响应客户请求阶段

对于到达Servlet容器的客户请求，Servlet容器创建特定于这个请求的ServletRequest对象和ServletResponse对象，然后调用Servlet的service方法。service方法从ServletRequest对象获得客户请求信息、处理该请求，并通过ServletReponse对象向客户返回响应结果。

7、Servlet的终止阶段

当web应用被终止，或Servlet容器终止运行，或Servlet容器重新装载Servlet的新实例时，Servlet容器会先调用Servlet的destroy方法。在destroy方法中，可以释放Servlet所占用的资源。

8、创建用户自己的HttpServlet类的步骤：

    1）扩展HttpServlet抽象类
    2）覆盖HttpServlet的部分方法，如覆盖doGet（）或doPost（）方法
    3）获取HTTP请求信息，例如通过HttpServletRequest对象来检索HTML表单所提交的数据或URL上的查询字符串。无论是HTML表单数据还是URL上的查询字符串，在HttpServletRequest对象中都以参数名/参数值的形式存放，你可以通过getParameter（String name）方法检索参数信息。

9、Servlet对象何时被创建

默认情况下，当web客户第一次请求访问某个Servlet时，web容器创建这个Servlet的实例；如果设置了<servlet>元素的<load-on startup>子元素，servlet容器在启动web应用时，将按照指定的顺序创建并初始化这个servlet。

某些Servlet在web.xml文件中只有<servlet>元素而没有<servlet-mapping>元素，这样我们就无法通过url地址的方式访问这个servlet了，这种Servlet通常会在<servlet>元素中配置一个<load-on-startup>子元素，让容器在启动的时候自动加载该servlet，并调用其init方法完成一些全局性的初始化工作。

10、web应用何时被启动

当Servlet容器启动时，会启动所有的web应用；通过控制台启动web应用。

11、ServletContext和web应用的关系

当Servlet容器启动web应用时，并为每个web应用创建唯一的ServletContext对象。你可以把ServletContext看成是一个web应用的服务器端组件的共享内存。在ServletContext中可以存放共享的数据，它提供了读取或设置共享数据的方法：
- setAttribute（String name，Object object ）把一个对象和一个属性名绑定，将这个对象存储在ServletContext中。
- getAttribute（String name）根据给定的属性名返回所绑定的对象。举例：counter.jsp

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    
    
    <title>My JSP 'counter.jsp' starting page</title>
    
  </head>
  
  <body>
    计数器:<%= application.getAttribute("counter") %>
  </body>
</html>

import java.io.IOException;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class CounterServlet extends HttpServlet
{
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		ServletContext context = req.getSession().getServletContext();
		
		if(null== context.getAttribute("counter"))
		{
			context.setAttribute("counter", 1);
		}
		else
		{
			int counter = (Integer)context.getAttribute("counter");
			
			context.setAttribute("counter", counter + 1);
		}
		
		req.getRequestDispatcher("counter.jsp").forward(req,resp);
		
	}
}

12、Servlet的多线程同步问题

- Servlet/JSP技术和ASP、PHP等相比，由于其多线程运行而具有很高的执行效率。
- 由于Servlet/JSP默认是以多线程模式执行的，所以，在编写代码时需要非常细致地考虑多线程的同步问题。
- 如果在编写Servlet/JSP程序时不注意到多线程同步的问题，这往往造成编写的程序在少量用户访问时没有任何问题，而在并发用户上升到一定值时，就会经常出现一些莫名其妙的问题，对于这类随机的问题调试难度很大。

一个会出问题的例子：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    
    <title>My JSP 'form.jsp' starting page</title>

  </head>
  
  <body>
   <form action="HelloServlet1">
   	<input type="text" name="username">
   	<input type="submit" value="submit">
   	   </form>
  </body>
</html>

import java.io.IOException;

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

public class HelloServlet1 extends HttpServlet
{
	private String username;
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		this.username = req.getParameter("username");
		
		try
		{
			Thread.sleep(5000);
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		req.setAttribute("username", this.username);
		req.getRequestDispatcher("hello.jsp").forward(req, resp);
	}
}

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    
    <title>My JSP 'hello.jsp' starting page</title>
    

  </head>
  
  <body>
    <%= request.getAttribute("username") %>
    <br>
    <%= request.getParameter("username") %>
  </body>
</html>

Servlet的多线程同步问题：Servlet本身是单实例的，这样当有多个用户同时访问某个Servlet时，会访问该唯一的Servlet实例中的成员变量。如果对成员变量进行写入操作，那就会导致Servlet的多线程问题，即数据不一致。解决方案是将成员变量转为局部变量。

13、Cookie——英文原意是“点心”，它是用户访问web服务器时，服务器在用户硬盘上存放的信息，好像是服务器送给客户的“点心”；服务器可以根据Cookie来跟踪用户，这对于需要区别用户的场合（如电子商务）特别有用。一个Cookie包含一对Key/Value。下面的代码生成一个Cookie并将它写到用户的硬盘上：
Cookie theCookie = new Cookie("coolieName","cookieValue");
response.addCookie(theCookie);

使用Servlet生成Cookie和从客户端获取cookie

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class CookieServlet extends HttpServlet
{
	private int count1;
	private int count2;
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws ServletException, IOException
	{
		Cookie cookie = new Cookie("cookieName" + count1++,"cookieValue" + count2++);
		cookie.setMaxAge(10);
		
		resp.addCookie(cookie);
		
		Cookie[] cookies = req.getCookies();
		
		if(null == cookies)
		{
			return;
		}
		for(Cookie c : cookies)
		{
			System.out.println("cookie name:" + c.getName());
			System.out.println("cookie value:" + c.getValue());
		}
		
		
		
	}
}

使用JSP来生成和获取cookie

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    
    <title>My JSP 'jspCookie.jsp' starting page</title>

  </head>
  
  <body>
    <%! int count1 = 0;
    	int count2 = 0;
    %>
    <% Cookie cookie = new Cookie("cookieName" + count1++,"cookieValue" + count2++);
    	cookie.setMaxAge(15);
    	response.addCookie(cookie);
    
    %>
    <%
    	Cookie[] cookies = request.getCookies();
    	if(null == cookies)
    	{
    		return;
    	}
    	for(Cookie c : cookies)
    	{
    		
      %>
      <p>
      <b>cookie name:</b><%= c.getName() %><br/>
      <b>cookie value:</b><%= c.getValue() %>
      </p>
      <% } %>
  </body>
</html>

14、比较Servlet和JSP

有很多相似之处，都可以生成动态网页；JSP的优点是擅长于网页制作，生成动态页面，比较直观。JSP的缺点是不容易跟踪与排错；Servlet是纯Java语言，擅长于处理流程和业务逻辑。Servlet的缺点是生成动态网页不直观。