title: Web笔记（三）Servlet 的类与接口API

date: 2018-09-01 09:58:35

url: develop/web/web/base-03

updated: 2018-09-01 09:58:35

categories:

- Java EE

tags:

- Servlet

Java Servlet 是运行在 Web 服务器或应用服务器上的程序，它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层。

使用 Servlet，您可以收集来自网页表单的用户输入，呈现来自数据库或者其他源的记录，还可以动态创建网页。

Java Servlet 通常情况下与使用 CGI（Common Gateway Interface，公共网关接口）实现的程序可以达到异曲同工的效果。但是相比于 CGI，Servlet 有以下几点优势：

- 性能明显更好。

- Servlet 在 Web 服务器的地址空间内执行。这样它就没有必要再创建一个单独的进程来处理每个客户端请求。

- Servlet 是独立于平台的，因为它们是用 Java 编写的。

- 服务器上的 Java 安全管理器执行了一系列限制，以保护服务器计算机上的资源。因此，Servlet 是可信的。

- Java 类库的全部功能对 Servlet 来说都是可用的。它可以通过 sockets 和 RMI 机制与 applets、数据库或其他软件进行交互。

<!-- more -->

Servlet API 包含两个包，分别是:javax.servlet 与javax.servlet.http包。具体的类与接口结构如下图：

Servlet 的运行需要Web 服务器的支持，Web服务器可以通过调用Servlet对象提提供的标准API ，对客户端请求做出处理。

[官方API](https://tomcat.apache.org/tomcat-5.5-doc/servletapi/)

定义所有 servlet 都必须实现的方法。

servlet 是运行在 Web 服务器中的小型 Java 程序。servlet 通常通过 HTTP（超文本传输协议）接收和响应来自 Web 客户端的请求。

要实现此接口，可以编写一个扩展 javax.servlet.GenericServlet 的一般 servlet，或者编写一个扩展 javax.servlet.http.HttpServlet 的 HTTP servlet。

此接口定义了初始化 servlet 的方法、为请求提供服务的方法和从服务器移除 servlet 的方法。这些方法称为生命周期方法，它们是按以下顺序调用的：

1. 构造 servlet，然后使用 init 方法将其初始化。

2. 处理来自客户端的对 service 方法的所有调用。

3. 从服务中取出 servlet，然后使用 destroy 方法销毁它，最后进行垃圾回收并终止它。

除了生命周期方法之外，此接口还提供了 getServletConfig 方法和 getServletInfo 方法，servlet 可使用前一种方法获得任何启动信息，而后一种方法允许 servlet 返回有关其自身的基本信息，比如作者、版本和版权。

Servlet 接口中定义的方法如下：

void destroy()

void init(ServletConfig config) throws ServletException

void service(ServletRequest req, ServletResponse res) throws ServletException, java.io.IOException

ServletConfig getServletConfig()

String getServletInfo()

由Servlet接口中的Init方法我们可以发现，init方法在做初始化工作的时候会传入ServletConfig类型的参数进行初始化工作， Servlet 容器使用的 ServletConfig配置对象，该对象在初始化期间将信息传递给 Servlet。

ServletConfig 接口中定义的方法如下：

String getInitParameter(String name)

java.util.Enumeration<E> getInitParameterNames()

ServletContext getServletContext()

String getServletName()

定义一般的、与协议无关的 Servlet。要编写用于 Web 上的 HTTP Servlet，请改为扩展 javax.servlet.http.HttpServlet。GenericServlet 实现 Servlet 和 ServletConfig 接口。**实现了Servlet 接口中除service（）方法之外的所有抽象方法，但是是默认实现。**Servlet可以直接扩展 GenericServlet，GenericServlet 使编写 Servlet变得更容易。它提供生命周期方法 init 和 destroy 的简单版本，以及 ServletConfig 接口中的方法的简单版本。GenericServlet 还实现 log 方法，在 ServletContext 接口中对此进行了声明。

要编写一般的 servlet，只需重写抽象 service 方法即可。在开发中很少使用，不再说明。

HttpServlet 类继承GenericServlet 类，是一个抽象类。在Java Web 开发中自定义Servlet 通常都是直接集成HttpServlet 类，此类实现了Servlet 接口中的service(ServletRequest request,ServletResponse response) 方法，用来处理客户端请求，根据request中的getMethod方法来调用不同的处理方法，例如，get方法，则调用doGet方法进行处理，也因此HttpServlet定义了处理不同请求的不同方法。

定义将客户端请求信息提供给某个 servlet 的对象。servlet 容器创建 ServletRequest 对象，并将该对象作为参数传递给该 servlet 的 service 方法。

ServletRequest 对象提供包括参数名称、参数值、属性和输入流的数据。扩展 ServletRequest 的接口可提供其他特定于协议的数据，例如 javax.servlet.http.HttpServletRequest 提供的 HTTP 数据。

ServletRequest中有很多有用的方法:

String getContextPath()

String getServletPath()

String getHeader(String name)

Object getAttribute(String name)

void setAttribute(String name,Object obj)

String getParameter(String name)

String getCharacteEncoding()

具体可以参考官方API

[ServletRequest API](https://tomcat.apache.org/tomcat-5.5-doc/servletapi/javax/servlet/ServletRequest.html)

ServletResponse 中有很多有用的方法：

String getCharacterEncoding()

OutputStream getOutputStream()throws IOException

Writer getWriter()throws IOException

void setContentType(String type)

具体可以参考官方API

[ServletResponse API](https://tomcat.apache.org/tomcat-5.5-doc/servletapi/javax/servlet/ServletResponse.html)

HttpServletRequest 是专用于HTTP的ServletRequest 子接口，客户端浏览器的请求被封装成一个HttpServletRequest 对象，请求信息请求的地址，参数，数据，上传的文件，IP地址，甚至操作系统信息都包含在内。

主要处理：

1. 读取和写入HTTP头标

2. 取得和设置cookies

3. 取得路径信息

4. 标识HTTP会话。

HttpServletRequest 常用方法：

Cookie[] getCookies()

String getMethod()

//返回客户端的会话ID

String getRequestedSessionId()

//调用getSession(true)的简化版。

HttpSession getSession()

HttpSession getSession(boolean create)

String getRequestURI()

String getQueryString()

String getContextPath()

HttpServletResponse 则继承了ServletResponse 接口。都提供了与HTTP有关的方法，主要是对HTTP状态码和Cookie的管理。

void addCookie(Cookie cookie)

void sendError(int status)

void sendRedirect(String location)

一个ServletContext 接口对象表示一个Web应用程序的上下文，运行在Java虚拟机中每个Web应用程序都有一个与之香瓜你的Servlet上下文，Sevetl API提供了一个ServletContext 接口老表示上下文，它提供了一些方法可以让Servlet 通过这些方法与Servlet 容器进行通信。

常用方法:

void setAttribute(String name, Object object)

Object getAttribute(String name)

String getInitParameter(String name)

[ServletContext 接口官方API](https://tomcat.apache.org/tomcat-5.5-doc/servletapi/javax/servlet/ServletContext.html)

提供一种方式，跨多个页面请求或对 Web 站点的多次访问标识用户并存储有关该用户的信息。

HttpSession 接口用于记录HTTP客户端和HTTP会话之间的关联，且可以在多个连接和请求中持续一段时间，Session则可以让无状态的HTTP请求在多个请求时识别用户记录状态。

此接口允许 servlet

查看和操作有关某个会话的信息，比如会话标识符、创建时间和最后一次访问时间

将对象绑定到会话，允许跨多个用户连接保留用户信息。

常用方法：

void invalidate()

void removeAttribute(String name)

void setAttribute(String name, Object value)

Object getAttribute(String name)

long getCreationTime()

String getId()

void setMaxInactiveInterval(int interval)

int getMaxInactiveInterval()

@WebServlet("/dispense")

public class DispenseServlet extends HttpServlet {

@Override

protected void doGet(HttpServletRequest req, HttpServletResponse resp)

throws ServletException, IOException {

// 获取请求方式：GET

System.out.println("req.getMethod():" + req.getMethod());

// 获取项目名称：/dispense

System.out.println("req.getContextPath():" + req.getContextPath());

// 获取完整请求路径：http://localhost:8888/dispense/dispense

System.out.println("req.getRequestURL():" + req.getRequestURL());

// 获取除了域名外的请求数据：/dispense/dispense

System.out.println("req.getRequestURI():" + req.getRequestURI());

// 获取请求参数：name=codingme.net

System.out.println("req.getQueryString():" + req.getQueryString());

// 获取请求头：

System.out.println("req.getHeader(\"user-Agent\"):" + req.getHeader("user-Agent"));

System.out.println("-------------------------------------------------");

// 获取所有的消息头名称

Enumeration<String> headerNames = req.getHeaderNames();

// 获取获取的消息头名称，获取对应的值，并输出

while (headerNames.hasMoreElements()) {

String nextElement = headerNames.nextElement();

System.out.println(nextElement + ":" + req.getHeader(nextElement));

}

System.out.println("---------------------------------------------------");

// 根据名称获取此重名的所有数据

System.out.println("req.getHeader(\"accept\"):" + req.getHeader("accept"));

// 获取请求主机名

System.out.println("req.getHeader(\"host\"):" + req.getHeader("host"));

}

@Override

protected void doPost(HttpServletRequest req, HttpServletResponse resp)

throws ServletException, IOException {

doGet(req, resp);

}

}

请求：http://localhost:8888/dispense/dispense?name=codingme.net

输出：