【JavaEE初阶系列】——Servlet运行原理以及Servlet API详解

发布于:2024-05-08 ⋅ 阅读:(19) ⋅ 点赞:(0)

目录

🚩Servlet运行原理

🚩Servlet API 详解

🎓HttpServlet核心方法

🎓HttpServletRequest核心方法

🎈核心方法的使用

🔴获取请求中的参数

💻query string

💻直接通过form表单

💻json

🎓HttpServletResponse核心方法

🎈setStatus(设置状态码)

🎈sendError发送错误码同时提示信息

🎈setHeader刷新浏览器时间戳

🎈setHeader和sendRedirect构造重定向响应


🚩Servlet运行原理

我们上一篇完成了一篇用servlet来写hello world程序,我们会发现 Servlet 的代码中我们并没有写 main 方法, 那么对应的 doGet 代码是如何被调用的呢? 响应又是如何 返回给浏览器的

servlet是一组api,操作http协议的,tomcat提供的。一组api也可以理解为一个HTTP服务器框架的。 


我们给一个程序,比喻成一辆汽车,main方法就是发动机,是否存在一辆车,没有发动机也可以跑呢?——火车车厢,只有火车头上面有发动机,后面的车厢都是不需要的,车头拉着跑就行了。

我们servlet的代码中没有写main方法,但是也是执行的,是因为我们的程序不是直接执行的,而是在tomcat上运行的,tomcat这个程序里面有main方法,tomcat是火车头,写的webapp就是车厢。

继承HttpServlet这个类,重写里面的方法,目的就是为了把咱们自己定义的代码,插入到“tomcat”中。

在tomcat中,就有形如以下这样的代码:

  • 先通过tcp socket读取请求,http也是基于tcp的 String requestString=readRequest();
  • 然后解析这个请求 HttpServletRequest req=parse(requestString)
  • 构造空的响应对象HttpServletResponse resp=new HttpServletResponse();
  • 创建一个HttpServlet对象 HttpServlet s=new HelloServlet(); s.doGet(req,resp);
  • 把得到的响应返回给浏览器
  • 。。。。。。

tomcat能够自动的new出一个咱们写的子类。执行到s.doGet(req,resp),就相当于把上述代码嵌套到tomcat代码中了。

相当于在处理一次请求的过程中,tomcat完成了99%的工作,剩余的1%由咱们写的代码来完成,(99%的工作是通用的公共的工作,剩下的1%是结合具体的业务,具有差异化的工作)。为了解决不同的业务场景,使用tomcat写网站,不同网站,涉及的业务是不同的。

我们写网站的时候,1.接收前端传来的http请求,并解析。2.根据http请求计算出一个http响应。3.把http响应返回到浏览器这边。  


🚩Servlet API 详解

🎓HttpServlet核心方法

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

  • 方法名称:init     调用时机:在HttpServlet实例化之后被调用一次   (完成初始化操作)
  • 方法名称:destroy     调用时机:在HttpServlet实例不再使用的时候调用一次(用来释放资源)
  • 方法名称:service     每次收到http请求,就会自动执行的方法,处理请求,计算响应(服务器的主逻辑)
  • 方法名称:doGet       收到GET请求的时候调用(由service方法调用)
  • 方法名称:doPost      收到POST请求的时候调用(由service方法调用)
  • 方法名称:doPut/doDelete/doOptions/.....  收到其他请求的时候调用(由service方法调用)

这几个方法,都是可以在子类中重写的。在子类重写这些方法之后,这些方法也都是不需要咱们手动调用的,都是tomcat在合适的时机自行调用。

如果不重写service,在父类(HttpServlet中),自己的service,就会根据请求的方法,来分别调用下面的doGet,doPost,doPut....

  • init
  • destroy
  • service   这三个方法是根据servlet的生命周期来进行的。

所谓生命周期 就是 什么时间点做什么事情。

我们在幼年/青年阶段我们需要学习,成年的时候我们需要工作,老年的时候我们需要养老和退休休息(当我们在执行servlet的时候,我们会根据特定的时间使用上述方法,如果在初始化的时候用init,在释放资源的时候我们用destroy,在收到http请求的时候我们用service方法。)

一个servlet不用了,说明tomcat要关闭了。

tomcat关闭有两种方式:

  • 1.直接干掉tomcat进程(比如直接在任务管理器中结束进程,或者直接点x)这时候我们完全用不到destroy方法
  • 2.通过8005管理端口,给tomcat发送一个“停机”指令,这个时候是能够执行destroy的。 

以往写的代码,都是自己定义方法,自己来调用,或者是直接调用别人定义好的方法。

从今往后,经常会涉及到咱们自己写好的代码,让别人帮咱们调用。所谓“框架”就是如此~~

一个程序的主体部分,都已经被其他大佬们写完了,有些细节内容,允许咱们插入咱们自己写的自定义的逻辑。

一台电脑整体的框架:cpu,主板,内存,硬盘,散热器,电源,机箱,显卡。大的框架确定,还可以有一些自定义的空间。

为什么写代码的时候,要使用框架呢?使用框架,就是不让我们随便写代码。就是限制程序员的自由,不能让程序员代码胡写。“设计模式”属于一种“软性的限制”,“使用框架”属于一种“硬性的限制”,所以框架就出现了。

使用postman,发起一个post请求,让我们看看效果。理解前端和后端之间的交互的对应关系,是一个很重要的事情,也是进入web开发的入门难点。


🎓HttpServletRequest核心方法

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

表示了一个HTTP请求。

类似于,第一行我们需要得到版本号,第二行我们需要知道uri......

方法 描述
  • String getProtocol() 返回请求协议的名称和版本。
  • String getMethod() 返回请求的 HTTP 方法的名称,例如,GETPOST PUT
  • String getRequestURI() 从协议名称直到 HTTP 请求的第一行的查询字符串中,返回该请求的 URL 的一部分。
  • String getContextPath() 返回指示请求上下文的请求 URI 部分。
  • String getQueryString() 返回包含在路径后的请求 URL 中的查询字符串。

  • Enumeration getParameterNames() 返回一个 String 对象的枚举,包含在该请求中包含的参数的名称。
  • String getParameter(String name) 以字符串形式返回请求参数的值,或者如果参数不存在则返回 null。
  • String[] getParameterValues(String name) 返回一个字符串对象的数组,包含所有给定的请求参数的值,如果参数不存在则返回 null。key存在重复的请求一个key有多个值?a=10&a=20;

query String本质上是键值对,一般都是根据key获取value,很少把queryString作为整体来使用。

  • Enumeration getHeaderNames() 返回一个枚举,包含在该请求中包含的所有的头名。
  • String getHeader(String name) 以字符串形式返回指定的请求头的值。

上述两个方法http请求header部分,也是键值对,也需要根据key获取到value

  • String getCharacterEncoding() 返回请求主体中使用的字符编码的名称。
  • String getContentType() 返回请求主体的 MIME 类型,如果不知道类型则返回 null
  • int getContentLength() 以字节为单位返回请求主体的长度,并提供输入流,或者如果长 度未知则返回 -1

上述三个方法,都是对getHeader进行了简单的封装。?a=10&b=20&c=30 query string更多的是希望能够知道a是几,b是几,c是几.

  • InputStream getInputStream() 用于读取请求的 body 内容. 返回一个 InputStream 对象

通过这个方法,得到一个流对象,读取这个对象,救恩那个得到整个请求的body。(很多时候,在代码中表示一个“不定长”的数据的时候,经常就会想到使用“流对象”)使用流对象,就允许咱们不必一次性处理完,一次处理一点,也可以一次全都处理,更好的兼容二进制数据。

上述介绍的方法,都是get系列的方法(都是读方法),没有set系列(没有写方法)。当前拿到的HttpServletRequest,这里的数据都是来自于客户端发来的,这些数据的内容已经确定下来了,程序员是不需要更改的。

🎈核心方法的使用

调用api,把得到的结果构造成一个字符串,同意返回给客户端。
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Enumeration;

@WebServlet("/show")
public class ShowRequestServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //调用api,把得到的结果构造成一个字符串,统一返回给客户端
        StringBuilder stringBuilder=new StringBuilder();
        stringBuilder.append(req.getProtocol());//得到版本号
        stringBuilder.append("<br>");
        stringBuilder.append(req.getMethod());//获取方法 get还是post还是delete
        stringBuilder.append("<br>");
        stringBuilder.append(req.getRequestURI());//地址
        stringBuilder.append("<br>");
        stringBuilder.append(req.getContextPath());//上下文路径
        stringBuilder.append("<br>");
        stringBuilder.append(req.getQueryString());//请求字符串
        stringBuilder.append("<br>");

        //获取所有的header
        Enumeration<String> headerName=req.getHeaderNames();//头部信息
        while (headerName.hasMoreElements()){
            String key=headerName.nextElement();
            String value=req.getHeader(key);
            stringBuilder.append(key+":"+"  "+value);
            stringBuilder.append("<br>");

        }
        //告诉浏览器,咱们的数据返回的是什么类型,任何一次服务器返回,都要做的事情
        resp.setContentType("text/html; charset=utf8");
        //把上述内容整体返回到客户端这边
        resp.getWriter().write(stringBuilder.toString());
    }
}

🔴获取请求中的参数
💻query string

在服务器这边获取到请求中的参数(Query String)

query string中的键值对,都是程序员自定义的,实际开发中都会非常广泛的使用到query string这样的机制。

请求就是相当于输入网址,后面写上 ?username=zyf&password=0528 那么就获取,然后打印出来,如果输入的地址(请求)没有username和passeord那么就是null
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

//从query string中获取用户名和密码
@WebServlet("/getParameter")
public class QueryStringGetParameterServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //此处约定,请求中给定的query string 是形如:username=zyf&password=0528
        //上述query string就会被tomcat给自动解析成一个Map结构
        //getParameter就会在map中查找
        //请求就是相当于输入网址,后面写上 ?username=zyf&password=0528 那么就获取,然后打印出来,如果输入的地址(请求)没有username和passeord那么就是null
        String username=req.getParameter("username");
        String password=req.getParameter("password");
        //对两者内容,进行处理,这里就是简单的打印出来
        System.out.println("username="+username);
        System.out.println("password="+password);
        resp.getWriter().write("ok");
    }
}

如果请求中没有加上query string,此时得到的结果是null null


💻直接通过form表单

body的格式就是query string格式,Content-Type:application/x-www-form-urlencoded

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/postParameter")
public class FormPostParameterServlet extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //约定 前端形如这样的请求:
        //POST: /postParameter
        //Content-Type: x-www-form-urlencoded

        //username=zyf&password=528
        //就需要在后端代码中,把body中的 值 给拿到,获取值的方法还是getParameter
        String username=req.getParameter("username");
        String password=req.getParameter("password");
        System.out.println("username="+username);
        System.out.println("password="+password);
        resp.getWriter().write("ok");
    }
}


💻json
        请求格式如下req(json字符串)——>得到Request对象
        Post /json
        Content-type: application/json
        {
           username:zhangsan",
           password:"123"


        }  此处约定响应的格式(也按照json来组织;
        {
          ok:true
        }

body的格式是json,Content-Type:application/json

json本质上也是键值对,规则和form表单截然不同,解析方式自然也变了,由于json支持“嵌套”,因此自己手写解析json的代码,并不容易。


用json处理请求中的参数,有些麻烦。

  • 1.下载导入jackson到项目中,通过maven

  • 2.使用jackson,一个类两个方法

ObjectMapper

把json字符串,映射成一个java对象——readValue

把一个java对象,映射成json字符串——writeValueAsString

网络传输,使用json字符串,java代码中各种逻辑,java对象。

站在服务器的角度,收到的请求,就是json字符串,就需要把json字符串,先映射到java对象中,再进行一系列的业务逻辑处理。

处理完了之后,可能还需要把得到的java对象,映射回json字符串,并且通过响应来返回。


把json字符串,映射成一个java对象——readValue

jackson从json字符串映射到java对象的过程:

  • 1.参数就是json字符串(json字符串是在http的body中的,就需要通过HttpServletRequest中的getInputStream来获取到)此处把这个流对象,直接传给readValue,readValue内部就会读取到InputStram中的所有数据(http请求的body,上面的json字符串)
  • 2.按照json的格式,进行解析,把json字符串,解析成Map(键值对)
  • 3.把Map转换成java对象,在方法的第二个参数,传入了Request.class告诉readValue方法内部,要把当前Map转成啥样的java对象。readValue内部,就可以通过反射api,创建出Request.class实例,并且,根据Request.class提供的属性的名字,来查询上述Map,把得到的结果,赋值给对应的属性。

举个例子:当前Request.class中就知道了,Request两个属性,分别叫做username和password。

拿到username去刚才的Map里查询~~查到的结果叫做cl,于是把cl赋值给username

拿着password去刚才的Map里查询~查到的结果叫做1005,于是把1005赋值给password属性

最终就得到了一个完整的Request对象,username就是cl,password是1005


把一个java对象,映射成json字符串——writeValueAsString

这个代码就是readValue的反向操作能把java对象映射成json字符串。writeValueAsString

  • 1.通过传入的参数,获取到类对象,通过反射拿到哪些属性,就有一个属性 ok
  • 2.根据属性的名字拿到属性的值 拿到了值 true
  • 3.把上述 属性名字 和 属性值 按照json格式构造成字符串就是返回值 形如"{ok:true}"

postman对于json格式要求比较严格,key必须加上引号(但是比如前端的ajax这里就可以不加引号)


🎓HttpServletResponse核心方法

类似于这种响应报文。

方法 描述
  • 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 中写入文本格式数据.
  • OutputStream getOutputStream() 用于往 body 中写入二进制格式数据.

🎈setStatus(设置状态码)

@WebServlet("/status")
public class StatusServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //不显示设置。默认是200
       // resp.setStatus(404);
        resp.sendError(404,"这个页面是个错误的页面");
    }
}

🎈sendError发送错误码同时提示信息


🎈setHeader刷新浏览器时间戳


通过setHeader给响应中设置一些特殊的header,比如,可以设置refresh:1,让浏览器,每秒钟自动刷新一次。

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebServlet("/refresh")
public class RefreshServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //通过setHeader给响应设置一些特殊的header
        //refresh使浏览器每隔xs都刷新一次
        resp.setHeader("refresh","1");
        resp.getWriter().write(" "+System.currentTimeMillis());//时间戳(当前时间)
    }
}

虽然是每秒刷新一次,但是也不是精准的1000ms,略多一点,浏览器发请求,到服务器返回响应,也需要时间。


🎈setHeader和sendRedirect构造重定向响应

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/Redirect")
public class RedirectServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //1.设置状态码302(重定向)
        //2.header里面设置一个属性location描述跳转到哪个页面中去
//        resp.setStatus(302);
      // resp.setHeader("Location","https://www.baidu.com");
        resp.sendRedirect("https://www.baidu.com");
    }
}
  • 重定向状态码是3xx(比如302)
  • header需要有一个Location属性,描述要跳转到哪里
resp.setHeader("Location","https://www.baidu.com");
  • 直接跳转到所写字符串ip地址
resp.sendRedirect("https://www.baidu.com");


知不足而奋进,望远山而前行。


网站公告

今日签到

点亮在社区的每一天
去签到