开发者联盟

Java EE 极简教程（二）：读懂 Servlet

2018-10-02  本文已影响22人  EvanNightly

一、Servlet 简介

先把 Servlet 当作一个普普通通的 Java 函数，来看一段最简单的样例代码。

// 导入相关的包
import java.io.IOException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
 // 继承 HttpServlet 类
public class HelloServlet extends HttpServlet {
    //重写对应用户get请求的doGet()方法，在其中加入我们需要的功能
    public void doGet(HttpServletRequest request, 
            HttpServletResponse response) {
        try {
            //在给浏览器的响应 response 中写入一句 html
            response.getWriter().println("<h1>Hello Servlet!</h1>");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

上述代码实现的功能是，当用户通过浏览器访问该 Servlet 对应的路径时，服务器端返回一个响应，其内容是一条能够在浏览器上被解析的 HTML 语句 <h1>Hello Servlet!</h1>。

可以看出，doGet 方法中实现了我们想要的功能，是我们重点要关注的部分。根据用户提交方式的不同，我们还可以重写 doPost 方法。（重写 service 也可，但会导致不能调用 doGet 和 doPost，一般不建议这么做）

接下来，让我们来看看该如何理解 Servlet。

1 如何理解 Servlet

2 Servlet 的生命周期

  1. 当 Servlet 第一次被调用的时候，其实例会被装在内存中。这个过程只会进行一次。
  2. Servlet 的 service 函数将被调用。
  3. 在之后的访问中，service 函数直接被调用。
  4. 当 web 应用 reload 或者服务器被关闭时，Servlet 的实例被销毁。

二、实战：开发 Servlet 程序

下面我们来做一个完整的例子，来展示 Servlet 如何对前端提交的数据进行处理。（使用 IntelliJ IDEA + Tomcat 服务器进行开发）

1 创建 Java 项目

打开 IDE ，File->New->Project，选择 Java Enterprise，并勾选 Web Application，点击 next，把项目命名为 MyServlet。



由于之前我已经配置好了 tomcat 服务器，所以这里可以直接使用。没有配置过的小伙伴可以参考

http://how2j.cn/k/idea/idea-tomcat/1361.html?p=50613

这里不再赘述。

2 导入必须的servlet-api.jar包

开发 Servlet 需要用到 servlet-api.jar 这个包里的相关类。

servlet-api.jar 包位于 \tomcat\lib\servlet-api.jar
(我的路径为 D:\apache-tomcat-9.0.10\lib\servlet-api.jar)

IDEA 中配置好 tomcat 后这个包是自动导入的，如果没有，可以在左侧点击 External Libraries -> Tomcat，在 servlet-api 上右键，选择 Add as Library 即可。

2 编写 html 页面

在工程的 web 目录下，右键 New 一个 HTML 文件，名字叫 test.html ，内容为

<!DOCTYPE html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>测试 Servlet</title>
</head>

<form action="test" method="post">
    开发者： <input type="text" name="developer"> <br>
    <input type="submit" value="提交">
</form>
</html>

主要的结构是一个 form，作用是把开发者这一信息提交到 /test 路径。这个 /test 路径，要通过接下来的配置与 Servlet 关联起来。

3 编写 Servlet

先在左侧资源管理器中 src 目录下右键 New 一个文件夹，命名为 servlet，再在这个新文件夹下创建一个 Servlet ，命名为 FirstServlet。当然也可以选择创建 Java Class，但是创建 Servlet，IDE 会自动提供代码框架如下：

package servlet;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet(name = "TestServlet")
public class TestServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    }
}

对应 HTTP 标准请求的 doGet、doPost 方法，继承自 javax.servlet.http.HttpServlet ，我们的业务逻辑需要写在这里。

此外，也可以重写 service 方法，这样做会使 doGet 和 doPost 失效。service 方法的形式与它们一致，为：

    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    }

前面我们编写的 test-servlet.html 中，提交的方法指定为 post，所以我们只需要重写 doPost 方法：

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String developer = request.getParameter("developer");
    response.setContentType("text/html; charset=UTF-8");
    response.getWriter().println("欢迎开发者" + developer);
}

作用是获取提交过来的 developer 参数，并把欢迎语句以 UTF-8 编码输出到客户端。

完整的代码如下：

package servlet;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet(name = "TestServlet")
public class TestServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String developer = request.getParameter("developer");
        response.setContentType("text/html; charset=UTF-8");
        response.getWriter().println("欢迎开发者" + developer);
    }
}

4 配置 web.xml

在 WEB-INF 目录中打开 web.xml（如果没有可以右键手动创建），进行配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">

    <servlet>
        <servlet-name>TestServlet</servlet-name>
        <servlet-class>servlet.TestServlet</servlet-class>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>TestServlet</servlet-name>
        <url-pattern>/test</url-pattern>
    </servlet-mapping>
 
</web-app>

这一步的作用是把我们的服务器端程序 TestServlet 与用户通过浏览器访问 xxx/test 路径这一行为联系起来。

<web-app> 标签上的一堆东西，配置了依赖，这样我们在写里面的内容时会有自动检查与补全功能。

<servlet> 标签：

<servlet-name> 即指定给 servlet 的名称，是自定义的。<servlet-class> 是指我们需要配置的 servlet 的名称，需要指定实际存在的 Java Class。<servlet-name> 最好与 <servlet-class> 一致，方便理解与维护。

<servlet-mapping> 标签：

提供路径与 servlet 的映射关系，要注意，这里的 <servlet-name> 要与前面 <servlet> 标签里的 <servlet-name> 对应。

5 启动并测试项目

运行项目，看到浏览器弹出默认访问页面，也就是我们创建工程时自带的 index.jsp，我们目前不用不管它，手动在浏览器中输入 http://localhost:8080/test-servlet.html （默认端口是 8080），进入到测试页面。

输入开发者名称，点击提交，则浏览器自动跳转到 http://localhost:8080/test ，大功告成！

6 小练习

还记得在文章的开头展示的代码吗？它的功能是向客户端输出

Hello Servlet！

比上面给出的例子还要简单，大家可以尝试完成这个功能。

更深入的内容，包括对数据库的增删改查等，可以参照 how2j 的 Servlet 教程 跟着做一遍，很快就能理解。

三、总结

在实际的项目开发中很少直接用到 Servlet，但它是 JavaEE 的重要组成部分，是日后进阶学习的基础，对深入理解 Java 企业级应用的开发有重要作用。Servlet 并不复杂，相信经过一些小小的实践，作为初学者的我们可以牢牢掌握这部分的知识！

前面的文章提到过，Servlet 是 JSP 的基础。那么 JSP 是用来解决什么问题的呢？欢迎浏览下一篇文章——

「Java EE 极简教程（三）：为什么要用 JSP？」

上一篇下一篇

猜你喜欢

热点阅读