Servlet核心接口

迈不过友情╰ 2022-05-14 08:40 222阅读 0赞

在servlet体系中，除了用于实现servlet接口、GenericServlet类和HttpServlet类外，还有一些辅助servlet获取相关资源的重要接口，，了解这些接口并熟练运用这些接口的常用方法是使用servlet进行web开发的基础

主要有一下四个接口：

1.  ServletConfig接口：用于获取servlet初始化参数和servletContext对象；
2.  ServletContext接口：代表当前servlet运行环境，servlet可以通过servletContext对象来访问Servlet容器的各种资源；
3.  HttpServletRequest接口：用于封装Http请求信息；
4.  HttpServletResponse接口：用于封装Http响应信息；

1.  **ServletConfig接口**

接口定义为：public abstract interface javax.servlet.ServletConfig;

容器在初始化一个servlet时，将为该servlet创建一个唯一的的servletConfig对象，并将这个对象通过init(ServletConfig config)方法来传递并保存在此Servlet对象中。

ServletConfig的主要方法有：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:159.8pt;"> 方 法 </td> 
 <td style="vertical-align:top;width:266.3pt;"> 描 述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:159.8pt;"> getInitParameter(String param) </td> 
 <td style="vertical-align:top;width:266.3pt;"> 根据参数的名称返回初始对应的参数值，若无返回null </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:159.8pt;"> getInitParameterNames() </td> 
 <td style="vertical-align:top;width:266.3pt;"> 返回一个Enumeration对象，包含初始化参数的名称 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:159.8pt;"> getServletContext() </td> 
 <td style="vertical-align:top;width:266.3pt;"> 返回ServletContext对象 </td> 
 </tr> 
 <tr> 
 <td style="width:159.8pt;"> getServletName() </td> 
 <td style="vertical-align:top;width:266.3pt;"> 返回servlet的名字，即@WebServet的name属性值，如果没有配置这个属性值，则返回servlet类的权限定名 </td> 
 </tr> 
 </tbody> 
</table>

ServletConfig接口主要访问两项内容；一是Servlet初始化信息，这个需要在Servlet配置的文件中获取；另一个是ServletContext对象，主要为servlet提供容器信息。

在实际的开发中，我们时常遇到某些信息不断变化，比如账户和密码，若有变化servlet将会重新编译，这将大大降低了运行速度。所以将这些信息编码到配置文件中，可以解决这一问题。

Web.xml配置文件中的代码

<init-param>

<param-name>url</param-name>

<param-value>123456</param-value>

</init-param>

Servlet中的代码

String s = config.getInitParameter(“url”);   //s=”123456”

# **2.ServletContext接口** #

ServletContext也称作servlet的上下文。一个web应用启动过后，servlet容器会创建唯一一个ServletContext对象，在应用中的任何servlet都可以共享这个ServletContext，这个对象有两种方法可以获取：1.通过init方法中的servletconfig接口getservletContext方法来获取。2.通过GenericServlet抽象类的getservletContext方法获取。

ServletContext方法：

1.  获取应用范围的初始化参数
2.  存取应用范围域属性的方法
3.  存取当前web信息
4.  获取当前容器信息的输出日志
5.  获取服务器文件资源

以下进行介绍

### **1）.获取应用的初始化参数** ###

在web.xml中使用<context-name>、<context-value>标签配置信息。容器在加载时会读取这些信息并且会存入ServletContext对象中。ServletContext接口会提供这些初始化参数的获取方法：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="width:173.3pt;"> 方法 </td> 
 <td style="width:252.8pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="width:173.3pt;"> getInitParameter(String name) </td> 
 <td style="width:252.8pt;"> 返回name的参数值。即返回&lt;context-name&gt;对应的&lt;context-value&gt;值 </td> 
 </tr> 
 <tr> 
 <td style="width:173.3pt;"> getInitParameterNames </td> 
 <td style="width:252.8pt;"> 返回包含所有初始化名称的的Enumeration </td> 
 </tr> 
 </tbody> 
</table>

### **2）.存取应用域属性** ###

ServletContext可以理解为一个容器中共享的空间，可以储存具有应用级别作用域的数据，web应用中的各个组件都可以共享这些数据，这些数据可以以key/value的形式来储存到servletcontext中，并以key作为属性名来访问。

### **3）.获取应用信息** ###

ServletContext还可以获取当前web应用中的根路径、应用的名称、应用的组件、应用组件间的转发以及容器下其他web应用的ServletContext对象等

### **4）.获取容器信息** ###

### **5）.获取服务器文件资源** ###

使用ServletContext接口还可以访问web应用中静态文件，例如HTML、GIF和Properties文件等，同时还可以获取文件资源的MIME类型以及其在服务器中的真实存放路径。

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> 方法 </td> 
 <td style="vertical-align:top;width:213.05pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getResourcceAsStream(String path) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 返回一个读取参数指定的文件输入流，参数路径以“/”开头 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getResource(String path) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 返回一个由path指定的资源路径对应的URL对象，参数以”/”开头 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getRealPath(String path) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 根据虚拟路径返回真实路径 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getMimeType(String file) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 根据参数指定的文件的MIME类型 </td> 
 </tr> 
 </tbody> 
</table>

# **3.HttpServletRequest接口** #

ServletRequest接口用于封装请求信息，该对象在用户每次请求servlet时创建并传入servlet的service（）方法。HttpServletRequest继承于servletRequest，专门用于HTTP协议的子接口。在Httpservlet类中的service（）方法中，传入的servletRequest将会被强制转化为HttpservletRequest对象来进行HTTP请求信息的处理。

HttpServletRequest接口有以下方法：

1.  获取请求报文信息
2.  获取网络连接信息
3.  存取请求域属性的方法

### **1）.获取请求行信息** ###

一个请求行一般由请求方法（POST、GET）、请求URL、请求协议及版本组成。

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> 方法 </td> 
 <td style="vertical-align:top;width:213.05pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getMethod() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取请求的方法POST、GET、PUT </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getRequestURI() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取请求行的资源 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getProrocol() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取使用协议和版本号 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getQueryString() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取请求URL查询字符，对get有效 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getServletPath() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取servlet所映射的路径 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getContextPath() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取资源所属的web应用的路径 </td> 
 </tr> 
 </tbody> 
</table>

### **2）.获取请求头信息** ###

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> 方法 </td> 
 <td style="vertical-align:top;width:213.05pt;"> &nbsp;描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getIntHeader(String name) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取整数类型参数名为name的http头 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getDateHeader(String name) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取long类型名为neme的http头 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getContentLength() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取请求内容的长度 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getContentType() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取请求的文档类型和编码 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getLocale() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取用户浏览器设置的local信息 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getCookies() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取一个cookie数组。所有的cookies </td> 
 </tr> 
 </tbody> 
</table>

### **3）.获取请求正文** ###

请求正文内容为POST请求参数名称和值所组成的一个字符串，而对于GET请求，请求参数附属在请求行中，没有正文。POST请求一般通过<form>表单来提交数据请求，<form>表单元素中有一个enctype属性用于指定浏览器使用哪种编码方式将表单中的数据传达给web服务器，enctype默认为application/x-www-form-urlencoded，名称和值用“=”连接，各个参数用“&”连接。使用这种编码方式可用以下方法：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="width:220.3pt;"> 方法 </td> 
 <td style="width:205.8pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="width:220.3pt;"> String getParameter(String name) </td> 
 <td style="width:205.8pt;"> 返回name指定的参数值 </td> 
 </tr> 
 <tr> 
 <td style="width:220.3pt;"> Enumeration getParameterNames() </td> 
 <td style="width:205.8pt;"> 返回所有用户的参数名 </td> 
 </tr> 
 <tr> 
 <td style="width:220.3pt;"> String[] getParameterValues(String name) </td> 
 <td style="width:205.8pt;"> name指定的一组值 </td> 
 </tr> 
 <tr> 
 <td style="width:220.3pt;"> Map getParameterMap() </td> 
 <td style="width:205.8pt;"> 返回一个请求参数的Map对象，Map中的键为参数的名称，值为参数对应的参数值 </td> 
 </tr> 
 </tbody> 
</table>

Enctype有另外一个属性   那就是multipart/form-data，并且此属性只适合于POST请求方式。他是在上传文件的时候才会用到

### **4）.请求参数的中文问题** ###

出现乱码的原因是浏览器采用的编码方式以及服务器对不同类型的请求(GET、post)的解码方式有关。所以对于POST请求，服务器端servlet在调用HttpServletRequest对象时使用getParameter()方法前要调用setCharacterEnocding（charset）的方法设定编码方式。

Reques.setCharacterEncoding(charset)

原因解剖：采用form表单的post请求，浏览器会按照显示页面所采用的字符集对中文数据编码。然后发到服务器，servlet调用HttpServletRequest对象的getParameter()方法来获取参数，而在没有设置编码的情况下默认为unll。这时会以ISO-8859-1字符集来编码，这个字符集不包含中文，所以产生的乱码。

而对于GET请求不能使用setCharacterEncoding(charset)。需要在jsp页面中进行编码<%@page language = “java” charset = “utf-8” pageEncoding = “utf-8”>

### **5）.获取网络连接** ###

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="width:213.05pt;"> 方法 </td> 
 <td style="width:213.05pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getRemoteAddr() </td> 
 <td style="width:213.05pt;"> 获取用户ip </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getRemoteHost() </td> 
 <td style="width:213.05pt;"> 获取用户主机名 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getRemotePort() </td> 
 <td style="width:213.05pt;"> 获取端口号 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getLocalAddr </td> 
 <td style="width:213.05pt;"> 获取web服务器的ip地址 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getLocalName() </td> 
 <td style="width:213.05pt;"> 获取web服务器的主机名 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getLocalPort() </td> 
 <td style="width:213.05pt;"> 获取web服务器的端口号 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getServerName() </td> 
 <td style="width:213.05pt;"> 获取网站域名 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getServerPort() </td> 
 <td style="width:213.05pt;"> 获取URL请求的端口号 </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getScheme() </td> 
 <td style="width:213.05pt;"> 获取请求使用的协议， </td> 
 </tr> 
 <tr> 
 <td style="width:213.05pt;"> getRequestURL() </td> 
 <td style="width:213.05pt;"> 获取URL </td> 
 </tr> 
 </tbody> 
</table>

### **6）.存取请求域的信息** ###

储存在HttpServletRequest对象中的对象称之为请求域属性，属于同一个请求的多处理组件之间可以通过请求域来共享这些信息。

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> 方法 </td> 
 <td style="vertical-align:top;width:213.05pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> setAtrribute(String name,Object value) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 设定name属性值为value，保存在request范围内。 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> getAttribute(String ame) </td> 
 <td style="vertical-align:top;width:213.05pt;"> 从request范围中获取name的值 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> removeAttribute(String name） </td> 
 <td style="vertical-align:top;width:213.05pt;"> 从request范围内移除name属性值 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:213.05pt;"> EnumerationgetAttributeNames() </td> 
 <td style="vertical-align:top;width:213.05pt;"> 获取所有request范围的属性 </td> 
 </tr> 
 </tbody> 
</table>

# **4.HttpServletResponse接口** #

HttpServletResponse继承自ServletResponse，封装了Http响应信息，用于Http子接口，在HttpServlet类的service()方法中，传入ServletResponse对象强制转化为HttpServletResponse对象来处理HTTP请求。该接口主要提供了具有如下功能类型的方法：

1.  设置响应状态的方法
2.  构建响应头的方法
3.  创建响应正文的方法

### **1）.设置响应状态** ###

Http响应报文的响应行由报文协议和版本以及状态码构成。

常见的状态码：

200：表示请求成果

302：表示页面暂时转移到其他URL

404：表示请求的资源不存在

500：服务器内部出现错误

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:184.8pt;"> 方法 </td> 
 <td style="vertical-align:top;width:241.3pt;"> 藐视 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:184.8pt;"> setStatus(int sc) </td> 
 <td style="vertical-align:top;width:241.3pt;"> 以指定的状态码将响应返回给客户端 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:184.8pt;"> setError(int sc) </td> 
 <td style="vertical-align:top;width:241.3pt;"> 使用指定的状态码向客户端返回一个错误的响应 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:184.8pt;"> sendError(ing sc,String msg) </td> 
 <td style="vertical-align:top;width:241.3pt;"> 使用指定的状态码，和描述返回给客户端 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:184.8pt;"> SendRedirect(String location) </td> 
 <td style="vertical-align:top;width:241.3pt;"> 请求重定向，会设定响应Location报头 </td> 
 </tr> 
 </tbody> 
</table>

### **2）.设置响应信息头** ###

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> 方法 </td> 
 <td style="vertical-align:top;width:210.3pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> setContentType(String mime) </td> 
 <td style="vertical-align:top;width:210.3pt;"> 设定Content-Type </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> setContentLength(int length) </td> 
 <td style="vertical-align:top;width:210.3pt;"> 设置Content-Length消息头 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> addHeader(String name,String value) </td> 
 <td style="vertical-align:top;width:210.3pt;"> 新增String类型的值到名为name头部 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> addIntHeader(Stirng name,int value) </td> 
 <td style="vertical-align:top;width:210.3pt;"> 新增int类型的值到name的头部 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> AddDataHeader(String name,long date </td> 
 <td style="vertical-align:top;width:210.3pt;"> 增long类型的值到name头部 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:215.8pt;"> addCookie(Cookie c) </td> 
 <td style="vertical-align:top;width:210.3pt;"> 为Set-Cookie消息头增一个值 </td> 
 </tr> 
 </tbody> 
</table>

### **3）.创建响应正文** ###

HttpServletResponse接口获取输出流对象的方法：

<table style="width:426.1pt;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:155.8pt;"> 方法 </td> 
 <td style="vertical-align:top;width:270.3pt;"> 描述 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:155.8pt;"> getOutputStream() </td> 
 <td style="vertical-align:top;width:270.3pt;"> 返回字节输出流对象ServletOutputStream </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:155.8pt;"> getWriter() </td> 
 <td style="vertical-align:top;width:270.3pt;"> 返回字符输出流对象PrintWriter </td> 
 </tr> 
 </tbody> 
</table>

### **4）.响应输出中文问题** ###

1.response.setCharacterEncoding(“UTF-8”);用于PrintWriter输出流

2.response.setContentType(“text/html,charset=utf-8”);可以用于PrintWriter输出流也可以用于浏览器编码方式

3.Respomse.setLocale(new java.util.Locale(“ZH”,”CN”));优先级最低，用于PrintWriter输出流

# **5.总结** #

1. 容器在初始化的过程中会创建一个ServletConfig对象，并通过servlet的init方法传递保存在servlet中。
2. ServletConfig接口中的方法，可以获取配置文件配置的初始化参数，也可以获取servletContext对象。
3. Web应用启动后会创建唯一的一个ServletContext对象，在该应用的其他servlet可以共享这个对象
4. ServletContext对象用的应用域属性用<content-param>指定，而ServletConfig靠<init-param>指定
5. HttpServletRequest对象通过getParameter()来获取参数