红帽构建的 Quarkus 入门

流程

1. 前往 项目目录。

2. 使用以下方法之一在 dev 模式中编译 Quarkus Hello 应用程序，具体取决于您要使用的开发人员工具：

   • 如果要使用 Apache Maven，请输入以下命令：

     mvn quarkus:dev

     Copy to Clipboard Toggle word wrap

   • 如果要使用 Quarkus 命令行界面(CLI)，请输入以下命令：

     quarkus dev

     Copy to Clipboard Toggle word wrap

   • 如果要使用 Maven 打包程序，请输入以下命令：

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

     预期输出

     以下摘录显示了预期的输出示例：

     INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
     INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, rest, smallrye-context-propagation, vertx]

     Copy to Clipboard Toggle word wrap

流程

1. 要修改应用程序并添加 companion bean，请使用以下内容创建 src/main/java/org/acme/quickstart/GreetingService.java 文件：

   package org.acme.quickstart;
   
   import jakarta.enterprise.context.ApplicationScoped;
   
   @ApplicationScoped
   public class GreetingService {
   
       public String greeting(String name) {
           return "hello " + name;
       }
   
   }

   Copy to Clipboard Toggle word wrap

2. 编辑 src/main/java/org/acme/quickstart/GreetingResource.java 以注入 GreetingService，并使用它来创建新端点：

   package org.acme.quickstart;
   
   import jakarta.inject.Inject;
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @Inject
       GreetingService service;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       @Path("/greeting/{name}")
       public String greeting(String name) {
           return service.greeting(name);
       }
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from Quarkus REST";
       }
   }

   Copy to Clipboard Toggle word wrap

3. 如果您停止了应用程序，请输入以下命令之一重启它：

   • 使用 Apache Maven：

     mvn quarkus:dev

     Copy to Clipboard Toggle word wrap

   • 使用 Quarkus CLI：

     quarkus dev

     Copy to Clipboard Toggle word wrap

   • 使用 Maven 打包程序：

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

4. 要验证端点是否返回 hello quarkus，请在新的终端窗口中输入以下命令：

   curl -w "\n" http://localhost:8080/hello/greeting/quarkus
   hello quarkus

   Copy to Clipboard Toggle word wrap

流程

1. 打开生成的 pom.xml 文件并查看内容：

   <plugin>
       <artifactId>maven-surefire-plugin</artifactId>
       <version>${surefire-plugin.version}</version>
       <configuration>
          <systemPropertyVariables>
            <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
            <maven.home>${maven.home}</maven.home>
          </systemPropertyVariable>
       </configuration>
   </plugin>

   Copy to Clipboard Toggle word wrap

   请注意以下属性的值：

   • 设置了 java.util.logging.manager 系统属性，以确保您的应用程序在测试中使用正确的日志管理器。
   • maven.home 属性指向 settings.xml 文件的位置，您可以在其中存储您要应用到项目的自定义 Maven 配置。

2. 编辑 src/test/java/org/acme/quickstart/GreetingResourceTest.java 文件，以匹配以下内容：

   package org.acme.quickstart;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import java.util.UUID;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingResourceTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/hello")
             .then()
                .statusCode(200)
                .body(is("Hello from Quarkus REST"));
       }
   
       @Test
       public void testGreetingEndpoint() {
           String uuid = UUID.randomUUID().toString();
           given()
             .pathParam("name", uuid)
             .when().get("/hello/greeting/{name}")
             .then()
               .statusCode(200)
               .body(is("hello " + uuid));
       }
   
   }

   Copy to Clipboard Toggle word wrap
   注意

   通过使用 QuarkusTest 运行程序，您可以指示 JUnit 启动应用，然后再启动测试。

3. 使用以下方法之一运行测试：

   • 使用 Apache Maven：

     mvn test

     Copy to Clipboard Toggle word wrap

   • 使用 Quarkus CLI：

     quarkus test

     Copy to Clipboard Toggle word wrap

   • 使用 Maven 打包程序：

     ./mvnw test

     Copy to Clipboard Toggle word wrap
     注意

     您还可以从 IDE 运行测试。如果这样做，请先停止应用程序。

     默认情况下，测试在端口 8081 上运行，因此它们不会与正在运行的应用程序冲突。在 Quarkus 中，RestAssured 依赖项被配置为使用此端口。

     注意

     如果要使用其他客户端，请使用 @TestHTTPResource 注释，将已测试应用的 URL 直接注入到 Test 类中的字段中。此字段可以是 String、URL 或 URI。您还可以在 @TestHTTPResource 注释中输入测试路径。例如，要测试公开给 /foo 的资源，请在测试中添加以下行：

     @TestHTTPResource("/foo")
     URL testUrl;

     Copy to Clipboard Toggle word wrap
4. 如有必要，在 quarkus.http.test-port 配置属性中指定测试端口。

流程

1. 启动 Quarkus 应用程序。

   • 如果您使用 code.quarkus.redhat.com 应用程序或 Quarkus CLI 创建 Getting Started 项目，则在生成项目时会提供 Maven 打包程序。在项目目录中输入以下命令：

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • 如果您使用在您的机器上安装的 Apache Maven 创建 Getting Started 项目，请输入以下命令：

     mvn quarkus:dev

     Copy to Clipboard Toggle word wrap

   • 如果您在 dev 模式下运行持续测试并使用 Quarkus CLI，请输入以下命令：

     quarkus dev

     Copy to Clipboard Toggle word wrap

2. 在生成的输出日志中查看测试状态的详情。

   注意

   要查看输出日志，您可能需要滚动到屏幕的底部。

   • 启用持续测试后，会显示以下信息：

     Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

     Copy to Clipboard Toggle word wrap

   • 当持续测试暂停时，会显示以下信息：

     Press [e] to edit command line args (currently ''), [r] to resume testing, [o] Toggle test output, [:] for the terminal, [h] for more options>

     Copy to Clipboard Toggle word wrap
     注意

     默认情况下，在启用连续测试后，测试会在启动应用程序后暂停。要查看用于控制如何运行测试的键盘命令，请查看 命令来控制连续测试。

3. 要开始运行测试，请在键盘上按 r 键。

4. 查看更新的输出日志，以监控测试状态和测试结果，检查测试统计信息，并获取后续操作的指导。例如：

   All 2 tests are passing (0 skipped), 2 tests were run in 2094ms. Tests completed at 14:45:11.
   Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

   Copy to Clipboard Toggle word wrap

验证

1. 进行代码更改。例如，在文本编辑器中，打开 src/main/java/org/acme/quickstart/GreetingsResource.java 文件。

2. 更改"hello"端点，以返回 "Hello world" 并保存文件。

   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello world";
       }
   }

   Copy to Clipboard Toggle word wrap
3. 验证 Quarkus 是否立即重新运行测试来测试更改的代码。

4. 查看输出日志，以检查测试结果。在本例中，测试会检查更改的字符串是否包含 "Hello from Quarkus REST" 值。测试失败，因为字符串已更改为 "Hello world"。

   2024-09-26 11:05:45,911 ERROR [io.qua.test] (Test runner thread) Test GreetingResourceTest#testHelloEndpoint() failed: java.lang.AssertionError: 1 expectation failed.
   Response body doesn't match expectation.
   Expected: is "Hello from Quarkus REST"
     Actual: Hello world
           at io.restassured.internal.ValidatableResponseOptionsImpl.body(ValidatableResponseOptionsImpl.java:238)
           at org.acme.quickstart.GreetingResourceTest.testHelloEndpoint(GreetingResourceTest.java:20)
   --
   1 test failed (1 passing, 0 skipped), 2 tests were run in 2076ms. Tests completed at 15:03:45.
   Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

   Copy to Clipboard Toggle word wrap
5. 要退出连续测试，请在键盘上按 Ctrl-C 或 q。

流程

1. 前往 getting-started 项目目录。

2. 要打包 Quarkus Getting Started 项目，请使用以下方法之一，具体取决于您要使用的开发人员工具：

   • 如果要使用 Apache Maven：

     mvn package

     Copy to Clipboard Toggle word wrap

   • 如果要使用 Quarkus CLI：

     quarkus build

     Copy to Clipboard Toggle word wrap

   • 如果您希望使用 Maven 打包程序：

     ./mvnw package

     Copy to Clipboard Toggle word wrap

     这个命令在 /target 目录中生成以下 JAR 文件：

     • getting-started-1.0-0-SNAPSHOT.jar: 包含项目的类和资源。这是 Maven 构建生成的常规工件。
     • quarkus-app/quarkus-run.jar: Is an executable JAR 文件。此文件不是 uber-JAR 文件。依赖项复制到 target/quarkus-app/lib 目录中。

3. 要启动应用程序，请输入以下命令：

   java -jar target/quarkus-app/quarkus-run.jar

   Copy to Clipboard Toggle word wrap
   注意
   • 在运行应用程序前，请确保停止 dev 模式、(press CTRL+C)，或者您将存在端口冲突。
   • quarkus-run.jar 文件中的 MANIFEST.MF 文件的 Class-Path 条目会明确列出 lib 目录中的 JAR 文件。如果要从另一个位置部署应用程序，您必须部署整个 quarkus-app 目录。

流程

1. 通过将 GRAALVM_HOME 环境变量设置为 GraalVM 安装目录来配置运行时环境。例如：

   export GRAALVM_HOME=$HOME/Development/graalvm/

   Copy to Clipboard Toggle word wrap

   • 在 macOS 中，将变量设置为 Home 子目录：

     export GRAALVM_HOME=$HOME/Development/graalvm/Contents/Home/

     Copy to Clipboard Toggle word wrap
   • 在 Windows 服务器上，使用 Control Panel 设置环境变量。

2. 安装 native-image 工具：

   ${GRAALVM_HOME}/bin/gu install native-image

   Copy to Clipboard Toggle word wrap

3. 将 JAVA_HOME 环境变量设置为 GraalVM 安装目录：

   export JAVA_HOME=${GRAALVM_HOME}

   Copy to Clipboard Toggle word wrap

4. 将 GraalVM bin 目录添加到路径中：

   export PATH=${GRAALVM_HOME}/bin:$PATH

   Copy to Clipboard Toggle word wrap

5. 进入 Getting Started 项目文件夹：

   cd getting-started

   Copy to Clipboard Toggle word wrap

6. 使用以下方法之一编译原生镜像：

   • 使用 Maven：

     mvn clean package -Pnative

     Copy to Clipboard Toggle word wrap

   • 使用 Quarkus CLI：

     quarkus build --native

     Copy to Clipboard Toggle word wrap

   • 使用 Maven 打包程序：

     ./mvnw clean package -Pnative

     Copy to Clipboard Toggle word wrap

验证

1. 启动应用程序：

   ./target/getting-started-1.0.0-SNAPSHOT-runner

   Copy to Clipboard Toggle word wrap

2. 观察日志消息，并验证它是否包含 原生 一词：

   2024-09-25 08:35:51,505 INFO [io.quarkus] (main) getting-started 1.0.0-SNAPSHOT native (powered by Quarkus 3.20.2.redhat-00004) started in 0.043s.
   Listening on: http://0.0.0.0:8080

   Copy to Clipboard Toggle word wrap