如何在Keycloak服务启动完成后执行自定义SPI中的指定方法

核心实现逻辑 #

Keycloak官方提供了StartupListenerProvider SPI，专门用于监听服务全量启动完成的事件，无需自行轮询服务状态，基于该SPI扩展即可实现需求。

具体实现步骤（适配Quarkus版Keycloak 17+） #

• 引入对应版本依赖
  项目依赖中添加和部署环境版本一致的keycloak-server-spi依赖，以Maven为例：

  <dependency>
      <groupId>org.keycloak</groupId>
      <artifactId>keycloak-server-spi</artifactId>
      <version>你的Keycloak服务版本号</version>
      <scope>provided</scope>
  </dependency>
  

• 实现StartupListenerProvider接口
  重写onStartup方法，该方法会在Keycloak所有内置组件、SPI全部加载完成，服务正式启动后自动触发，在该方法内调用自定义SPI的目标方法即可：

  import org.keycloak.models.KeycloakSession;
  import org.keycloak.startup.StartupListenerProvider;
  
  public class CustomAutoExecListener implements StartupListenerProvider {
  
      private final KeycloakSession session;
  
      public CustomAutoExecListener(KeycloakSession session) {
          this.session = session;
      }
  
      @Override
      public void onStartup() {
          // 此处调用自定义SPI的指定方法
          YourCustomSpiProvider customProvider = session.getProvider(YourCustomSpiProvider.class);
          customProvider.yourTargetMethod();
      }
  
      @Override
      public void close() {
          // 无待释放资源可留空
      }
  }
  

• 实现对应ProviderFactory

  import org.keycloak.Config;
  import org.keycloak.models.KeycloakSession;
  import org.keycloak.models.KeycloakSessionFactory;
  import org.keycloak.startup.StartupListenerProvider;
  import org.keycloak.startup.StartupListenerProviderFactory;
  
  public class CustomAutoExecListenerFactory implements StartupListenerProviderFactory {
  
      public static final String PROVIDER_ID = "custom-auto-exec-listener";
  
      @Override
      public StartupListenerProvider create(KeycloakSession session) {
          return new CustomAutoExecListener(session);
      }
  
      @Override
      public void init(Config.Scope config) {
          // 如需读取配置参数可在此处实现，无需求留空
      }
  
      @Override
      public void postInit(KeycloakSessionFactory factory) {
          // 工厂初始化后执行逻辑，无需求留空
      }
  
      @Override
      public void close() {
          // 工厂销毁逻辑，无需求留空
      }
  
      @Override
      public String getId() {
          return PROVIDER_ID;
      }
  }
  

• 注册SPI
  在jar包的META-INF/services目录下创建名为org.keycloak.startup.StartupListenerProviderFactory的文本文件，内容填写你实现的Factory类全限定名，示例：

  com.yourcompany.yourpackage.CustomAutoExecListenerFactory
  

• 部署生效
  将打包完成的jar放入Keycloak根目录下的providers文件夹，重启Keycloak服务即可生效。

兼容旧版WildFly架构Keycloak（17版本之前） #

如果使用的是较早的WildFly版Keycloak，可通过CDI事件监听实现相同效果：

import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.event.Observes;
import javax.enterprise.inject.spi.Initialized;
import javax.inject.Inject;

@ApplicationScoped
public class LegacyStartupListener {

    @Inject
    private YourCustomSpiProvider customProvider;

    public void onAppStart(@Observes @Initialized(ApplicationScoped.class) Object initEvent) {
        customProvider.yourTargetMethod();
    }
}

注意事项 #

• 若执行逻辑涉及数据库读写操作，需要主动开启并管理事务：

  session.getTransactionManager().begin();
  try {
      // 你的业务执行逻辑
      session.getTransactionManager().commit();
  } catch (Exception e) {
      session.getTransactionManager().rollback();
      throw new RuntimeException("启动任务执行失败", e);
  }
  

• 集群部署场景下，每个Keycloak实例启动时都会触发一次该方法，如果需要全局仅执行一次，可以通过分布式锁、数据库状态标记的方式做幂等控制。

内容的提问来源于stack exchange，提问作者Nury Garryyev