Servlet中常用的接口、类、方法
一、Servlet接口
二、ServletConfig接口
三、ServletContext接口
四、HttpServletRequest 接口
ServletRequest与HttpServletRequest的关系
HttpServletRequest 接口继承自 ServletRequest 接口。
HttpServletRequest主要作用是封装 HTTP 请求消息,所以我们也将HttpServletRequest称之为请求对象。
由于 HTTP 请求消息分为请求行、请求消息头和请求消息体三部分。
因此,在HttpServletRequest 接口中定义了获取请求行、请求头和请求消息体的相关方法。
4.1 获取请求行信息的相关方法
当访问 Servlet 时,所有请求消息将被封装到 HttpServletRequest 对象中,请求消息的请求行中包含请求方法、请求资源名、请求路径等信息,为了获取这些信息,HttpServletRequest 接口定义了一系列方法。
方法声明 | 功能描述 |
---|---|
String getMethod() | 该方法用于获取 HTTP 请求消息中的请求方式(如 GET、POST 等) |
String getRequestURI() | 该方法用于获取请求行中的资源名称部分即位于 URL 的主机和端门之后、参数部分之前的部分 |
String getQueryString() | 该方法用于获取请求行中的参数部分,也就是资源路径后问号(?)以后的所有内容 |
String getContextPath() | 该方法用于获取请求 URL 中属于 Web 应用程序的路径,这个路径以 / 开头,表示相对于整个 Web 站点的根目录,路径结尾不含 /。如果请求 URL 属于 Web 站点的根目录,那么返回结果为空字符串("") |
String getServletPath() | 该方法用于获取 Servlet 的名称或 Servlet 所映射的路径 |
String getRemoteAddr() | 该方法用于获取请求客户端的 IP 地址,其格式类似于 192.168.0.3 |
String getRemoteHost() | 该方法用于获取请求客户端的完整主机名,其格式类似于 pcl.mengma.com。需要注意的是,如果无法解析出客户机的完整主机名,那么该方法将会返回客户端的 IP 地址 |
int getRemotePort() | 该方法用于获取请求客户端网络连接的端口号 |
String getLocaIAddr() | 该方法用于获取 Web 服务器上接收当前请求网络连接的 IP 地址 |
String getLocalName() | 该方法用于获取 Web 服务器上接收当前网络连接 IP 所对应的主机名 |
int getLocalPort() | 该方法用于获取 Web 服务器上接收当前网络连接的端口号 |
String getServerName() | 该方法用于获取当前请求所指向的主机名,即 HTTP 请求消息中 Host 头字段所对应的主机名部分 |
int gctServcrPort() | 该方法用于获取当前请求所连接的服务器端口号,即 HTTP 请求消息中 Host 头字段所对应的端口号部分 |
StringBuffcr getRequestURL() | 该方法用于获取客户端发出请求时的完整 URL,包括协议、服务器名、端口号、 资源路径等信息,但不包括后面的査询参数部分。注意,getRequcstURL() 方法返冋的结果是 StringBuffer 类型,而不是 String 类型,这样更便于对结果进行修改 |
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse resp) throws ServletException, IOException {
//通过HttpServletRequest对象得到请求行信息
System.out.println("getMethod : " + request.getMethod());
System.out.println("getRequestURI:" + request.getRequestURL());
System.out.println("getQueryString:" + request.getQueryString());
System.out.println("getContextPath:" + request.getContextPath());
System.out.println("getServletPath:" + request.getServletPath());
System.out.println("getRemoteAddr : " + request.getRemoteAddr());
System.out.println("getRemoteHost : " + request.getRemoteHost());
System.out.println("getRemotePort : " + request.getRemotePort());
System.out.println("getLocalAddr : " + request.getLocalAddr());
System.out.println("getLocalName : " + request.getLocalName());
System.out.println("getLocalPort : " + request.getLocalPort());
System.out.println("getServerName : " + request.getServerName());
System.out.println("getServerPort : " + request.getServerPort());
System.out.println("getRequestURL : " + request.getRequestURL());
}
http://localhost:8080/TestServlet7/test7?myname=zhangsan
4.2 获取请求消息头的相关方法
浏览器发送 Servlet 请求时,需要通过请求消息头向服务器传递附加信息,例如,客户端可以接收的数据类型、压缩方式、语言等。为此,在 HttpServletRequest 接口中定义了一系列用于获取 HTTP 请求头字段的方法
方法声明 | 功能描述 |
---|---|
String getHeader(String name) | 该方法用于获取一个指定头字段的值,如果请求消息中没有包含指定的头字段,则 getHeader() 方法返回 null;如果请求消息中包含多个指定名称的头字段,则 getHeader() 方法返回其中第一个头字段的值 |
Enumeration getHeaders(String name) | 该方法返回一个 Enumeration 集合对象,该集合对象由请求消息中出现的某个指定名称的所有头字段值组成。在多数情况下,一个头字段名在请求消息中只出现一次,但有时可能会出现多次 |
Enumeration getHeaderNames() | 该方法用于获取一个包含所有请求头字段的 Enumeration 对象 |
int getIntHeader(String name) | 该方法用于获取指定名称的头字段,并且将其值转为 int 类型。需要注意的是,如果指定名称的头字段不存在,则返回值为 -1;如果获取到的头字段的值不能转为 int 类型,则将发生 NumberFormatException 异常 |
long getDateHeader(String name) | 该方法用于获取指定头字段的值,并将其按 GMT 时间格式转换为一个代表日期/时间的长整数,该长整数是自 1970 年 1 月 1 日 0 时 0 分 0 秒算起的以毫秒为单位的时间值 |
String getContentType() | 该方法用于获取 Content-Type 头字段的值,结果为 String 类型 |
int getContentLength() | 该方法用于获取 Content-Length 头字段的值,结果为 int 类型 |
String getCharacterEncoding() | 该方法用于返回请求消息的实体部分的字符集编码,通常是从 Content-Type 头字段中进行提取,结果为 String 类型 |
Void setCharacterEncoding(String charname) | 设置请求对象的字符编码 |
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse resp) throws ServletException, IOException {
//获取请求消息中的所有头字段
Enumeration headerNames = request.getHeaderNames();
//用循环遍历所有请求头,并通过 getHeader() 方法获取一个指定名称的头字段
while (headerNames.hasMoreElements()) {
//得到请求头的名称
String headerName = (String) headerNames.nextElement();
System.out.println(headerName + ":" + request.getHeader(headerName));
}
}
}
4.3 获取请求参数
在实际开发中,经常需要获取用户提交的表单数据,例如用户名和密码等,为了方便获取表单中的请求参数,在 HttpServletRequest 接口的父类 ServletRequest 中定义了一系列获取请求参数的方法
方法声明 | 功能描述 |
---|---|
String getParameter(String name) | 该方法用于获取某个指定名称的参数值。如果请求消息中没有包含指定名称的参数,则 getParameter() 方法返回 null。如果指定名称的参数存在但没有设置值,则返回一个空串。如果请求消息中包含多个该指定名称的参数,则 getParameter() 方法返回第一个出现的参数值 |
String [] getParameterValues (String name) | HTTP 请求消息中可以有多个相同名称的参数(通常由一个包含多个同名的字段元素的 form 表单生成),如果要获得 HTTP 请求消息中的同一个参数名所对应的所有参数值,那么就应该使用 getParameterValues() 方法,该方法用于返回一个 String 类型的数组。 |
Enumeration getParameterNames() | 方法用于返回一个包含请求消息中所有参数名的 Enumeration 对象,在此基础上,可以对请求消息中的所有参数进行遍历处理 |
Map getParameterMap() | getParameterMap() 方法用于将请求消息中的所有参数名和值装入一个 Map 对象中返回 |
例如:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>注册页面</title>
</head>
<body>
<form action="/TestServlet7/test7" method="post">
用户名:<input type="text" name="username"><br/>
密 码:<input type="password" name="password"/><br/>
<br/>
爱好:
<input type="checkbox" name="hobby" value="sing"/>唱歌
<input type="checkbox" name="hobby" value="dance"/>跳舞
<input type="checkbox" name="hobby" value="game"/>玩游戏
<br/>
<input type="submit" value="提交"/>
</form>
</body>
</html>
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse resp) throws ServletException, IOException {
//得到请求参数
String name=request.getParameter("username");
System.out.println("用户名:"+name);
String password=request.getParameter("password");
System.out.println("密码:"+password);
String hobby[]=request.getParameterValues("hobby");
System.out.print("爱好:");
for(String value:hobby){
System.out.print(value+",");
}
}
4.4 通过 Request 对象传递数据
方法声明 | 功能描述 |
---|---|
Void setAttribute(String name,Object o) | 用于将一个对象与一个名称关联后存储到 ServletRequest 对象中 |
Object getAttribute(String name) | 用于从 ServletRequest 对象中返回指定名称的属性对象 |
void removeAttribute(String name); | 用于从 ServletRequest 对象中删除指定名称的属性 |
上面的方法我们需要完成servlet的跳转时再来测试使用
五、HttpServletResponse
HttpServletResponse 接口继承自 ServletResponse 接口。
主要用于封装 HTTP 响应消息。
由于 HTTP 响应消息分为状态行、响应消息头、消息体三部分。因此,在 HttpServletResponse 接口中定义了向客户端发送响应状态码、响应消息头、响应消息体的方法。
5.1 发送状态码相关的方法
当 Servlet 向客户端回送响应消息时,需要在响应消息中设置状态码。
(1)setStatus(int status)方法
该方法用于设置 HTTP 响应消息的状态码,并生成响应状态行。由于响应状态行中的状态描述信息直接与状态码相关,而 HTTP 版本由服务器确定,因此,只要通过 setStatus(int status)方法设置了状态码,即可实现状态行的发送。需要注意的是,在正常情况下,Web 服务器会默认产生一个状态码为 200 的状态行。
(2)sendError(int sc)方法
该方法用于发送表示错误信息的状态码。例如,404 状态码表示找不到客户端请求的资源。response 对象提供了两个重载的 sendError(int sc)方法,具体如下:
public void sendError(int code) throws java.io.IOException
public void sendError(int code,String message)throws java.io.IOException
在上面重载的两个方法中,第一个方法只发送错误信息的状态码,而第二个方法除了发送状态码以外,还可以增加一条用于提示说明的文本信息,该文本信息将出现在发送给客户端的正文内容中。
5.2 发送响应消息头相关的方法
方法声明 | 功能描述 |
void addHeader(String name,String value) | 这两个方法都是用于设置 HTTP 协议的响应头字段。其中,参数 name 用于指定响应头字段的名称,参数 value 用于指定响 应头字段的值。不同的是,addHeader() 方法可以增加同名的响应头字段,而 setHeader() 方法则会覆盖同名的头字段 |
void setHeader (String name,String value) | |
void addIntHeader(String name,int value) | 这两个方法专门用于设置包含整数值的响应头,避免了使用 addHeader() 与 setHeader() 方法时需要将 int 类型的设置值转换为 String 类型的麻烦 |
void setIntHeader(String name, int value) | |
void setContentType(String type) | 该方法用于设置 Servlet 输出内容的 MIME 类型,对于 HTTP 协议来说,就是设置 Content-Type 响应头字段的值。例如,如果发送到客户端的内容是 jpeg 格式的图像数据,就需要将响应头字段的类型设置为 image/jpeg。需要注意的是,如果响应的内容为文本,setContentType() 方法还可以设置字符编码,如 text/html;charset = UTF-8 |
void setLocale (Locale loc) | 该方法用于设置响应消息的本地化信息。对 HTTP 来说,就是设置 Content-Language 响应头字段和 Content-Type 头字段中的字符集编码部分。需要注意的是,如果 HTTP 消息没有设置 Content-Type 头字段,则 setLocale() 方法设置的字符集编码不会出现在 HTTP 消息的响应头中,如果调用 setCharacterEncoding() 或 setContentType() 方法指定了响应内 容的字符集编码,则 setLocale() 方法将不再具有指定字符集编码的功能 |
void setCharacterEncoding(String charset) | 该方法用于设置输出内容使用的字符编码,对 HTTP 协议来说,就是设置 Content-Type 头字段中的字符集编码部分。如果没有设置 Content-Type 头字段,则 setCharacterEncoding 方法设 置的字符集编码不会出现在 HTTP 消息的响应头中。setCharacterEncoding() 方法比 setContentType() 和 setLocale() 方法的优先权高,它的设置结果将覆盖 setContentType() 和 setLocale() 方法所设置的字符码表 |
5.3 发送响应消息体相关的方法
由于在 HTTP 响应消息中,大量的数据都是通过响应消息体传递的,因此,ServletResponse 遵循以 I/O 流传递大量数据的设计理念。在发送响应消息体时,定义了两个与输出流相关的方法。
(1)getOutputStream() 方法
该方法所获取的字节输出流对象为 ServletOutputStream 类型。由于 ServletOutputStream是OutputStream 的子类,它可以直接输出字节数组中的二进制数据。因此,要想输出二进制格式的响应正文,就需要使用 getOutputStream() 方法。
(2)getWriter() 方法
该方法所获取的字符输出流对象为 PrintWriter 类型。由于 PrintWriter 类型的对象可以直接输出字符文本内容,因此,要想输出内容全部为字符文本的网页文档,则需要使用 getWriter() 方法。
例如:通过HttpServletResponse 接口输出一个html文件
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>注册页面</title>
</head>
<body>
<form action="/TestServlet7/test7" method="post">
用户名:<input type="text" name="username"><br/>
密 码:<input type="password" name="password"/><br/>
<br/>
爱好:
<input type="checkbox" name="hobby" value="sing"/>唱歌
<input type="checkbox" name="hobby" value="dance"/>跳舞
<input type="checkbox" name="hobby" value="game"/>玩游戏
<br/>
<input type="submit" value="提交"/>
</form>
</body>
</html>
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse resp) throws ServletException, IOException {
request.setCharacterEncoding("utf-8");
resp.setCharacterEncoding("utf-8");
//得到请求参数
String name=request.getParameter("username");
//通过HttpServletResponse 接口输出一个html文件
PrintWriter out=resp.getWriter();
out.write("<html>");
out.write("<head><meta charset=\"utf-8\"><title>Servlet</title></head>");
out.write("<body><center><center><h1>恭喜"+name+",登陆成功</h1></center></body>");
out.write("</html>");
out.close();
}
forward与Redirect的区别
1. forward — RequestDispatcher接口的
forward(ServletRequest request,ServletResponse response)—该方法用于将请求从一个 Servlet 传递给另一个 Web 资源。【请求转发】
HttpServletRequest接口从ServletRequest接口中继承了一个获取 RequestDispatcher 对象的方法
RequestDispatcher getRequestDispatcher (String path)–返回封装了某条路径所指定资源的 RequestDispatcher 对象。
参数String path—目标路径【必须以“/”开头,用于表示当前 Web 应用的根目录】
需要注意的是,WEB-INF 目录中的内容对 RequestDispatcher 对象也是可见的。因此,传递给 getRequestDispatcher(String path) 方法的资源可以是 WEB-INF 目录中的文件
例如:
package com.wangxing.servlet;
import java.io.IOException;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class TestServlet8 extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("TestServlet8--------");
//通过HttpServletRequest对象得到RequestDispatcher对象
RequestDispatcher reDispatcher=req.getRequestDispatcher("/other");
//通过RequestDispatcher对象的forward(ServletRequest request,ServletResponse response)
//方法将请求转发到目录路径
reDispatcher.forward(req, resp);
}
}
package com.wangxing.servlet;
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 OtherServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("OtherServlet--------");
}
}
http://localhost:8080/TestServlet8/test8
通过 Request 对象传递数据
方法声明 | 功能描述 |
---|---|
Void setAttribute(String name,Object o) | 用于将一个对象与一个名称关联后存储到 ServletRequest 对象中 |
Object getAttribute(String name) | 用于从 ServletRequest 对象中返回指定名称的属性对象 |
void removeAttribute(String name); | 用于从 ServletRequest 对象中删除指定名称的属性 |
例如:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>login</title>
</head>
<body>
<form action="test8" method="post">
用户名:<input type="text" name="username"><br/>
密 码:<input type="password" name="password"/><br/>
<input type="submit" value="提交"/>
</form>
</body>
</html>
package com.wangxing.servlet;
import java.io.IOException;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class TestServlet8 extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("TestServlet8--------");
//得到请求提交的用户名
String name=req.getParameter("username");
//将得到的用户名保存到HttpServletRequest对象中
req.setAttribute("myname", name);
//从 HttpServletRequest对象中删除指定名称的属性
//req.removeAttribute("myname");
//通过HttpServletRequest对象得到RequestDispatcher对象
RequestDispatcher reDispatcher=req.getRequestDispatcher("/other");
//通过RequestDispatcher对象的forward(ServletRequest request,ServletResponse response)
//方法将请求转发到目录路径
reDispatcher.forward(req, resp);
}
}
package com.wangxing.servlet;
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 OtherServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//得到来自TestServlet8中保存在HttpServletRequest中的myname数值
String myname=(String)req.getAttribute("myname");
System.out.println("OtherServlet--------myname==="+myname);
}
}
RequestDispatcher的forward(req, resp) — 请求转发的工作原理图
2.Redirect----HttpServletRespone.sendRedirect()[重定向]
为了实现请求重定向,HttpServletResponse 接口定义了一个 sendRedirect() 方法.
sendRedirect() 方法的完整语法如下所示:
public void sendRedirect(java.lang.String location) throws java.io.IOException
参数String location — 重定向后目标访问路径。
package com.wangxing.servlet;
import java.io.IOException;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class TestServlet8 extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("TestServlet8--------");
//通过HttpServletResponse对象的sendRedirect方法完成重定向
resp.sendRedirect("other"); //http://localhost:8080/TestServlet8/other
}
}
package com.wangxing.servlet;
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 OtherServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("OtherServlet--------");
}
}
package com.wangxing.servlet;
import java.io.IOException;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class TestServlet8 extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//得到请求提交的用户名
String name=req.getParameter("username");
//将得到的用户名保存到HttpServletRequest对象中
req.setAttribute("myname", name);
resp.sendRedirect("other");
}
}
package com.wangxing.servlet;
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 OtherServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
String myname=(String)req.getAttribute("myname");
System.out.println("OtherServlet--------myname=="+myname);
}
}
总结:
RequestDispatcher.forward(req, resp) | HttpServletRespone.sendRedirect() |
---|---|
请求转发 | 重定向 |
使用的是同一个请求对象 | 使用的是不同的请求对象 |
浏览器地址栏中的url不会变 | 浏览器地址栏中的url会变化 |
可以通过HttpServletRequest对象传递数据 | 不可以通过HttpServletRequest对象传递数据 |
设置目标路径时“/”可以写也可以不写 | 设置目标路径时“/”一定不能写 |
依赖ServletRequest接口 | 依赖HttpServletRespone对象 |
1. html页面-----》Servlet处理程序
(1) < form action=“test8” method=“post”>
(2) < a href=”test8”>
(3)Js的ajax异步请求发送
2. Servlet处理程序----》html页面
(1)RequestDispatcher.forward(req, resp)
(2)HttpServletRespone.sendRedirect()