一、Servlet简介:
1.1.动态资源和静态资源
(1)静态资源:无需在程序运行时通过代码运行生成的资源,在程序运行之前就写好的资源.例如:html、css、js、img、音频文件和视频文件;
(2)动态资源:需要在程序运行时通过代码运行生成的资源,在程序运行之前无法确定的数据,运行时动态生成;动态资源指的不是视图上的动画效果或者是简单的人机交互效果;
1.2.Servlet简介:
Servlet(server applet)是运行在服务端(Tomcat)的Java小程序,是sun公司提供一套定义动态资源规范;代码层面上Servlet就是一个接口。
Servlet用来接收、处理客户端请求、响应给浏览器的动态资源。在整个Web应用中,Servlet主要负责接收处理请求、协同调度功能以及响应数据。我们可以把Servlet称为Web应用中的控制器;
不是所有的JAVA类都能用于处理客户端请求,能处理客户端请求并做出响应的一套技术标准就是Servlet;
Servlet是运行在服务端的,所以Servlet必须在WEB项目中开发且在Tomcat这样的服务容器中运行
二、Servlet开发流程:
步骤一:开发一个web类型的module
步骤二:开发一个UserServlet
(1)自定义一个类,要继承HttpServlet类;
(2)重写service(HttpServletRequest reg, HttpServletResponse resp)方法,该方法主要就是用于处理用户请求的服务方法;
(3)HttpServletRequest代表请求对象,是有请求报文经过Tomcat转换而来的,通过该对象可以获取请求中的信息;
(4)HttpServletResponse 代表响应对象,该对象会被Tomcat转换为响应的报文,通过该对象可以设置响应中的信息;
(5)Servlet对象的生命周期(创建、初始化、处理服务、销毁)是由Tomcat管理的,无需自己new;
(6)HttpServletRequest、HttpServletResponse 两个对象也是由Tomcat负责转换,在调用service方法时传入给我们用的;
public class UserServlet extends HttpServlet{
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
// 获取请求中的键值对参数key=value
String username =reg.getParameter("username");
if("atguigu".equals(username)){
//通过响应对象响应信息
resp.getWriter().write("No");
}else{
resp.getWriter().write("YES");
}
}
}
步骤3:在web.xml为UseServlet配置请求的映射路径
(1).Servlet并不是文件系统中实际存在的文件或者目录,所以为了能够请求到该资源,需要为其配置映射路径;
(2).Servlet的请求映射路径配置在web.xml中;
(3).<servlet-name>作为Servlet的别名,可以自己随意定义,见名知意就好;
(4).<url-pattern>标签用于定义Servlet的请求映射路径;
(5).一个Servlet可以对应多个不同的<url-pattern>;
(6).多个Servlet不能使用相同的<url-pattern>;
(7).<url-pattern>中可以使用一些通配写法:
/:表示通配所有资源,不包括jsp文件
/*:表示通配所有资源,包括jsp文件
/a/*:匹配所有以a前缀的映射路径
*.action:匹配所有以action为后缀的映射路径
<?xml version="1." encoding="UTF-8"?>
<web-app xmIns="https://jakarta.ee/xml/ns/jakartaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaeehttps://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
version="5.0">
<servlet>
<!--给UserServlet起一个别名-->
<servlet-name>userServlet</servlet-name>
<servlet-class>com.atguiqu.servlet.UserServlet</servlet-class>
</servlet>
<servlet-mapping>
<!--关联别名和映射路径-->
<servlet-name>userServlet</servlet-name>
<!--可以为一个Servlet匹配多个不同的映射路径,
但是不同的Servlet不能使用相同的ùrl-pattern-->
<!-- 一个servlet-name 可以同时对应多个url-pattern;
一个servlet标签可以同时对应多个servlet-mapping标签-->
<url-pattern>/userServlet</url-pattern>
<!-- <url-pattern>/userServlet2</url-pattern>-->
<!--
'/' 表示通配所有资源,不包括jsp文件;
'/*'表示通配所有资源,包括jsp文件;
'/a/*'匹配所有以a前缀的映射路径;
'*.action'匹配所有以action为后缀的映射路径 -->
</servlet-mapping>
</web-app>
步骤4:开发一个form表单,向servlet发送一个GET请求并携带username参数;
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8'>
<title>Title</title>
</head>
<body>
<form action="userServlet">
请输入用户名:<input type="text" name="username" /> <br>
<input type="submit" value="校验
</form>
</body>
</html>
步骤5:启动项目,访问index.html,提交表单测试;
三、Servlet注解方式配置
@WebServlet注解使用
使用@WebServlet注解替换Web.xml文件中Servlet的配置:
@WebServlet(
name ="userServlet",
urlPatterns ={"/userServlet1","/userServlet2","/userServlet"},
initParams ={@WebInitParam(name =“encoding",value = "UTF-8")},
loadOnStartup = 6
)
public class UserServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException, IException{
String encoding = getServletConfig().getInitParameter("encoding");
System.out.println(encoding);
String username = reg.getParameter("username");
if("atguigu".equals(username)){
//通过响应对象响应信息
resp.getwriter().write("No");
}else{
resp.getWriter().write("Yes");
}
}
}
四、Servlet生命周期:
4.1.生命周期简介
Servlet的生命周期:
应用程序中的对象不仅在空间上有层次结构的关系,在时间上也会因为处于程序运行过程中的不同阶段而表现出不同状态和不同行为,这就是对象的生命周期。简单的叙述生命周期,就是对象在容器中从开始创建到销毁的过程。
Servlet容器:
Servlet对象是Servlet容器创建的,生命周期方法都是由容器(目前我们使用的是Tomcat)调用的;
Servlet主要的生命周期执行特点:
生命周期 | 对应方法 | 执行时机 | 执行次数 |
构造对象 | 构造器 | 第一次请求或容器启动 | 1 |
初始化 | init() | 构造完毕后 | 1 |
处理服务 | service(HttpServletRequest reg,HttpServletResponse resp) | 每次请求 | 多次 |
销毁 | destory() | 容器关闭 | 1 |
4.2.测试生命周期代码:
package com.atguigu.servlet;
import jakarta.servlet.ServletException;
importjakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
public class ServletLifeCycle extends HttpServlet {
public ServletLifeCycle(){
System.out.println("构造器");
}
@Override
public void init()throws ServletException {
System.out.println("初始化方法");
}
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
System.out.println("service方法");
}
@Override
public void destroy(){
System.out.println("销毁方法");
}
}
4.3.生命周期总结
(1)通过生命周期测试发现Servlet对象在容器中是单例的;
(2)容器是可以处理并发的用户请求的,每个请求在容器中都会开启一个线程;
(3)多个线程可能会使用相同的Servlet对象,所以在Servlet中我们不要轻易定义一些需要经常修改的成员变量;
(4).xml配置文件中的load-on-startup标签中定义的正整数表示实例化顺序,如果数字重复容器会自行解决实例化顺序问题,但是应该避免重复;load-on-startup标签默认值是-1,含义是tomcat启动时不会实例化该servlet
(5)Tomcat容器中已经定义了一些随系统启动实例化的Servlet,自定义的Servlet的load-on-startup尽量不要占用数字1-5;
五、Servlet继承结构:
5.1.Servlet接口:
public interface Servlet
接口及方法说明:Servlet规范接口,所有的Servlet必须实现
public void init(ServletConfig config) throws ServletException;
1.初始化方法,容器在构造servlet对象后自动调用的方法,容器负责实例化一个Servletconfig对象,并在调用该方法时传入;
2.ServletConfig对象可以为Servlet提供初始化参数;
public ServletConfig getServletConfig();
获取Servletconfig对象的方法,后续可以通过该对象获取Servlet初始化参数;
public void service(ServletRequest reg, ServletResponse res) throws ServletException,IOException;
1.处理请求并做出响应的服务方法,每次请求产生时由容器调用;
2.容器创建一个ServletRequest对象和ServletResponse对象,容器在调用service方法时传入这两个对象
public String getServletInfo();
获取ServletInfo信息的方法
public void destroy();
Servlet实例在销毁之前调用的方法
5.2.GenericServlet抽象类:
public abstract class GenericServlet implements Servlet
接口及方法说明:Genericservlet抽象类是对Servlet接口一些固定功能的粗糙实现,以及对service方法的再次抽象声明,并定义了一些其他相关功能方法
private transient ServletConfig config;
初始化配置对象作为属性
public GenericServlet(){}
构造器,为了满足继承而准备;
public void destroy(){}
销毁方法的平庸实现
public String getInitParameter(String name)
获取初始参数的快捷方法
public Enumeration getInitParameterNames()
返回所有初始化参数名的方法
public ServletConfig getServletConfig()
获取初始Servlet初始配置对象ServletConfig的方法
public ServletContext getServletContext()
获取上下文对象ServletContext的方法
public String getServletInfo()
获取Servlet信息的平庸实现
public void init(ServletConfig config) throws ServletException()
初始化方法的实现,并在此调用了init的重载方法
public void init() throws ServletException
重载init方法,为了让我们自己定义初始化功能的方法
public void log(String msg)
public void log(String message, Throwable t)
打印日志的方法及重载
public abstract void servicelServletRequest reg, ServletResponse res) throws ServletException,IOException;
服务方法再次声明
public String getServletName()
获取ServletName的方法
5.3.HttpServlet抽象类
abstract class HttpServlet extends GenericServlet
除了基本的实现以外,增加了更多的基础功能;
private static final String METHOD_DELETE = "DELETE";
private static final String METHOD_HEAD = "HEAD";
private static final String METHOD_GET = "GET";
private static final String METHOD_OPTIONS = "OPTIONS";
private static final String METHOD_POST = "POST";
private static final String METHOD_PUT = "PUT";
private static final String METHOD_TRACE= "TRACE";
上述属性用于定义常见请求方式名常量值
public HttpServlet(){}
构造器,用于处理继承
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;
对服务方法的实现
在该方法中,将请求和响应对象转换成对应HTTP协议的HttpServletRequest和HttpServletResponse对象
调用重载的service方法
public void service(HttpServletRequest reg, HttpServletResponse res) throws ServletException,IOException
重载的service方法,被重写的service方法所调用
在该方法中,通过请求方式判断调用具体的do***方法完成请求的处理
protected void doGet(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doPost(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doHead(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doPut(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doDelete(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doOptions(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
protected void doTrace(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException
对应不同请求方式的处理方法
除了doOptions和doTrace方法,其他的do***方法都在故意响应错误信息
5.4.自定义Servlet类:
自定义Servlet中必须要对处理请求的方法进行重写:要么重写service方法/要么重写doGet/doPost方法;
六、ServletConfig和ServletContext
6.1.ServletConfig的使用
ServletConfig:为Servlet提供初始配置参数的一种对象,每个Servlet都有自己独立唯一的ServletConfig对象;容器会为每个Servlet实例化一个ServletConfig对象,并通过Servlet生命周期的init方法传入给Servlet作为属性
ServletConfig是一个接口,定义了如下API:
package jakarta.servlet;
import java.util.Enumeration,
public interface ServletConfig{
String getServletName();
ServletContext getServletContext();
String getInitParameter(String var1);
Enumeration<String>getInitParameterNames();
}
方法名 | 作用 |
getServletName() | 获取<servlet-name>HelloServlet</servlet-name>定义的Servlet名称。 |
getServletContext() | 获取ServletContext对象 |
getlnitParameter() | 获取配置Servlet时设置的初始化参数,根据名字获取值。 |
getlnitParameterNames() | 获取所有初始化参数名组成的Enumeration对象 |
ServletConfig具体使用:
public class ServletA extends HttpServlet {
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
ServletConfig servletConfig =this.getServletConfig();
//根据参数名获取单个参数
String value =servletConfig.getInitParameter("param1");
System.out.println("param1:"+value);
//获取所有参数名
Enumeration<String> parameterNames = servletConfig.getInitParameterNames();
// 迭代并获取参数名
while(parameterNames.hasMoreElements()){
String paramaterName =parameterNames.nextElement();
System.out.println(paramaterName+":"+servletConfig.getInitParameter(paramaterName));
}
}
}
public class ServletB extends HttpServlet {
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
ServletConfig servletConfig =this.getServletConfig();
//根据参数名获取单个参数
String value =servletConfig.getInitParameter("param1");
System.out.println("param1:"+value);
//获取所有参数名
Enumeration<String> parameterNames = servletConfig.getInitParameterNames();
// 迭代并获取参数名
while(parameterNames.hasMoreElements()){
String paramaterName =parameterNames.nextElement();
System.out.println(paramaterName+":"+servletConfig.getInitParameter(paramaterName));
}
}
}
<servlet>
<servlet-name>ServletA</servlet-name>
<servlet-class>com.atguigu.servlet.ServletA</servlet-class>
<!--配置ServletA的初始参数-->
<init-param>
<param-name>param1</param-name>
<param-value>value1</param-value>
</init-param>
<init-param>
<param-name>param2</param-name>
<param-value>value2</param-value>
</init-param>
</servlet>
<servlet>
<servlet-name>ServletB</servlet-name>
<servlet-class>com.atguigu.servlet.ServletB</servlet-class>
<!--配置ServletB的初始参数-->
<init-param>
<param-name>param3</param-name>
<param-value>value3</param-value>
</init-param>
<init-param>
<param-name>param4</param-name>
<param-value>value5</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>ServletA</servlet-name>
<url-pattern>/servletA</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>ServletB</servlet-name>
<url-pattern>/servletB</url-pattern>
</servlet-mapping>
6.2.ServletContext的使用
ServletContext:ServetContext对象有称呼为上下文对象,或者叫应用域对象;容器会为每个app创建独立的唯一的ServletContext对象;ServletContext对象为所有的Servlet所共享;ServletContext可以为所有的Servlet提供初始配置参数;
ServletContext具体使用:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
xmlns:xsi="http://www.w3.org/2801/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaeehttps://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
version="5.0">
<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>
</web-app>
public class ServletA extends HttpServlet {
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
//从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));
}
}
}
ServletContext其他重要API:
获取资源的磁盘路径:目标是需要获取项目中某个静态资源的路径,不是工程目录中的路径,而是部署目录中的路径;如果直接拷贝其电脑中的完整路径的话其实是有问题的,因为如果该项目以后部署到公司服务器上的话路径肯定是会发生改变的,所以需要使用代码动态获取资源的真实路径;只要使用了servletContext动态获取资源的真实路径,那么无论项目的部署路径发生什么变化都会动态获取项目运行时候的实际磁盘路径,所以就不会发生由于写死真实路径而导致项目部署位置改变引发的路径错误问题。
String realPath = servletContext.getRealPath("资源在web目录中的路径");
获取项目的上下文路径:项目的部署名称,也叫项目的上下文路径,在部署进入tomcat时所使用的路径,该路径是可能发生变化的,通过该API动态获取项目真实的上下文路径,可以帮助解决一些后端页面渲染技术或者请求转发和响应重定向中的路径问题。
String contextPath = servletContext.getContextPath();
域对象的相关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是一个接口,其父接口是ServletRequest;HttpServletRequest是Tomcat将请求报文转换封装而来的对象,在Tomcat调用service方法时传入;HttpServletRequest代表客户端发来的请求,请求中的所有信息都可以通过该对象获得;
7.2.HttpServletRequest常见API
(1).获取请求行信息相关(方式,请求的url,协议及版本):
API | 功能解释 |
StringBuffer getRequestURL(); | 获取客户端请求的url |
String getRequestURl(); | 获取客户端请求项目中的具体资源 |
int getServerPort(); | 获取客户端发送请求时的端口 |
int getLocalPort(); | 获取本应用在所在容器的端口 |
int getRemotePort(); | 获取客户端程序的端口 |
String getScheme(); | 获取请求协议 |
String getProtocol(); | 获取请求协议及版本号 |
String getMethod(); | 获取请求方式 |
(2).获得请求头信息相关:
API | 功能解释 |
String getHeader(String headerName); | 根据头名称获取请求头 |
Enumeration getHeaderNames(); | 获取所有的请求头名字 |
String getContentType(); | 获取content-type请求头 |
(3).获得请求参数相关:
API | 功能解释 |
String getParameter(String parameterName); | 根据请求参数名获取请求单个参数值 |
String[] getParameterValues(String parameterName); | 根据请求参数名获取请求多个参数值数组 |
Enumeration getParameterNames(); | 获取所有请求参数名 |
Map<String, String[]> getParameterMap(); | 获取所有请求参数的键值对集合 |
BufferedReader getReader() throws lOException; | 获取读取请求体的字符输入流 |
ServletinputStream getInputStream() throws IOException; | 获取读取请求体的字节输入流 |
int getContentLength(); | 获得请求体长度的字节数 |
(4).其他API:
API | 功能解释 |
String getServletPath(); | 获取请求的Servet的映射路径 |
ServletContext getServletContext(); | 获取ServletContext对象 |
Cookie[] getCookies(); | 获取请求中的所有cookie |
HttpSession getSession(); | 获取Session对象 |
void setCharacterEncoding(String encoding); | 设置请求体字符集 |
八、HttpServletResponse
8.1.HttpServletResponse简介
HttpServletResponse是一个接口,其父接口是ServletResponse;HttpServletResponse是Tomcat预先创建的,在Tomcat调用service方法时传入;HttpServletResponse代表对客户端的响应,该对象会被转换成响应的报文发送给客户端,通过该对象我们可以设置响应信息;
8.2.HttpServletResponse的常见API
(1).设置响应行相关:
API | 功能解释 |
void setStatus(int code); | 设置响应状态码 |
(2).设置响应头相关:
API | 功能解释 |
void setHeader(String headerName,String headerValue); | 设置/修改响应头键值对 |
void setContentType(String contentType); | 设置content-type响应头及响应字符集(设置MIME类型) |
(3).设置响应体相关:
API | 功能解释 |
PrintWriter getWriter()throws lOException; | 获得向响应体放入信息的字符输出流 |
ServletOutputStream getOutputStream() throws lOException; | 获得向响应体放入信息的字节输出流 |
void setContentLength(int length); | 设置响应体的字节长度,其实就是在设置content-length响应头 |
(4).其他API:
API | 功能解释 |
void sendError(int code, String message) throws IOException; | 向客户端响应错误信息的方法,需要指定响应码和响应信息 |
void addCookie(Cookie cookie); | 向响应体中增加cookie |
void setCharacterEncoding(String encoding); | 设置响应体字符集 |
(5).MIME类型:
MIME类型,可以理解为文档类型,用户表示传递的数据是属于什么类型的文档;浏览器可以根据MIME类型决定该用什么样的方式解析接收到的响应体数据;可以这样理解:前后端交互数据时,告诉对方发给对方的是 html/css/js/图片/声音/视频..….;tomcat/conf/web.xml中配置了常见文件的拓展名和MIMIE类型的对应关系;
文件拓展名 | MIME类型 |
.html | text/html |
.css | text/css |
.js | application/javascript |
.json | application/json |
.png/.jpg/.jpeg | image/jpeg |
.mp3/.mpe/.mpeg/... | audio/mpeg |
.mp4 | video/mp4 |
.mlv/.m1v/.m2v/.mpe/..... | video/mpeg |
九、请求转发和响应重定向
9.1.概述
请求转发和响应重定向是web应用中间接访问项目资源的两种手段,也是Servlet控制页面跳转的两种手段;请求转发通过HttpServletRequest实现,响应重定向通过HttpServletResponse实现;
9.2.请求转发
请求转发特点:
(1).请求转发通过HttpServletRequest对象获取请求转发器实现;
(2).请求转发是服务器内部的行为,对客户端是屏蔽的;
(3).客户端只发送了一次请求,客户端地址栏不变;
(4).服务端只产生了一对请求和响应对象,这一对请求和响应对象会继续传递给下一个资源;
(5).因为全程只有一个HttpServletRequset对象,所以请求参数可以传递,请求域中的数据也可以传递;
(6).请求转发可以转发给其他Servlet动态资源,也可以转发给一些静态资源以实现页面跳转;
(7).请求转发可以转发给WEB-INF下受保护的资源;
(8).请求转发不能转发到本项目以外的外部资源;
@WebServlet("/servletA")
public class ServletA extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException,IOException{
//获取请求转发器
// 转发给servlet ok
RequestDispatcher requestDispatcher =reg.getRequestDispatcher("servletB");
// 转发给一个视图资源 ok
RequestDispatcher requestDispatcher = req.getRequestDispatcher("welcome.html");
// 转发给WEB-INF下的资源 ok
RequestDispatcher requestDispatcher = reg.getRequestDispatcher("WEB.INF/views/view1.html");
// 获取请求参数
String username =reg.getParameter("username");
System.out.println(username);
//向请求域中添加数据
req.setAttribute("reqKey","requestMessage");
//做出转发动作
requestDispatcher.forward(req,resp);
}
}
@WebServlet("/servletB")
public class ServletB extends HttpServlet {
@Override
protected void service(HttpServletRequest reg, HttpServletResponse resp) throws ServletException,IOException{
// 获取请求参数
String username = reg.getParameter("username");
System.out.println(username);
//获取请求域中的数据
String reqMessage =(String)req.getAttribute("reqKey");
System.out.println(reqMessage);
// 做出响应
resp.getWriter().write("servletB response");
}
}