一個(gè)簡(jiǎn)單的servlet容器代碼設(shè)計(jì)

Servlet算是Java Web開發(fā)請(qǐng)求鏈路調(diào)用棧中底層的一個(gè)技術(shù)，當(dāng)客戶端發(fā)起一個(gè)請(qǐng)求后，到達(dá)服務(wù)器內(nèi)部，就會(huì)先進(jìn)入Servlet（這里不討論更底層的鏈路），SpringMVC的請(qǐng)求分發(fā)核心也是一個(gè)Servlet，名叫DispatcherServlet，一個(gè)請(qǐng)求首先會(huì)進(jìn)入到這個(gè)Servlet，然后在通過(guò)SpringMVC的機(jī)制去分發(fā)到對(duì)應(yīng)的Controller下。

但是再往上一層說(shuō)，普通的開發(fā)人員可能不會(huì)關(guān)心Servlet是怎么被調(diào)用的，我們只要寫一個(gè)@WebServlet注解在Servlet的類上，運(yùn)行后，客戶端的請(qǐng)求就會(huì)自動(dòng)進(jìn)入到相應(yīng)的Servlet中，而做這些事的叫Servlet容器，Servlet容器一定是一個(gè)Web服務(wù)器，但Web服務(wù)器反過(guò)來(lái)可不一定是Servlet容器哦。

而了解一個(gè)Servlet容器的實(shí)現(xiàn)有助于更好的理解JavaWeb開發(fā)。

Github地址

項(xiàng)目最后的實(shí)現(xiàn)在Github上可以查看到

https://github.com/houxinlin/jerrycat

容器的實(shí)現(xiàn)

在JavaWeb的開發(fā)世界，有很多都要遵守規(guī)范，JDBC也是，Servlet容器也是，Java很多不去做實(shí)現(xiàn)，只做接口，具體的實(shí)現(xiàn)留給各大廠商去做，而Servlet容器其中一個(gè)實(shí)現(xiàn)就是Tomcat。

Tomcat的實(shí)現(xiàn)還是很復(fù)雜的，這里也不做研究，我們只搞清楚一個(gè)小型的Servlet容器實(shí)現(xiàn)的步驟即可。

我們起一個(gè)容器名，叫JerryCat吧，他的實(shí)現(xiàn)功能只有一個(gè)，將請(qǐng)求交給對(duì)應(yīng)的Servlet，并將其處理結(jié)果返回給客戶端，因?yàn)檫@才是核心，而實(shí)現(xiàn)他的具體步驟如下。

• 解壓war文件
• 收集Servlet信息
• 啟動(dòng)web服務(wù)器
• 請(qǐng)求映射 & 返回結(jié)果

解壓war文件

當(dāng)你在Tomcat的webapps目錄下放入一個(gè)war文件，啟動(dòng)tomcat后，tomcat會(huì)自動(dòng)把這個(gè)war文件解壓了，后續(xù)所有的操作將會(huì)針對(duì)這個(gè)解壓后的目錄，而解壓一個(gè)war文件很簡(jiǎn)單，代碼如下。

 
public static void unzipWar(String warFilePath, String outputFolder) throws IOException {
    byte[] buffer = new byte[1024];
    try (ZipInputStream zis = new ZipInputStream(Files.newInputStream(Paths.get(warFilePath)))) {
        ZipEntry zipEntry;
        while ((zipEntry = zis.getNextEntry()) != null) {
            String entryName = zipEntry.getName();
            File newFile = new File(outputFolder + File.separator + entryName);
            if (zipEntry.isDirectory()) {
                newFile.mkdirs();
            } else {
                new File(newFile.getParent()).mkdirs();
                try (FileOutputStream fos = new FileOutputStream(newFile)) {
                    int len;
                    while ((len = zis.read(buffer)) > 0) {
                        fos.write(buffer, 0, len);
                    }
                }
            }
            zis.closeEntry();
        }
    }
}

收集Servlet信息

這一步是一個(gè)核心，因?yàn)镾ervlet容器一定要知道一個(gè)war項(xiàng)目中所有的Servlet信息，也就是要知道開發(fā)人員定義的請(qǐng)求路徑和具體Servlet的映射關(guān)系，當(dāng)請(qǐng)求進(jìn)來(lái)的時(shí)候，才能根據(jù)這個(gè)映射關(guān)系調(diào)用到對(duì)應(yīng)的Servlet下。

在Servlet 3.0規(guī)范以前，所有的映射關(guān)系需要在web.xml中去配置，比如下面這樣，這個(gè)配置用來(lái)告訴容器將/hello的請(qǐng)求映射到com.example.HelloServlet下，容器只需要讀取一個(gè)配置即可。

<servlet>
    <servlet-name>HelloServlet</servlet-name>
    <servlet-class>com.example.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>HelloServlet</servlet-name>
    <url-pattern>/hello</url-pattern>
</servlet-mapping>

但是自從規(guī)范3.0開始，增加了@WebServlet等注解，如下，這也是告訴容器，這個(gè)類的請(qǐng)求路徑是/hello。

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {}

那么容器的實(shí)現(xiàn)就會(huì)增加負(fù)擔(dān)，因?yàn)橐闅v所有的class，找出標(biāo)有@WebServlet的類，并做收集，那問(wèn)題是怎么找到這些符合的類呢？ 首先不能通過(guò)反射，因?yàn)橛袃蓚€(gè)問(wèn)題。

第一個(gè)問(wèn)題是類加載器的問(wèn)題(這里假設(shè)你已經(jīng)了解了類加載器的概念)，因?yàn)槿萜鞯念惣虞d器是不能加載war項(xiàng)目中的class的，即使能加載，你要通過(guò)Class.forName()去加載類時(shí)，在這個(gè)收集信息階段，容器是不可能知道有那些類名稱的，雖然可以通過(guò)在web.xml直接告訴容器，但說(shuō)回來(lái)，嘗試Class.forName()時(shí)會(huì)拋出ClassNotFoundException，而真正的容器實(shí)現(xiàn)都會(huì)自定義一個(gè)ClassLoader，專門去加載項(xiàng)目的class和資源。

那么就算有了自定義的ClassLoader，可以加載到項(xiàng)目的class，那么Class.forName會(huì)觸發(fā)static代碼塊，如果項(xiàng)目中的Servlet正好寫了static代碼快，則會(huì)調(diào)用，雖然最終這個(gè)代碼塊都會(huì)被調(diào)用，但不應(yīng)該在這個(gè)時(shí)候，會(huì)出一些問(wèn)題。

而正確的做法是直接讀取二進(jìn)制class文件，從class文件規(guī)范中找到這個(gè)class是不是有@WebServlet注解，這是唯一的辦法，Spring掃描注解的時(shí)候也是這樣做的，而Tomcat也是這樣，Tomcat解析class文件的類可以點(diǎn)擊我查看。

Tomcat是純自己手?jǐn)]出一個(gè)解析器，如果熟悉class文件格式后，還是比較容易的，所以這里我們依靠一個(gè)框架，比如用org.ow2.asm這個(gè)庫(kù)，額外的知識(shí)：Spring也是靠第三方庫(kù)來(lái)讀取的。

具體例子如下

private void collectorServlet() {
    try {
        final Set<String> classFileSet = new HashSet<>();
        Files.walkFileTree(Paths.get(this.webProjectPath, WEB_CLASSES_PATH), new SimpleFileVisitor<Path>() {
            @Override
            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                if (file.toString().endsWith(".class")) classFileSet.add(file.toString());
                return super.visitFile(file, attrs);
            }
        });
        ClassNode classNode = new ClassNode();
        for (String classFile : classFileSet) {
            ClassReader classReader = new ClassReader(Files.newInputStream(Paths.get(classFile)));
            classReader.accept(classNode, ClassReader.EXPAND_FRAMES);
            List<AnnotationNode> visibleAnnotations = classNode.visibleAnnotations;
            for (AnnotationNode visibleAnnotation : visibleAnnotations) {
                if ("Ljavax/servlet/annotation/WebServlet;".equalsIgnoreCase(visibleAnnotation.desc)) {
                    Map<String, Object> annotationValues = ClassUtils.getAnnotationValues(visibleAnnotation.values);
                    Object o = loaderClass(classReader.getClassName());
                    servletMap.put(annotationValues.get("value").toString(), ((HttpServlet) o));
                }
            }
        }
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}
    private Object loaderClass(String name) {
        try {
            Class<?> aClass = appClassloader.loadClass(name);
            return aClass.newInstance();
        } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }

主要就是遍歷/WEB-INF/classes/目錄，使用ClassReader類解析這個(gè)class文件，并判斷是不是標(biāo)有WebServlet注解，如果存在，則通過(guò)自定義的類加載器加載并實(shí)例化他，而這個(gè)類加載器主要作用就是根據(jù)給定的類名，從/WEB-INF/classes/加載類，如果給定的類不存在，則交給父類加載器。

但向Tomcat都有一些公共的類區(qū)域，可以把所有項(xiàng)目所用到的共同庫(kù)提取出來(lái)，放到一個(gè)目錄下，另外war規(guī)范中，/WEB-INF/lib目錄用來(lái)存放第三方的jar文件庫(kù)，類加載器也需要考慮這個(gè)目錄。

那么這個(gè)類加載器加載路徑依次如下：

• /WEB-INF/classes/目錄
• /WEB-INF/lib目錄
• 公共區(qū)域
• 父類加載器

如果最后一個(gè)也加載不到，則拋出異常，擁有一個(gè)公共區(qū)域其實(shí)是很有必要的，通常來(lái)說(shuō)我們都會(huì)依賴大量的第三方庫(kù)，可能自己的代碼和資源都不到10M，但是大量的第三方庫(kù)可能占到上百M(fèi)，部署傳輸起來(lái)可能不方便，正確的做法應(yīng)該是把用到的第三方庫(kù)一次性上傳到公共區(qū)域，部署時(shí)只傳自己的代碼。

并且類加載器還需要重寫getResource、getResourceAsStream等這些方法用來(lái)在項(xiàng)目的類路徑下查找資源。

啟動(dòng)web服務(wù)器

上面說(shuō)到，Servlet容器也是一個(gè)Web服務(wù)器，只有啟動(dòng)一個(gè)Web服務(wù)器后，收到請(qǐng)求，才能傳遞給Servlet，并且，他還能處理靜態(tài)資源，實(shí)現(xiàn)一個(gè)Web服務(wù)器重要的是解析HTTP報(bào)文，并且根據(jù)響應(yīng)結(jié)果生成HTTP報(bào)文。

這部分我們可以使用一個(gè)Java提供的現(xiàn)成庫(kù)，如下。

HttpServer httpServer = HttpServer.create(new InetSocketAddress(4040), 10);

• HttpServer：是Java中用于創(chuàng)建HTTP服務(wù)器的類。它是Java SE 6引入的，用于支持簡(jiǎn)單的HTTP服務(wù)端功能。
• HttpServer.create：用于創(chuàng)建一個(gè)新的HTTP服務(wù)器實(shí)例。
• new InetSocketAddress(4040)：InetSocketAddress表示IP地址和端口號(hào)的類。這里的4040是端口號(hào)，表示HTTP服務(wù)器將在本地計(jì)算機(jī)的4040端口上監(jiān)聽傳入的HTTP請(qǐng)求。
• 10：這是服務(wù)器的等待隊(duì)列的最大長(zhǎng)度。當(dāng)HTTP服務(wù)器在處理傳入的請(qǐng)求時(shí)，如果同時(shí)有更多請(qǐng)求到達(dá)，它們將被放入等待隊(duì)列。這里的10表示等待隊(duì)列的最大長(zhǎng)度為10，即最多允許同時(shí)有10個(gè)請(qǐng)求在等待處理。

請(qǐng)求映射 & 返回結(jié)果

這里有一點(diǎn)比較麻煩，我們知道doGet和doPost的參數(shù)是HttpServletRequest、HttpServletResponse，容器需要實(shí)現(xiàn)這兩個(gè)接口，提供請(qǐng)求參數(shù)，這里我們偷個(gè)懶，使用mockito這個(gè)庫(kù)來(lái)構(gòu)造一個(gè)請(qǐng)求。

下面代碼中，createContext用來(lái)監(jiān)聽某個(gè)請(qǐng)求路徑，當(dāng)有請(qǐng)求過(guò)來(lái)時(shí)，HttpServer會(huì)把請(qǐng)求對(duì)象封裝為HttpExchange，而我們做的事是把他轉(zhuǎn)換為HttpServletRequest。

當(dāng)調(diào)用service時(shí)，javax.servlet.http.HttpServlet會(huì)自動(dòng)根據(jù)請(qǐng)求訪問(wèn)，調(diào)用doGet或者是doPost等。

try {
    HttpServer httpServer = HttpServer.create(new InetSocketAddress(4040), 10);
    httpServer.createContext("/", httpExchange -> {
        Servlet servlet = servletMap.get(httpExchange.getRequestURI().toString());
        JerryCatHttpServletResponse httpServletResponse = new JerryCatHttpServletResponse(Mockito.mock(HttpServletResponse.class));
        HttpServletRequest httpServletRequest = createHttpServletRequest(httpExchange);
        if (servlet != null) {
            try {
                servlet.service(httpServletRequest, httpServletResponse);
                byte[] responseByte = httpServletResponse.getResponseByte();
                httpExchange.sendResponseHeaders(200, responseByte.length);
                httpExchange.getResponseBody().write(responseByte);
                httpExchange.getResponseBody().flush();
            } catch (ServletException e) {
                e.printStackTrace();
            }
        }
    });
    httpServer.start();
} catch (IOException e) {
    throw new RuntimeException(e);
}

到這里就結(jié)束容器的任務(wù)了，只需要等待Servlet處理完成，將結(jié)果返回給客戶端即可。

但這里，請(qǐng)求映射顯的有點(diǎn)簡(jiǎn)單，因?yàn)槲覀兩倭颂幚硗ㄅ浞那闆r。

其余規(guī)范

其他特性我們不說(shuō)，但屬于Servlet規(guī)范的容器一定要實(shí)現(xiàn)，其余規(guī)范還有如ServletContainerInitializer、Filter等這里我們都沒有實(shí)現(xiàn)，ServletContainerInitializer是一個(gè)很有用的東西，SpringBoot打包成war后，就依靠它去啟動(dòng)。

Filter同樣的做法，也是通過(guò)ClassReader讀取，在調(diào)用service前一步，先調(diào)用Filter。

結(jié)束

這里只實(shí)現(xiàn)了一個(gè)容器的雛形中的核心，一個(gè)完整的容器，至少要做到提供完整的HttpServletRequest的實(shí)現(xiàn)，還有HttpServletResponse，這里只做演示，沒有做太多處理，比如最重要的Cookie管理、Session管理，否則應(yīng)用程序就無(wú)法實(shí)現(xiàn)用戶登錄狀態(tài)維護(hù)。

HttpServletRequest是繼承ServletRequest的，他們定義的方法加起來(lái)共有70多個(gè)，需要一一去實(shí)現(xiàn)，才能給用戶提供一個(gè)完整的請(qǐng)求信息供給，否則用戶想拿一個(gè)請(qǐng)求頭都拿不到，也沒辦法繼續(xù)開發(fā)。

有完整的信息提供后，就可以做額外的功能開發(fā)了，比如WebSocket，當(dāng)請(qǐng)求過(guò)來(lái)時(shí)候，發(fā)現(xiàn)是一個(gè)WebSocket握手請(qǐng)求，那么相應(yīng)的要做一個(gè)協(xié)議升級(jí)，轉(zhuǎn)換為WebSocket協(xié)議。

另外，一個(gè)容器進(jìn)程是可以加載多個(gè)war項(xiàng)目的，就像tomcat，久而久之，支持的東西多了，就成了真正的容器。

到此這篇關(guān)于詳解一個(gè)簡(jiǎn)單的Servlet容器的設(shè)計(jì)與實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Servlet容器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論