Utiliser une base H2 avec SpringBoot

Introduction

H2 est une base de données rapide et légère qui peut être persistée (dans un fichier) ou non. Je la trouve utile pour au moins 2 cas d’utilisation :

– Lorsque je veux réaliser un PoC, ça me permet d’avoir une base de données configurée en 2 minutes.

– Lorsque je veux faire des tests d’intégration qui communiquent avec une BDD SQL, H2 est une base de données très légère et très rapide qui fait très bien l’affaire.

Ce que j’aime beaucoup avec une base de données H2, c’est qu’elle est vraiment facile à installer et elle vient même avec une petite interface web qui permet de voir sa base et d’exécuter des requêtes.

On va voir étape par étape comment utiliser très simplement une base H2 dans notre application SpringBoot utilisant SpringDataJPA, c’est parti 😎

I. Prérequis

Ajouter la dépendance suivante:

Maven:

<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <scope>runtime</scope>
</dependency>

Gradle:

runtimeOnly 'com.h2database:h2'

Note: Cette dépendance est présente dans votre pom.xml si vous sélectionnez “h2”  dans l’initialize spring boot (https://start.spring.io/)

II. Configuration

1. Pour une base sans persistence

Pour une base “volatile” c’est à dire qui sera remise à zéro à chaque fois que vous relancez votre application (ce qui est utile pour les tests par exemple) :

Dans le fichier application.properties à la racine de votre projet, ajoutez les lignes suivantes:

spring.datasource.url=jdbc:h2:mem:demo
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

2. Pour une base persistée dans un fichier

Dans le fichier application.properties à la racine de votre projet, ajoutez les lignes suivantes :

spring.datasource.url=jdbc:h2:file:./src/main/resources/db/demo
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

En lançant votre application, vous devriez voir le fichier demo.mv.db créé dans votre repertoire src/main/resources/db/:

Note: si vous ne spécifiez pas les informations de connexion, les identifiants par défaut seront “sa” pour le username et vide pour le password.

III.    Accéder à la base de données (optionnel)

Si vous voulez avoir un accès au contenu de votre base H2, vous pouvez ajouter les lignes suivantes dans votre application.properties :

spring.h2.console.enabled=true
spring.h2.console.path=/h2

Relancez votre application. Si vous allez sur URL http://localhost:port/h2 vous devriez voir une fenêtre de connexion. En remplaçant les informations par celles spécifiées dans votre properties :

Exemple pour une base persistée :

Exemple pour une base non-persistée :

Puis “connect”, vous verrez le contenu de votre base et pourrez effectuer vos requêtes.

C’est tout ce qu’il y a à faire, à présent vos données vont être persistées dans votre base H2 🙂

IV. Pour aller plus loin

Vous pouvez initialiser votre base de données H2 via des scripts SQL qui seront lus au démarrage de l’application.

– Vous pouvez initialiser sa structure via un fichier schema.sql présent dans les ressources de votre projet (à la racine).

– Vous pouvez insérer des données via un fichier data.sql présent dans les ressources de votre projet (à la racine).

Note:  suivant votre version de SpringBoot, la façon dont est exécutée ces scripts par défaut peut changer  (ordre d’exécution, type de base pour laquelle ils se jouent etc..). Ca a notamment bien changé à partir de SpringBoot 2.5 

donc pensez bien à lire la doc 🙂

Exemple:

Résultat:

Conclusion

On a vu ensemble comment pouvoir utiliser H2 dans votre projet SpringBoot et quelques options disponibles. Que ça soit dans les tests ou pour des PoC, je trouve que c’est une base de données légère, facile à configurer qui fait très bien l’affaire 🙂

Projet

Projet utilisé pour ce guide: https://github.com/maximedezette/kata-api

Sources

https://www.baeldung.com/spring-boot-h2-database

http://www.h2database.com/html/features.html

https://howtodoinjava.com/spring-boot2/h2-database-example/