JavaWeb-Servlet

Servlet基础

什么是Servlet

Servlet是JavaWeb的三大组件之一，它属于动态资源。Servlet的作用是处理请求，服务器会把接收到的请求交给Servlet来处理，在Servlet中通常需要：

• 接收请求数据
  
• 处理请求
  
• 完成响应
  

例如客户端发出登录请求，或者输出注册请求，这些请求都应该由Servlet来完成处理。Servlet需要我们自己来编写，每个Servlet必须实现javax.servlet.Servlet接口。

在程序中的表现

• 包：javax.servlet
  
• 已知子接口：HttpJspPage, JspPage
  
• 已知实现类：FacesServlet, GenericServlet, HttpServlet
  
  

实现一个Servlet的三种方法
（1）定义一个普通类，类实现javax.servlet.Servlet接口。
（2）定义一个普通类，继承javax.servlet.GenericServlet类。
（3）定义一个HTTP相关的类，可以继承javax.servlet.http.HttpServlet类.

通常我们会去继承HttpServlet类来完成我们的Servlet，但学习Servlet还要从javax.servlet.Servlet接口开始学习。

接口方法

返回类型	方法名	参数类型1	参数名1	参数类型2	参数名2	描述
void	destroy	void				由Servlet容器调用，摧毁当前Servlet容器。生命周期方法。
ServletConfig	getServletConfig	void				返回ServletConfig对象，该对象包含此Servlet的初始化和启动参数。
java.lang.String	getServletInfo	void				返回有关Servlet的信息，如作者、版本和版权。
void	init	ServletConfig	config			由Servlet容器调用，类初始化时调用的方法。生命周期方法。
void	service	ServletRequest	req	ServletResponse	res	由Servlet容器调用，处理服务器请求，并且给客户端做出响应的方法。生命周期方法。

Servlet的生命周期

诞生： 当客户端浏览器第一个访问Servlet的时候，init方法被执行。此时Servlet诞生。
服务： 客户端每请求一次，Service方法就被执行一次。
销毁： 服务器关闭，或者是Servlet从web容器当中移除的时候，此时Servlet销毁。

特性

• 单例，一个类只有一个对象；当然，可能存在多个Servlet类。
• 线程不安全，所以它的效率更高！

Servlet类由我们来写，但对象由服务器来创建，并且由服务器来调用相应的方法。

作用

（1）接收客户端的请求，处理请求。
（2）响应给客户端。

Servlet的访问

配置Servlet信息

打开wwwroot/WEB-INF/目录下的web.xml文件
在<web-app></web-app>中添加<servlet></servlet>标签，再在其中添加<servlet-name></servlet-name>标签，并在其中记录名称（最好与类名一致）。
并列<servlet-name></servlet-name>标签添加<servlet-class></servlet-class>标签其中记录类全路径名。
并列<servlet></servlet>标签添加<servlet-mapping></servlet-mapping>标签，该标签记录Servlet的映射，它其中的标签<servlet-name></servlet-name>映射到<servlet></servlet>中的<servlet-name></servlet-name>的记录内容，因此<servlet></servlet>的<servlet-name></servlet-name>中的记录要和<servlet-mapping></servlet-mapping>标签中<servlet-name></servlet-name>的记录内容一致。
<servlet-mapping></servlet-mapping>中的<url-pattern></url-pattern>中添加的是浏览器地址栏中域名后的路径。（全部配置如下）

<web-app>
	<servlet>
    		<servlet-name>TestServlet</servlet-name>
    		<servlet-class>com.test.TestServlet</servlet-class>
  	</servlet>
	<servlet-mapping>
    		<servlet-name>TestServlet</servlet-name>
    		<url-pattern>/servlet/TestServlet</url-pattern>
  	</servlet-mapping>
</web-app>

访问Servlet实验

• 编写代码

package com.test.t001;

import java.io.IOException;

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

public class FirstServlet implements Servlet {

	public void destroy() {
		System.out.println("已销毁");
	}

	public ServletConfig getServletConfig() {
		return null;
	}

	public String getServletInfo() {
		return null;
	}

	public void init(ServletConfig config) throws ServletException {
		System.out.println("初始化");
	}

	public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {
		System.out.println("服务中");
	}

}

• 在控制台可以看到运行结果
  

• 开启服务器控制台打印“初始化”
• 浏览器访问http://localhost:8080/servlet/FirstServlet后控制台打印“服务中”
• 关闭服务器控制台打印“已销毁”

ServletConfig 接口

描述

ServletConfig对象对应web.xml文件中的<servlet>元素。例如你想获取当前Servlet在web.xml文件中的配置名，那么可以使用servletConfig.getServletName()方法获取。ServletConfig对象是由服务器创建的，然后传递给Servlet的init()方法，你可以在init()方法中使用它。

接口信息

• 包：javax.servlet
  
• 所有已知实现类：GenericServlet, HttpServlet
  

接口方法

返回类型	方法名	参数类型	参数名	描述
java.lang.String	getInitParameter	java.lang.String	name	用来获取在web.xml中配置的初始化参数，通过参数名来获取参数值
java.util.Enumeration<java.lang.String>	getInitParameterNames	void		用来获取在web.xml中配置的所有初始化参数名称，在<servlet>元素中还可以配置初始化参数
ServletContext	getServletContext	void		用来获取ServletContext对象，返回对调用方正在其中执行的servletContext的引用。
java.lang.String	getServletName	void		获取Servlet在web.xml文件中的配置名称，即<servlet-name>指定的名称

• 在OneServlet中，可以使用ServletConfig对象的getInitParameter()方法来获取初始化参数，例如：

String value1 = servletConfig.getInitParameter(“paramName1”);//获取到paramValue1

GenericServlet类

描述

GenericServlet是Servlet接口的实现类，我们可以通过继承GenericServlet来编写自己的Servlet。下面是GenericServlet类的源代码：

GenericServlet.java

public abstract class GenericServlet implements Servlet,ServletConfig,java.io.Serializable {
    private static final long serialVersionUID = 1L;
    private transient ServletConfig config;
    public GenericServlet() {}
    @Override
    public void destroy() {}
    @Override
    public String getInitParameter(String name) {
        return getServletConfig().getInitParameter(name);
    }
    @Override
    public Enumeration<String> getInitParameterNames() {
        return getServletConfig().getInitParameterNames();
    }
    @Override
    public ServletConfig getServletConfig() {
        return config;
    }
    @Override
    public ServletContext getServletContext() {
        return getServletConfig().getServletContext();
    }
    @Override
    public String getServletInfo() {
        return "";
    }
    @Override
    public void init(ServletConfig config) throws ServletException {
        this.config = config;
        this.init();
    }
    public void init() throws ServletException {}
    public void log(String msg) {
        getServletContext().log(getServletName() + ": " + msg);
    }
    public void log(String message, Throwable t) {
        getServletContext().log(getServletName() + ": " + message, t);
    }
    @Override
    public abstract void service(ServletRequest req, ServletResponse res)
            throws ServletException, IOException;
    @Override
    public String getServletName() {
        return config.getServletName();
    }
}

类信息

• 包：javax.servlet
  
• 父类：java.lang.Object
  
• 实现的接口：java.io.Serializable,Servlet,ServletConfig
  
• 已知子类：HttpServlet
  

类方法（已经展示过的接口方法略）

返回值	方法名	参数类型1	参数名1	参数类型2	参数名2	描述
void	init	void				一种方便的方法，可以重写，这样就不需要调用super.init（config）了。
void	init	ServletConfig	config			同上述接口中方法
void	log	java.lang.String	msg			将指定的消息写入servlet日志文件，并以servlet的名称作为前缀。
void	log	java.lang.String	message	java.lang.Throwable	t	向servlet日志文件中写入一条解释性消息和一个给定的可丢弃异常的堆栈跟踪，并以servlet的名称作为前缀。

• GenericServlet的init()方法说明
  
  在GenericServlet中，定义了一个ServletConfig config实例变量，并在init(ServletConfig)方法中把参数ServletConfig赋给了实例变量。然后在该类的很多方法中使用了实例变量config。
  如果子类覆盖了GenericServlet的init(StringConfig)方法，那么this.config=config这一条语句就会被覆盖了，也就是说GenericServlet的实例变量config的值为null，那么所有依赖config的方法都不能使用了。如果真的希望完成一些初始化操作，那么去覆盖GenericServlet提供的init()方法，它是没有参数的init()方法，它会在init(ServletConfig)方法中被调用。
  
  

• 实现了ServletConfig接口
  
  GenericServlet还实现了ServletConfig接口，所以可以直接调用getInitParameter()、getServletContext()等ServletConfig的方法。

HttpServlet类

描述

• HttpServlet类是GenericServlet的子类，它提供了对HTTP请求的特殊支持，所以通常我们都会通过继承HttpServlet来完成自定义的Servlet。
  
  

HttpServlet覆盖了service()方法

HttpServlet类中提供service(HttpServletRequest, HttpServletResponse) 方法，这个方法是HttpServlet自己的方法，不是从Servlet继承来的。在HttpServlet的service(ServletRequest, ServletResponse)方法中会把ServletRequest和ServletResponse强转成HttpServletRequest和HttpServletResponse，然后调用service(HttpServletRequest, HttpServletResponse)方法，这说明子类可以去覆盖service(HttpServletRequest, HttpServletResponse)方法即可，这就不用自己去强转请求和响应对象了。

其实子类也不用去覆盖service(HttpServletRequest, HttpServletResponse)方法，因为HttpServlet还要做另一步简化操作。

• HttpServlet.java源代码（部分略）

public abstract class HttpServlet extends GenericServlet {
	protected void service(HttpServletRequest req,HttpServletResponse resp) throws ServletException, IOException {
		//……
	}
	@Override
	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);
	}
	//……
}

doGet()和doPost()方法

• 在HttpServlet的service(HttpServletRequest,HttpServletResponse)方法中会去判断当前请求是GET还是POST，如果是GET请求，那么会去调用本类的doGet()方法，如果是POST请求会去调用doPost()方法，这说明我们在子类中去覆写doGet()或doPost()方法即可。
  

• 例如

public class AServlet extends HttpServlet {
	public void doGet(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {
		System.out.println("hello doGet()...");
	}
}

public class BServlet extends HttpServlet {
	public void doPost(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {
		System.out.println("hello doPost()...");
	}
}

HttpServlet方法总结

返回值	方法名称	参数类型1	参数名1	参数类型2	参数名2	描述
protected void	doDelete	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用，以允许servlet处理删除请求。
protected void	doGet	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用，以允许servlet处理get请求。
protected void	doHead	HttpServletRequest	req	HttpServletResponse	resp	从受保护的服务方法接收HTTP头请求并处理该请求。
protected void	doOptions	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用，以允许servlet处理选项请求。
protected void	doPost	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用，以允许servlet处理post请求。
protected void	doPut	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用以允许servlet处理Put请求。
protected void	doTrace	HttpServletRequest	req	HttpServletResponse	resp	由服务器（通过服务方法）调用以允许servlet处理跟踪请求。
protected long	getLastModified	HttpServletRequest	req			返回上一次修改httpservletrequest对象的时间，单位为毫秒，从1970年1月1日午夜开始计算。
protected void	service	HttpServletRequest	req	HttpServletResponse	resp	接收来自公共服务方法的标准HTTP请求，并将其发送到此类中定义的doXXX方法。
void	service	ServletRequest	req	ServletResponse	res	向受保护的服务方法发送客户端请求。

关于Servlet的零散知识点

Servlet小细节

• 不要在Servlet中创建成员。创建局部变量即可。
  
• 可以创建无状态成员。
  
• 可以创建有状态的成员，但状态必须为只读的。
  

让服务器在启动时就创建Servlet

在<servlet>元素中配置<load-on-startup>元素可以让服务器在启动时就创建该Servlet，其中元素的值必须是大于等于0的整数，它的使用是服务器启动时创建Servlet的顺序。下例中，根据<load-on-startup>的值可以得知服务器创建Servlet的顺序为Hello1Servlet、Hello2Servlet、Hello3Servlet。

<!--0第一启动-->
<servlet>
	<servlet-name>hello1</servlet-name>
	<servlet-class>com.test.servlet.Hello1Servlet</servlet-class>
	<load-on-startup>0</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>hello1</servlet-name>
	<url-pattern>/hello1</url-pattern>
</servlet-mapping>

<!--1第二启动-->
<servlet>
	<servlet-name>hello2</servlet-name>
	<servlet-class>com.test.servlet.Hello2Servlet</servlet-class>
	<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>hello2</servlet-name>
	<url-pattern>/hello2</url-pattern>
</servlet-mapping>

<!--2第三启动-->
<servlet>
	<servlet-name>hello3</servlet-name>
	<servlet-class>com.test.servlet.Hello3Servlet</servlet-class>
	<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>hello3</servlet-name>
	<url-pattern>/hello3</url-pattern>
</servlet-mapping>

关于web.xml中的元素

<url-pattern>是<servlet-mapping>的子元素，用来指定Servlet的访问路径，即URL。它必须是以“/”开头！

1. 可以在<servlet-mapping>中给出多个<url-pattern>，那么这说明一个Servlet绑定了两个URL，无论访问/AServlet还是/BServlet，访问的都是AServlet。例如：

<servlet-mapping>
	<servlet-name>AServlet</servlet-name>
	<url-pattern>/AServlet</url-pattern>
	<url-pattern>/BServlet</url-pattern>
</servlet-mapping> 

2. 还可以在<url-pattern>中使用通配符，所谓通配符就是星号“*”，星号可以匹配任何URL前缀或后缀，使用通配符可以命名一个Servlet绑定一组URL，例如：

   • <url-pattern>/servlet/*<url-patter>：/servlet/a、/servlet/b，都匹配/servlet/*
     
   • <url-pattern>*.do</url-pattern>：/abc/def/ghi.do、/a.do，都匹配*.do
     
   • <url-pattern>/*<url-pattern>：匹配所有URL
     

   请注意，通配符要么为前缀，要么为后缀，不能出现在URL中间位置，也不能只有通配符。例如：/*.do就是错误的，因为星号出现在URL的中间位置上了。*.*也是不对的，因为一个URL中最多只能出现一个通配符。 注意，通配符是一种模糊匹配URL的方式，如果存在更具体的<url-pattern>，那么访问路径会去匹配具体的<url-pattern>。例如：

<servlet>
	<servlet-name>hello1</servlet-name>
	<servlet-class>com.test.servlet.Hello1Servlet</servlet-class>
</servlet>
	<servlet-mapping>
	<servlet-name>hello1</servlet-name>
	<url-pattern>/servlet/hello1</url-pattern>
</servlet-mapping>
<servlet>
	<servlet-name>hello2</servlet-name>
	<servlet-class>com.test.servlet.Hello2Servlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>hello2</servlet-name>
	<url-pattern>/servlet/*</url-pattern>
</servlet-mapping>

当访问路径为http://localhost:8080/hello/servlet/hello1时，因为访问路径即匹配hello1的，又匹配hello2的，但因为hello1的中没有通配符，所以优先匹配，即设置hello1。

web.xml文件的继承

在${CATALINA_HOME}\conf\web.xml中的内容，相当于写到了每个项目的web.xml中，它是所有web.xml的父文件。
每个完整的JavaWeb应用中都需要有web.xml，但我们不知道所有的web.xml文件都有一个共同的父文件，它在Tomcat的conf/web.xml路径。

• conf/web.xml

<?xml version="1.0" encoding="ISO-8859-1"?>

<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
<servlet>
	<servlet-name>default</servlet-name>
	<servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
	<init-param>
		<param-name>debug</param-name>
		<param-value>0</param-value>
	</init-param>
	<init-param>
		<param-name>listings</param-name>
		<param-value>false</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>

<servlet>
	<servlet-name>jsp</servlet-name>
	<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
	<init-param>
		<param-name>fork</param-name>
		<param-value>false</param-value>
	</init-param>
	<init-param>
		<param-name>xpoweredBy</param-name>
		<param-value>false</param-value>
	</init-param>
	<load-on-startup>3</load-on-startup>
</servlet>

<servlet-mapping>
	<servlet-name>default</servlet-name>
	<url-pattern>/</url-pattern>
</servlet-mapping>

<servlet-mapping>
	<servlet-name>jsp</servlet-name>
	<url-pattern>*.jsp</url-pattern>
	<url-pattern>*.jspx</url-pattern>
</servlet-mapping>

<session-config>
	<session-timeout>30</session-timeout>
</session-config>

<!-- 这里省略了大概4000多行的MIME类型的定义,这里只给出两种MIME类型的定义 -->
<mime-mapping>
	<extension>bmp</extension>
	<mime-type>image/bmp</mime-type>
</mime-mapping>
<mime-mapping>
	<extension>htm</extension>
	<mime-type>text/html</mime-type>
</mime-mapping>

<welcome-file-list>
	<welcome-file>index.html</welcome-file>
	<welcome-file>index.htm</welcome-file>
	<welcome-file>index.jsp</welcome-file>
</welcome-file-list>

</web-app>

ServletContext

特性

一个项目只有一个ServletContext对象。 我们可以在N多个Servlet中来获取这个唯一的对象，使用它可以给多个Servlet传递数据。 这个对象在服务器启动时就创建，在服务器关闭时才会死去。

描述

服务器会为每个应用创建一个ServletContext对象：

• ServletContext对象的创建是在服务器启动时完成的
  
• ServletContext对象的销毁是在服务器关闭时完成的
  
  

ServletContext对象的作用是在整个Web应用的动态资源之间共享数据。例如在AServlet中向ServletContext对象中保存一个值，然后在BServlet中就可以获取这个值，这就是共享数据了。

获取ServletContext

• ServletConfig中的方法getServletContext()；
• GenericServlet中的方法getServletContext();
• HttpSession中的方法getServletContext()
• ServletContextEvent中的方法getServletContext()

public class MyServlet implements Servlet {
	public void init(ServletConfig config) {
		ServletContext context = config.getServletContext();
	}
	//…
}

public class MyServlet extends HttpServlet {
	public void doGet(HttpServletRequest request, HttpServletResponse response) {
		ServletContext context = this.getServletContext();
	}
}

域对象的功能

ServletContext是JavaWeb四大域对象之一：

1. PageContext
   
2. ServletRequest
   
3. HttpSession
   
4. ServletContext
   
   
   

所有域对象都有存取数据的功能，因为域对象内部有一个Map，用来存储数据，下面是ServletContext对象用来操作数据的方法：

1. void setAttribute(String name, Object value)：用来存储一个对象，也可以称之为存储一个域属性，例如：servletContext.setAttribute(“xxx”, “XXX”)，在ServletContext中保存了一个域属性，域属性名称为xxx，域属性的值为XXX。请注意，如果多次调用该方法，并且使用相同的name，那么会覆盖上一次的值，这一特性与Map相同
   
2. Object getAttribute(String name)：用来获取ServletContext中的数据，当前在获取之前需要先去存储才行，例如：String value = (String)servletContext.getAttribute(“xxx”);，获取名为xxx的域属性
   
3. void removeAttribute(String name)：用来移除ServletContext中的域属性，如果参数name指定的域属性不存在，那么本方法什么都不做
   
4. Enumeration getAttributeNames()：获取所有域属性的名称
   
   
   

获取应用初始化参数

Servlet也可以获取初始化参数，但它是局部的参数；也就是说，一个Servlet只能获取自己的初始化参数，不能获取别人的，即初始化参数只为一个Servlet准备。
可以配置公共的初始化参数，为所有Servlet而用。这需要使用ServletContext才能使用。

还可以使用ServletContext来获取在web.xml文件中配置的应用初始化参数！注意，应用初始化参数与Servlet初始化参数不同：

<web-app>
  <!--...-->
  <context-param>
	<param-name>paramName1</param-name>
	<param-value>paramValue1</param-value>  	
  </context-param>
  <context-param>
	<param-name>paramName2</param-name>
	<param-value>paramValue2</param-value>  	
  </context-param>
</web-app>

	//...
	ServletContext context = this.getServletContext();
	String value1 = context.getInitParameter("paramName1");
	String value2 = context.getInitParameter("paramName2");
	System.out.println(value1 + ", " + value2);
		
	Enumeration names = context.getInitParameterNames();
	while(names.hasMoreElements()) {
		System.out.println(names.nextElement());
	}
	//...

获取资源相关方法

获取真实路径

可以使用ServletContext对象来获取Web应用下的资源，例如在应用的根目录下创建a.txt文件，现在想在Servlet中获取这个资源，就可以使用ServletContext来获取。

1. 获取a.txt的真实路径：String realPath = servletContext.getRealPath(“/a.txt”)，realPath的值为a.txt文件的绝对路径：F:\tomcat6\webapps\hello\a.txt
   
2. 获取b.txt的真实路径：String realPath = servletContext.getRealPath(“/WEB-INF/b.txt”)
   

获取资源流

不只可以获取资源的路径，还可以通过ServletContext获取资源流，即把资源以输入流的方式获取：

1. 获取a.txt资源流：InputStream in = servletContext.getResourceAsStream(“/a.txt”)
   
2. 获取b.txt资源流：InputStream in = servletContext.getResourceAsStream(“/WEB-INF/b.txt”)
   

获取指定目录下所有资源路径

还可以使用ServletContext获取指定目录下所有资源路径，例如获取/WEB-INF下所有资源的路径：

	Set set = context.getResourcePaths("/WEB-INF");
	System.out.println(set);

[/WEB-INF/lib/, /WEB-INF/classes/, /WEB-INF/b.txt, /WEB-INF/web.xml]