使用 JBoss EAP XP 4.0.0

流程

1. 使用以下管理命令启用 microprofile-opentracing-smallrye 子系统：

   /subsystem=microprofile-opentracing-smallrye:add()

   Copy to Clipboard Toggle word wrap

2. 重新加载服务器以使更改生效。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 删除 microprofile-opentracing-smallrye 子系统。

   /subsystem=microprofile-opentracing-smallrye:remove()

   Copy to Clipboard Toggle word wrap

2. 重新加载服务器以使更改生效。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 在 CLI 中运行以下命令来使用 docker 安装 Jaeger：

   $ docker run -d --name jaeger   -p 6831:6831/udp   -p 5778:5778   -p 14268:14268   -p 16686:16686   jaegertracing/all-in-one:1.16

   Copy to Clipboard Toggle word wrap

流程

1. 创建一个要存储文件的目录：

   $ mkdir -p ~/config/prop-files/

   Copy to Clipboard Toggle word wrap

2. 进入该目录：

   $ cd ~/config/prop-files/

   Copy to Clipboard Toggle word wrap

3. 创建 文件名 来存储属性名为 的值：

   $ touch name

   Copy to Clipboard Toggle word wrap

4. 将属性值添加到文件中：

   $ echo "jim" > name

   Copy to Clipboard Toggle word wrap

5. 创建一个 ConfigSource，其中文件名是属性，文件内容为属性值：

   /subsystem=microprofile-config-smallrye/config-source=file-props:add(dir={path=~/config/prop-files})

   Copy to Clipboard Toggle word wrap

   这会生成以下 XML 配置：

   <subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
       <config-source name="file-props">
           <dir path="/etc/config/prop-files"/>
       </config-source>
   </subsystem>

   Copy to Clipboard Toggle word wrap

流程

1. 使用以下管理 CLI 命令添加 MicroProfile 容错扩展：

   /extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

   Copy to Clipboard Toggle word wrap

2. 使用以下命令启用 microprofile-fault-tolerance-smallrye 子系统：

   /subsystem=microprofile-fault-tolerance-smallrye:add

   Copy to Clipboard Toggle word wrap

3. 使用以下管理命令重新载入服务器：

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 导航到 Runtime 选项卡，再选择服务器。
2. 在 Monitor 列中，单击 MicroProfile Health → View。

流程

1. 在 microprofile-health-smallrye 子系统中将 security-enabled 属性设置为 true。

   /subsystem=microprofile-health-smallrye:write-attribute(name=security-enabled,value=true)

   Copy to Clipboard Toggle word wrap

2. 重新加载服务器以使更改生效。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 在 JBoss EAP 中启用 MicroProfile JWT 小扩展：

   /extension=org.wildfly.extension.microprofile.jwt-smallrye:add

   Copy to Clipboard Toggle word wrap

2. 启用 microprofile-jwt-smallrye 子系统：

   /subsystem=microprofile-jwt-smallrye:add

   Copy to Clipboard Toggle word wrap

3. 重新载入服务器：

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 在 microprofile-metrics-smallrye 子系统中将 security-enabled 属性设置为 true。

   /subsystem=microprofile-metrics-smallrye:write-attribute(name=security-enabled,value=true)

   Copy to Clipboard Toggle word wrap

2. 重新加载服务器以使更改生效。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 为 undertow 子系统启用统计信息：

   • 启动启用统计的单机服务器：

     $ ./standalone.sh -Dwildfly.statistics-enabled=true

     Copy to Clipboard Toggle word wrap

   • 对于已在运行的服务器，启用 undertow 子系统的统计信息：

     /subsystem=undertow:write-attribute(name=statistics-enabled,value=true)

     Copy to Clipboard Toggle word wrap

2. 部署 helloworld-rs 快速启动：

   • 在 Quickstart 的根目录中，使用 Maven 部署 Web 应用程序：

     $ mvn clean install wildfly:deploy

     Copy to Clipboard Toggle word wrap

3. 使用 curl 命令在 CLI 中查询 HTTP 端点，并过滤 request_count:

   $ curl -v http://localhost:9990/metrics |  grep request_count

   Copy to Clipboard Toggle word wrap

   预期输出：

   jboss_undertow_request_count_total{server="default-server",http_listener="default",} 0.0

   Copy to Clipboard Toggle word wrap

   返回的属性值是 0.0。

4. 在网页浏览器中访问位于 http://localhost:8080/helloworld-rs/ 的快速入门并点击任何链接。

5. 再次通过 CLI 查询 HTTP 端点：

   $ curl -v http://localhost:9990/metrics |  grep request_count

   Copy to Clipboard Toggle word wrap

   预期输出：

   jboss_undertow_request_count_total{server="default-server",http_listener="default",} 1.0

   Copy to Clipboard Toggle word wrap

   该值更新为 1.0。

   重复最后两个步骤，以验证请求数是否已更新。

流程

1. 在 JBoss EAP 中启用 MicroProfile OpenAPI smallrye 扩展：

   /extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

   Copy to Clipboard Toggle word wrap

2. 使用以下管理命令启用 microprofile-openapi-smallrye 子系统：

   /subsystem=microprofile-openapi-smallrye:add()

   Copy to Clipboard Toggle word wrap

3. 重新加载服务器。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 在应用程序源树中创建目录：

   $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

   Copy to Clipboard Toggle word wrap

   APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

2. 查询 OpenAPI 端点，将输出重定向到文件：

   $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

   Copy to Clipboard Toggle word wrap

   默认情况下，端点提供 YAML 文档，format=JSON 指定返回 JSON 文档。

3. 配置应用程序，以便在处理 OpenAPI 文档模型时跳过注解扫描：

   $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

   Copy to Clipboard Toggle word wrap

4. 重建应用程序：

   $ mvn clean install

   Copy to Clipboard Toggle word wrap

5. 使用以下管理 CLI 命令再次部署应用程序：

   1. 取消部署应用程序：

      undeploy microprofile-openapi.war

      Copy to Clipboard Toggle word wrap

   2. 部署应用程序：

      deploy APPLICATION_ROOT/target/microprofile-openapi.war

      Copy to Clipboard Toggle word wrap

流程

1. 打开 JBoss EAP 管理 CLI。
2. 输入以下代码：

流程

1. 运行以下 CLI 脚本以更新默认的 standalone.xml 服务器配置文件：

   $ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli

   Copy to Clipboard Toggle word wrap

2. 使用以下命令，选择默认 standalone.xml 服务器配置文件以外的独立服务器配置：

   $ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli -Dconfig=<standalone-full.xml|standalone-ha.xml|standalone-full-ha.xml>

   Copy to Clipboard Toggle word wrap
3. 指定的配置文件现在包含 MicroProfile 子系统和扩展。

流程

1. 打开浏览器并登录 红帽客户门户。
2. 从页面顶部的菜单中选择 Downloads。
3. 在列表中找到 Red Hat JBoss Enterprise Application Platform 条目并选择它。
4. 从 Product 下拉列表中，选择 JBoss EAP XP。
5. 从 Version 下拉列表中，选择 4.0.0。
6. 点 Releases 选项卡。
7. 在列表中找到 JBoss EAP XP 4.0.0 Incremental Maven Repository，然后单击 Download。
8. 将存档文件保存到您的本地目录。

流程

1. 找到 Red Hat JBoss Enterprise Application Platform 7.4.0.GA Maven 存储库的路径。例如： /path/to/repo/jboss-eap-7.4.0.GA-maven-repository/maven-repository/.

2. 将下载的 JBoss EAP XP 4.0.0 Incremental Maven 存储库直接提取到 Red Hat JBoss Enterprise Application Platform 7.4.0.GA Maven 存储库的目录中。例如，打开一个终端并发出以下命令，替换 Red Hat JBoss Enterprise Application Platform 7.4.0.GA Maven 存储库路径的值：

   $ unzip -o jboss-eap-xp-4.0.0-incremental-maven-repository.zip -d EAP_MAVEN_REPOSITORY_PATH

   Copy to Clipboard Toggle word wrap

流程

1. 选择配置方法并配置 JBoss EAP MicroProfile Maven 存储库。

2. 在配置了 JBoss EAP MicroProfile Maven 存储库后，将 jboss-eap-xp-microprofile BOM 添加到项目 POM 文件中。以下示例演示了如何在 pom.xml 文件的 < dependencyManagement& gt; 部分中配置 BOM：

   <dependencyManagement>
     <dependencies>
       ...
       <dependency>
         <groupId>org.jboss.bom</groupId>
         <artifactId>jboss-eap-xp-microprofile</artifactId>
         <version>4.0.0.GA</version>
         <type>pom</type>
         <scope>import</scope>
     </dependency>
       ...
     </dependencies>
   </dependencyManagement>

   Copy to Clipboard Toggle word wrap
   注意

   如果您没有为 pom.xml 文件中的 type 元素指定值，Maven 会为元素指定一个 jar 值。

流程

1. 设置 Maven 项目。

   $ mvn archetype:generate \
       -DgroupId=com.example \
       -DartifactId=microprofile-config \
       -DinteractiveMode=false \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp
   cd microprofile-config

   Copy to Clipboard Toggle word wrap

   这将为项目和 pom.xml 配置文件创建目录结构。

2. 要让 POM 文件自动管理 MicroProfile 配置构件的版本和 jboss-eap-xp-microprofile BOM 中的 MicroProfile REST 客户端构件，请将 BOM 导入到项目 POM 文件的 & lt;dependencyManagement > 部分。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>4.0.0.GA</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

   Copy to Clipboard Toggle word wrap

3. 将 MicroProfile Config 构件和 MicroProfile REST 客户端构件和其他依赖项（由 BOM 管理）添加到项目 POM 文件的 <dependency > 部分。以下示例演示了将 MicroProfile 配置和 MicroProfile REST 客户端依赖项添加到该文件中：

   <!-- Add the MicroProfile REST Client API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.rest.client</groupId>
     <artifactId>microprofile-rest-client-api</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the MicroProfile Config API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.config</groupId>
     <artifactId>microprofile-config-api</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the {JAX-RS} API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.jboss.spec.javax.ws.rs</groupId>
     <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
     <scope>provided</scope>
   </dependency>
   <!-- Add the CDI API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>jakarta.enterprise</groupId>
     <artifactId>jakarta.enterprise.cdi-api</artifactId>
     <scope>provided</scope>
   </dependency>

   Copy to Clipboard Toggle word wrap

流程

1. 创建用于存储类文件的目录：

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/config/

   Copy to Clipboard Toggle word wrap

   其中 APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

2. 进入新目录：

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/config/

   Copy to Clipboard Toggle word wrap

   创建此流程中描述的所有类文件。

3. 创建名为 HelloApplication.java 的类文件，其内容如下：

   package com.example.microprofile.config;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class HelloApplication extends Application {
   
   }

   Copy to Clipboard Toggle word wrap

   此类将应用定义为 Jakarta RESTful Web Services 应用。

4. 创建名为 HelloService.java 的类文件，其内容如下：

   package com.example.microprofile.config;
   
   public class HelloService {
   	String createHelloMessage(String name){
           return "Hello " + name;
       }
   }

   Copy to Clipboard Toggle word wrap

5. 创建名为 HelloWorld.java 的类文件，其内容如下：

   package com.example.microprofile.config;
   
   import javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   
   @Path("/config")
   public class HelloWorld {
   
       @Inject
       @ConfigProperty(name="name", defaultValue="jim") 

   1

   
       String name;
   
      	@Inject
      	HelloService helloService;
   
      	@GET
      	@Path("/json")
      	@Produces({ "application/json" })
      	public String getHelloWorldJSON() {
           String message = helloService.createHelloMessage(name);
          	return "{\"result\":\"" + message + "\"}";
   	}
   }

   Copy to Clipboard Toggle word wrap

   1

   MicroProfile Config 属性注入到类中，其注释为 @ConfigProperty (name="name", defaultValue="jim")。如果没有配置 ConfigSource，则返回值 jim。

6. 在 src/main/webapp/WEB-INF/ 目录中创建一个名为 beans.xml 的空文件：

   $ touch APPLICATION_ROOT/src/main/webapp/WEB-INF/beans.xml

   Copy to Clipboard Toggle word wrap

   其中 APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

7. 进入应用程序的根目录：

   $ cd APPLICATION_ROOT

   Copy to Clipboard Toggle word wrap

   其中 APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

8. 构建项目：

   $ mvn clean install wildfly:deploy

   Copy to Clipboard Toggle word wrap

9. 测试输出：

   $ curl http://localhost:8080/microprofile-config/config/json

   Copy to Clipboard Toggle word wrap

   以下是预期的输出：

   {"result":"Hello jim"}

   Copy to Clipboard Toggle word wrap

流程

1. 使用以下管理 CLI 命令添加 MicroProfile 容错扩展：

   /extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

   Copy to Clipboard Toggle word wrap

2. 使用以下命令启用 microprofile-fault-tolerance-smallrye 子系统：

   /subsystem=microprofile-fault-tolerance-smallrye:add

   Copy to Clipboard Toggle word wrap

3. 使用以下管理命令重新载入服务器：

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 设置 Maven 项目：

   mvn archetype:generate \
       -DgroupId=com.example.microprofile.faulttolerance \
       -DartifactId=microprofile-fault-tolerance \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp \
       -DinteractiveMode=false
   cd microprofile-fault-tolerance

   Copy to Clipboard Toggle word wrap

   该命令创建项目的目录结构以及 pom.xml 配置文件。

2. 要让 POM 文件自动管理 jboss-eap-xp-microprofile BOM 中 MicroProfile Fault Tolerance 工件的版本，请将 BOM 导入到项目 POM 文件的 & lt;dependencyManagement > 部分。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>${version.microprofile.bom}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

   Copy to Clipboard Toggle word wrap

   将 ${version.microprofile.bom} 替换为安装的 BOM 版本。

3. 将由 BOM 管理的 MicroProfile Fault Tolerance 工件添加到项目 POM 文件的 & lt;dependency > 部分。以下示例演示了将 MicroProfile Fault Tolerance 依赖项添加到该文件中：

   <!-- Add the MicroProfile Fault Tolerance API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.fault.tolerance</groupId>
     <artifactId>microprofile-fault-tolerance-api</artifactId>
     <scope>provided</scope>
   </dependency>

   Copy to Clipboard Toggle word wrap

流程

1. 创建用于存储类文件的目录：

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/faulttolerance

   Copy to Clipboard Toggle word wrap

   APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

2. 进入新目录：

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/faulttolerance

   Copy to Clipboard Toggle word wrap

   对于以下步骤，请在新目录中创建所有类文件。

3. 创建一个简单的实体，其代表 Coffee 示例为 Coffee.java，其内容如下：

   package com.example.microprofile.faulttolerance;
   
   public class Coffee {
   
       public Integer id;
       public String name;
       public String countryOfOrigin;
       public Integer price;
   
       public Coffee() {
       }
   
       public Coffee(Integer id, String name, String countryOfOrigin, Integer price) {
           this.id = id;
           this.name = name;
           this.countryOfOrigin = countryOfOrigin;
           this.price = price;
       }
   }

   Copy to Clipboard Toggle word wrap

4. 创建包含以下内容的类文件 CoffeeApplication.java ：

   package com.example.microprofile.faulttolerance;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/")
   public class CoffeeApplication extends Application {
   }

   Copy to Clipboard Toggle word wrap

5. 创建包含以下内容的 Jakarta 上下文和依赖注入 Bean 作为 CoffeeRepositoryService.java ：

   package com.example.microprofile.faulttolerance;
   
   import java.util.ArrayList;
   import java.util.Collections;
   import java.util.HashMap;
   import java.util.List;
   import java.util.Map;
   import java.util.stream.Collectors;
   import javax.enterprise.context.ApplicationScoped;
   
   @ApplicationScoped
   public class CoffeeRepositoryService {
   
       private Map<Integer, Coffee> coffeeList = new HashMap<>();
   
       public CoffeeRepositoryService() {
           coffeeList.put(1, new Coffee(1, "Fernandez Espresso", "Colombia", 23));
           coffeeList.put(2, new Coffee(2, "La Scala Whole Beans", "Bolivia", 18));
           coffeeList.put(3, new Coffee(3, "Dak Lak Filter", "Vietnam", 25));
       }
   
       public List<Coffee> getAllCoffees() {
           return new ArrayList<>(coffeeList.values());
       }
   
       public Coffee getCoffeeById(Integer id) {
           return coffeeList.get(id);
       }
   
       public List<Coffee> getRecommendations(Integer id) {
           if (id == null) {
               return Collections.emptyList();
           }
           return coffeeList.values().stream()
                   .filter(coffee -> !id.equals(coffee.id))
                   .limit(2)
                   .collect(Collectors.toList());
       }
   }

   Copy to Clipboard Toggle word wrap

6. 创建包含以下内容的类文件 CoffeeResource.java ：

   package com.example.microprofile.faulttolerance;
   
   import java.util.List;
   import java.util.Random;
   import java.util.concurrent.atomic.AtomicLong;
   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 java.util.Collections;
   import javax.ws.rs.PathParam;
   import org.eclipse.microprofile.faulttolerance.Fallback;
   import org.eclipse.microprofile.faulttolerance.Timeout;
   import org.eclipse.microprofile.faulttolerance.Retry;
   
   @Path("/coffee")
   @Produces(MediaType.APPLICATION_JSON)
   public class CoffeeResource {
   
       @Inject
       private CoffeeRepositoryService coffeeRepository;
   
       private AtomicLong counter = new AtomicLong(0);
   
       @GET
       @Retry(maxRetries = 4) 

   1

   
       public List<Coffee> coffees() {
           final Long invocationNumber = counter.getAndIncrement();
           return coffeeRepository.getAllCoffees();
       }
   
   
       @GET
       @Path("/{id}/recommendations")
       @Timeout(250) 

   2

   
       public List<Coffee> recommendations(@PathParam("id") int id) {
               return coffeeRepository.getRecommendations(id);
           }
   
       @GET
       @Path("fallback/{id}/recommendations")
       @Fallback(fallbackMethod = "fallbackRecommendations") 

   3

   
       public List<Coffee> recommendations2(@PathParam("id") int id) {
           return coffeeRepository.getRecommendations(id);
           }
   
       public List<Coffee> fallbackRecommendations(int id) {
           //always return a default coffee
           return Collections.singletonList(coffeeRepository.getCoffeeById(1));
       }
   }

   Copy to Clipboard Toggle word wrap

   1

   定义重新应用到 4 的数量。

   2

   以毫秒为单位定义超时间隔。

   3

   定义在调用失败时调用的回退方法。

7. 进入应用程序的根目录：

   $ cd APPLICATION_ROOT

   Copy to Clipboard Toggle word wrap

8. 使用以下 Maven 命令构建应用程序：

   $ mvn clean install wildfly:deploy

   Copy to Clipboard Toggle word wrap

   访问位于 http://localhost:8080/microprofile-fault-tolerance/coffee 的应用。

流程

1. 在 JBoss EAP 中启用 MicroProfile JWT 小扩展：

   /extension=org.wildfly.extension.microprofile.jwt-smallrye:add

   Copy to Clipboard Toggle word wrap

2. 启用 microprofile-jwt-smallrye 子系统：

   /subsystem=microprofile-jwt-smallrye:add

   Copy to Clipboard Toggle word wrap

3. 重新载入服务器：

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 设置 maven 项目：

   $ mvn archetype:generate -DinteractiveMode=false \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-webapp \
       -DgroupId=com.example -DartifactId=microprofile-jwt \
       -Dversion=1.0.0.Alpha1-SNAPSHOT
     cd microprofile-jwt

   Copy to Clipboard Toggle word wrap

   该命令创建项目的目录结构以及 pom.xml 配置文件。

2. 要让 POM 文件自动管理 jboss-eap-xp-microprofile BOM 中 MicroProfile JWT 构件的版本，请将 BOM 导入到项目 POM 文件的 & lt;dependencyManagement > 部分。

   <dependencyManagement>
     <dependencies>
       <!-- importing the microprofile BOM adds MicroProfile specs -->
       <dependency>
           <groupId>org.jboss.bom</groupId>
           <artifactId>jboss-eap-xp-microprofile</artifactId>
           <version>${version.microprofile.bom}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>

   Copy to Clipboard Toggle word wrap

   将 ${version.microprofile.bom} 替换为安装的 BOM 版本。

3. 将由 BOM 管理的 MicroProfile JWT 构件添加到项目 POM 文件的 & lt;dependency > 部分。以下示例演示了将 MicroProfile JWT 依赖项添加到文件中：

   <!-- Add the MicroProfile JWT API. Set provided for the <scope> tag, as the API is included in the server. -->
   <dependency>
     <groupId>org.eclipse.microprofile.jwt</groupId>
     <artifactId>microprofile-jwt-auth-api</artifactId>
     <scope>provided</scope>
   </dependency>

   Copy to Clipboard Toggle word wrap

流程

1. 创建令牌生成器。

   此步骤充当参考。对于生产环境，请使用 Red Hat SSO 等身份提供程序。

   1. 为 token the generator 实用程序创建一个目录 src/test/java，并导航到它：

      $ mkdir -p src/test/java
      $ cd src/test/java

      Copy to Clipboard Toggle word wrap

   2. 使用以下内容创建一个类文件 TokenUtil.java ：

      package  com.example.mpjwt;
      
      import java.io.FileInputStream;
      import java.io.InputStream;
      import java.nio.charset.StandardCharsets;
      import java.security.KeyFactory;
      import java.security.PrivateKey;
      import java.security.spec.PKCS8EncodedKeySpec;
      import java.util.Base64;
      import java.util.UUID;
      
      import javax.json.Json;
      import javax.json.JsonArrayBuilder;
      import javax.json.JsonObjectBuilder;
      
      import com.nimbusds.jose.JOSEObjectType;
      import com.nimbusds.jose.JWSAlgorithm;
      import com.nimbusds.jose.JWSHeader;
      import com.nimbusds.jose.JWSObject;
      import com.nimbusds.jose.JWSSigner;
      import com.nimbusds.jose.Payload;
      import com.nimbusds.jose.crypto.RSASSASigner;
      
      public class TokenUtil {
      
          private static PrivateKey loadPrivateKey(final String fileName) throws Exception {
              try (InputStream is = new FileInputStream(fileName)) {
                  byte[] contents = new byte[4096];
                  int length = is.read(contents);
                  String rawKey = new String(contents, 0, length, StandardCharsets.UTF_8)
                          .replaceAll("-----BEGIN (.*)-----", "")
                          .replaceAll("-----END (.*)----", "")
                          .replaceAll("\r\n", "").replaceAll("\n", "").trim();
      
                  PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(Base64.getDecoder().decode(rawKey));
                  KeyFactory keyFactory = KeyFactory.getInstance("RSA");
      
                  return keyFactory.generatePrivate(keySpec);
              }
          }
      
          public static String generateJWT(final String principal, final String birthdate, final String...groups) throws Exception {
          	PrivateKey privateKey = loadPrivateKey("private.pem");
      
              JWSSigner signer = new RSASSASigner(privateKey);
              JsonArrayBuilder groupsBuilder = Json.createArrayBuilder();
              for (String group : groups) { groupsBuilder.add(group); }
      
              long currentTime = System.currentTimeMillis() / 1000;
              JsonObjectBuilder claimsBuilder = Json.createObjectBuilder()
                      .add("sub", principal)
                      .add("upn", principal)
                      .add("iss", "quickstart-jwt-issuer")
                      .add("aud", "jwt-audience")
                      .add("groups", groupsBuilder.build())
                      .add("birthdate", birthdate)
                      .add("jti", UUID.randomUUID().toString())
                      .add("iat", currentTime)
                      .add("exp", currentTime + 14400);
      
              JWSObject jwsObject = new JWSObject(new JWSHeader.Builder(JWSAlgorithm.RS256)
                      .type(new JOSEObjectType("jwt"))
                      .keyID("Test Key").build(),
                      new Payload(claimsBuilder.build().toString()));
      
              jwsObject.sign(signer);
      
              return jwsObject.serialize();
          }
      
          public static void main(String[] args) throws Exception {
              if (args.length < 2) throw new IllegalArgumentException("Usage TokenUtil {principal} {birthdate} {groups}");
              String principal = args[0];
              String birthdate = args[1];
              String[] groups = new String[args.length - 2];
              System.arraycopy(args, 2, groups, 0, groups.length);
      
              String token = generateJWT(principal, birthdate, groups);
              String[] parts = token.split("\\.");
              System.out.println(String.format("\nJWT Header - %s", new String(Base64.getDecoder().decode(parts[0]), StandardCharsets.UTF_8)));
              System.out.println(String.format("\nJWT Claims - %s", new String(Base64.getDecoder().decode(parts[1]), StandardCharsets.UTF_8)));
              System.out.println(String.format("\nGenerated JWT Token \n%s\n", token));
          }
      }

      Copy to Clipboard Toggle word wrap

2. 在 src/main/webapp/WEB-INF 目录中创建 web.xml 文件，其内容如下：

   <context-param>
       <param-name>resteasy.role.based.security</param-name>
       <param-value>true</param-value>
   </context-param>
   
   <security-role>
       <role-name>Subscriber</role-name>
   </security-role>

   Copy to Clipboard Toggle word wrap

3. 使用以下内容创建一个类文件 SampleEndPoint.java ：

   package com.example.mpjwt;
   
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   
   import java.security.Principal;
   import javax.ws.rs.core.Context;
   import javax.ws.rs.core.SecurityContext;
   
   import javax.annotation.security.RolesAllowed;
   import javax.inject.Inject;
   
   import java.time.LocalDate;
   import java.time.Period;
   import java.util.Optional;
   
   import org.eclipse.microprofile.jwt.Claims;
   import org.eclipse.microprofile.jwt.Claim;
   
   import org.eclipse.microprofile.jwt.JsonWebToken;
   
   @Path("/Sample")
   public class SampleEndPoint {
   
       @GET
       @Path("/helloworld")
       public String helloworld(@Context SecurityContext securityContext) {
           Principal principal = securityContext.getUserPrincipal();
           String caller = principal == null ? "anonymous" : principal.getName();
   
           return "Hello " + caller;
       }
   
       @Inject
   	JsonWebToken jwt;
   
   	@GET()
   	@Path("/subscription")
   	@RolesAllowed({"Subscriber"})
   	public String helloRolesAllowed(@Context SecurityContext ctx) {
       	Principal caller =  ctx.getUserPrincipal();
       	String name = caller == null ? "anonymous" : caller.getName();
       	boolean hasJWT = jwt.getClaimNames() != null;
       	String helloReply = String.format("hello + %s, hasJWT: %s", name, hasJWT);
   
       	return helloReply;
   	}
   
   	@Inject
   	@Claim(standard = Claims.birthdate)
   	Optional<String> birthdate;
   
   	@GET()
   	@Path("/birthday")
   	@RolesAllowed({ "Subscriber" })
   	public String birthday() {
       	if (birthdate.isPresent()) {
           	LocalDate birthdate = LocalDate.parse(this.birthdate.get().toString());
           	LocalDate today = LocalDate.now();
           	LocalDate next = birthdate.withYear(today.getYear());
           	if (today.equals(next)) {
               	return "Happy Birthday";
           }
           if (next.isBefore(today)) {
               next = next.withYear(next.getYear() + 1);
           }
   
           Period wait = today.until(next);
   
           return String.format("%d months and %d days until your next birthday.", wait.getMonths(), wait.getDays());
       }
   
       return "Sorry, we don't know your birthdate.";
   
   	}
   
   }

   Copy to Clipboard Toggle word wrap

   使用 @Path 注解的方法是 Jakarta RESTful Web Services 端点。

   注释 @Claim 定义 JWT 声明。

4. 创建类文件 App.java 以启用 Jakarta RESTful Web Services：

   package com.example.mpjwt;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   import org.eclipse.microprofile.auth.LoginConfig;
   
   @ApplicationPath("/rest")
   @LoginConfig(authMethod="MP-JWT", realmName="MP JWT Realm")
   public class App extends Application {}

   Copy to Clipboard Toggle word wrap

   注释 @LoginConfig (authMethod="MP-JWT", realmName="MP JWT Realm") 在部署过程中启用 JWT RBAC。

5. 使用以下 Maven 命令编译应用程序：

   $ mvn package

   Copy to Clipboard Toggle word wrap

6. 使用令牌生成器工具生成 JWT 令牌：

   $ mvn exec:java -Dexec.mainClass=org.wildfly.quickstarts.mpjwt.TokenUtil -Dexec.classpathScope=test -Dexec.args="testUser 2017-09-15 Echoer Subscriber"

   Copy to Clipboard Toggle word wrap

7. 使用以下 Maven 命令构建和部署应用程序：

   $ mvn package wildfly:deploy

   Copy to Clipboard Toggle word wrap

8. 测试应用。

   • 使用 bearer 令牌调用 Sample/subscription 端点：

     $ curl -H "Authorization: Bearer ey..rg" http://localhost:8080/microprofile-jwt/rest/Sample/subscription

     Copy to Clipboard Toggle word wrap

   • 调用 Sample/birthday 端点：

     $ curl -H "Authorization: Bearer ey..rg" http://localhost:8080/microprofile-jwt/rest/Sample/birthday

     Copy to Clipboard Toggle word wrap

流程

1. 使用以下内容创建一个类文件 HelloService.java ：

   package com.example.microprofile.metrics;
   
   public class HelloService {
       String createHelloMessage(String name){
           return "Hello" + name;
       }
   }

   Copy to Clipboard Toggle word wrap

2. 使用以下内容创建一个类文件 HelloWorld.java ：

   package com.example.microprofile.metrics;
   
   import javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import org.eclipse.microprofile.metrics.annotation.Counted;
   
   @Path("/")
   public class HelloWorld {
   @Inject
       HelloService helloService;
   
   @GET
   @Path("/json")
       @Produces({ "application/json" })
       @Counted(name = "requestCount",
     		 absolute = true,
   description = "Number of times the getHelloWorldJSON was requested")
       public String getHelloWorldJSON() {
           return "{\"result\":\"" + helloService.createHelloMessage("World") + "\"}";
       }
   }

   Copy to Clipboard Toggle word wrap

3. 更新 pom.xml 文件，使其包含以下依赖项：

   <dependency>
       <groupId>org.eclipse.microprofile.metrics</groupId>
       <artifactId>microprofile-metrics-api</artifactId>
       <scope>provided</scope>
   </dependency>

   Copy to Clipboard Toggle word wrap

4. 使用以下 Maven 命令构建应用程序：

   $ mvn clean install wildfly:deploy

   Copy to Clipboard Toggle word wrap

5. 测试指标：

   1. 在 CLI 中运行以下命令：

      $ curl -v http://localhost:9990/metrics |  grep request_count | grep helloworld-rs-metrics

      Copy to Clipboard Toggle word wrap

      预期输出：

      jboss_undertow_request_count_total{deployment="helloworld-rs-metrics.war",servlet="org.jboss.as.quickstarts.rshelloworld.JAXActivator",subdeployment="helloworld-rs-metrics.war",microprofile_scope="vendor"} 0.0

      Copy to Clipboard Toggle word wrap
   2. 在浏览器中，导航到 URL http://localhost:8080/helloworld-rs/rest/json。

   3. 在 CLI 中重新尝试以下命令：

      $ curl -v http://localhost:9990/metrics |  grep request_count | grep helloworld-rs-metrics

      Copy to Clipboard Toggle word wrap

      预期输出：

      jboss_undertow_request_count_total{deployment="helloworld-rs-metrics.war",servlet="org.jboss.as.quickstarts.rshelloworld.JAXActivator",subdeployment="helloworld-rs-metrics.war",microprofile_scope="vendor"} 1.0

      Copy to Clipboard Toggle word wrap

流程

1. 在 JBoss EAP 中启用 MicroProfile OpenAPI smallrye 扩展：

   /extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

   Copy to Clipboard Toggle word wrap

2. 使用以下管理命令启用 microprofile-openapi-smallrye 子系统：

   /subsystem=microprofile-openapi-smallrye:add()

   Copy to Clipboard Toggle word wrap

3. 重新加载服务器。

   reload

   Copy to Clipboard Toggle word wrap

流程

1. 初始化项目：

   mvn archetype:generate \
        -DgroupId=com.example.microprofile.openapi \
        -DartifactId=microprofile-openapi\
        -DarchetypeGroupId=org.apache.maven.archetypes \
        -DarchetypeArtifactId=maven-archetype-webapp \
        -DinteractiveMode=false
   cd microprofile-openapi

   Copy to Clipboard Toggle word wrap

   该命令创建项目的目录结构以及 pom.xml 配置文件。

2. 编辑 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>com.example.microprofile.openapi</groupId>
       <artifactId>microprofile-openapi</artifactId>
       <version>1.0-SNAPSHOT</version>
       <packaging>war</packaging>
   
       <name>microprofile-openapi Maven Webapp</name>
       <!-- Update the value with the URL of the project -->
       <url>http://www.example.com</url>
   
       <properties>
           <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
           <maven.compiler.source>1.8</maven.compiler.source>
           <maven.compiler.target>1.8</maven.compiler.target>
           <version.server.bom>4.0.0.GA</version.server.bom>
       </properties>
   
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>org.jboss.bom</groupId>
                   <artifactId>jboss-eap-xp-microprofile</artifactId>
                   <version>${version.server.bom}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
   
       <dependencies>
           <dependency>
               <groupId>org.jboss.spec.javax.ws.rs</groupId>
               <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
               <scope>provided</scope>
           </dependency>
       </dependencies>
   
       <build>
           <!-- Set the name of the archive -->
           <finalName>${project.artifactId}</finalName>
           <plugins>
               <plugin>
                   <artifactId>maven-clean-plugin</artifactId>
                   <version>3.1.0</version>
               </plugin>
               <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
               <plugin>
                   <artifactId>maven-resources-plugin</artifactId>
                   <version>3.0.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-compiler-plugin</artifactId>
                   <version>3.8.0</version>
               </plugin>
               <plugin>
                   <artifactId>maven-surefire-plugin</artifactId>
                   <version>2.22.1</version>
               </plugin>
               <plugin>
                   <artifactId>maven-war-plugin</artifactId>
                   <version>3.2.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-install-plugin</artifactId>
                   <version>2.5.2</version>
               </plugin>
               <plugin>
                   <artifactId>maven-deploy-plugin</artifactId>
                   <version>2.8.2</version>
               </plugin>
               <!-- Allows to use mvn wildfly:deploy -->
               <plugin>
                   <groupId>org.wildfly.plugins</groupId>
                   <artifactId>wildfly-maven-plugin</artifactId>
               </plugin>
           </plugins>
       </build>
   </project>

   Copy to Clipboard Toggle word wrap

   使用 pom.xml 配置文件和目录结构来创建应用。

流程

1. 创建用于存储类文件的目录：

   $ mkdir -p APPLICATION_ROOT/src/main/java/com/example/microprofile/openapi/

   Copy to Clipboard Toggle word wrap

   APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

2. 进入新目录：

   $ cd APPLICATION_ROOT/src/main/java/com/example/microprofile/openapi/

   Copy to Clipboard Toggle word wrap

   必须在这个目录中创建以下步骤中的所有类文件。

3. 使用以下内容创建类文件 InventoryApplication.java ：

   package com.example.microprofile.openapi;
   
   import javax.ws.rs.ApplicationPath;
   import javax.ws.rs.core.Application;
   
   @ApplicationPath("/inventory")
   public class InventoryApplication extends Application {
   }

   Copy to Clipboard Toggle word wrap

   此类充当应用的 REST 端点。

4. 使用以下内容创建一个类文件 Fruit.java ：

   package com.example.microprofile.openapi;
   
   public class Fruit {
   
       private final String name;
       private final String description;
   
       public Fruit(String name, String description) {
           this.name = name;
           this.description = description;
       }
   
       public String getName() {
           return this.name;
       }
   
       public String getDescription() {
           return this.description;
       }
   }

   Copy to Clipboard Toggle word wrap

5. 创建包含以下内容的类文件 FruitResource.java ：

   package com.example.microprofile.openapi;
   
   import java.util.Collections;
   import java.util.LinkedHashMap;
   import java.util.Set;
   
   import javax.ws.rs.Consumes;
   import javax.ws.rs.DELETE;
   import javax.ws.rs.GET;
   import javax.ws.rs.POST;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   @Path("/fruit")
   @Produces(MediaType.APPLICATION_JSON)
   @Consumes(MediaType.APPLICATION_JSON)
   public class FruitResource {
   
       private final Set<Fruit> fruits = Collections.newSetFromMap(Collections.synchronizedMap(new LinkedHashMap<>()));
   
       public FruitResource() {
           this.fruits.add(new Fruit("Apple", "Winter fruit"));
           this.fruits.add(new Fruit("Pineapple", "Tropical fruit"));
       }
   
       @GET
       public Set<Fruit> all() {
           return this.fruits;
       }
   
       @POST
       public Set<Fruit> add(Fruit fruit) {
           this.fruits.add(fruit);
           return this.fruits;
       }
   
       @DELETE
       public Set<Fruit> remove(Fruit fruit) {
           this.fruits.removeIf(existingFruit -> existingFruit.getName().contentEquals(fruit.getName()));
           return this.fruits;
       }
   }

   Copy to Clipboard Toggle word wrap

6. 进入应用程序的根目录：

   $ cd APPLICATION_ROOT

   Copy to Clipboard Toggle word wrap

7. 使用以下 Maven 命令构建和部署应用程序：

   $ mvn wildfly:deploy

   Copy to Clipboard Toggle word wrap

8. 测试应用。

   • 使用 curl 访问示例应用程序的 OpenAPI 文档：

     $ curl http://localhost:8080/openapi

     Copy to Clipboard Toggle word wrap

   • 返回以下输出：

     openapi: 3.0.1
     info:
       title: Archetype Created Web Application
       version: "1.0"
     servers:
     - url: /microprofile-openapi
     paths:
       /inventory/fruit:
         get:
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
         post:
           requestBody:
             content:
               application/json:
                 schema:
                   $ref: '#/components/schemas/Fruit'
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
         delete:
           requestBody:
             content:
               application/json:
                 schema:
                   $ref: '#/components/schemas/Fruit'
           responses:
             "200":
               description: OK
               content:
                 application/json:
                   schema:
                     type: array
                     items:
                       $ref: '#/components/schemas/Fruit'
     components:
       schemas:
         Fruit:
           type: object
           properties:
             description:
               type: string
             name:
               type: string

     Copy to Clipboard Toggle word wrap

流程

1. 在应用程序源树中创建目录：

   $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

   Copy to Clipboard Toggle word wrap

   APPLICATION_ROOT 是包含应用的 pom.xml 配置文件的目录。

2. 查询 OpenAPI 端点，将输出重定向到文件：

   $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

   Copy to Clipboard Toggle word wrap

   默认情况下，端点提供 YAML 文档，format=JSON 指定返回 JSON 文档。

3. 配置应用程序，以便在处理 OpenAPI 文档模型时跳过注解扫描：

   $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

   Copy to Clipboard Toggle word wrap

4. 重建应用程序：

   $ mvn clean install

   Copy to Clipboard Toggle word wrap

5. 使用以下管理 CLI 命令再次部署应用程序：

   1. 取消部署应用程序：

      undeploy microprofile-openapi.war

      Copy to Clipboard Toggle word wrap

   2. 部署应用程序：

      deploy APPLICATION_ROOT/target/microprofile-openapi.war

      Copy to Clipboard Toggle word wrap