Quarkus 入门

流程

1. 在命令终端中，输入以下命令验证 Maven 是否使用 JDK 11，并且 Maven 版本是否为 3.6.2 或更高版本：

   mvn --version

   Copy to Clipboard Toggle word wrap
2. 如果上述命令没有返回 JDK 11，请将 JDK 11 的路径添加到 PATH 环境变量中，然后再次输入上述命令。

3. 要生成项目，请输入以下命令之一：

   注意

   不支持 Apple macOS 和 Microsoft Windows。

   • 如果您使用 Linux 或 Apple macOS，请输入以下命令：

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create \
         -DprojectGroupId=org.acme \
         -DprojectArtifactId=getting-started \
         -DplatformGroupId=com.redhat.quarkus \
         -DplatformVersion=1.11.7.Final-redhat-00009 \
         -DclassName="org.acme.quickstart.GreetingResource" \
         -Dpath="/hello"
     cd getting-started

     Copy to Clipboard Toggle word wrap

   • 如果使用 Microsoft Windows 命令行，请输入以下命令：

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create -DprojectGroupId=org.acme -DprojectArtifactId=getting-started -DplatformGroupId=com.redhat.quarkus -DplatformVersion=1.11.7.Final-redhat-00009 -DclassName="org.acme.quickstart.GreetingResource" -Dpath="/hello"

     Copy to Clipboard Toggle word wrap

   • 如果使用 Microsoft Windows Powershell，请输入以下命令：

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create "-DprojectGroupId=org.acme" "-DprojectArtifactId=getting-started" "-DplatformVersion=1.11.7.Final-redhat-00009" "-DplatformGroupId=com.redhat.quarkus" "-DclassName=org.acme.quickstart.GreetingResource" "-Dpath=/hello"

     Copy to Clipboard Toggle word wrap

     这些命令在 ./getting-started 目录中创建以下元素：

     • Maven 项目目录结构
     • 在 /hello上公开的 org.acme.quickstart.GreetingResource 资源
     • 在原生模式和 JVM 模式中测试应用程序的相关单元测试
     • 启动应用程序后可在 http://localhost:8080 上访问登录页面
     • src/main/docker 目录中的 Dockerfile.jvm、Dockerfile.native、Dockerfile.fast-jar 文件示例
     • 应用程序配置文件

4. 创建目录结构后，在文本编辑器中打开 pom.xml 文件并检查文件的内容：

   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>com.redhat.quarkus</groupId>
               <artifactId>quarkus-universe-bom</artifactId>
               <version>${quarkus.version}</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <build>
     <plugins>
       <plugin>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-maven-plugin</artifactId>
         <version>${quarkus-plugin.version}</version>
         <executions>
           <execution>
             <goals>
               <goal>build</goal>
               <goal>generate-code</goal>
               <goal>generate-code-tests</goal>
             </goals>
           </execution>
         </executions>
       </plugin>
    </plugins>
   </build>

   Copy to Clipboard Toggle word wrap

   Quarkus BOM 包含在 pom.xml 文件的 &lt ;dependencyManagement > 部分。因此，您不需要在 pom.xml 文件中列出单个 Quarkus 依赖项的版本。此外，您可以看到 quarkus-maven-plugin 插件，该插件负责打包应用程序并提供开发模式。

5. 查看 pom.xml 文件中的 quarkus-resteasy 依赖项。通过这个依赖项，您可以开发 REST 应用程序：

       <dependency>
           <groupId>io.quarkus</groupId>
           <artifactId>quarkus-resteasy</artifactId>
       </dependency>

   Copy to Clipboard Toggle word wrap

6. 查看 src/main/java/org/acme/quickstart/GreetingResource.java 文件：

   package org.acme.quickstart;
   
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "hello";
       }
   }

   Copy to Clipboard Toggle word wrap

   此文件包含一个简单的 REST 端点，它将 hello 作为您发送到 /hello 端点的请求的响应。

   注意

   使用 Quarkus 时，支持 JAX-RS 的应用程序类，但不是必需的。另外，只创建一个 GreetingResource 类的实例，且每个请求不创建一个实例。您可以使用不同的 sVirt Scoped 注解进行配置，如 ApplicationScoped、RequestScoped 等等。

流程

1. 要在开发模式下编译 Quarkus Hello 应用程序，请从项目目录输入以下命令：

   ./mvnw compile quarkus:dev

   Copy to Clipboard Toggle word wrap

   以下示例显示了这个命令的输出：

   [INFO] --------------------< org.acme:getting-started >---------------------
   [INFO] Building getting-started 1.0.0-SNAPSHOT
   [INFO] --------------------------------[ jar ]---------------------------------
   [INFO]
   [INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ getting-started ---
   [INFO] Using 'UTF-8' encoding to copy filtered resources.
   [INFO] skip non existing resourceDirectory /Users/starksm/Dev/JBoss/Quarkus/starksm64-quarkus-quickstarts/getting-started/src/main/resources
   [INFO]
   [INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ getting-started ---
   [INFO] Changes detected - recompiling the module!
   [INFO] Compiling 2 source files to /Users/starksm/Dev/JBoss/Quarkus/starksm64-quarkus-quickstarts/getting-started/target/classes
   [INFO]
   [INFO] --- quarkus-maven-plugin:<version>:dev (default-cli) @ getting-started ---
   Listening for transport dt_socket at address: 5005
   2019-02-28 17:05:22,347 INFO  [io.qua.dep.QuarkusAugmentor] (main) Beginning quarkus augmentation
   2019-02-28 17:05:22,635 INFO  [io.qua.dep.QuarkusAugmentor] (main) Quarkus augmentation completed in 288ms
   2019-02-28 17:05:22,770 INFO  [io.quarkus] (main) Quarkus started in 0.668s. Listening on: http://localhost:8080
   2019-02-28 17:05:22,771 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]

   Copy to Clipboard Toggle word wrap

2. 在新终端窗口中输入以下命令向应用程序提供的端点发送请求：

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

   Copy to Clipboard Toggle word wrap
   注意

   本例使用 "\n" 属性在命令的输出前自动添加新行。这可防止您的终端打印 '%' 字符，或者将结果和下一个命令提示符放在同一行中。

3. 按 CTRL+C 停止应用程序。

流程

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

   package org.acme.quickstart;
   
   import javax.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 javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   import org.jboss.resteasy.annotations.jaxrs.PathParam;
   
   @Path("/hello")
   public class GreetingResource {
   
       @Inject
       GreetingService service;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       @Path("/greeting/{name}")
       public String greeting(@PathParam String name) {
           return service.greeting(name);
       }
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "hello";
       }
   }

   Copy to Clipboard Toggle word wrap

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

   ./mvnw compile 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"));
       }
   
       @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. 要从 Maven 运行这些测试，请输入以下命令：

   ./mvnw test

   Copy to Clipboard Toggle word wrap
   注意

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

   默认情况下，测试在端口 8081 上运行，以便它们不会与正在运行的应用程序冲突。在 Quarkus 中，Chtrace Assured 依赖项配置为使用此端口。如果要使用其他客户端，请使用 @TestHTTPResource 注释将经过测试应用的 URL 直接注入到 Test 类的字段中。此字段可以是 字符串、URL 或 URI 类型。您还可以在此注解中提供测试路径。例如，要测试映射到 /myservlet 的 servlet，请在测试中添加以下几行：

   @TestHTTPResource("/myservlet")
   URL testUrl;

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

流程

1. 要打包您的 Quarkus Getting Started 项目，请 在根目录中 输入以下命令：

   ./mvnw package

   Copy to Clipboard Toggle word wrap

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

   • get-started-1.0-0-SNAPSHOT.jar ：包含项目的类和资源。这是 Maven 构建生成的常规工件。

   • get-started-1.0-0-SNAPSHOT-runner.jar: Is a executable JAR file.请注意，这个文件不是 uber-JAR 文件，因为依赖项被复制到 目标/lib 目录中。

     警告

     当应用程序以开发模式运行时，您必须按 CTRL+C 停止您的应用程序。当您尝试在启用开发模式时打包应用程序时，您会遇到端口冲突。

2. 输入以下命令启动应用程序：

   java -jar target/getting-started-1.0-0-SNAPSHOT-runner.jar

   Copy to Clipboard Toggle word wrap
   注意

   来自 runner JAR 文件中的 MANIFEST.MF 文件的 Class-Path 条目明确列出了 lib 目录中的 JAR 文件。如果要从其他位置部署应用程序，您必须复制 运行程序 JAR 文件和 lib 目录。

流程

1. 使用 Web 浏览器进入到 https://code.quarkus.redhat.com。

2. 指定项目的基本详情：

   1. 输入项目的组名称。名称的格式遵循 Java 软件包命名约定，如 org.acme。
   2. 输入您要用于项目生成的 Maven 工件的名称，如 code-with-quarkus。

   3. 选择您要用来编译和启动应用程序的构建工具。您选择的构建工具决定：

      • 生成的项目的目录结构。
      • 您生成的项目中使用的配置文件格式。

      • 在生成项目后，用来编译和启动应用程序的自定义构建脚本和命令会显示 code.quarkus.redhat.com。

        注意

        红帽提供了对使用 code.quarkus.redhat.com 创建 Quarkus Maven 项目的支持。红帽不支持生成 Gradle 项目。

        

3. 指定应用程序项目的更多详情：

   1. 选择 Configure more options 来显示包含额外应用程序详情的字段。
   2. 输入项目生成的工件中使用的版本。此字段的默认值为 1.0.0-SNAPSHOT。建议使用 语义版本 控制，但如果您偏好使用不同类型的版本控制。

   3. 选择您是否希望 code.quarkus.redhat.com 将示例代码添加到您的项目中。当您从扩展列表中添加标记为 图标的扩展时，您可以启用这个选项，以便在生成项目时为这些扩展自动创建示例类文件和资源文件。当您不添加提供示例代码的任何扩展时，这个选项不会影响您生成的项目。

      
      注意

      code.quarkus.redhat.com 会自动使用红帽构建的 Quarkus 的最新版本。您可在生成项目后手动更改 pom.xml 文件中的 BOM 版本。

4. 从扩展列表中选择您要在应用程序中使用的扩展。所选扩展包含在 Quarkus 应用程序的依赖项中，及其版本由 Quarkus 平台管理，以确保其兼容性。

   您可以启用这个选项来为标记为 图标的扩展自动生成示例代码。

   

   请注意，红帽为列表上的单个扩展 提供不同的支持级别，由每个扩展名称旁的标签表示：

   • 红帽完全支持 SUPPORTED 扩展，用于生产环境中的企业级应用程序。
   • 在 技术预览功能支持范围 下，红帽对生产环境中的 支持 受到有限的支持。
   • 红帽不支持将 DEV-SUPPORT 扩展用于生产环境，但红帽提供的核心功能由红帽开发人员支持用于开发新应用程序。
   • 红帽不支持未标记的扩展用于生产环境。

   • DEPRECATED 扩展计划被提供相同功能的较新的技术或实施替代。

     您可以扩展每个扩展旁边的溢出菜单，以访问您可以使用的附加选项：

     • 在命令行中使用 Quarkus maven 插件，将扩展添加到现有项目。
     • 复制 XML 代码片段，将扩展添加到项目的 pom.xml 文件中。
     • 获取每个扩展的 groupId、artifactId 和 version。

     • 打开扩展指南。

       

5. 选择 Generate your application 来确认您的选择并显示覆盖页面，其中包含包含您生成的项目的存档的下载链接。覆盖屏幕还显示可用于编译和启动应用程序的自定义命令。
6. 选择 Download the ZIP，将生成的项目文件的归档保存到机器中。
7. 提取存档的内容。

8. 进入包含您提取的项目文件的目录：

   cd <directory_name>

   Copy to Clipboard Toggle word wrap

9. 以开发模式编译并启动应用程序：

   ./mvnw compile quarkus:dev

   Copy to Clipboard Toggle word wrap