文章目录
一 Servlet简介
1.2 Servlet简介
Servlet (server applet) 是运行在服务端(tomcat)的Java小程序，是sun公司提供一套定义动态资源规范; 从代码层面上来讲Servlet就是一个接口
- 用来接收、处理客户端请求、响应给浏览器的动态资源。在整个Web应用中，Servlet主要负责接收处理请求、协同调度功能以及响应数据。我们可以把Servlet称为Web应用中的控制器
- 不是所有的JAVA类都能用于处理客户端请求,能处理客户端请求并做出响应的一套技术标准就是Servlet
- Servlet是运行在服务端的,所以 Servlet必须在WEB项目中开发且在Tomcat这样的服务容器中运行
二 Servlet开发流程
2.1 目标
校验注册时,用户名是否被占用. 通过客户端向一个Servlet发送请求,携带username,如果用户名是’atguigu’,则向客户端响应 NO,如果是其他,响应YES
2.2 开发过程
步骤1 开发一个web类型的module
步骤2 开发一个UserServlet
public class UserServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 获取请求中的参数
String username = req.getParameter("username");
if("name".equals(username)){
//通过响应对象响应信息
resp.getWriter().write("NO");
}else{
resp.getWriter().write("YES");
}
}
}
步骤3 在web.xml为UseServlet配置请求的映射路径
<servlet>
<servlet-name>userServlet</servlet-name>
<servlet-class>UserServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>userServlet</servlet-name>
<url-pattern>/userServlet</url-pattern>
</servlet-mapping>
</web-app>
- Servlet并不是文件系统中实际存在的文件或者目录,所以为了能够请求到该资源,我们需要为其配置映射路径
- servlet的请求映射路径配置在
web.xml中 - servlet-name作为servlet的别名,可以自己随意定义,见名知意就好
- url-pattern标签用于定义Servlet的请求映射路径
- 一个servlet可以对应
多个不同的url-pattern - 多个servlet
不能使用相同的url-pattern url-pattern中可以使用一些通配写法- / 表示通配所有资源,不包括
jsp文件 - /* 表示通配所有资源,包括
jsp文件 - /a/* 匹配所有以a前缀的映射路径
- *.action 匹配所有以action为后缀的映射路径
- / 表示通配所有资源,不包括
步骤4 开发一个form表单,向servlet发送一个get请求并携带username参数
<body>
<form action="userServlet">
请输入用户名:<input type="text" name="username" /> <br>
<input type="submit" value="校验">
</form>
</body>
启动项目,访问index.html ,提交表单测试
三 Servlet注解方式配置
3.2 @WebServlet注解使用
使用@WebServlet注解替换Servlet配置
@WebServlet(
name = "userServlet",
//value = "/user",
urlPatterns = {"/userServlet1","/userServlet2","/userServlet"},
initParams = {@WebInitParam(name = "encoding",value = "UTF-8")},
loadOnStartup = 6//服务器启动时就要实例化Servlet
)
public class UserServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
......
}
}
四 Servlet生命周期
4.1 生命周期简介
什么是Servlet的生命周期
- 应用程序中的对象不仅在空间上有层次结构的关系，在时间上也会因为处于程序运行过程中的不同阶段而表现出不同状态和不同行为——这就是对象的生命周期。
- 简单的叙述生命周期，就是对象在容器中从开始创建到销毁的过程。
Servlet容器
- Servlet对象是Servlet容器创建的，生命周期方法都是由容器(目前我们使用的是Tomcat)调用的。
Servlet主要的生命周期执行特点
| 生命周期 | 对应方法 | 执行时机 | 执行次数 |
|---|---|---|---|
| 构造对象 | 构造器 | 第一次请求或者容器启动 | 1 |
| 初始化 | init() | 构造完毕后 | 1 |
| 处理服务 | service(HttpServletRequest req,HttpServletResponse resp) | 每次请求 | 多次 |
| 销毁 | destory() | 容器关闭 | 1 |
4.2 生命周期总结
- Servlet对象在容器中是
单例的 - 容器是可以处理并发的用户请求的,每个请求在容器中都会开启
一个线程 - 多个线程可能会使用相同的Servlet对象,所以在Servlet中,我们
不要轻易定义一些容易经常发生修改的成员变量 load-on-startup中定义的正整数表示实例化顺序,如果数字重复了,容器会自行解决实例化顺序问题,但是应该避免重复- Tomcat容器中,已经定义了一些随系统启动实例化的servlet,我们自定义的servlet的load-on-startup
尽量不要占用数字1-5
五 Servlet继承结构
5.1 Servlet 接口
接口及方法说明
- Servlet 规范接口,所有的Servlet必须实现
- public void init(ServletConfig config) throws ServletException;
- 初始化方法,容器在构造servlet对象后,自动调用的方法,容器负责实例化一个ServletConfig对象,并在调用该方法时传入
- ServletConfig对象可以为Servlet 提供初始化参数
- public ServletConfig getServletConfig();
- 获取ServletConfig对象的方法,后续可以通过该对象获取Servlet初始化参数
- public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;
- 处理请求并做出响应的服务方法,每次请求产生时由容器调用
- 容器创建一个ServletRequest对象和ServletResponse对象,容器在调用service方法时,传入这两个对象
- public String getServletInfo();
- 获取ServletInfo信息的方法
- public void destroy();
- Servlet实例在销毁之前调用的方法
- public void init(ServletConfig config) throws ServletException;
5.2 GenericServlet 抽象类
源码解释
- GenericServlet 抽象类是对Servlet接口一些固定功能的
粗糙实现,以及对service方法的再次抽象声明,并定义了一些其他相关功能方法(只列举两个)
public void init(ServletConfig config) throws ServletException {
//将config对象存储为当前的属性
this.config = config;
//调用init方法,完成初始化
this.init();
}
//重载的init方法,我们实际中要重写的方法
public void init() throws ServletException {
}
5.3 HttpServlet 抽象类
解释
-
abstract class HttpServlet extends GenericServlet HttpServlet抽象类,除了基本的实现以外,增加了更多的基础功能
- public HttpServlet() {}
- 构造器,用于处理继承
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException- 对服务方法的实现
- 在该方法中,将请求和响应对象转换成对应HTTP协议的HttpServletRequest HttpServletResponse对象
- 调用重载的service方法
public void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException- 重载的service方法,被重写的service方法所调用
- 在该方法中,通过请求方式判断,调用具体的do***方法完成请求的处理
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException- 故意响应405
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException- 故意响应405
- public HttpServlet() {}
5.4 自定义Servlet
- 自定义Servlet中,必须要对处理请求的方法进行重写
- 要么重写service方法
- 要么重写doGet/doPost方法
六 ServletConfig和ServletContext
6.1 ServletConfig的使用
ServletConfig是什么
- 为Servlet提供初始配置参数的一种对象,每个Servlet都有自己独立唯一的ServletConfig对象
- 容器会为每个Servlet实例化一个ServletConfig对象,并通过Servlet生命周期的init方法传入给Servlet作为属性
ServletConfig servletConfig = this.getServletConfig();
ServletConfig是一个接口,定义了如下API
| 方法名 | 作用 |
|---|---|
| getServletName() | 获取<servlet-name>HelloServlet</servlet-name>定义的Servlet名称 |
| getServletContext() | 获取ServletContext对象 |
| getInitParameter() | 获取配置Servlet时设置的『初始化参数』，根据名字获取值 |
| getInitParameterNames() | 获取所有初始化参数名组成的Enumeration对象 |
需要注意的是,每个ServletConfig对象都有自己独立的初始化参数,所以我们在获取初始化参数时,需要通过名字来获取,而不是通过索引来获取
@WebServlet(
urlPatterns = {"/Servlet1"},
initParams = {@WebInitParam(name = "xx",value = "value1")}
)
public class Servlet1 extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
ServletConfig servletConfig = this.getServletConfig();
String value = servletConfig.getInitParameter("xx");
System.out.println(value);
//获取全部初始参数信息
Enumeration<String> initParameterNames = servletConfig.getInitParameterNames();
while (initParameterNames.hasMoreElements()) {
String paramName = initParameterNames.nextElement();
System.out.println(paramName+":"+servletConfig.getInitParameter(paramName));
}
}
}
@WebServlet(
urlPatterns = {"/Servlet2"},
initParams = {@WebInitParam(name = "xx",value = "value2")}
)
public class Servlet2 extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
......
}
}
6.2 ServletContext的使用
ServletContext是什么
- ServletContext对象有称呼为
上下文对象,或者叫应用域对象(后面统一讲解域对象) - 容器会为每个
app创建一个独立的唯一的ServletContext对象 - ServletContext对象为
所有的Servlet所共享 - ServletContext可以为
所有的Servlet提供初始配置参数
ServletContext怎么用
- 配置ServletContext参数
<context-param>
<param-name>paramA</param-name>
<param-value>valueA</param-value>
</context-param>
<context-param>
<param-name>paramB</param-name>
<param-value>valueB</param-value>
</context-param>
- 在Servlet中获取ServletContext并获取参数
// 从ServletContext中获取为所有的Servlet准备的参数
ServletContext servletContext = this.getServletContext();
String valueA = servletContext.getInitParameter("paramA");
System.out.println("paramA:"+valueA);
// 获取所有参数名
Enumeration<String> initParameterNames = servletContext.getInitParameterNames();
// 迭代并获取参数名
while (initParameterNames.hasMoreElements()) {
String paramaterName = initParameterNames.nextElement();
System.out.println(paramaterName+":"+servletContext.getInitParameter(paramaterName));
6.3 ServletContext其他重要API
获取资源的真实路径
String realPath = servletContext.getRealPath("资源在web目录中的路径");
- 例如我们的目标是需要获取项目中某个静态资源的路径，不是工程目录中的路径，而是部署目录中的路径；我们如果直接拷贝其在我们电脑中的完整路径的话其实是有问题的，因为如果该项目以后部署到公司服务器上的话，路径肯定是会发生改变的，所以我们需要使用代码动态获取资源的真实路径. 只要使用了servletContext动态获取资源的真实路径，那么无论项目的部署路径发生什么变化，都会动态获取项目运行时候的实际路径，所以就不会发生由于写死真实路径而导致项目部署位置改变引发的路径错误问题
获取项目的上下文路径
String contextPath = servletContext.getContextPath();
- 项目的部署名称,也叫项目的上下文路径,在部署进入tomcat时所使用的路径,该路径是可能发生变化的,通过该API动态获取项目真实的上下文路径,可以帮助我们解决一些后端页面渲染技术或者请求转发和响应重定向中的路径问题
域对象的相关API
- 域对象: 一些用于存储数据和传递数据的对象,传递数据不同的范围,我们称之为不同的域,不同的域对象代表不同的域,共享数据的范围也不同
- ServletContext代表应用,所以ServletContext域也叫作应用域,是webapp中最大的域,可以在本应用内实现数据的共享和传递
- webapp中的三大域对象,分别是应用域,会话域,请求域
后续我们会将三大域对象统一进行讲解和演示,三大域对象都具有的API如下
| API | 功能解释 |
|---|---|
void setAttribute(String key,Object value); | 向域中存储/修改数据 |
Object getAttribute(String key); | 获得域中的数据 |
| void removeAttribute(String key); | 移除域中的数据 |
七 HttpServletRequest
7.1 HttpServletRequest简介
HttpServletRequest是什么
- HttpServletRequest是一个
接口,其父接口是ServletRequest - HttpServletRequest是Tomcat将
请求报文转换封装而来的对象,在Tomcat调用service方法时传入 - HttpServletRequest代表
客户端发来的请求,所有请求中的信息都可以通过该对象获得
7.2 HttpServletRequest常见API
HttpServletRequest怎么用
- 获取请求行信息相关(方式,请求的url,协议及版本)
| API | 功能解释 |
|---|---|
| StringBuffer getRequestURL(); | 获取客户端请求的url |
| String getRequestURI(); | 获取客户端请求项目中的具体资源 |
| int getServerPort(); | 获取客户端发送请求时的端口 |
| int getLocalPort(); | 获取本应用在所在容器的端口 |
| int getRemotePort(); | 获取客户端程序的端口 |
| String getScheme(); | 获取请求协议 |
| String getProtocol(); | 获取请求协议及版本号 |
| String getMethod(); | 获取请求方式 |
- 获得请求头信息相关
| API | 功能解释 |
|---|---|
| String getHeader(String headerName); | 根据头名称获取请求头 |
| Enumeration getHeaderNames(); | 获取所有的请求头名字 |
| String getContentType(); | 获取content-type请求头 |
- 获得请求参数相关
| API | 功能解释 |
|---|---|
| String getParameter(String parameterName); | 根据请求参数名获取请求单个参数值 |
| String[] getParameterValues(String parameterName); | 根据请求参数名获取请求多个参数值数组 |
| Enumeration getParameterNames(); | 获取所有请求参数名 |
| Map<String, String[]> getParameterMap(); | 获取所有请求参数的键值对集合 |
| BufferedReader getReader() throws IOException; | 获取读取请求体的字符输入流 |
| ServletInputStream getInputStream() throws IOException; | 获取读取请求体的字节输入流 |
| int getContentLength(); | 获得请求体长度的字节数 |
- 其他API
| API | 功能解释 |
|---|---|
| String getServletPath(); | 获取请求的Servlet的映射路径 |
| ServletContext getServletContext(); | 获取ServletContext对象 |
| Cookie[] getCookies(); | 获取请求中的所有cookie |
| HttpSession getSession(); | 获取Session对象 |
| void setCharacterEncoding(String encoding) ; | 设置请求体字符集 |
八 HttpServletResponse
8.1 HttpServletResponse简介
HttpServletResponse是什么
- HttpServletResponse是一个
接口,其父接口是ServletResponse - HttpServletResponse是Tomcat预先创建的,在Tomcat调用
service方法时传入 - HttpServletResponse代表
对客户端的响应,该对象会被转换成响应的报文发送给客户端,通过该对象我们可以设置响应信息
8.2 HttpServletResponse的常见API
HttpServletRequest怎么用
- 设置响应行相关
| API | 功能解释 |
|---|---|
| void setStatus(int code); | 设置响应状态码 |
- 设置响应头相关
| API | 功能解释 |
|---|---|
| void setHeader(String headerName, String headerValue); | 设置/修改响应头键值对 |
| void setContentType(String contentType); | 设置content-type响应头及响应字符集(设置MIME类型) |
- 设置响应体相关
| API | 功能解释 |
|---|---|
| PrintWriter getWriter() throws IOException; | 获得向响应体放入信息的字符输出流 |
| ServletOutputStream getOutputStream() throws IOException; | 获得向响应体放入信息的字节输出流 |
| void setContentLength(int length); | 设置响应体的字节长度,其实就是在设置content-length响应头 |
- 其他API
| API | 功能解释 |
|---|---|
| void sendError(int code, String message) throws IOException; | 向客户端响应错误信息的方法,需要指定响应码和响应信息 |
| void addCookie(Cookie cookie); | 向响应体中增加cookie |
| void setCharacterEncoding(String encoding); | 设置响应体字符集 |
九 请求转发和响应重定向
9.1 概述
什么是请求转发和响应重定向
-
请求转发和响应重定向是web应用中间接访问项目资源的两种手段,也是Servlet控制页面跳转的两种手段
-
请求转发通过HttpServletRequest实现,响应重定向通过HttpServletResponse实现 -
请求转发生活举例: 张三找李四借钱,李四没有,李四找王五,让王五借给张三 -
响应重定向生活举例:张三找李四借钱,李四没有,李四让张三去找王五,张三自己再去找王五借钱
9.2 请求转发
- ServletA
@WebServlet("/servletA")
public class ServletA extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 获取请求转发器
RequestDispatcher requestDispatcher = req.getRequestDispatcher("servletB");
//让请求转发器做出转发的行为
requestDispatcher.forward(req,resp);
}
}
}
- ServletB
@WebServlet("/servletB")
public class ServletB extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("servletB被访问了");
//若客户端直接访问WEB-INF/b.html会响应404
RequestDispatcher requestDispatcher = req.getRequestDispatcher("WEB-INF/b.html");
requestDispatcher.forward(req,resp);
}
}
请求转发特点
- 请求转发通过
HttpServletRequest对象获取请求转发器实现 - 请求转发是服务器内部的行为,
对客户端是屏蔽的 - 客户端只发送了
一次请求,客户端地址栏不变 - 服务端只产生了
一对请求和响应对象,这一对请求和响应对象会继续传递给下一个资源 - 因为全程只有一个
HttpServletRequset对象,所以请求参数可以传递,请求域中的数据也可以传递 - 请求转发可以转发给其他
Servlet动态资源,也可以转发给一些静态资源以实现页面跳转 - 请求转发可以转发给
WEB-INF下受保护的资源 - 请求转发
不能转发到本项目以外的外部资源
WEB-INF 是 Java 的 web 应用的安全目录
9.3 响应重定向(302响应码)
- ServletA
@WebServlet("/servletA")
public class ServletA extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//响应重定向,设置响应码为302,同时设置location响应头
resp.sendRedirect("servletB");
}
}
- ServletB
@WebServlet("/servletB")
public class ServletB extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("servletB被访问了");
}
}
}
响应重定向特点
- 响应重定向通过
HttpServletResponse对象的sendRedirect方法实现 - 响应重定向是服务端通过
302响应码和路径,告诉客户端自己去找其他资源,是在服务端提示下客户端的行为 - 客户端
至少发送了两次请求,客户端地址栏是要变化的 - 服务端产生了
多对请求和响应对象,且请求和响应对象不会传递给下一个资源 - 因为全程产生了
多个HttpServletRequset对象,所以请求参数不可以传递,请求域中的数据也不可以传递 - 重定向可以是
其他Servlet动态资源,也可以是一些静态资源以实现页面跳转 - 重定向
不可以到给WEB-INF下受保护的资源 - 重定向可以到本项目
以外的外部资源
同样能够实现页面跳转,优先使用响应重定向
十 web乱码和路径问题总结
10.1 乱码问题
乱码问题产生的根本原因是什么
- 数据的编码和解码使用的不是同一个字符集
- 使用了不支持某个语言文字的字符集
各个字符集的兼容性
- 由上图得知,上述字符集都兼容了ASCII
- ASCII中有什么? 英文字母和一些通常使用的符号,所以这些东西无论使用什么字符集都不会乱码
10.1.1 HTML乱码问题
当前视图文件的字符集通过meta charset="UTF-8"来告知浏览器通过什么字符集来解析当前文件
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
中文
</body>
</html>
10.1.2 Tomcat控制台乱码
在tomcat10.1.7这个版本中,修改 tomcat/conf/logging.properties中,所有的UTF-8为GBK即可
sout乱码问题,设置JVM加载.class文件时使用UTF-8字符集
- 设置虚拟机加载.class文件的字符集和编译时使用的字符集一致
10.1.3 请求乱码问题
10.1.3.1 GET请求乱码
GET请求方式乱码分析
- GET方式提交参数的方式是将参数放到URL后面,如果使用的不是UTF-8,那么会对参数进行URL编码处理
- HTML中的 影响了GET方式提交参数的URL编码
- tomcat10.1.7的URI编码默认为 UTF-8
- 当GET方式提交的参数URL编码和tomcat10.1.7默认的URI编码不一致时,就会出现乱码
GET请求方式乱码解决
- 方式1 :设置GET方式提交的编码和Tomcat10.1.7的URI默认解析编码一致即可 (推荐)
- 方式2 : 设置Tomcat10.1.7的URI解析字符集和GET请求发送时所使用URL转码时的字符集一致即可,修改conf/server.xml中 Connecter 添加 URIEncoding=“GBK” (不推荐)
10.1.3.2 POST方式请求乱码
POST请求方式乱码分析
- POST请求将参数放在
请求体中进行发送 请求体使用的字符集受到了meta charset="字符集"的影响- Tomcat10.1.7 默认使用
UTF-8字符集对请求体进行解析 - 如果请求体的URL转码和Tomcat的请求体解析编码不一致,就容易出现乱码
POST请求方式乱码解决
-
方式1 : 请求时,使用UTF-8字符集提交请求体 (推荐)
-
方式2 : 后端在获取参数前,设置解析请求体使用的字符集和请求发送时使用的字符集一致 (不推荐)
10.1.3.3 响应乱码问题
响应乱码分析
- 在Tomcat10.1.7中,向响应体中放入的数据默认使用了工程编码
UTF-8 - 浏览器在接收响应信息时,使用了不同的字符集或者是不支持中文的字符集就会出现乱码
响应乱码演示
-
服务端通过response对象向响应体添加数据
-
浏览器接收数据解析乱码
响应乱码解决
-
方式1 : 手动设定浏览器对本次响应体解析时使用的字符集(不推荐)
- edge和 chrome浏览器没有提供直接的比较方便的入口,不方便
-
方式2: 后端通过设置响应体的字符集和浏览器解析响应体的默认字符集一致(不推荐)
- 方式3: 通过设置content-type响应头,告诉浏览器以指定的字符集解析响应体(推荐)
resp.setCharacterEncoding("UTF-8");
resp.setContentType("text/html;charset=UTF-8);