先生と生徒の会話形式で理解しよう

生徒

「Quarkusのプロジェクトを作ったら、application.propertiesというファイルが出てきました。これは何に使うんですか？」

先生

「Quarkusでは、アプリ全体の設定を管理するために設定ファイルを使います。application.propertiesはその中心的な存在ですね。」

生徒

「yaml形式も使えると聞いたんですが、どちらを使えばいいんでしょうか？」

先生

「それぞれの特徴を理解すると、自分のプロジェクトに合った選び方ができるようになります。」

1. Quarkusにおける設定ファイルの役割

Quarkusアプリケーションでは、アプリの動作ルールを「設定ファイル」にまとめて管理します。たとえば、どの番号のポートで起動するか、ログをどのくらい詳しく出すか、アプリの名前を何にするか、といった内容です。

これらを設定ファイルに書いておくことで、Javaのコード自体を修正しなくても、動作だけを簡単に変更できます。プログラミング未経験の方でも、「設定＝アプリの動きを決めるメモ帳」のように考えるとイメージしやすいでしょう。

実際の設定は、とてもシンプルな形で書かれます。たとえば次のように、一行ごとに意味を持つ設定を書いていきます。


quarkus.http.port=8080

この一行だけで、「このQuarkusアプリは8080番ポートで起動する」という意味になります。数字を変えるだけで、アプリの動作が変わるのが設定ファイルの便利な点です。

Quarkusでは主に、シンプルで書きやすいapplication.propertiesと、整理しやすいapplication.yamlの二つの形式が使われます。まずは設定ファイルがアプリ全体の動作を支えている、という点をしっかり押さえておきましょう。

2. application.propertiesの基本構成

application.propertiesは、キーと値をイコールでつなぐシンプルな形式の設定ファイルです。Java開発に慣れている人にとっては、最も扱いやすい形式と言えます。

設定は一行ずつ記述され、設定項目が増えても構造が分かりやすいのが特徴です。Quarkus公式ドキュメントでも、この形式がよく使われています。

初心者が最初に触れる設定ファイルとして、application.propertiesはとても理解しやすい存在です。

3. application.propertiesのサンプル例

以下は、Quarkusアプリでよく使われる基本的な設定例です。


quarkus.http.port=8080
quarkus.log.level=INFO
quarkus.application.name=sample-app

このように、設定内容がそのまま一行で表現されるため、設定の意味を追いやすいのが利点です。

4. application.yamlの基本構成

application.yamlは、階層構造を持った設定ファイル形式です。インデントによって設定のまとまりを表現できるため、設定項目が多い場合に全体像を把握しやすくなります。

Quarkusでは、application.propertiesと同じ内容をyaml形式で書くことができます。どちらか一方を選んで使うのが一般的です。

設定が増えてきたときに整理しやすい点が、yaml形式の大きな特徴です。

5. application.yamlのサンプル例

application.propertiesと同じ内容をyamlで書くと、次のようになります。


quarkus:
  http:
    port: 8080
  log:
    level: INFO
  application:
    name: sample-app

設定が階層ごとにまとまっているため、関連する設定を一目で把握しやすくなります。

6. propertiesとyamlの使い分け方

どちらを使うか迷った場合は、まずapplication.propertiesを選ぶのがおすすめです。記述が単純で、Quarkusの学習初期には理解しやすいからです。

一方で、設定項目が増えてきたり、環境ごとに細かく整理したい場合は、yaml形式が役立ちます。

どちらの形式でも、Quarkusの動作自体は変わらないため、好みやチームの方針で選んでも問題ありません。

7. 設定値をJavaコードから利用する方法

設定ファイルに書いた内容は、Javaコードから簡単に参照できます。これにより、設定とロジックを分離した設計が可能になります。


package org.example.config;

import org.eclipse.microprofile.config.inject.ConfigProperty;
import jakarta.enterprise.context.ApplicationScoped;

@ApplicationScoped
public class AppConfig {

    @ConfigProperty(name = "quarkus.application.name")
    String appName;

    public String getAppName() {
        return appName;
    }
}

この仕組みにより、設定変更がコードに影響しにくくなり、保守性が向上します。