【Tomcat】第十篇：手写嵌入式Tomcat插件（超简单）

本是古典何须时尚 2022-12-09 15:55 233阅读 0赞

## 1.两种类型tomcat ##

*  传统tomcat：需要jar部署，通过BootStrap启动
 *  嵌入式tomcat：maven引入Tomcat类，自定义启动插件（Connector，Engin，Host，Context，Wrapper）
    
     *  能搞嵌入式的根本原因：开源
     *  如SpringBoor使用的就是嵌入式Tomcat
     *  Tomcat类中有默认TomcatRunner插件，可以启动；但仍然可以自定义tomcat插件，来做自定义启动

## 2.手写传统tomcat ##

具体请参考：

*  [【Tomcat】第八篇：基于BIO的150代码手写Tomcat（超详细注释）][Tomcat_BIO_150_Tomcat]
 *  [【Tomcat】第九篇：使用 Netty 重构之前手写的 Tomcat][Tomcat_ Netty _ Tomcat]

## 3.手写嵌入式tomcat插件 ##

下面先贴一张项目结构的截图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]

### 3.1 在 pom.xml 引入依赖 ###

<dependencies>
            
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>javax.servlet-api</artifactId>
                <version>3.0.1</version>
                <scope>provided</scope>
            </dependency>
    		
            
            <dependency>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.1</version>
            </dependency>
    </dependencies>

### 3.2 准备 Servlet 示例 ###

先写一个处理业务逻辑的Servlet示例，在下面插件配置时要用

public class DemoServlet extends HttpServlet {
        
    
        public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException
        {
        
            request.setCharacterEncoding("UTF-8");
            response.setCharacterEncoding("UTF-8");
            response.setContentType("text/html;charset=UTF-8");
    
            response.getWriter().println("hello world!!!");
    
    //        String message = request.getParameter("message");
    //        response.getWriter().print(message);
        }
    }

### 3.3 编写插件：EmbeddedTomcat（核心） ###

这里先强调一下，插件的目的是为了对现有资源灵活运用，它既可以大到几十兆的压缩包，也可以小到只有一个类。就比如这里的嵌入式tomcat插件，它只用下面的 EmbeddedTomcat 这一个类就可以实现对引入的 Tomcat 包相关资源的灵活管控 。

EmbeddedTomcat 这个类主要有两个作用：

1.  实现自定义配置和启动。即传统tomcat的server.xml 和 web.xml 的相关配置都在这里。
2.  是启动 Tocmat 的入口。

public class EmbeddedTomcatServer {
        
    
        public static void main(String[] args) throws LifecycleException {
        
    
            Tomcat tomcat = new Tomcat();
            // 1.设置Connctor，包括端口
            Connector connector = tomcat.getConnector();
            connector.setPort(8080);
    	    
            // 2.设置Engine，此处没什么可以设的...
            
            // 3.设置Host，包括域名，context路径 ---> 至此Tomcat可以正常启动，只不过没有
            Host host = tomcat.getHost();
            host.setAppBase("webapp");
            host.setName("localhost");
    	    
            // 4.设置Context，包括host与应用的位置
            String classpath = System.getProperty("user.dir"); // C:\Users\13275\Documents\Java\...
            Context context = tomcat.addContext(host, "/", classpath);
            
            if (context instanceof StandardContext) {
        
                // Context还可以设置默认web.xml
                // StandardContext ctx = (StandardContext)context;
                // ctx.setDefaultContextXml("C:\\Users\\...\\web.xml");
                
                // 5.设置Wrapper（Servlet），及其映射路径（注：servlet中的@webServlet没用）
                Wrapper servlet = tomcat.addServlet("/", "DemoServlet", new DemoServlet());
                servlet.addMapping("/demo");
            }
    		
            // 启动tomcat
            tomcat.start();
            // 防止main提前结束，使main阻塞
            tomcat.getServer().await();
        }
    }

### 成果演示 ###

启动EmbeddedTomcat的main函数，然后在浏览器输入localhost:8080/demo，可以看到正确输出。  
![在这里插入图片描述][20200923171435805.png_pic_center]

[Tomcat_BIO_150_Tomcat]: https://blog.csdn.net/weixin_43935927/article/details/108741585
[Tomcat_ Netty _ Tomcat]: https://blog.csdn.net/weixin_43935927/article/details/111939530
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/038101b3eeb74c4194ff9256c8946605.png
[20200923171435805.png_pic_center]: /images/20221123/d1e582908dad4299b333405e6b14d51c.png