【JavaWeb】Servlet

Servlet

一、简介

Servlet (server applet) 是运行在服务端(tomcat)的Java小程序，是sun公司提供一套定义动态资源规范; 从代码层面上来讲Servlet就是一个接口

• 用来接收、处理客户端请求、响应给浏览器的动态资源。在整个Web应用中，Servlet主要负责接收处理请求、协同调度功能以及响应数据。我们可以把Servlet称为Web应用中的控制器
• 不是所有的JAVA类都能用于处理客户端请求，能处理客户端请求并做出响应的一套技术标准就是Servlet
• Servlet是运行在服务端的，所以 Servlet必须在WEB项目中开发且在Tomcat这样的服务容器中运行

请求响应与HttpServletRequest和HttpServletResponse之间的对应关系：

二、开发流程

1. 参照上一篇内容，创建一个web类型的module
2. 新建一个Servlet类，继承HttpServlet，重写service或doMeth方法（doGet、doPost等方法）
   • Servlet对象的生命周期(创建，初始化，处理服务，销毁)是由tomcat管理的，无需我们自己new
   • HttpServletRequest 代表请求对象，是由请求报文经过tomcat转换而来的，通过该对象可以获取请求中的信息
   • HttpServletResponse 代表响应对象，该对象会被tomcat转换为响应的报文，通过该对象可以设置响应中的信息
3. 在 web.xml 为自定义的Servlet配置请求的映射路径，配置 servlet 和 servlet-mapping

步骤2：

public class UserServlet extends HttpServlet {

	@Override
	public void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
		String username = request.getParameter("username");
		if (username != null && !username.isEmpty()) {
			response.getWriter().println("参数获取成功：" + username);
		} else {
			response.getWriter().println("参数获取失败");
		}
	}
}

步骤3：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd"
         version="6.0">
    <servlet>
        <servlet-name>userServlet</servlet-name>
        <servlet-class>servlet.UserServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>userServlet</servlet-name>
        <url-pattern>/userServlet</url-pattern>
    </servlet-mapping>
</web-app>

还可以用 @WebServlet 注解方式代替xml配置

@WebServlet(
		name = "userServlet",
		urlPatterns = {"/userServlet"}
)
public class UserServlet extends HttpServlet {

	@Override
	public void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
		String username = request.getParameter("username");
		HttpSession session = request.getSession();
		System.out.println(session.getId());
		System.out.println(session.isNew());
		response.setContentType("text/html;charset=UTF-8");
		if (username != null && !username.isEmpty()) {
			response.getWriter().println("参数获取成功：" + username);
		} else {
			response.getWriter().println("参数获取失败");
		}
	}
}

三、生命周期

Servlet对象是Servlet容器创建的，生命周期方法都是由容器(目前我们使用的是Tomcat)调用的。这一点和我们之前所编写的代码有很大不同。在今后的学习中我们会看到，越来越多的对象交给容器或框架来创建，越来越多的方法由容器或框架来调用，开发人员要尽可能多的将精力放在业务逻辑的实现上。

生命周期	对应方法	执行时机	执行次数
构造对象	构造器	第一次请求或者容器启动	1
初始化	init()	构造完毕后	1
处理服务	service(HttpServletRequest req,HttpServletResponse resp)	每次请求	多次
销毁	destory()	容器关闭	1

• Servlet对象在容器中是单例的
• 容器是可以处理并发的用户请求的，每个请求在容器中都会开启一个线程

load-on-startup ：当值为0或者大于0时，代表容器启动时加载该servlet。正数的值越小，启动时加载该servlet的优先级越高。如果为负数，则容器启动时不会加载该servlet，只有该servlet被选择时才会加载。

• 如果数字重复了，容器会自行解决实例化顺序问题，但是应该避免重复

• Tomcat容器中已经定义了一些随系统启动实例化的servlet，我们自定义的servlet的load-on-startup尽量不要占用数字1-5

四、ServletConfig和ServletContext

ServletConfig：ServletConfig为Servlet提供初始配置参数的一种对象，每个Servlet都有自己独立唯一的ServletConfig对象。容器会为每个Servlet实例化一个ServletConfig对象,并通过Servlet生命周期的init方法传入给Servlet作为属性。可通过该对象迭代获取servlet初始化配置参数。

方法名	作用
getServletName()	获取<servlet-name>HelloServlet</servlet-name>定义的Servlet名称
getServletContext()	获取ServletContext对象
getInitParameter()	获取配置Servlet时设置的『初始化参数』，根据名字获取值
getInitParameterNames()	获取所有初始化参数名组成的Enumeration对象

ServletContext：ServletContext对象有称呼为上下文对象，或者叫应用域对象。容器会为每个app创建一个独立的唯一的ServletContext对象。通过该对象可获取静态资源的真实路径以及项目的上下文路径

域对象：一些用于存储数据和传递数据的对象，传递数据不同的范围为不同的域。

• ServletContext代表应用，所以ServletContext域也叫作应用域，是webapp中最大的域，可以在应用内实现数据的共享和传递
• webapp中的三大域对象，分别是应用域，会话域，请求域
• 三大域对象都具有的API如下

API	功能解释
void setAttribute(String key,Object value);	向域中存储/修改数据
Object getAttribute(String key);	获得域中的数据
void removeAttribute(String key);	移除域中的数据

五、HttpServletRequest常见API

• 获取请求行信息相关(方式，请求的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常见API

• 设置响应行相关

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);	设置响应体字符集

七、请求转发和响应重定向

7.1 概述

• 请求转发和响应重定向是web应用中间接访问项目资源的两种手段,也是Servlet控制页面跳转的两种手段
• 请求转发通过HttpServletRequest实现，响应重定向通过HttpServletResponse实现

7.2 请求转发

• 请求转发通过HttpServletRequest对象获取请求转发器实现
• 请求转发是服务器内部的行为,对客户端是屏蔽的
• 客户端只发送了一次请求,客户端地址栏不变
• 服务端只产生了一对请求和响应对象,这一对请求和响应对象会继续传递给下一个资源
• 因为全程只有一个HttpServletRequset对象，所以请求参数可以传递，请求域中的数据也可以传递
• 请求转发可以转发给其他Servlet动态资源，也可以转发给一些静态资源以实现页面跳转
• 请求转发可以转发给WEB-INF下受保护的资源
• 请求转发不能转发到本项目以外的外部资源

@WebServlet("/servletA")
public class ServletA extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //  获取请求转发器
        //  转发给servlet  ok
        RequestDispatcher  requestDispatcher = req.getRequestDispatcher("servletB");
        //  转发给一个视图资源 ok
        //RequestDispatcher requestDispatcher = req.getRequestDispatcher("welcome.html");
        //  转发给WEB-INF下的资源  ok
        //RequestDispatcher requestDispatcher = req.getRequestDispatcher("WEB-INF/views/view1.html");
        //  转发给外部资源   no
        //RequestDispatcher requestDispatcher = req.getRequestDispatcher("http://www.baidu.com");
        //  获取请求参数
        String username = req.getParameter("username");
        System.out.println(username);
        //  向请求域中添加数据
        req.setAttribute("reqKey","requestMessage");
        //  做出转发动作
        requestDispatcher.forward(req,resp);
    }
}

7.3 响应重定向

• 响应重定向通过HttpServletResponse对象的sendRedirect方法实现
• 响应重定向是服务端通过302响应码和路径，告诉客户端自己去找其他资源，是在服务端提示下的客户端的行为
• 客户端至少发送了两次请求，客户端地址栏是要变化的
• 服务端产生了多对请求和响应对象，且请求和响应对象不会传递给下一个资源
• 因为全程产生了多个HttpServletRequset对象，所以请求参数不可以传递，请求域中的数据也不可以传递
• 重定向可以是其他Servlet动态资源，也可以是一些静态资源以实现页面跳转
• 重定向不可以到给WEB-INF下受保护的资源
• 重定向可以到本项目以外的外部资源

@WebServlet("/servletA")
public class ServletA extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //  获取请求参数
        String username = req.getParameter("username");
        System.out.println(username);
        //  向请求域中添加数据
        req.setAttribute("reqKey","requestMessage");
        //  响应重定向
        // 重定向到servlet动态资源 OK
        resp.sendRedirect("servletB");
        // 重定向到视图静态资源 OK
        //resp.sendRedirect("welcome.html");
        // 重定向到WEB-INF下的资源 NO
        //resp.sendRedirect("WEB-INF/views/view1");
        // 重定向到外部资源
        //resp.sendRedirect("http://www.baidu.com");
    }
}

八、请求与响应乱码问题

8.1 GET与POST请求乱码

• HTML中的 <meta charset='字符集'/> 影响了GET和POST方式提交参数的编码
• tomcat 10.1 的URI编码默认为 UTF-8

解决方案：

• 方式1：修改<meta charset='字符集'/>编码和 Tomcat10.1 的URI默认解析编码一致即可 (推荐)
• GET请求方式2：修改 Tomcat10.1 的URI解析字符集。修改conf/server.xml中 Connecter 添加 URIEncoding=“GBK” (不推荐)
• POST请求方式2：修改请求解析体使用的字符集与前端保持一致，调用 req.setCharacterEncoding 方法 (不推荐)

8.2 响应乱码问题

• 在Tomcat10.1.7中，向响应体中放入的数据默认使用了工程编码 UTF-8
• 浏览器在接收响应信息时,使用了不同的字符集或者是不支持中文的字符集就会出现乱码

解决方案：

• 方式一：客户手动设定浏览器对本次响应体解析时使用的字符集(不推荐)
• 方式二：后端通过设置响应体的字符集和浏览器解析响应体的默认字符集一致，调用 resp.setCharacterEncoding 方法(不推荐)
• 方式三：通过设置content-type响应头，告诉浏览器以指定的字符集解析响应体(推荐)

// 告诉浏览器以指定的MIME类型和字符集解析响应体
resp.setContentType("text/html;charset=UTF-8")

MIME类型

• MIME类型,可以理解为文档类型,用户表示传递的数据是属于什么类型的文档
• 浏览器可以根据MIME类型决定该用什么样的方式解析接收到的响应体数据
• 可以这样理解: 前后端交互数据时,告诉对方发给对方的是 html/css/js/图片/声音/视频/… …
• tomcat/conf/web.xml中配置了常见文件的拓展名和MIMIE类型的对应关系
• 常见的MIME类型举例如下

文件拓展名	MIME类型
.html	text/html
.css	text/css
.js	application/javascript
.png /.jpeg/.jpg/… …	image/jpeg
.mp3/.mpe/.mpeg/ … …	audio/mpeg
.mp4	video/mp4
.m1v/.m1v/.m2v/.mpe/… …	video/mpeg

九、MVC架构模式

MVC（Model View Controller）是软件工程中的一种 软件架构模式，它把软件系统分为 模型、视图 和 控制器 三个基本部分。用一种业务逻辑、数据、界面显示分离的方法组织代码，将业务逻辑聚集到一个部件里面，在改进和个性化定制界面及用户交互的同时，不需要重新编写业务逻辑。

• M：Model 模型层，具体功能如下
  1. 存放和数据库对象的实体类以及一些用于存储非数据库表完整相关的VO对象
  2. 存放一些对数据进行逻辑运算操作的的一些业务处理代码
• V：View 视图层，具体功能如下
  1. 存放一些视图文件相关的代码 html css js等
  2. 在前后端分离的项目中，后端已经没有视图文件，该层次已经衍化成独立的前端项目
• C：Controller 控制层，具体功能如下
  1. 接收客户端请求，获得请求数据
  2. 将准备好的数据响应给客户端

MVC模式下,项目中的常见包

• M：

  1. 实体类包(pojo /entity /bean) 专门存放和数据库对应的实体类和一些VO对象
  2. 数据库访问包(dao/mapper) 专门存放对数据库不同表格CURD方法封装的一些类
  3. 服务包(service) 专门存放对数据进行业务逻辑运算的一些类

• C：

  1. 控制层包(controller)

• V：

  1. web目录下的视图资源 html css js img 等
  2. 前端工程化后,在后端项目中已经不存在了

非前后端分离的MVC

前后端分离的MVC