【Servlet】如何编写第一个Servlet程序

我会带着你远行 2024-04-27 07:15 92阅读 0赞

> 个人主页：[兜里有颗棉花糖][Link 1]  
> 欢迎 点赞? 收藏✨ 留言✉ 加关注?本文由 [兜里有颗棉花糖][Link 1] 原创  
> 收录于专栏【[Servlet][]】  
> 本专栏旨在分享学习Servlet的一点学习心得，欢迎大家在评论区交流讨论?

**Servlet是Java编写的服务器端程序，主要用于处理客户端请求和生成响应。它可以接收来自客户端（通常是Web浏览器）的请求，执行特定的任务，并返回响应给客户端。**

#### 目录 ####

*  一、创建项目
 *  二、引入依赖
 *  三、创建必要的目录和文件
 *  四、代码编写
 *  五、打包程序
 *  六、程序部署
 *  七、验证程序
 *   *  注意事项

**重要的事情放前面：`Servlet程序运行时，一定要保证Tomcat处于运行状态`。**

## 一、创建项目 ##

![在这里插入图片描述][0af54980973e44888c3e9e6787aeea8e.png]

> **`什么是Maven`：**  
> **Maven是Java中的一个构建工具。**  
> **一个程序在编写过程中往往会涉及到第三方库的依赖，同时需要对写好的程序进行一个打包部署。**  
> **Maven存在的意义就是为了能够方便的进行`依赖管理`和`打包部署`。**  
> **而`IntelliJ`是Java中默认的构建工具，`Gradle`（安卓中会用到）同样是是Java中常见的构建工具。**

![在这里插入图片描述][34e92ca1b0944554b69783b1bc2bfd3c.png]

> **我们来带看一下`pom.xml文件`：**  
> ![在这里插入图片描述][aa90c7963dd64ab186ed53e330519be0.png]  
> 后续我们会根据需要会继续向`pom.xml`文件中放新的内容。  
> ![在这里插入图片描述][1c422fcb430c42a585ccee87601a5fbc.png]

好了，以上就是创建项目的步骤，接下来我们来到下一步，即引入依赖。

## 二、引入依赖 ##

当前的代码要使用Servlet开发，而Servlet并不是Java标准库自带的，所以我们需要Maven把Servlet的依赖获取到。所以我们需要找到Maven的中央仓库，然后从中央仓库中找到我们想要获取到的依赖。

**中央仓库地址：[https://mvnrepository.com/][https_mvnrepository.com]**

> 来到中央仓库后，直接搜索servlet即可。  
> ![在这里插入图片描述][500262bab3ea41af88a95a4c2bd2d5e2.png]  
> 如上图，点击`Java Servlet API`后来到如下页面  
> ![在这里插入图片描述][f2a3c253ee2e4d3689f237ec7476a585.png]  
> **找到`3.1.0`的版本，因为Tomcat和Servlet是有对应关系的：如果Tomcat使用8版本的话，那么Servlet就需要使用3.1版本。**  
> ![在这里插入图片描述][c720385556fe43839b6b047b21749b79.png]  
> ![在这里插入图片描述][ea62245d48a34d1db5cdc9629184591c.png]  
> **此时IDEA就会自动的通过Maven从中央仓库下载到这里的依赖。**  
> 我们可以看到上面报红了，有可能还没有下载完（第一次使用一般会比较慢，因为要从中央仓库中下载很多的依赖），这种情况稍微等一下就好了。  
> 但是如果等了很长时间都没有解决的话，我们就需要点击下面的刷新按钮：  
> ![在这里插入图片描述][ed6e213d356a4e289a9ad957f79d52b8.png]

好了，以上就是引入依赖的全过程。

## 三、创建必要的目录和文件 ##

Tomcat对于Servlet项目是有一些额外的要求的。

Maven最为一个通用的工具，不仅仅可以管理Servlet项目，还可以管理其它的项目。再此基础上还需要按照Servlet项目的要求来创建出特定的目录和文件。

*  在main目录下创建`webapp目录`
 *  在`webapp目录中`创建一个目录`WEB-INF`
 *  **在`WEB-INF`目录中创建`web.xml`文件，`web.xml文件`的作用就是告诉Tomcat我这个目录中的内容是一个webapp，需要把我加载起来。**

整个目录结构如下：  
![在这里插入图片描述][0a428b1e78534c5496fd7abc294db1b6.png]  
上述创建的目录结构（包括目录的名字）和文件都是固定的。

另外，我们需要在`web.xml`中编写一些内容，编写内容如下（直接复制粘贴即可）：

<!DOCTYPE web-app PUBLIC
    "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
    "http://java.sun.com/dtd/web-app_2_3.dtd" >
    <web-app>
      <display-name>Archetype Created Web Application</display-name>
    </web-app>

这个配置文件即`web.xml`的作用是指定了该 Web 应用程序的基本信息和配置参数，例如，控制应用程序如何处理请求、响应、会话管理等（具体细节我们这里暂时跳过）。

> 上述的配置文件可能会出现如下报错，请看：  
> ![在这里插入图片描述][903f22fbac6e45d28f1226a033622587.png]  
> 爆红不是我们的原因，这里直接忽略即可（并不影响程序的运行）。  
> 解释一下：爆红的部分即`"http://java.sun.com/dtd/web-app_2_3.dtd"`是一个`schema文件`，该文件描述了xml文件的格式是怎样的（哪些标签是合法的，哪些是不合法的，以及标签之间如何进行嵌套）。

好了，以上就是创建目录结构及文件的全部内容。接下来开始正式的代码编写。

## 四、代码编写 ##

*  **第一步**：创建类`HelloServlet`，然后让该类继承`HttpServlet`（此类是Servlet的jar包提供的，编写Servlet程序一般都需要继承这个类——`HttpServlet`），如下图：

> ![在这里插入图片描述][c8dcad6937cc42c7b679802ca725a000.png]  
> 如果`HttpServlet`报红的话，可能是之前的`pom.xml`中的依赖没有正确引入。这是我们只需要刷新一下`pom.xml`文件即可。  
> ![在这里插入图片描述][2380465ed4aa4d5ea1ff1e64f0e383c5.png]  
> ![在这里插入图片描述][44ffc63ac6bb46bfb3b9165cfcf62a69.png]

*  **第二步**：重写父类`HttpServlet`中的方法（`doGet方法`）

![在这里插入图片描述][ac2a7c4e9e2d4164bab8ab5939d904b0.png]  
在解释`doGet`方法之前，我们先来回顾下服务器典型的三步走流程：  
①读取请求并解析请求  
②根据请求计算响应  
③把响应写回到客户端

好了接下来解释`doGet`方法：  
![在这里插入图片描述][d16ba37aa9ec400dbf4cf53270300d39.png]

**doGet方法要做的事情就是根据请求（req）计算出响应（resp），所以对应的doGet方法中的代码就是根据req请求中不同的参数细节从而生成一个具体的resp对象（即往空对象中设置属性）。**

**然后，Tomcat就会根据这个resp响应对象转换成符合HTTP协议的响应报文并返回给浏览器。**

> 注解（配置路由）：  
> ![在这里插入图片描述][58db7ffb21834bef905f0102a7e17699.png]  
> **我们已经知道Tomcat会在合适的时机自动调用doGet方法，体现在两个方面：**  
> 第一个方面：根据请求方法的不同来调用不同的方法。举例：如果请求方法是GET，那么Tomcat就会在合适的时机自动调用doGet；如果请求的方法是PUT，那么Tomcat就会在合适的时机自动调用doPost。  
> 第二个方面：请求的路径中，url后面带有层次结构的路径。一个Servlet程序中可能有多个Servlet类，这些Servlet类需要在不同的情况下被执行到。比如当请求的路径中有hello的时候，才能执行到HelloServlet的代码。当然，**`不同的Servlet类可以关联到不同的路径`**。  
> **总结：Tomcat在合适的时机自动调用Servlet的方法，根据请求的方法类型和请求的路径进行匹配，以调用对应的Servlet方法来处理请求。这样可以实现不同Servlet类在不同情况下的执行（`不同的代码应用到不同的场景`）。**

**总而言之，`doGet`方法就是`根据请求算出响应`（即服务器典型三步走的第二步，第一步和第三步由Tomcat来完成）。**

> **以上就是代码的编写，现在问题来了，为什么没有出现main方法。**  
> **解释：Servlet程序不需要main方法。上述写的代码并不是独立的程序，而是放到Tomcat上去执行的。`而main方法在Tomcat，我们写的代码比如说doGet之类的方法都是让Tomcat来调用的`。**

## 五、打包程序 ##

这里写的程序是放到Tomcat上运行，所以需要对程序进行打包。  
打包成一个Tomcat能识别的包的格式，此时代码才会被Tomcat给加载起来。  
**`打包的过程是借助Maven来完成。`**

![在这里插入图片描述][db92ffcfaa3e42b987db06a56507b2e8.png]

> **看到如下图就说明已经打包好了。**![在这里插入图片描述][f41cd38338ce4981a43a1dbc524b0cba.png]  
> ![在这里插入图片描述][68b259db301347be803fd015bfdd0e76.png]  
> **在Maven中默认打包生成的是jar包（jar包是java中常用的打包方式，jar包中就是一些.class文件），但是Tomcat需要的并不是jar包，而是war包（war包本质上和jar包差不多，war包中会包含一些前端的代码，如html、css等，以及一些Tomcat的配置（web.xml））。**  
> **`所以我们需要修改配置项来让Maven打包出来的是一个war包`**  
> 在`pom.xml文件`中插入`<packaging>war</packaging>`即可，如下图：  
> ![在这里插入图片描述][4cadf26c71574a0dba87278f1ddf002f.png]

另外，除了在`pom.xml`中添加`packaging`标签外，我们还可以添加其它标签，如下：

<build>
        <finalName>java_servlet</finalName>
    </build>

> ![在这里插入图片描述][4fb0f83f220d4143a60ea1860186f467.png]  
> **通过finalName标签可以设置打包出来的war包的名字（不是必须的，也可以使用默认的名字）。**

> **好了，修改了上述的配置之后，接下来我们重新打包：**  
> ![在这里插入图片描述][b9806be8c26d4c8997dfee258ca4f960.png]  
> ![在这里插入图片描述][b1d030d8827942d2b68343a6d620b8cf.png]  
> 可以看到上图中target目录中新打成的war包。  
> ![在这里插入图片描述][4a2935fe7f1a45c49a1a2814baf03995.png]  
> **这个war包就是我们想要向Tomcat中部署的内容。**

**至此，打包完成，我们就可以把war包放到Tomcat中了。**

## 六、程序部署 ##

程序部署就是把我们刚刚打包生成的war包放到Tomcat上，具体来说就是把这个war包拷贝到Tomcat中的webapps目录中。

![在这里插入图片描述][1044c19b41d8457ebd69cc6cf80331f8.png]  
把war包复制到Tomcat中的webapps目录后，Tomcat就会识别到有新的webapp到来了，然后就会自动对这个war包进行解压缩。

下面就到了最后一步——验证程序。

## 七、验证程序 ##

通过浏览器发起http get请求，触发刚刚的servlet的代码。

![在这里插入图片描述][bc02e1ea7e3d405db4f2551213cc9634.png]  
**`第一点：`通过第一级路径（称为context path/application path）来确认要访问哪个webapp（这个路径就是war包的名字）；`第二点：`然后通过第二级路径（称为servlet path）来访问哪一个servlet代码；`第三点：`然后通过方法来确定执行servlet中哪个方法。**

结合上面三点就定位到了要执行的代码时doGet方法

**最后，程序成功执行。**

![在这里插入图片描述][ac6659d192e24a4f8b809bc4938398b6.png]

### 注意事项 ###

**如果我们要对代码进行修改的话，我们需要重复上述的`五、六、七`步骤。**

好了，以上就是本文的全部内容了。希望各位友友可以一键三连哈！！！

![在这里插入图片描述][80626c5ccbcc4923af0bca181b092306.png]

[Link 1]: https://xiaofeizhu.blog.csdn.net/
[Servlet]: https://blog.csdn.net/m0_74352571/category_12563008.html
[0af54980973e44888c3e9e6787aeea8e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/c7eccf5358104800985393e043c0b7bd.png
[34e92ca1b0944554b69783b1bc2bfd3c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/18f6b3564b1843a4a0dc75941b7ffa87.png
[aa90c7963dd64ab186ed53e330519be0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/94abe4530849424a969b1391e53e9feb.png
[1c422fcb430c42a585ccee87601a5fbc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/fca5fa2e3b8344cda75ab59999612a71.png
[https_mvnrepository.com]: https://mvnrepository.com/
[500262bab3ea41af88a95a4c2bd2d5e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/d37652a68bfa48fa84390009d7d11e39.png
[f2a3c253ee2e4d3689f237ec7476a585.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/69d3f233f7ee4440ac0d5a435f1cb015.png
[c720385556fe43839b6b047b21749b79.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/52b16aa2cd9c41868560de2434157c27.png
[ea62245d48a34d1db5cdc9629184591c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/be2b90a2fe684727bcb633f4b1d7bc15.png
[ed6e213d356a4e289a9ad957f79d52b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/4424a64738f94ff9bd9eab4abd04fdb6.png
[0a428b1e78534c5496fd7abc294db1b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/d5bc52800a3e4640b98eceb180fe4e0e.png
[903f22fbac6e45d28f1226a033622587.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/487ab3b3a0e64b38b593c8774a987df0.png
[c8dcad6937cc42c7b679802ca725a000.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/7068846bd420418b9404ac438668d69f.png
[2380465ed4aa4d5ea1ff1e64f0e383c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/2a89cd7fad13430da86296faf4caf01e.png
[44ffc63ac6bb46bfb3b9165cfcf62a69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/586e34ebe4de4172b6cb5a6503b475fd.png
[ac2a7c4e9e2d4164bab8ab5939d904b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/539178592128429c87d9082aa2301a9a.png
[d16ba37aa9ec400dbf4cf53270300d39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/1083402b03094a5ba9075a0aa26c7129.png
[58db7ffb21834bef905f0102a7e17699.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/8a4b4d7ea6fb4593b911b2f43eff3fc6.png
[db92ffcfaa3e42b987db06a56507b2e8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/120f1c6d9c0749739a1d6642e30670bf.png
[f41cd38338ce4981a43a1dbc524b0cba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/df0619677bd541e3bc8b142c118af0cf.png
[68b259db301347be803fd015bfdd0e76.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/32b4ddf0c70c489ca7d7fb6e99bfdf9e.png
[4cadf26c71574a0dba87278f1ddf002f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/867fcf80e49b48f3abcdb7d1db9aa1af.png
[4fb0f83f220d4143a60ea1860186f467.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/a86fd60ea14d4fef8cce1d80832b3e51.png
[b9806be8c26d4c8997dfee258ca4f960.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/2c977a0adba949bdb165efc1064119ae.png
[b1d030d8827942d2b68343a6d620b8cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/1d684eb1c6f3424f829cc5bf6746f3a3.png
[4a2935fe7f1a45c49a1a2814baf03995.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/538c797ee9c14813a55b451c46c83acc.png
[1044c19b41d8457ebd69cc6cf80331f8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/981a08bbe1514caab79cfd7680a77ab0.png
[bc02e1ea7e3d405db4f2551213cc9634.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/61907a38b9724741959dc1c93f69e02a.png
[ac6659d192e24a4f8b809bc4938398b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/7f0aa6d9cdf54f52aee34598cea2ca5c.png
[80626c5ccbcc4923af0bca181b092306.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/27/1db725c7859948138df6b17a776a2917.png