ZetCode

Java Servlet

最后修改于 2024 年 1 月 27 日

Java Servlet 教程展示了如何在 Java 中创建一个简单的 servlet。我们使用嵌入式 Jetty 服务器。

Java Servlet

Servlet 是一个 Java 类,它响应网络请求。这通常是一个 HTTP 请求。Java servlet 用于创建 Web 应用程序。它们运行在 servlet 容器中,例如 Tomcat 或 Jetty。现代 Java Web 开发使用构建在 servlet 之上的框架。例如,Spring 或 Vaadin 框架使用 servlet。

javax.servletjavax.servlet.http 包提供了用于编写 servlet 的接口和类。

Java Servlet 示例

在下面的例子中,我们使用 @WebServlet 注解来创建一个 Java Servlet。另外,可以在 web.xml 文件中创建映射。

pom.xml
src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │               HelloServlet.java
│   ├───resources
│   └───webapp
│           index.html
└───test
    └───java

这是项目结构。

pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
            http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>JavaServlet</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

        <dependency>
            <groupId>jakarta.servlet</groupId>
            <artifactId>jakarta.servlet-api</artifactId>
            <version>6.0.0</version>
            <scope>provided</scope>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.2.3</version>
            </plugin>

            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>11.0.11</version>
                <configuration>
                    <webApp>
                        <contextPath>/app</contextPath>
                    </webApp>
                </configuration>
            </plugin>

        </plugins>
    </build>

</project>

这是 Maven POM 文件。jakarta.servlet-api 提供了 Servlet API。provided 作用域使依赖项在编译时可用,并指示它在运行时已经可用。它包含在 Servlet 容器(如 Jetty)中。

maven-war-plugin 负责收集 Web 应用程序的所有工件依赖项、类和资源,并将它们打包到 Web 应用程序存档中。jetty-maven-plugin 允许我们使用 mvn jetty:run 运行嵌入式 Jetty 服务器。

<configuration>
    <webApp>
        <contextPath>/app</contextPath>
    </webApp>
</configuration>

在 Jetty Maven 插件中,我们将上下文路径设置为 /app

com/zetcode/HelloServlet.java
package com.zetcode;

import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;

@WebServlet(name = "HelloServlet", urlPatterns = {"/hello"})
public class HelloServlet extends HttpServlet {

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

        response.setContentType("text/plain;charset=UTF-8");
        var out = response.getOutputStream();

        out.print("Hello there from Servlet");
    }
}

HelloServlet 将一个简单的文本消息返回给客户端。

@WebServlet(name = "HelloServlet", urlPatterns = {"/hello"})

Java 类使用 @WebServlet 注解进行修饰。它被映射到 hello URL 模式。

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

对于 GET 请求,将调用 doGet 方法。该方法接收 HttpServletRequestHttpServletResponse 对象。

response.setContentType("text/plain;charset=UTF-8");

servlet 以纯文本形式发送输出数据,并将数据的编码设置为 UTF-8。

var out = response.getOutputStream();

通过 getOutputStream 方法,我们获得 servlet 输出流。请注意,我们不关闭输出流;这是容器的任务。

out.print("Hello there from Servlet");

我们使用 print 方法写入文本消息。

webapp/index.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Home page</title>
</head>
<body>

<p>
    This is home page. Call <a href="/app/hello">HelloServlet</a>
</p>

</body>
</html>

在主页中,我们有一个链接可以调用 servlet。

$ mvn jetty:run

我们运行嵌入式 Jetty 服务器,并将浏览器导航到 https://:8080/app/

来源

Jakarta Servlet 文档

在本文中,我们展示了如何使用嵌入式 Jetty 服务器创建一个简单的 Java Servlet。

作者

我叫 Jan Bodnar,是一位充满热情的程序员,拥有丰富的编程经验。我从 2007 年开始撰写编程文章。迄今为止,我已经撰写了超过 1,400 篇文章和 8 本电子书。我拥有超过十年的编程教学经验。

列出所有Java教程