文章

02.JavaWeb Servlet入门

发表于 更新于
作者 Hacket Zeng
10 分钟阅读
02.JavaWeb Servlet入门

Servlet 入门

什么是 Servlet？

Java Servlet 是运行在 Web 服务器或应用服务器上的程序，它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层。

使用 Servlet，您可以收集来自网页表单的用户输入，呈现来自数据库或者其他源的记录，还可以动态创建网页。

Java Servlet 通常情况下与使用 CGI（Common Gateway Interface，公共网关接口）实现的程序可以达到异曲同工的效果。但是相比于 CGI，Servlet 有以下几点优势：

  • 1、性能明显更好。
  • 2、Servlet 在 Web 服务器的地址空间内执行。这样它就没有必要再创建一个单独的进程来处理每个客户端请求。
  • 3、Servlet 是独立于平台的，因为它们是用 Java 编写的。
  • 4、服务器上的 Java 安全管理器执行了一系列限制，以保护服务器计算机上的资源。因此，Servlet 是可信的。
  • 5、Java 类库的全部功能对 Servlet 来说都是可用的。它可以通过 sockets 和 RMI 机制与 applets、数据库或其他软件进行交互。

Servlet HelloWorld

示例 1：普通未用 Maven

Ea

  • 新建普通的 Java（非 Maven）项目

  • 找到 Add Framework Support，如若找不到，再次双击 shift 键（选中 Include non-project items

如果 Add Framework Support 为灰色，可能是没有选中项目根目录，选中 src 也不行

会增加 web 目录：

![300](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202410032216342.png)
  • 添加 servlet-api.jar
![700](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202410032101929.png)
  • 目录结构
![400](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202409160112986.png)
  • @WebServlet 注解配置 url
1
2
3
4
5
6
7
8
9

@WebServlet(name = "HelloServlet", urlPatterns = "/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html;charset=UTF-8");
        PrintWriter writer = resp.getWriter();
        writer.println("hello world");
    }
}

访问：http://localhost:8080/HelloWorldJavaWebMaven_war_exploded/hello

示例 2：用 Maven

  • Maven Archetype

  • Maven 目录结构

400

  • 实现Servlet接口，这里我们直接继承HttpServlet
1
2
3
4
5
6
7
8
9
10
11
12
13
14

public class HelloServlet extends HttpServlet {
    // 由于get或post只是请求实现的不同的方式，可以相互调用，业务逻辑都是一样；
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//        ServletOutputStream outputStream = resp.getOutputStream();
        PrintWriter writer = resp.getWriter();  // 响应流
        writer.print("Hello, Serlvet2");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}
  • 配置 web.xml 编写Servlet的映射
  • 为什么需要映射：我们写的是 JAVA 程序，但是要通过浏览器访问，而浏览器需要连接 web 服务器，所以我们需要再 web 服务中注册我们写的 Servlet，还需给他一个浏览器能够访问的路径；
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<?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_4_0.xsd"
         version="4.0">

    <!--注册Servlet-->
    <servlet>
        <servlet-name>hello2</servlet-name>
        <servlet-class>me.hacket.HelloServlet</servlet-class>
    </servlet>
    <!--Servlet的请求路径-->
    <!--  localhost:8080/Servlet/hello/hello  -->
    <servlet-mapping>
        <servlet-name>hello2</servlet-name>
        <url-pattern>/hello2</url-pattern>
    </servlet-mapping>

</web-app>
  • 访问

http://localhost:8080/HelloWorldJavaWebMaven_war_exploded/hello2

Jakarta EE

配置 Tomcat

  • 找到 Tomcat Server（注意不是 TomEE Server）

  • 点击 Configure…找到之前下载好的 tomcat 路径

  • 配置 artifact（或者点击下面的 fix）

  • 配置 ok，可以测试了
![300](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202410032322880.png)

Mapping 问题

一个 Servlet 可以指定一个映射路径

1
2
3
4

<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello</url-pattern>
</servlet-mapping>

一个 Servlet 可以指定多个映射路径

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello</url-pattern>
</servlet-mapping>
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello2</url-pattern>
</servlet-mapping>
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello3</url-pattern>
</servlet-mapping>
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello4</url-pattern>
</servlet-mapping>
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello5</url-pattern>
</servlet-mapping>

一个 Servlet 可以指定通用映射路径

1
2
3
4

<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello/*</url-pattern>
</servlet-mapping>

默认请求路径

1
2
3
4
5

<!--默认请求路径-->
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>

指定一些后缀或者前缀等等…

1
2
3
4
5
6
7
8

<!-- 可以自定义后缀实现请求映射
	 注意点，*前面不能加项目映射的路径
	 hello/subei.github
	-->
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>*.github</url-pattern>
</servlet-mapping>

优先级问题

  • 指定了固有的映射路径优先级最高，如果找不到就会走默认的处理请求；
1
2
3
4
5
6
7
8
9

<!--  404  -->
<servlet>
	<servlet-name>error</servlet-name>
	<servlet-class>me.hacket.ErrorServlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>error</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

public class ErrorServelt extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");

        PrintWriter writer = resp.getWriter();
        writer.println("<h1>404</h1>");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

ServletContext

web 容器在启动的时候，它会为每个 web 程序都创建一个对应的 ServletContext 对象，它代表了当前的 web 应用；

共享数据

在这个 Servlet 中保存的数据，可以在另外一个 servlet 中拿到；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//        this.getInitParameter(); 初始化参数
//        this.getServletConfig(); Servlet配置
//        this.getServletContext(); Servlet上下文
        ServletContext context = this.getServletContext();

        String name = "学习超好";   // 数据
        // 将一个数据保存在了ServletContext中，名字为：name ,值 name
        context.setAttribute("name",name);

        System.out.println("Hello");

    }
}

在另外一个 Servlet 获取：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

public class GetServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext context = this.getServletContext();
        String name = (String)context.getAttribute("name");

        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");
        resp.getWriter().print("名字:"+name);

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}
  • Mapping
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<servlet>
	<servlet-name>hello</servlet-name>
	<servlet-class>com.github.servlet.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>hello</servlet-name>
	<url-pattern>/hello</url-pattern>
</servlet-mapping>

<servlet>
	<servlet-name>getc</servlet-name>
	<servlet-class>com.github.servlet.GetServlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>getc</servlet-name>
	<url-pattern>/getc</url-pattern>
</servlet-mapping>

获取初始化参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<!-- 配置一些Web应用初始化参数 -->
<context-param>
	<param-name>url</param-name>
	<param-value>jdbc:mysql://localhost:3306/mybatis</param-value>
</context-param>

<servlet>
	<servlet-name>gp</servlet-name>
	<servlet-class>com.github.servlet.ServletDemo03</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>gp</servlet-name>
	<url-pattern>/gp</url-pattern>
</servlet-mapping>

Servlet 代码：

1
2
3
4
5
6
7
8
9
10
11
12
13

public class ServletDemo03 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext context = this.getServletContext();
        String url = context.getInitParameter("url");
        resp.getWriter().print(url);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

请求转发

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

public class ServletDemo04 extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletContext context = this.getServletContext();
        System.out.println("进入ServletDemo04文件！");
//        转发的请求路径
//        RequestDispatcher requestDispatcher = context.getRequestDispatcher("/gp");
//        调用forward实现请求转发;
//        requestDispatcher.forward(req,resp);
        context.getRequestDispatcher("/gp").forward(req,resp);

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

Mapping：

1
2
3
4
5
6
7
8

<servlet>
	<servlet-name>gp02</servlet-name>
	<servlet-class>com.github.servlet.ServletDemo04</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>gp02</servlet-name>
	<url-pattern>/gp02</url-pattern>
</servlet-mapping>

读取资源文件

  • Properties
    • 在 java 目录下新建 properties 在 resources 目录下新建 properties
    • 在 resources 目录下新建 properties
![600](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202409190012975.png)

被打包到了同一个路径下：classes，我们俗称这个路径为 classpath:

![400](https://raw.githubusercontent.com/hacket/ObsidianOSS/master/obsidian/202409190013245.png)

代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

public class ServletDemo05 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        InputStream is = this.getServletContext().getResourceAsStream("/WEB-INF/classes/com/github/servlet/aa.properties");

        Properties prop = new Properties();
        prop.load(is);
        String user = prop.getProperty("username");
        String pwd = prop.getProperty("password");

        resp.getWriter().print(user+":"+pwd);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doPost(req, resp);
    }
}

HttpServletRequest 和 HttpServletResponse

web 服务器接收到客户端的 http 请求，针对这个请求，分别创建一个代表请求的 HttpServletRequest 对象，代表响应的一个 HttpServletResponse；

  • 如果要获取客户端请求过来的参数：找 HttpServletRequest；
  • 如果要给客户端响应一些信息：找 HttpServletResponse。

HttpServletResponse

HttpServletRequest

  • HttpServletRequest 代表客户端的请求，用户通过 Http 协议访问服务器，HTTP 请求中的所有信息会被封装到 HttpServletRequest，通过这个 HttpServletRequest 的方法，获得客户端的所有信息；

Servlet 的生命周期

back-end, JavaWeb
JavaWeb Servlet
本文由作者按照 CC BY 4.0 进行授权