Jetty 11 未检测到 Jakarta Servlet

Posted 2023-02-22

【中文标题】Jetty 11 未检测到 Jakarta Servlet

【英文标题】：Jetty 11 Doesn't Detect Jakarta Servlets

【发布时间】：2021-09-04 13:10:09

【问题描述】：

这是对this 问题的跟进。我不认为这是重复的，因为接受的答案表明 Jetty 11 不能与 javax servlet 一起使用，但我在问为什么 Jetty 11 不能与 jakarta servlet 一起使用。

我有一个示例项目here，它使用Jetty 9 部署本地服务器，包括一个使用@WebServlet 注释的javax servlet。这一切都很好。

现在我正在尝试更新它以使用 Jetty 11 和 Jakarta servlets API。

pom.xml

<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>io.happycoding</groupId>
  <artifactId>jetty-hello-world</artifactId>
  <version>1</version>

  <properties>
    <!-- Java 11 -->
    <maven.compiler.source>11</maven.compiler.source>
    <maven.compiler.target>11</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <jetty.version>11.0.5</jetty.version>
    <exec.mainClass>io.happycoding.ServerMain</exec.mainClass>
  </properties>

  <dependencies>
    <!-- Jakarta Servlets API -->
    <dependency>
      <groupId>jakarta.servlet</groupId>
      <artifactId>jakarta.servlet-api</artifactId>
      <version>5.0.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- Jetty -->
    <dependency>
      <groupId>org.eclipse.jetty</groupId>
      <artifactId>jetty-server</artifactId>
      <version>$jetty.version</version>
    </dependency>
    <dependency>
      <groupId>org.eclipse.jetty</groupId>
      <artifactId>jetty-annotations</artifactId>
      <version>$jetty.version</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <!-- Copy static resources like html files into the output jar file. -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.7</version>
        <executions>
          <execution>
            <id>copy-web-resources</id>
            <phase>compile</phase>
            <goals><goal>copy-resources</goal></goals>
            <configuration>
              <outputDirectory>
                $project.build.directory/classes/META-INF/resources
              </outputDirectory>
              <resources>
                <resource><directory>./src/main/webapp</directory></resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>

      <!-- Package everything into a single executable jar file. -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>3.2.4</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals><goal>shade</goal></goals>
            <configuration>
              <createDependencyReducedPom>false</createDependencyReducedPom>
              <transformers>
                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <mainClass>$exec.mainClass</mainClass>
                </transformer>
              </transformers>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

ServerMain.java

package io.happycoding;

import java.net.URL;
import org.eclipse.jetty.annotations.AnnotationConfiguration;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.handler.DefaultHandler;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.DefaultServlet;
import org.eclipse.jetty.webapp.Configuration;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.webapp.WebInfConfiguration;

/**
 * Starts up the server, including a DefaultServlet that handles static files,
 * and any servlet classes annotated with the @WebServlet annotation.
 */
public class ServerMain 

  public static void main(String[] args) throws Exception 

    // Create a server that listens on port 8080.
    Server server = new Server(8080);
    WebAppContext webAppContext = new WebAppContext();
    server.setHandler(webAppContext);

    // Load static content from inside the jar file.
    URL webAppDir =
        ServerMain.class.getClassLoader().getResource("META-INF/resources");
    webAppContext.setResourceBase(webAppDir.toURI().toString());

    // Enable annotations so the server sees classes annotated with @WebServlet.
    webAppContext.setConfigurations(new Configuration[] 
      new AnnotationConfiguration(),
      new WebInfConfiguration(), 
    );

    // Look for annotations in the classes directory (dev server) and in the
    // jar file (live server)
    webAppContext.setAttribute(
        "org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern", 
        ".*/target/classes/|.*\\.jar");

    // Handle static resources, e.g. html files.
    webAppContext.addServlet(DefaultServlet.class, "/");

    // Start the server! ????
    server.start();
    System.out.println("Server started!");

    // Keep the main thread alive while the server is running.
    server.join();
  

HelloWorldServlet.java

package io.happycoding.servlets;

import java.io.IOException;

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

@WebServlet("/hello")
public class HelloWorldServlet extends HttpServlet 

  @Override
  public void doGet(HttpServletRequest request, HttpServletResponse response)
      throws IOException 
    response.setContentType("text/html;");
    response.getWriter().println("<h1>Hello world!</h1>");
  

index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>Jetty Hello World</title>
  </head>
  <body>
    <h1>Jetty Hello World</h1>
    <p>This is a sample HTML file. Click <a href="/hello">here</a> to see content served from a servlet.</p>
    <p>Learn more at <a href="https://happycoding.io">HappyCoding.io</a>.</p>
  </body>
</html>

我可以使用mvn package exec:java 运行服务器，它启动得很好。

我的index.html 文件正确加载：

但是当我导航到我的 servlet 的 URL 时，我得到一个 404：

我在命令行中看不到任何错误（或任何输出）。

我还应该提到，我的 Jakarta servlet 可以在完整版的 Jetty 11 上正常工作（使用 Jetty 主目录和 Jetty 基本目录，如 here 所述）。只是这个“独立”的 Jetty 服务器启动器似乎有问题，所以我怀疑我的 ServerMain.java 文件。

我需要进行哪些更改才能让 Jetty 11 检测到我的 Jakarta servlet？

【问题讨论】：

@ElliottFrisch 对my previous question 的回答表明Jetty 11 不能与javax servlet 一起使用。如果 Jetty 11 也不能与 Jakarta servlet 一起使用，那么它可以与什么 一起使用？

@ElliottFrisch 您是说 Jetty 11 根本不支持 servlet？我很欣赏这些回复，但这与我迄今为止读过的任何其他内容都不匹配。对于example：“Eclipse Jetty 11 已发布并被认证为与 Jakarta Servlet v5.0 规范兼容。”甚至您链接的documentation 也说“Jetty 提供了一个 Web 服务器和 servlet 容器”。

@ElliottFrisch jakartaee.servlet 似乎不是 Maven 依赖项。我正在尝试通读文档，但我所阅读的所有内容都表明我正在做的事情应该有效。我猜我的ServerMain.java 文件中有一些愚蠢的东西，但我不确定到底是什么。我正在使用 Maven，我还不太担心 App Engine，只是想先让一些东西在我自己的机器上运行。但是最新版本的 App Engine 支持任意服务器容器，所以我猜如果我可以让它在本地工作，它也可以在 App Engine 上工作。但这不是优先事项。

@ElliottFrisch 我还应该提到，我的 Jakarta servlet 可以在完整版的 Jetty 11 上正常工作（使用 Jetty 主目录和 Jetty 基本目录）。只是这个“独立”的 Jetty 服务器启动器似乎有问题，这就是为什么我怀疑我的 ServerMain.java 文件。我将编辑我的问题以包含该信息。

【参考方案1】：

删除配置工作，它使用错误，是您问题的根源。

这些行，删除它们。

    // Enable annotations so the server sees classes annotated with @WebServlet.
    webAppContext.setConfigurations(new Configuration[] 
      new AnnotationConfiguration(),
      new WebInfConfiguration(), 
    );

从 Jetty 10 开始，您不再以这种方式管理 Configuration 选项。 在您的类路径中存在具有该功能的 jar 就足够了。 （在你的情况下是jetty-annotations-<ver>.jar）

其次，您永远不会将setConfigurations() 与这么小的Configuration 列表一起使用（您会遗漏许多必需的Configuration 条目）。

相反，您应该使用addConfiguration(Configuration...) 方法，仅用于new AnnotationConfiguration()，但前提是该特定Configuration 不是自动发现的，而jetty-annotation 是。

提示，在调用server.start() 之前使用server.setDumpAfterStart(true)，查看服务器状态，包括WebAppContext 的外观及其Configuration 条目。这是查看您的更改对您的服务器和您的上下文所做的事情的好方法。

这是一个使用 Jetty 11 的示例项目，使用 @WebServlet 和 WebAppContext。

https://github.com/jetty-project/embedded-servlet-server/blob/jetty-11.0.x/src/main/java/org/eclipse/jetty/demos/EmbedMe.java

【讨论】：

非常感谢！这完美地解决了我的问题。非常感谢您的帮助。