2019/04/26

Tomcat DBCPをSpring Boot 2のマルチデータソースでも使うには

Spring Boot 2でdefaultのDBCPが変更

Spring Boot 2で大きな変更がいくつか行われている。defaultのDBCPがTomcat JDBC Connection PoolからHikariCPになったのもその1つだ。Migrationしようとした時、Tomcat DBCPに依存したコードを書いていた(sql_modeの設定が適切でないので、Poolから接続を持ってくるときに設定しなおすsqlを割り込ませていた)ので、

  • HikariCPに対応したコードに修正する
  • Tomcat DBCPをそのまま使い続ける
の選択に迫られ、検証の作業工数が少なくて済みそうな後者で対応することにした。

Tomcat DBCPを使い続ける設定

application.propertiesに

spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
と書いて、pom.xmlで
<dependency>
   <groupId>org.apache.tomcat</groupId>
   <artifactId>tomcat-jdbc</artifactId>
   <version>9.0.16</version>
</dependency>
とすれば、Tomcat DBCPが使われるようになる。

複数のデータソースの場合の設定

Amazon Auroraのように、readとwriteで別々の接続を持たせた方が嬉しいDBMSがある。また、アクセス数が多いシステムであれば、readはレプリカから行うように負荷分散していることも多いはずだ。

たまたま、複数のDBにアクセスする必要があったプログラムをSpring Boot 2にバージョンアップしてみたところ、上記の設定だけではHikariCPが使われてしまっていた。

結局、HikariCPがクラスパス上に存在していなければTomcat DBCPが使われることから、pom.xmlでspring-boot-starter-jdbcを指定する際、

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-jdbc</artifactId>
   <exclusions>
      <exclusion>
         <groupId>com.zaxxer</groupId>
         <artifactId>HikariCP</artifactId>
      </exclusion>
   </exclusions>
</dependency>

<dependency>
   <groupId>org.apache.tomcat</groupId>
   <artifactId>tomcat-jdbc</artifactId>
   <version>9.0.16</version>
</dependency>
のように、HikariCPを除外するようにして解決した。Spring Boot 2.0 Migration Guideを深読みすれば気が付く内容であったが、application.propertiesの設定でなんとかなるのではないかとがんばってしまった。もしかしたら、なんとかできる設定があるのかもしれない。

HikariCPに乗り換える?

Spring Bootのバージョンアップに関する記事をいくつか見てみたが、Tomcat DBCPをそのまま使い続けようとしているものは検索結果の上位にはなかった。

確かに、DBCPに限らず、いろいろこのタイミングでSpring Bootのdefaultにあわせて変更するのがよさそうに思えるが、そこまで作業工数に恵まれたプロジェクトばかりではないのだ…。