从零手写实现 tomcat-05-servlet 处理支持

创作缘由

平时使用 tomcat 等 web 服务器不可谓不多，但是不停一知半解。
于是想着本身实现一个简单版本，学习一下 tomcat 的精华。
系列教程

从零手写实现 apache Tomcat-01-入门先容
从零手写实现 apache Tomcat-02-web.xml 入门详细先容
从零手写实现 tomcat-03-根本的 socket 实现
从零手写实现 tomcat-04-哀求和相应的抽象
从零手写实现 tomcat-05-servlet 处理支持
从零手写实现 tomcat-06-servlet bio/thread/nio/netty 池化处理
从零手写实现 tomcat-07-war 如何解析处理三方的 war 包？
从零手写实现 tomcat-08-tomcat 如何与 springboot 集成？
从零手写实现 tomcat-09-servlet 处理类
从零手写实现 tomcat-10-static resource 静态资源文件
从零手写实现 tomcat-11-filter 过滤器
从零手写实现 tomcat-12-listener 监听器
团体思绪

模仿实现 servlet 的逻辑处理，而不是局限于上一节的静态文件资源。
团体流程

1）界说 servlet 标准的 接口+实现
2）解析 web.xml 获取对应的 servlet 实例与 url 之间的映射关系。
3）调用哀求
1. servlet 实现

api 接口

servlet 接口，我们直接引入 servlet-api 的标准。

1. <dependency>
2.     <groupId>javax.servlet</groupId>
3.     <artifactId>javax.servlet-api</artifactId>
4.     <version>${javax.servlet.version}</version>
5. </dependency>

复制代码

抽象 servlet 界说

1. package com.github.houbb.minicat.support.servlet;
3. import com.github.houbb.minicat.constant.HttpMethodType;
5. import javax.servlet.ServletException;
6. import javax.servlet.ServletRequest;
7. import javax.servlet.ServletResponse;
8. import javax.servlet.http.HttpServlet;
9. import javax.servlet.http.HttpServletRequest;
10. import javax.servlet.http.HttpServletResponse;
11. import java.io.IOException;
13. public abstract class AbstractMiniCatHttpServlet extends HttpServlet {
15.     public abstract void doGet(HttpServletRequest request, HttpServletResponse response);
17.     public abstract void doPost(HttpServletRequest request, HttpServletResponse response);
19.     @Override
20.     public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {
21.         HttpServletRequest httpServletRequest = (HttpServletRequest) req;
22.         HttpServletResponse httpServletResponse = (HttpServletResponse) res;
23.         if(HttpMethodType.GET.getCode().equalsIgnoreCase(httpServletRequest.getMethod())) {
24.             this.doGet(httpServletRequest, httpServletResponse);
25.             return;
26.         }
28.         this.doPost(httpServletRequest, httpServletResponse);
29.     }
31. }

复制代码

根据哀求方式分别处理
简单的实现例子

下面是一个简单的处理实现：

• MyMiniCatHttpServlet.java
  

1. package com.github.houbb.minicat.support.servlet;
3. import com.github.houbb.log.integration.core.Log;
4. import com.github.houbb.log.integration.core.LogFactory;
5. import com.github.houbb.minicat.dto.MiniCatResponse;
6. import com.github.houbb.minicat.util.InnerHttpUtil;
8. import javax.servlet.http.HttpServletRequest;
9. import javax.servlet.http.HttpServletResponse;
11. /**
12. * 仅用于测试
13. *
14. * @since 0.3.0
15. */
16. public class MyMiniCatHttpServlet extends AbstractMiniCatHttpServlet {
18.     private static final Log logger = LogFactory.getLog(MyMiniCatHttpServlet.class);
20.     @Override
21.     public void doGet(HttpServletRequest request, HttpServletResponse response) {
22.         String content = "MyMiniCatServlet-get";
24.         MiniCatResponse miniCatResponse = (MiniCatResponse) response;
25.         miniCatResponse.write(InnerHttpUtil.http200Resp(content));
26.     }
28.     @Override
29.     public void doPost(HttpServletRequest request, HttpServletResponse response) {
30.         String content = "MyMiniCatServlet-post";
32.         MiniCatResponse miniCatResponse = (MiniCatResponse) response;
33.         miniCatResponse.write(InnerHttpUtil.http200Resp(content));
34.     }
36. }

复制代码

2. web.xml 解析

阐明

web.xml 需要解析处理。
比如这样的：

1. <?xml version="1.0" encoding="UTF-8" ?>
2. <web-app>
4.     <servlet>
5.         <servlet-name>my</servlet-name>
6.         <servlet-class>com.github.houbb.minicat.support.servlet.MyMiniCatHttpServlet</servlet-class>
7.     </servlet>
9.     <servlet-mapping>
10.         <servlet-name>my</servlet-name>
11.         <url-pattern>/my</url-pattern>
12.     </servlet-mapping>
14. </web-app>

复制代码

解析方式

接口界说

1. package com.github.houbb.minicat.support.servlet;
3. import javax.servlet.Servlet;
4. import javax.servlet.http.HttpServlet;
6. /**
7. * servlet 管理
8. *
9. * @since 0.3.0
10. */
11. public interface IServletManager {
13.     /**
14.      * 注册 servlet
15.      *
16.      * @param url     url
17.      * @param servlet servlet
18.      */
19.     void register(String url, HttpServlet servlet);
21.     /**
22.      * 获取 servlet
23.      *
24.      * @param url url
25.      * @return servlet
26.      */
27.     HttpServlet getServlet(String url);
29. }

复制代码

web.xml

web.xml 的解析方式，核心的处理方式:

1.     //1. 解析 web.xml
2.     //2. 读取对应的 servlet mapping
3.     //3. 保存对应的 url + servlet 示例到 servletMap
4.     private void loadFromWebXml() {
5.         InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream("web.xml");
6.         SAXReader saxReader = new SAXReader();
7.         try {
8.             Document document = saxReader.read(resourceAsStream);
9.             Element rootElement = document.getRootElement();
11.             List<Element> selectNodes = rootElement.selectNodes("//servlet");
12.             //1, 找到所有的servlet标签，找到servlet-name和servlet-class
13.             //2, 根据servlet-name找到<servlet-mapping>中与其匹配的<url-pattern>
14.             for (Element element : selectNodes) {
15.                 /**
16.                  * 1, 找到所有的servlet标签，找到servlet-name和servlet-class
17.                  */
18.                 Element servletNameElement = (Element) element.selectSingleNode("servlet-name");
19.                 String servletName = servletNameElement.getStringValue();
20.                 Element servletClassElement = (Element) element.selectSingleNode("servlet-class");
21.                 String servletClass = servletClassElement.getStringValue();
23.                 /**
24.                  * 2, 根据servlet-name找到<servlet-mapping>中与其匹配的<url-pattern>
25.                  */
26.                 //Xpath表达式：从/web-app/servlet-mapping下查询，查询出servlet-name=servletName的元素
27.                 Element servletMapping = (Element) rootElement.selectSingleNode("/web-app/servlet-mapping[servlet-name='" + servletName + "']'");
29.                 String urlPattern = servletMapping.selectSingleNode("url-pattern").getStringValue();
30.                 HttpServlet httpServlet = (HttpServlet) Class.forName(servletClass).newInstance();
32.                 this.register(urlPattern, httpServlet);
33.             }
35.         } catch (Exception e) {
36.             logger.error("[MiniCat] read web.xml failed", e);
38.             throw new MiniCatException(e);
39.         }
40.     }

复制代码

解析之后的 HttpServlet 全部放在 servletMap 中。
然后在对应的 url 我们选取处理即可。
3. url 的处理

阐明

根据 url 找到对应的 servlet 进行处理。
主要分为 3 大类：
1）url 不存在
2）url 为 html 等静态资源

• servlet 的处理逻辑
  

设计

我们把这部门抽象为接口：

1. public void dispatch(RequestDispatcherContext context) {
2.     final MiniCatRequest request = context.getRequest();
3.     final MiniCatResponse response = context.getResponse();
4.     final IServletManager servletManager = context.getServletManager();
5.     // 判断文件是否存在
6.     String requestUrl = request.getUrl();
7.     if (StringUtil.isEmpty(requestUrl)) {
8.         emptyRequestDispatcher.dispatch(context);
9.     } else {
10.         // 静态资源
11.         if (requestUrl.endsWith(".html")) {
12.             staticHtmlRequestDispatcher.dispatch(context);
13.         } else {
14.             // servlet
15.             servletRequestDispatcher.dispatch(context);
16.         }
17.     }
18. }

复制代码

servlet 例子

如果是 servlet 的话，核心处理逻辑如下：

1. // 直接和 servlet 映射
2. final String requestUrl = request.getUrl();
3. HttpServlet httpServlet = servletManager.getServlet(requestUrl);
4. if(httpServlet == null) {
5.     logger.warn("[MiniCat] requestUrl={} mapping not found", requestUrl);
6.     response.write(InnerHttpUtil.http404Resp());
7. } else {
8.     // 正常的逻辑处理
9.     try {
10.         httpServlet.service(request, response);
11.     } catch (Exception e) {
12.         logger.error("[MiniCat] http servlet handle meet ex", e);
13.         throw new MiniCatException(e);
14.     }
15. }

复制代码

4. 读取 request 的问题修复

问题

发现 request 读取输入流的时候，有时候读取为空，但是页面明明是正常哀求的。
原始代码

1. private void readFromStream() {
2.     try {
3.         //从输入流中获取请求信息
4.         int count = inputStream.available();
5.         byte[] bytes = new byte[count];
6.         int readResult = inputStream.read(bytes);
7.         String inputsStr = new String(bytes);
8.         logger.info("[MiniCat] readCount={}, input stream {}", readResult, inputsStr);
9.         if(readResult <= 0) {
10.             logger.info("[MiniCat] readCount is empty, ignore handle.");
11.             return;
12.         }
13.         //获取第一行数据
14.         String firstLineStr = inputsStr.split("\\n")[0];  //GET / HTTP/1.1
15.         String[] strings = firstLineStr.split(" ");
16.         this.method = strings[0];
17.         this.url = strings[1];
18.         logger.info("[MiniCat] method={}, url={}", method, url);
19.     } catch (IOException e) {
20.         logger.error("[MiniCat] readFromStream meet ex", e);
21.         throw new RuntimeException(e);
22.     }
23. }

复制代码

mini-cat 是简易版本的 tomcat 实现。别称【嗅虎】(心有猛虎，轻嗅蔷薇。)
开源地址：https://github.com/houbb/minicat

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。