0Pricing
Spring Boot 4 Complete Guide · レッスン

アプリケーションプロパティの外部化

`application.properties`と`application.yml`ファイルを使ってアプリケーションを設定し、プロファイルを管理します。

「アプリケーションプロパティの外部化」はCoddyKit上の無料Spring Boot 4 Complete Guideレッスンです。 これはレッスン3/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはSpring Boot 4 Complete Guide学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Keep Config Flexible

Imagine building an app for different environments like development, testing, and production. Each might need unique database credentials, API keys, or server ports.

Hardcoding these values directly into your code is a bad practice. It makes your app inflexible and difficult to manage.

Externalizing configuration means storing these changeable values outside your main application code, allowing you to modify them without rebuilding your app.

application.properties

Spring Boot makes external configuration easy. The most common way is using the application.properties file, located in your src/main/resources folder.

It uses a simple key-value pair format, where each property is on a new line:

  • server.port=8080
  • spring.datasource.url=jdbc:h2:mem:testdb
  • my.custom.greeting=Hello CoddyKit!

These values can then be injected into your Spring components.

Injecting with @Value

To use an externalized property in your Java code, Spring provides the @Value annotation.

You can apply @Value to fields, constructor parameters, or method parameters. It reads the value associated with a specific key from your properties files.

The syntax is @Value("${property.key}"). If the property is not found, you can provide a default value like @Value("${property.key:Default Value}").

@Value in Action

Let's see how @Value works. First, we'll create an application.properties file.

src/main/resources/application.properties:

app.message=Welcome to CoddyKit!

Now, run this Spring Boot application. It will inject the property and print it on startup.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@Component
class MessagePrinter implements CommandLineRunner {

  @Value("${app.message}")
  private String message;

  @Override
  public void run(String... args) throws Exception {
    System.out.println("Application Message: " + message);
  }
}

Structured YAML Files

Another popular format for external configuration is YAML (YAML Ain't Markup Language), typically in an application.yml file.

YAML offers a more human-readable, hierarchical structure compared to the flat key-value pairs of .properties files. It uses indentation to define nested properties.

  • Readability: Easier to grasp complex configurations.
  • Hierarchy: Naturally groups related properties.
  • Less Repetition: Avoids repeating common prefixes.

YAML for Clarity

Here's how the same message property from before would look in application.yml:

src/main/resources/application.yml:

app: message: Welcome to CoddyKit! (YAML)

The Java code remains exactly the same as Spring Boot automatically supports both formats. Run this to see it in action.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@Component
class MessagePrinter implements CommandLineRunner {

  @Value("${app.message}")
  private String message;

  @Override
  public void run(String... args) throws Exception {
    System.out.println("Application Message: " + message);
  }
}

Who Wins? Precedence

What if you have both application.properties and application.yml in your project? Which one takes precedence?

Spring Boot has a specific order for loading configuration sources. Generally, properties defined in application.properties take precedence over those in application.yml when both exist and define the same key.

This allows you to override default values with more specific ones when needed, without changing the original files.

Adapting with Profiles

Spring Profiles provide a way to segregate parts of your application configuration and make it available only in certain environments.

For example, you might have different database settings for your development, test, and production environments. Instead of manually changing configuration files, you can define profiles.

When a specific profile is active, only the beans and configuration associated with that profile are loaded.

Tailoring for Environments

To define profile-specific properties, you create additional configuration files following a specific naming convention:

  • application-{profile}.properties
  • application-{profile}.yml

For example:

  • application-dev.properties for development settings.
  • application-prod.yml for production settings.

These files contain properties that apply only when their corresponding profile is active.

Switching Profiles

You can activate a Spring profile in several ways:

  • JVM System Property: Pass -Dspring.profiles.active=dev when running your app.
  • Environment Variable: Set SPRING_PROFILES_ACTIVE=prod.
  • Inside application.properties/.yml: Set spring.profiles.active=test.

It's common to use JVM arguments or environment variables for production deployments, keeping your main application.properties clean.

Quick Check: Config

You have an application.properties file with app.environment=development. You also have an application-prod.properties file with app.environment=production.

How would you activate the prod profile to ensure app.environment resolves to production?

Config Mastery Recap

Great job! You've learned how to externalize application properties in Spring Boot, making your applications more flexible and easier to manage across different environments.

  • We explored application.properties for simple key-value pairs.
  • We saw application.yml for structured, hierarchical configuration.
  • You learned to inject properties into your code using the @Value annotation.
  • Finally, we covered Spring Profiles to tailor configurations for specific environments and how to activate them.

This knowledge is crucial for building robust and adaptable Spring Boot applications!

よくある質問

「アプリケーションプロパティの外部化」レッスンは無料ですか？

はい。「アプリケーションプロパティの外部化」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Spring Boot 4 Complete Guideコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

「アプリケーションプロパティの外部化」で何を学びますか？

`application.properties`と`application.yml`ファイルを使ってアプリケーションを設定し、プロファイルを管理します。 ブラウザで直接実行するハンズオンコードでSpring Boot 4 Complete Guideを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Spring Boot 4 Complete Guideを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのSpring Boot 4 Complete Guideは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン3/4です。

「アプリケーションプロパティの外部化」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このSpring Boot 4 Complete Guideレッスンでコードを書いて実行できますか？

はい。すべてのSpring Boot 4 Complete Guideレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. Spring IoCコンテナの基礎
  2. 依存性注入の実践
  3. アプリケーションプロパティの外部化
  4. Beanスコープとライフサイクル管理
← Spring Boot 4 Complete Guideに戻る