这一节中,我们来看看如何为Keycloak配置数据库。默认情况下,Keycloak使用的是轻量级的内嵌数据库H2,作为学习是足够的,但在生成环境下还需为其配置功能更强大的关系型数据库。
Keycloak数据持久化使用了两层结构,底层为JDBC用于连接具体的数据库,上层为Hibernate JPA,用于实现ORM。在本节中,我们将使用Posgres作为示例进行演示,配置如下:
- Keycloak 8.0.1
- Docker (用于运行数据库实例)
- Postgres 9.6.17
- JDBC driver postgresql-42.2.11
使用Docker运行本地数据库
使用了官方的镜像postgres:9.6.17,运行如下命令
docker run -p 5432:5432 --name my-postgres -e POSTGRES_PASSWORD=123456 -e POSTGRES_USER=root -e POSTGRES_DB=keycloak -d postgres:9.6.17
其中通过-e
来指定了用户名和密码,同时配置了初始的数据库keycloak
。运行后,可使用Navcat
来查看数据库是否正常运行。
配置JDBC driver
地址为:https://jdbc.postgresql.org/download.html在这里给出了不同的driver版本,官方建议没有特殊需求可直接使用最新的版本,此时最新的为42.2.11。同时还需要注意JDBC 4.x的版本需要,由于Keycloak使用的是Java 8,所以可以采用JDBC 4.2。
下载后需要把该jar包放在指定的位置,路径为:keycloak-8.0.1/modules/system/layers/keycloak/org/postgresql/main/postgresql-42.2.11.jar
,此时会发现在org
下并没有postgresql
目录,手动创建即可。同时还需要为其添加配置文件,目的是让wildfly可以读取到该JDBC driver,配置文件和jar包在同一目录下即可:
<?xml version="1.0" ?>
<module xmlns="urn:jboss:module:1.3" name="org.postgresql">
<resources>
<resource-root path="postgresql-42.2.11.jar"/>
</resources>
<dependencies>
<module name="javax.api"/>
<module name="javax.transaction.api"/>
</dependencies>
</module>
由于在同级目录下,resource-root path
直接赋值为当前的jar文件名。
配置DataSource
为了让Keycloak启动后可以直接使用到我们外置的数据库,需要将原先使用H2的配置,更改为Postgres。根据不同的部署方式,需要更改不同的配置文件,对于单体应用而言,需要修改standalone/configuration/standalone.xml
,而对于集群部署,则需要修改standalone/configuration/standalone-ha.xml
。在配置文件中,可根据关键词datasource
进行搜索
<subsystem xmlns="urn:jboss:domain:datasources:5.0">
<datasources>
<datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="ExampleDS" enabled="true" use-java-context="true" statistics-enabled="${wildfly.datasources.statistics-enabled:${wildfly.statistics-enabled:false}}">
<connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE</connection-url>
<driver>h2</driver>
<security>
<user-name>sa</user-name>
<password>sa</password>
</security>
</datasource>
<datasource jndi-name="java:jboss/datasources/KeycloakDS" pool-name="KeycloakDS" enabled="true" use-java-context="true" statistics-enabled="${wildfly.datasources.statistics-enabled:${wildfly.statistics-enabled:false}}">
<connection-url>jdbc:postgresql://localhost:5432/keycloak</connection-url>
<driver>postgresql</driver>
<pool>
<max-pool-size>20</max-pool-size>
</pool>
<security>
<user-name>root</user-name>
<password>123456</password>
</security>
</datasource>
<drivers>
<driver name="postgresql" module="org.postgresql">
<xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class>
</driver>
<driver name="h2" module="com.h2database.h2">
<xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class>
</driver>
</drivers>
</datasources>
</subsystem>
在drivers这个tag下,原先只有h2,此时我们添加了postgresql。同时在上方的datasource中,将KeycloakDS下的配置也需要修改为postgresql。这里的配置无需过多说明,比较容易理解。
此外还有关于数据库的一些配置,如初始化方式,migration策略等,可以保持默认即可:
<spi name="connectionsJpa">
<provider name="default" enabled="true">
<properties>
<property name="dataSource" value="java:jboss/datasources/KeycloakDS"/>
<property name="initializeEmpty" value="true"/>
<property name="migrationStrategy" value="update"/>
<property name="migrationExport" value="${jboss.home.dir}/keycloak-database-update.sql"/>
</properties>
</provider>
</spi>
initializeEmpty
:当数据库为空时,是否自动进行初始化,若设置为false,则需要手动进行初始化。
migrationStrategy
:migration策略,可选的有update, manual 和 validate。
检验
配置完成后,运行./standalone.sh
即可运行,通过Navcat可以查看到Keycloak默认创建的表: