4.2. MicroProfile Config の開発

手順

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 ファイルが jboss-eap-xp-microprofile BOM の MicroProfile Config アーティファクトおよび MicroProfile REST Client アーティファクトのバージョンを自動的に管理できるようにするには、POM ファイルの <dependencyManagement> セクションに BOM をインポートします。

   <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. BOM によって管理される MicroProfile Config アーティファクトおよび MicroProfile REST Client アーティファクトおよびその他依存関係をプロジェクト POM ファイルの <dependency> セクションに追加します。以下の例は、MicroProfile Config および MicroProfile REST Client 依存関係をファイルに追加する方法を示しています。

   <!-- 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. アプリケーションの root ディレクトリーに移動します。

   $ 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