• TOP
• Spring Boot

Spring BootでH2 コンソールの設定｜H2 Console

2019-04-19T09:11:00+09:00 2019-04-19T16:28:29Z H2 DataBase Spring Spring Boot

Spring Bootのapplication.propertiesを使用して、H2 コンソールの設定ができます。

ここでは、
以下のH2 コンソールの設定について、紹介します。

・コンソール利用設定
・コンソールパス設定
・トレース出力設定
・リモートアクセス設定

アプリケーションプロパティ - application.properties

application.propertiesでは、以下のH2 コンソールの設定をすることができます。

・サンプル例

/src/main/resources/application.properties

spring.h2.console.enabled=true
spring.h2.console.path=/h2-console
spring.h2.console.settings.trace=false
spring.h2.console.settings.web-allow-others=false

コンソール利用設定 - spring.h2.console.enabled

true：有効/false：無効

H2 コンソールの利用について設定します。

例えば、

H2 コンソールを利用したい場合は、「true」を設定します。これで、H2 コンソールを利用できるようになります。

コンソールパス設定 - spring.h2.console.path

H2 コンソールのパスを設定します。

例えば、
「/h2-console」を設定すると、

ブラウザで「http://localhost:8080/h2-console」にアクセスして、h2 コンソールを利用することができます。

トレース出力設定 - spring.h2.console.settings.trace

true：有効/false：無効

トレース出力について設定します。

例えば、

「true」を設定すると、トレース出力されるようになります。

リモートアクセス設定 - spring.h2.console.settings.web-allow-others

true：有効/false：無効

リモートアクセスについて設定します。

例えば、

「true」を設定すると、H2 コンソールにリモートアクセスできるようになります。

メモ

H2 コンソールの利用

Spring Bootは、以下1)～3)の条件を満たす場合、H2 DataBaseが提供しているブラウザベースのH2 コンソールを自動で設定します。

この場合、application.propertiesでspring.h2.console.enabledプロパティ、spring.h2.console.pathプロパティを設定しなくても、ブラウザで「http://localhost:8080/h2-console」にアクセスして、h2 コンソールを利用することができます。

1) サーブレットベースのWebアプリケーション開発している

2) com.h2DataBase:h2がクラスパス上にある

3) Spring Bootの開発者ツール（DEVTOOLS）を使用している


Spring Bootの開発者ツール（DEVTOOLS）を使用していないが、H2 コンソールを利用したい場合は、application.propertiesでspring.h2.console.enabledプロパティに「true」を設定して、利用することができます。

また、H2 コンソールは、開発中の使用のみを目的としていますので、本番環境では、spring.h2.console.enabledプロパティに「true」を設定しないなど、注意が必要です。

H2 コンソールパスのデフォルト設定

H2 コンソールパスは、spring.h2.console.pathプロパティを使用しない場合、デフォルトで「/h2-console」になっています。

また、spring.h2.console.pathプロパティを使用して、H2 コンソールパスを任意のパスに設定することができます。

参考

H2's Web Console - Reference Guide（Spring Boot 2.1.3）

31.5 Using H2's Web Console

  31.5.1 Changing the H2 Console's Path

application properties - Reference Guide（Spring Boot 2.1.3）

X. Appendices

  A. Common application properties

# H2 Web Console (H2ConsoleProperties)
spring.h2.console.enabled=false # Whether to enable the console.
spring.h2.console.path=/h2-console # Path at which the console is available.
spring.h2.console.settings.trace=false # Whether to enable trace output.
spring.h2.console.settings.web-allow-others=false # Whether to enable remote access.

スポンサーリンク