嵌入式Keycloak与Spring Boot应用配置导出方案咨询

刚好我之前做过类似的嵌入式Keycloak+Spring Boot的配置固化，给你分享几个实用的方法，完美解决你重启后要重新配置的问题：

这是官方推荐的方式，直接把已配置好的Realm（包含客户端、资源、权限、策略）导出成JSON文件，重启时自动导入。

• 导出配置：在运行的Keycloak实例上执行命令（Windows用kc.bat）：

  bin/kc.sh export --realm=你的Realm名称 --file=realm-config.json
  

  执行后会生成一个realm-config.json，里面包含了你所有的Realm配置细节，包括客户端的confidential类型、授权开关，还有你创建的资源、权限和策略。

• 导入配置：

  • 如果是独立运行的Keycloak：把realm-config.json放到conf/import目录下，启动时加参数：

    bin/kc.sh start --import-realm
    

  • 如果是Spring Boot集成的嵌入式Keycloak：在application.properties或application.yml里添加配置，启动时自动导入：

    keycloak.import=classpath:realm-config.json
    

    记得把导出的JSON文件放到src/main/resources目录下。

如果不想依赖外部JSON文件，想完全用代码定义所有配置，可以通过Keycloak Admin Client在Spring Boot启动时自动初始化Realm和相关配置。

举个简化的示例配置类：

@Configuration
public class KeycloakAutoConfig {

    // 初始化Keycloak Admin客户端
    @Bean
    public Keycloak keycloakAdminClient() {
        return KeycloakBuilder.builder()
                .serverUrl("http://localhost:8080/auth") // 你的Keycloak地址
                .realm("master")
                .username("admin") // 管理员账号
                .password("admin") // 管理员密码
                .clientId("admin-cli")
                .resteasyClient(new ResteasyClientBuilder().connectionPoolSize(10).build())
                .build();
    }

    // 启动时检查并创建配置
    @PostConstruct
    public void initKeycloakResources() {
        Keycloak keycloak = keycloakAdminClient();
        String targetRealm = "你的Realm名称";

        // 检查Realm是否存在，不存在则创建
        if (keycloak.realms().findByRealmName(targetRealm) == null) {
            // 1. 创建Realm
            RealmRepresentation realm = new RealmRepresentation();
            realm.setRealm(targetRealm);
            realm.setEnabled(true);

            // 2. 创建客户端
            ClientRepresentation client = new ClientRepresentation();
            client.setClientId("你的客户端ID");
            client.setSecret("你的客户端密钥");
            client.setAccessType("confidential");
            client.setAuthorizationServicesEnabled(true);

            // 3. 配置授权资源、权限、策略
            AuthorizationSettingsRepresentation authSettings = new AuthorizationSettingsRepresentation();
            
            // 创建资源
            ResourceRepresentation resource = new ResourceRepresentation();
            resource.setName("你的资源名称");
            resource.setUris(Collections.singletonList("/api/your-resource/**"));
            
            // 创建权限范围
            ScopeRepresentation scope = new ScopeRepresentation();
            scope.setName("view");
            
            // 创建权限
            PermissionRepresentation permission = new PermissionRepresentation();
            permission.setName("view-permission");
            permission.setResources(Collections.singletonList("你的资源名称"));
            permission.setScopes(Collections.singletonList("view"));
            
            // 把授权配置绑定到客户端
            authSettings.setResources(Collections.singletonList(resource));
            authSettings.setScopes(Collections.singletonList(scope));
            authSettings.setPermissions(Collections.singletonList(permission));
            client.setAuthorizationSettings(authSettings);

            // 把客户端添加到Realm
            realm.setClients(Collections.singletonList(client));

            // 最终创建Realm
            keycloak.realms().create(realm);
        }
        keycloak.close();
    }
}

这样每次Spring Boot启动时，都会自动检查你的Realm是否存在，不存在就一键创建所有配置，完全不用手动操作。

如果你已经在运行的Keycloak里配置好了所有内容，也可以用Admin Client程序化导出JSON配置，方便后续备份或导入：

public void exportRealmConfig() {
    Keycloak keycloak = KeycloakBuilder.builder()
            .serverUrl("http://localhost:8080/auth")
            .realm("master")
            .username("admin")
            .password("admin")
            .clientId("admin-cli")
            .build();

    // 获取Realm的完整配置
    RealmRepresentation realm = keycloak.realm("你的Realm名称").toRepresentation();
    
    // 序列化为JSON并保存到文件
    ObjectMapper mapper = new ObjectMapper();
    try {
        mapper.writeValue(new File("realm-backup.json"), realm);
    } catch (IOException e) {
        e.printStackTrace();
    }
    keycloak.close();
}

导出的JSON和命令行导出的格式完全一致，之后可以用方法1的方式导入。

小提示 #

• 如果你用的是嵌入式内存模式的Keycloak，重启后数据会全部丢失，所以必须用上面的导入或代码初始化方式；如果是用数据库存储Keycloak数据，其实重启后配置不会丢，但备份导出依然是好习惯。
• 导出的JSON文件包含客户端密钥等敏感信息，一定要妥善保管，别随便提交到代码仓库里！

内容的提问来源于stack exchange，提问作者c'est moi