【Java】Servlet的执行原理、API以及实现简单的前后端分离的计算器

Servlet执行原理

在 Servlet 的代码中并没有写 main 方法, 那对应的 doGet 代码是如何被调用的呢? 响应又是如何返回给浏览器的?

接收请求:
① 用户在浏览器输入一个 URL, 此时浏览器就会构造一个 HTTP 请求；
②这个 HTTP 请求会经过网络协议栈逐层进行 封装 成二进制的 bit 流, 最终通过物理层的硬件设备转换成光信号/电信号传输出去；
③这些承载信息的光信号/电信号通过互联网上的一系列网络设备，最终到达目标主机(这个过程也需要网络层和数据链路层参与)；
④服务器主机收到这些光信号/电信号, 又会通过网络协议栈逐层进行 分用, 层层解析, 最终还原成HTTP 请求，并交给 Tomcat 进程进行处理(根据端口号确定进程)；
⑤Tomcat 通过 Socket 读取到这个请求(一个字符串), 并按照 HTTP 请求的格式来解析这个请求, 根据请求中的 Context Path 确定一个 webapp, 再通过 Servlet Path 确定一个具体的 类。再根据当前请求的方法 (GET/POST/…), 决定调用这个类的 doGet 或者 doPost 等方法。此时我们的代码中的doGet / doPost 方法的第一个参数 HttpServletRequest 就包含了这个 HTTP 请求的详细信息。

根据请求计算响应:
在我们的 doGet / doPost 方法中, 就执行到了我们自己的代码。我们自己的代码会根据请求中的一
些信息，来给 HttpServletResponse 对象设置一些属性。例如状态码, header, body 等。

返回响应:
①我们的 doGet / doPost 执行完毕后, Tomcat 就会自动把 HttpServletResponse 这个我们刚设置
好的对象转换成一个符合 HTTP 协议的字符串, 通过 Socket 把这个响应发送出去；
②此时响应数据在服务器的主机上通过网络协议栈层层 封装, 最终又得到一个二进制的 bit 流, 通过物理层硬件设备转换成光信号/电信号传输出去；
③这些承载信息的光信号/电信号通过互联网上的一系列网络设备, 最终到达浏览器所在的主机(这个过程也需要网络层和数据链路层参与)；
④浏览器主机收到这些光信号/电信号, 又会通过网络协议栈逐层进行 分用, 层层解析, 最终还原成HTTP 响应, 并交给浏览器处理；
⑤浏览器也通过 Socket 读到这个响应(一个字符串), 按照 HTTP 响应的格式来解析这个响应. 并且把body 中的数据按照一定的格式显示在浏览器的界面上。

伪代码

Tomcat初始化

class Tomcat { 
 // 用来存储所有的 Servlet 对象
 private List<Servlet> instanceList = new ArrayList<>();
 public void start() {
       // 根据约定，读取 WEB-INF/web.xml 配置文件;
        // 并解析被 @WebServlet 注解修饰的类
       
        // 假定这个数组里就包含了我们解析到的所有被 @WebServlet 注解修饰的类. 
        Class<Servlet>[] allServletClasses = ...;
        
        // 这里要做的的是实例化出所有的 Servlet 对象出来;
        for (Class<Servlet> cls : allServletClasses) {
            // 这里是利用 java 中的反射特性做的
           // 实际上还得涉及一个类的加载问题，因为我们的类字节码文件，是按照约定的
            // 方式（全部在 WEB-INF/classes 文件夹下）存放的，所以 tomcat 内部是
            // 实现了一个自定义的类加载器(ClassLoader)用来负责这部分工作。
            
            Servlet ins = cls.newInstance();
            instanceList.add(ins);
       }
        
        // 调用每个 Servlet 对象的 init() 方法，这个方法在对象的生命中只会被调用这一次;
        for (Servlet ins : instanceList) {
            ins.init();
       }
        
        // 利用我们之前学过的知识，启动一个 HTTP 服务器
        // 并用线程池的方式分别处理每一个 Request
        ServerSocket serverSocket = new ServerSocket(8080);
        // 实际上 tomcat 不是用的固定线程池，这里只是为了说明情况
        ExecuteService pool = Executors.newFixedThreadPool(100);
        
        while (true) {
            Socket socket = ServerSocket.accept();
            // 每个请求都是用一个线程独立支持，这里体现了我们 Servlet 是运行在多线程环境下的
            pool.execute(new Runnable() {
               doHttpRequest(socket); 
           });
       }
        // 调用每个 Servlet 对象的 destroy() 方法，这个方法在对象的生命中只会被调用这一次;
        for (Servlet ins : instanceList) {
            ins.destroy();
       }
   }
    
    public static void main(String[] args) {
        new Tomcat().start();
   }
}

• Tomcat 的代码中内置了main方法. 当我们启动Tomcat 的时候, 就是从Tomcat 的main方法开始执行的。
• 被@WebServlet 注解修饰的类会在Tomcat 启动的时候就被获取到, 并集中管理。 Tomcat通过反射这样的语法机制来创建被@WebServlet 注解修饰的类的实例。
• 这些实例被创建完了之后，会调用其中的init方法进行初始化。(这个方法是HttpServlet自带的, 我们自己写的类可以重写init)
• 这些实例被销毁之前, 会调用其中的destory 方法进行收尾工作。(这个方法是HttpServlet 自带的, 我们自己写的类可以重写destory)
• Tomcat 内部也是通过Socket API 进行网络通信. Tomcat 为了能同时相应多个HTTP请求, 采取了多线程的方式实现。因此Servlet 是运行在多线程环境下的。

Tomcat处理请求

class Tomcat {
    void doHttpRequest(Socket socket) {
        // 参照我们之前学习的 HTTP 服务器类似的原理，进行 HTTP 协议的请求解析，和响应构建
        HttpServletRequest req = HttpServletRequest.parse(socket);
        HttpServletRequest resp = HttpServletRequest.build(socket);
        
        // 判断 URL 对应的文件是否可以直接在我们的根路径上找到对应的文件，如果找到，就是静态内容
        // 直接使用我们学习过的 IO 进行内容输出
        if (file.exists()) {
            // 返回静态内容
            return;
       }
        
        // 走到这里的逻辑都是动态内容了
        
        // 根据我们在配置中说的，按照 URL -> servlet-name -> Servlet 对象的链条
        // 最终找到要处理本次请求的 Servlet 对象
        Servlet ins = findInstance(req.getURL());
        
        // 调用 Servlet 对象的 service 方法
        // 这里就会最终调用到我们自己写的 HttpServlet 的子类里的方法了
        try {
       ins.service(req, resp); 
       } catch (Exception e) {
            // 返回 500 页面，表示服务器内部错误
       }
   }
}

• Tomcat 从 Socket 中读到的 HTTP 请求是一个字符串，然后会按照 HTTP 协议的格式解析成一个HttpServletRequest 对象。
•Tomcat 会根据 URL 中的 path 判定这个请求是请求一个静态资源还是动态资源。如果是静态资源。直接找到对应的文件把文件的内容通过 Socket 返回。 如果是动态资源，才会执行到 Servlet 的相关逻辑。
•Tomcat 会根据 URL 中的 Context Path 和 Servlet Path 确定要调用哪个 Servlet 实例的 service
方法。通过 service 方法, 就会进一步调用到我们之前写的 doGet 或者 doPost。

Servlet 的service方法

class Servlet {
    public void service(HttpServletRequest req, HttpServletResponse resp) {
        String method = req.getMethod();
        if (method.equals("GET")) {
            doGet(req, resp);
       } else if (method.equals("POST")) {
            doPost(req, resp);
       } else if (method.equals("PUT")) {
            doPut(req, resp);
       } else if (method.equals("DELETE")) {
            doDelete(req, resp);
       } 
       ......
   }
}

Servlet 的 service 方法内部会根据当前请求的方法，决定调用其中的某个 doXXX 方法。
在调用 doXXX 方法的时候，就会触发多态机制，从而执行到我们自己写的子类中的 doXXX 方法。
此处的多态：
我们前面自己写的 HelloServlet 类，继承自 HttpServlet 类，而 HttpServlet 又继承自 Servlet。相当于 HelloServlet 就是 Servlet 的子类。接下来，在 Tomcat 启动阶段, Tomcat 已经根据注解的描述，创建了 HelloServlet 的实例，然后把这个实例放到了 Servlet 数组中，后面我们根据请求的 URL从数组中获取到了该 HelloServlet 实例，但是我们是通过 Servlet ins这样的父类引用来获取到 HelloServlet 实例的。最后，我们通过 ins.doGet() 这样的代码调用 doGet 的时候，正是 “父类引用指向子类对象”， 此时就会触发多态机制，从而调用到我们之前在 HelloServlet 中所实现的 doGet 方法。

ServletAPI

HttpServlet

写 Servlet 代码的时候, 首先第一步就是先创建类, 继承自 HttpServlet, 并重写其中的某些方法。

方法	调用时机
init	在 HttpServlet 实例化之后被调用一次
destory	在 HttpServlet 实例不再使用的时候调用一次
service	收到 HTTP 请求的时候调用
doGet	收到 GET 请求的时候调用(由 service 方法调用)
doPost	收到 POST 请求的时候调用(由 service 方法调用)
doPut/doDelete/doOptions/…	收到其他请求的时候调用(由 service 方法调用)

这些方法的调用时机, 称为 “Servlet 生命周期”，描述了一个 Servlet 实例从生到死的过程。

HttpServletRequest

当 Tomcat 通过 Socket API 读取 HTTP 请求(字符串)， 并且按照 HTTP 协议的格式把字符串解析成HttpServletRequest 对象。

方法	描述
String getProtocol()	返回请求协议的名称和版本
String getMethod()	返回请求的 HTTP 方法的名称，例如，GET、POST 或 PUT
String getRequestURI()	从协议名称直到 HTTP 请求的第一行的查询字符串中，返回该请求的 URL 的一部分
String getContextPath()	返回指示请求上下文的请求 URI 部分
String getQueryString()	返回包含在路径后的请求 URL 中的查询字符串
Enumerationget ParameterNames()	返回一个 String 对象的枚举，包含在该请求中包含的参数的名称
String getParameter(String name)	以字符串形式返回请求参数的值，或者如果参数不存在则返回null
String[] getParameterValues(String name)	返回一个字符串对象的数组，包含所有给定的请求参数的值，如果参数不存在则返回 nul
Enumeration getHeaderNames()	返回一个枚举，包含在该请求中包含的所有的头名
String getHeader(String name)	以字符串形式返回指定的请求头的值
String getCharacterEncoding()	返回请求主体中使用的字符编码的名称
String getContentType()	返回请求主体的 MIME 类型，如果不知道类型则返回 null
int getContentLength()	以字节为单位返回请求主体的长度，并提供输入流，或者如果长度未知则返回 -1
InputStream getInputStream()	用于读取请求的 body 内容. 返回一个 InputStream 对象

通过输入流来获取json格式的参数：

@WebServlet("/calc_ajax_json")
public class CalcByAjaxJSONServlet extends HttpServlet {
    private final ObjectMapper objectMapper = new ObjectMapper();
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("application/json;charset=utf-8");
        //定义返回的对象
        LinkedHashMap<String,Object> result = new LinkedHashMap<>();
        //存放返回的jsonrequest请求
        byte[] jsonReq = new byte[req.getContentLength()];
        //获取参数
        ServletInputStream inputStream =  req.getInputStream();
        //将流信息写入byte数组
        inputStream.read(jsonReq);
        //将byte[]转换成String(json字符串)
        String reqStr = new String(jsonReq);
        HashMap<String,Object> reqMap = objectMapper.readValue(reqStr,HashMap.class);
        Integer num1= (Integer) reqMap.get("num1");
        Integer num2= (Integer) reqMap.get("num2");
        //非空校验
        if(num1 == null || num2 == null){
            result.put("code",-1);
            result.put("msg","非法参数");
            result.put("data","");
        }else{
            int sum= num1 + num2;
            result.put("code",200);
            result.put("msg","");
            result.put("data",sum);
        }
        resp.getWriter().write(objectMapper.writeValueAsString(result));
    }
}

通过postman我们可以看见，发送一个json格式的数据，得到的也是json格式的响应。

🚨 注意: 请求对象是服务器收到的内容, 不应该修改。 因此上面的方法也都只是 “读” 方法，而不是"写" 方法。

HttpServletResponse

Servlet 中的 doXXX 方法的目的就是根据请求计算得到相应, 然后把响应的数据设置到
HttpServletResponse 对象中。然后 Tomcat 就会把这个 HttpServletResponse 对象按照 HTTP 协议的格式, 转成一个字符串, 并通过Socket 写回给浏览器。

方法	描述
void setStatus(int sc)	为该响应设置状态码
void setHeader(String name, String value)	设置一个带有给定的名称和值的 header. 如果 name 已经存在,则覆盖旧的值
void addHeader(String name, String value)	添加一个带有给定的名称和值的 header. 如果 name 已经存在,不覆盖旧的值, 并列添加新的键值对
void setContentType(String type)	设置被发送到客户端的响应的内容类型
void setCharacterEncoding(String charset)	设置被发送到客户端的响应的字符编码（MIME 字符集）例如，UTF-8
void sendRedirect(String location)	使用指定的重定向位置 URL 发送临时重定向响应到客户端
PrintWriter getWriter()	用于往 body 中写入文本格式数据
OutputStreamgetOutputStream()	用于往 body 中写入二进制格式数据

请求重定向和请求转发的区别：可以参考这个链接，我觉得这个说的很清楚。当设置了重定向的地址之后，我在浏览器中写入当前的URL敲回车之后，会直接跳转到重定向的页面。

@WebServlet("/resp")
public class ResposeServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.sendRedirect("https://www.baidu.com");
    }
}

🚨 注意: 响应对象是服务器要返回给浏览器的内容， 这里的重要信息都是自己设置的。因此上面的方法都是 “写” 方法。对于状态码/响应头的设置要放到 getWriter / getOutputStream 之前，否则可能设置失效。

实现计算器

form表单提交实现

后端实现：

@WebServlet("/calc_form")
public class CalcByForm extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req,resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //0.设置返回的数据类型和编码格式
        resp.setContentType("text/html;charset=utf-8");
        //1.从request中获取到参数的值
        String num1 = req.getParameter("num1");
        String num2 = req.getParameter("num2");
        //2.非空校验
        if(num1==null || num1.equals("") || num2==null || num2.equals("") ){
            resp.getWriter().write("抱歉，参数有误！");
        }
        //3.进行类型的转换
        int nummber1= Integer.valueOf(num1);
        int nummber2= Integer.valueOf(num2);
        //4.计算相加结果
        int result = nummber1 + nummber2;
        //5.将结果返回给前端
        resp.getWriter().write("相加的结果：" + result);
    }
}

前端实现：

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <title>计算器 - from表单提交</title> 
        
    </head>
    <body>
        <form method="get" action="calc_form">
            <div style="margin-top: 50px; margin-left: 40%;">
                <h2>计算器</h2>
                数值1：<input id="num1" name="num1"><p></p>
                数值2：<input id="num2" name="num2"><p></p>
                <input type="submit" value=" 相 加">
            </div>
        </form>
    </body>
</html>

注意：在form表单提交中，id是给js用的，name是form提交给后端用的，相当于key。

实现结果：

可以发现，用form表单提交时，当每次计算一个结果时，页面进行了跳转，之前的页面没了，不能再进行下一次操作。

ajax提交实现

后端实现：

@WebServlet("/calc_ajax")
public class CalcByAjax extends HttpServlet {
    private final ObjectMapper objectMapper = new ObjectMapper();
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req,resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //0.设置返回的数据类型和编码格式
        resp.setContentType("application/json;charset=utf-8");
        //1.从request中获取到参数的值
        String num1 = req.getParameter("num1");
        String num2 = req.getParameter("num2");
        //2.非空校验
        if(num1==null || num1.equals("") || num2==null || num2.equals("") ){
            resp.getWriter().write("抱歉，参数有误！");
        }
        //3.进行类型的转换
        int nummber1= Integer.valueOf(num1);
        int nummber2= Integer.valueOf(num2);
        //4.计算相加结果
        int result = nummber1 + nummber2;
        //5.将json结果返回给前端
        //方法一：强行拼
//        String jsonResult = "{\"code\":200,\"msg\":\"\",\"data\":" + result + "}";
//        resp.getWriter().write(jsonResult);
        //方法二：json工具类，来自jackson，需要引入jackson依赖
        LinkedHashMap<String,Object> map = new LinkedHashMap<>();
        map.put("code",200);
        map.put("msg","");
        map.put("data",result);
        将map对象转换为json字符串
        resp.getWriter().write(objectMapper.writeValueAsString(map));
    }
}

前端实现：

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <title>计算器 - ajax提交</title> 
        <script src="jquery.min.js"></script>
        
    </head>
    <body>
        <form method="get" action="calc_form">
            <div style="margin-top: 50px; margin-left: 40%;">
                <h2>计算器</h2>
                数值1：<input id="num1" name="num1"><p></p>
                数值2：<input id="num2" name="num2"><p></p>
                <input type="button" value=" 相 加" onclick="mysub()">
            </div>
            <script>
                function mysub(){
                    //1.非空校验
                    var num1 = jQuery("#num1");
                    var num2 = jQuery("#num2");
                    if(num1.val().trim()==""){
                        //未输入任何信息
                        alert("抱歉：请先输入数值1！");
                        num1.focus();
                        return false;
                    }
                    if(num2.val().trim()==""){
                        //未输入任何信息
                        alert("抱歉：请先输入数值2！");
                        num2.focus();
                        return false;
                    }
                    //2.发送ajax请求
                    jQuery.ajax({
                        url:"calc_ajax", //提交地址
                        method:"GET",    //请求类型
                        data:{           //传递的参数
                            "num1":num1.val(),
                            "num2":num2.val()
                        },
                        success:function(res){        //{code:"200",msg:"描述",data:"xx" }
                             if(res.code==200){
                                 alert("计算的结果为：" + res.data);
                             }else{
                                 alert("操作失败！" + res.msg);
                             }

                        }
                    });
                }
            </script>
        </form>
    </body>
</html>

实现结果：

---

继续加油~