一個簡單的servlet容器代碼設計

Servlet算是Java Web開發(fā)請求鏈路調用棧中底層的一個技術，當客戶端發(fā)起一個請求后，到達服務器內(nèi)部，就會先進入Servlet（這里不討論更底層的鏈路），SpringMVC的請求分發(fā)核心也是一個Servlet，名叫DispatcherServlet，一個請求首先會進入到這個Servlet，然后在通過SpringMVC的機制去分發(fā)到對應的Controller下。

但是再往上一層說，普通的開發(fā)人員可能不會關心Servlet是怎么被調用的，我們只要寫一個@WebServlet注解在Servlet的類上，運行后，客戶端的請求就會自動進入到相應的Servlet中，而做這些事的叫Servlet容器，Servlet容器一定是一個Web服務器，但Web服務器反過來可不一定是Servlet容器哦。

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

Github地址

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

https://github.com/houxinlin/jerrycat

容器的實現(xiàn)

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

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

我們起一個容器名，叫JerryCat吧，他的實現(xiàn)功能只有一個，將請求交給對應的Servlet，并將其處理結果返回給客戶端，因為這才是核心，而實現(xiàn)他的具體步驟如下。

• 解壓war文件
• 收集Servlet信息
• 啟動web服務器
• 請求映射 & 返回結果

解壓war文件

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

 
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信息

這一步是一個核心，因為Servlet容器一定要知道一個war項目中所有的Servlet信息，也就是要知道開發(fā)人員定義的請求路徑和具體Servlet的映射關系，當請求進來的時候，才能根據(jù)這個映射關系調用到對應的Servlet下。

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

<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等注解，如下，這也是告訴容器，這個類的請求路徑是/hello。

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

那么容器的實現(xiàn)就會增加負擔，因為要遍歷所有的class，找出標有@WebServlet的類，并做收集，那問題是怎么找到這些符合的類呢？ 首先不能通過反射，因為有兩個問題。

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

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

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

Tomcat是純自己手擼出一個解析器，如果熟悉class文件格式后，還是比較容易的，所以這里我們依靠一個框架，比如用org.ow2.asm這個庫，額外的知識：Spring也是靠第三方庫來讀取的。

具體例子如下

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類解析這個class文件，并判斷是不是標有WebServlet注解，如果存在，則通過自定義的類加載器加載并實例化他，而這個類加載器主要作用就是根據(jù)給定的類名，從/WEB-INF/classes/加載類，如果給定的類不存在，則交給父類加載器。

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

那么這個類加載器加載路徑依次如下：

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

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

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

啟動web服務器

上面說到，Servlet容器也是一個Web服務器，只有啟動一個Web服務器后，收到請求，才能傳遞給Servlet，并且，他還能處理靜態(tài)資源，實現(xiàn)一個Web服務器重要的是解析HTTP報文，并且根據(jù)響應結果生成HTTP報文。

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

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

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

請求映射 & 返回結果

這里有一點比較麻煩，我們知道doGet和doPost的參數(shù)是HttpServletRequest、HttpServletResponse，容器需要實現(xiàn)這兩個接口，提供請求參數(shù)，這里我們偷個懶，使用mockito這個庫來構造一個請求。

下面代碼中，createContext用來監(jiān)聽某個請求路徑，當有請求過來時，HttpServer會把請求對象封裝為HttpExchange，而我們做的事是把他轉換為HttpServletRequest。

當調用service時，javax.servlet.http.HttpServlet會自動根據(jù)請求訪問，調用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);
}

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

但這里，請求映射顯的有點簡單，因為我們少了處理通配符的情況。

其余規(guī)范

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

Filter同樣的做法，也是通過ClassReader讀取，在調用service前一步，先調用Filter。

結束

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

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

有完整的信息提供后，就可以做額外的功能開發(fā)了，比如WebSocket，當請求過來時候，發(fā)現(xiàn)是一個WebSocket握手請求，那么相應的要做一個協(xié)議升級，轉換為WebSocket協(xié)議。

另外，一個容器進程是可以加載多個war項目的，就像tomcat，久而久之，支持的東西多了，就成了真正的容器。

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

最新評論