Servlet开发

在上一节中,我们看到,一个完整的Web应用程序的开发流程如下:

  • 编写Servlet;
  • 打包为war文件;
  • 复制到Tomcat的webapps目录下;
  • 启动Tomcat。 这个过程是不是很繁琐?如果我们想在IDE中断点调试,还需要打开Tomcat的远程调试端口并且连接上去。

javaee-expert

javaee-newbee

许多初学者经常卡在如何在IDE中启动Tomcat并加载webapp,更不要说断点调试了。

我们需要一种简单可靠,能直接在IDE中启动并调试webapp的方法。

因为Tomcat实际上也是一个Java程序,我们看看Tomcat的启动流程:

  • 启动JVM并执行Tomcat的main()方法;
  • 加载war并初始化Servlet;
  • 正常服务。 启动Tomcat无非就是设置好classpath并执行Tomcat某个jar包的main()方法,我们完全可以把Tomcat的jar包全部引入进来,然后自己编写一个main()方法,先启动Tomcat,然后让它加载我们的webapp就行。

我们新建一个web-servlet-embedded工程,编写pom.xml如下:

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>com.itranswarp.learnjava</groupId>
  6. <artifactId>web-servlet-embedded</artifactId>
  7. <version>1.0-SNAPSHOT</version>
  8. <packaging>war</packaging>
  9. <properties>
  10. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  11. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  12. <maven.compiler.source>11</maven.compiler.source>
  13. <maven.compiler.target>11</maven.compiler.target>
  14. <java.version>11</java.version>
  15. <tomcat.version>9.0.26</tomcat.version>
  16. </properties>
  17. <dependencies>
  18. <dependency>
  19. <groupId>org.apache.tomcat.embed</groupId>
  20. <artifactId>tomcat-embed-core</artifactId>
  21. <version>${tomcat.version}</version>
  22. <scope>provided</scope>
  23. </dependency>
  24. <dependency>
  25. <groupId>org.apache.tomcat.embed</groupId>
  26. <artifactId>tomcat-embed-jasper</artifactId>
  27. <version>${tomcat.version}</version>
  28. <scope>provided</scope>
  29. </dependency>
  30. </dependencies>
  31. </project>

其中,<packaging>类型仍然为war,引入依赖tomcat-embed-coretomcat-embed-jasper,引入的Tomcat版本<tomcat.version>9.0.26

不必引入Servlet API,因为引入Tomcat依赖后自动引入了Servlet API。因此,我们可以正常编写Servlet如下:

  1. @WebServlet(urlPatterns = "/")
  2. public class HelloServlet extends HttpServlet {
  3. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  4. resp.setContentType("text/html");
  5. String name = req.getParameter("name");
  6. if (name == null) {
  7. name = "world";
  8. }
  9. PrintWriter pw = resp.getWriter();
  10. pw.write("<h1>Hello, " + name + "!</h1>");
  11. pw.flush();
  12. }
  13. }

然后,我们编写一个main()方法,启动Tomcat服务器:

  1. public class Main {
  2. public static void main(String[] args) throws Exception {
  3. // 启动Tomcat:
  4. Tomcat tomcat = new Tomcat();
  5. tomcat.setPort(Integer.getInteger("port", 8080));
  6. tomcat.getConnector();
  7. // 创建webapp:
  8. Context ctx = tomcat.addWebapp("", new File("src/main/webapp").getAbsolutePath());
  9. WebResourceRoot resources = new StandardRoot(ctx);
  10. resources.addPreResources(
  11. new DirResourceSet(resources, "/WEB-INF/classes", new File("target/classes").getAbsolutePath(), "/"));
  12. ctx.setResources(resources);
  13. tomcat.start();
  14. tomcat.getServer().await();
  15. }
  16. }

这样,我们直接运行main()方法,即可启动嵌入式Tomcat服务器,然后,通过预设的tomcat.addWebapp("", new File("src/main/webapp"),Tomcat会自动加载当前工程作为根webapp,可直接在浏览器访问http://localhost:8080/

embedded-tomcat

通过main()方法启动Tomcat服务器并加载我们自己的webapp有如下好处:

  • 启动简单,无需下载Tomcat或安装任何IDE插件;
  • 调试方便,可在IDE中使用断点调试;
  • 使用Maven创建war包后,也可以正常部署到独立的Tomcat服务器中。 对SpringBoot有所了解的童鞋可能知道,SpringBoot也支持在main()方法中一行代码直接启动Tomcat,并且还能方便地更换成Jetty等其他服务器。它的启动方式和我们介绍的是基本一样的,后续涉及到SpringBoot的部分我们还会详细讲解。

练习

Servlet开发 - 图4下载练习:使用嵌入式Tomcat运行Servlet (推荐使用IDE练习插件快速下载)

小结

开发Servlet时,推荐使用main()方法启动嵌入式Tomcat服务器并加载当前工程的webapp,便于开发调试,且不影响打包部署,能极大地提升开发效率。

读后有收获可以支付宝请作者喝咖啡,读后有疑问请加微信群讨论:

Servlet开发 - 图5Servlet开发 - 图6