1概要

デフォルトでは、Spring Bootにはアプリケーションが起動するとすぐに表示されるバナーが付いています。

この記事では、カスタムバナーを作成してSpring Bootアプリケーションで使用する方法を学習します。


2バナーを作成する

始める前に、アプリケーションの起動時に表示されるカスタムバナーを作成する必要があります。カスタムバナーを最初から作成するか、またはこれを実行するさまざまなツールを使用できます。

この例では、Baeldungの公式ロゴを使用しました。

ただし、状況によっては、バナーの維持が比較的簡単なため、プレーンテキスト形式のバナーを使用することをお勧めします。

この例で使用したプレーンテキストのカスタムバナーはhttps://github.com/eugenp/tutorials/blob/master/spring-boot/src/main/resources/banner.txt[ここ]から入手できます。

ここで注意する点は、ANSI文字セットはコンソールにカラフルなテキストを表示する機能を持っているということです。これは単純なプレーンテキスト形式ではできません。


3カスタムバナーの使用

カスタムバナーを用意したので、

src/main/resources

ディレクトリに

banner.txt

という名前のファイルを作成し、そこにバナーコンテンツを貼り付ける必要があります。

ここで注意しなければならないのは、

banner.txt

が、Spring Bootが使用するデフォルトのバナーファイル名です。ただし、バナーに他の場所または別の名前を選択する場合は、

application.properties

ファイルで

spring.banner.location

プロパティを設定する必要があります。

spring.banner.location=classpath:/path/to/banner/bannername.txt

画像をバナーとしても使用できます。

banner.txt

と同じように、Spring Bootはバナー画像の名前を

banner.gif

と想定します。さらに、

application.properties

で高さ、幅などのさまざまな画像プロパティを設定できます。

spring.banner.image.location=classpath:banner.gif
spring.banner.image.width= //TODO
spring.banner.image.height=//TODO
spring.banner.image.margin=//TODO
spring.banner.image.invert=//TODO

ただし、テキスト形式を使用することをお勧めします。複雑な画像構造を使用すると、アプリケーションの起動時間が大幅に長くなるためです。


4結論

この簡単な記事では、Spring Bootアプリケーションでカスタムバナーを使用する方法を示しました。

いつものように、完全なソースコードはhttps://github.com/eugenp/tutorials/tree/master/spring-boot[over on GitHub]から入手可能です。