嵌入Keycloak springboot应用，将keycloak从12升级到14

Question

您好，我有一个使用以下示例创建的带有嵌入式 Keyclock 的 SpringBoot 应用程序 https://www.baeldung.com/keycloak-embedded-in-spring-boot-app

我正在尝试将Keycloak从12升级到14，并将resteasy升级到3.15.1.Final，将infinispan升级到11.0.9.Final。应用程序无法启动，日志中除了 NullPointerException 之外没有太多内容。我想看看是否有人尝试过相同的操作并提出任何建议，因为日志中没有太多内容。谢谢

2021-07-07 10:02:05 [main] INFO  org.keycloak.services - KC-SERVICES0050: Initializing master realm
2021-07-07 10:02:07 [main] DEBUG org.keycloak.keys.GeneratedRsaKeyProviderFactory - Generated keys for master
2021-07-07 10:02:07 [main] DEBUG org.keycloak.keys.GeneratedHmacKeyProviderFactory - Generated secret for master
2021-07-07 10:02:07 [main] DEBUG org.keycloak.keys.GeneratedAesKeyProviderFactory - Generated secret for master
2021-07-07 10:02:07 [main] DEBUG org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProvider - Going to release database lock namespace=KEYCLOAK_BOOT
2021-07-07 10:02:07 [main] DEBUG org.keycloak.connections.jpa.updater.liquibase.lock.CustomLockService - Going to release database lock
2021-07-07 10:02:07 [main] DEBUG org.keycloak.models.cache.infinispan.InfinispanUserCacheProviderFactory - Registered cluster listeners
2021-07-07 10:02:07 [main] DEBUG org.keycloak.executors.DefaultExecutorsProviderFactory - We are in managed environment. Executor 'java:jboss/ee/concurrency/executor/default' was available.
2021-07-07 10:02:07 [main] DEBUG org.keycloak.executors.DefaultExecutorsProviderFactory - Found executor for 'storage-provider-threads' under JNDI name 'java:jboss/ee/concurrency/executor/storage-provider-threads'
2021-07-07 10:02:07 [main] FATAL org.keycloak.services - java.lang.NullPointerException

2021-07-07 10:02:07 [main] DEBUG org.keycloak.executors.DefaultExecutorsProviderFactory - Found executor for 'storage-provider-threads' under JNDI name 'java:jboss/ee/concurrency/executor/storage-provider-threads'
$$$$$$$$$$$$$$$$Stachtrace$$$$$$$$$$$$$ : java.lang.NullPointerException
    at java.base/java.util.concurrent.ConcurrentHashMap.putVal(ConcurrentHashMap.java:1011)
    at java.base/java.util.concurrent.ConcurrentHashMap.put(ConcurrentHashMap.java:1006)
    at org.keycloak.executors.DefaultExecutorsProviderFactory.getExecutor(DefaultExecutorsProviderFactory.java:113)
    at org.keycloak.executors.DefaultExecutorsProviderFactory$1.getExecutor(DefaultExecutorsProviderFactory.java:68)
    at org.keycloak.utils.ServicesUtils.timeBoundOne(ServicesUtils.java:71)
    at org.keycloak.storage.AbstractStorageManager.mapEnabledStorageProvidersWithTimeout(AbstractStorageManager.java:135)
    at org.keycloak.storage.UserStorageManager.getUsersCount(UserStorageManager.java:374)
    at org.keycloak.models.cache.infinispan.UserCacheSession.getUsersCount(UserCacheSession.java:545)
    at org.keycloak.storage.user.UserQueryProvider.getUsersCount(UserQueryProvider.java:52)
    at org.keycloak.services.managers.ApplianceBootstrap.createMasterRealmUser(ApplianceBootstrap.java:99)

Answer 1

在 Spring Boot/Servlet 风格的应用程序中将嵌入式 keycloak 升级到 15 时，我们遇到了类似的模糊错误消息。但我们最终通过爬取本baeldung.com 教程所基于的项目的代码/历史记录来修复它们；thomasdarimont 的嵌入式 Keycloak 服务器在 Spring Boot 应用程序中运行。这个存储库是对初始教程的一些升级；一直到 Keycloak 13。我们将历史记录与我们的代码进行了比较，并为从 keycloak 11 到 13 的每个版本增量应用/测试修复。之后，从 13 到 15 的更新更容易理解，并且错误也不再那么神秘。 。

我们的应用程序与 Baeldung 教程中给出的示例代码并不完全相同，但下面是升级到 Keycloak 15.0.1 所需的更改列表。这些更改可能与您的项目不是 1:1，但希望这些更改可以帮助人们节省一些时间。

• 将KeycloakApplication领域设置函数从构造函数方法移至bootstrap()方法。（此处找到了修复示例）

  
  public class EmbeddedKeycloakApplication extends KeycloakApplication {
  ...
  
   //public EmbeddedKeycloakApplication() {
   //    createMasterRealmAdminUser();
   //    createBaeldungRealm();
   //}
  
   @Override
   protected ExportImportManager bootstrap() {
       final ExportImportManager exportImportManager = super.bootstrap();
       createMasterRealmAdminUser();
       createBaeldungRealm();
       return exportImportManager;
   }
  
  

• 在EmbeddedKeycloakConfig我们添加了几个新的 bean 引用/工厂（都在这里找到）

  
  public class EmbeddedKeycloakConfig {
  ...
   @Bean("fixedThreadPool")
   public ExecutorService fixedThreadPool() {
       return Executors.newFixedThreadPool(5);
   }
  
   @Bean
   @ConditionalOnMissingBean(name = "springBootPlatform")
   protected SimplePlatformProvider springBootPlatform() {
       return (SimplePlatformProvider) Platform.getPlatform();
   }
  
  

• 在我们的 keycloak-server.json 中，我们从 mapStorage 提供程序中删除了默认的“concurrenthashmap”名称，但仍然提供了 concurrenthashmap 属性。这与其他 Keycloak 15 示例相匹配。正如Paul提到的，需要启用map_storage，最简单的解决方案是使用系统属性-Dkeycloak.profile.feature.map_storage=enabled -Dkeycloak.mapStorage.provider=concurrenthashmap。类似的示例可以在此处和此处的Keycloak 测试套件中找到。然而：我们在使用这些系统属性时遇到了错误，并决定我们的代码不需要它。幸运的是，教程中没有特别提到“mapStorage”；它只能在参考教程代码中找到。因此，我们简单地匹配了其他 Keycloak 13+ 示例，并删除了 keycloak-server.json 中的引用（如下所示）以消除空指针异常。

  
  //Change this:
   "mapStorage": {
       "provider": "${keycloak.mapStorage.provider:concurrenthashmap}",
       "concurrenthashmap": {
           "dir": "${project.build.directory:target}"
       }
   },
  
  //To This
   "mapStorage": {
       "provider": "${keycloak.mapStorage.provider:}",
       "concurrenthashmap": {
           "dir": "${project.build.directory:target}"
       } 
   },
  
  

• 使用 keycloak 版本升级了正确的 infinispan 和 rest 版本。（教程代码参考）

  
  < properties>
   < keycloak.version>15.0.1</keycloak.version>
  
   < !-- these should be updated together with Keycloak -->
   < !-- check keycloak-dependencies-server-all effective pom -->
   < infinispan.version>11.0.9.Final</infinispan.version>
   < resteasy.version>3.15.1.Final/resteasy.version>
  
  < /properties>
  

• 我们还在 SimplePlatformProvider 中添加了临时目录位置，因为此字段是必需的。注意：不建议在生产环境中使用示例中使用的系统临时文件夹。

  
   @Override
   public File getTmpDirectory() {
       return System.getProperty("java.io.tmpdir");
   }
  
  

我希望有人发现此信息有用，祝你好运！