Keycloak中新增实体，添加自定义业务逻辑

2023-06-03 17:14:32

使用 Keycloak 的自定义实体扩展身份管理

Keycloak 是一款强大的身份和访问管理 (IAM) 解决方案，可帮助组织安全地管理其用户的身份。它提供了高度可定制的平台，允许开发人员扩展其功能以满足特定需求。本文将深入探讨如何使用 Keycloak 的 SPI（服务提供商接口）向 Keycloak 添加自定义实体，从而存储和管理您自己的数据。

何为自定义实体？

自定义实体是您添加到 Keycloak 的定制数据对象，可用于存储特定于您的应用程序或业务逻辑的信息。它们提供了将您的自定义数据与 Keycloak 的强大身份管理功能相集成的灵活性。

创建自定义实体

要创建自定义实体，需要创建一个 Java 类来表示实体，并使用 JPA（Java Persistence API）进行注释以与数据库交互。例如，让我们创建一个名为 User 的简单实体：

import javax.persistence.*;

@Entity
@Table(name = "users")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;
    private String password;
    private String email;

    // getters and setters
}

配置数据持久性

使用 Spring Data JPA 配置数据持久性，以便 Keycloak 可以访问您的实体。这涉及创建 DataSource 和 JpaRepository：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

import javax.sql.DataSource;

@Configuration
@EnableJpaRepositories
public class DataSourceConfig {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource dataSource() {
        return DataSourceBuilder.create().build();
    }
}

public interface UserRepository extends JpaRepository<User, Long> {
}

注册自定义实体 SPI

使用 Keycloak 的 SPI 向其注册自定义实体。为此，需要创建实现 EntitySpiProvider 接口的 Java 类：

import org.keycloak.provider.Provider;
import org.keycloak.provider.ProviderFactory;
import org.keycloak.provider.Spi;
import org.keycloak.services.resource.RealmResourceProvider;

import java.util.Collections;
import java.util.List;

public class CustomEntitySpiProvider implements ProviderFactory<RealmResourceProvider>, Spi {

    @Override
    public List<Provider> getSpiImplementations() {
        return Collections.singletonList(new CustomEntityResourceProvider());
    }

    @Override
    public String getId() {
        return "custom-entity-spi-provider";
    }
}

创建自定义资源提供程序

自定义资源提供程序是处理自定义实体 API 请求的 Java 类。它需要实现 RealmResourceProvider 接口：

import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.models.UserProvider;
import org.keycloak.provider.ProviderConfigProperty;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.services.resource.RealmResourceProvider;

import java.util.List;

public class CustomEntityResourceProvider implements RealmResourceProvider {

    @Override
    public Object getResource() {
        return new CustomEntityResource();
    }

    @Override
    public void init(RuntimeDelegate runtimeDelegate) {

    }

    @Override
    public void close() {

    }

    @Override
    public String getName() {
        return "custom-entity-resource-provider";
    }

    @Override
    public List<ProviderConfigProperty> getConfigProperties() {
        return Collections.emptyList();
    }

    private class CustomEntityResource {

        public List<UserRepresentation> getUsers(KeycloakSession session, RealmModel realm) {
            UserProvider userProvider = session.users();
            return userProvider.searchForUserByUsernamesStream(realm, Collections.singletonList("user"))
                    .map(UserModel::toRepresentation)
                    .toList();
        }
    }
}