keycloak~自定義rest接口

rest資源

對於我們集成keycloak來說，你可能會遇到它沒有實現的功能，這時需要對kc進行擴展，資源的擴展是其中一個方面，它需要實現RealmResourceProvider和RealmResourceProviderFactory兩個接口，然后在KC啟動之后，它可以被注冊到IOC容器里，方便以后我們直接使用。

KC里的擴展是開閉原則OCP的完美體現，擴展在kc里叫SPI，它通過SPI的方式實現對功能的擴展，類似於面向接口的編程，通過META-INF/services里的文件進行注冊，這類似於spring里的META-INF/spring.factories的功能。

例子

• 定義一個資源工廠

public class WeixinUserResourceProviderFactory implements RealmResourceProviderFactory {
    private static final Logger logger = Logger.getLogger(WeixinUserResourceProviderFactory.class);

    public WeixinUserResourceProviderFactory() {
        System.err.println("WeixinUserResourceProviderFactory.init");
    }

    /**
     * 資源提供者名稱會在url上體現.
     *
     * @return
     */
    @Override
    public String getId() {
        return "weixin-api";
    }

    @Override
    public RealmResourceProvider create(KeycloakSession session) {
        return new WeixinUserResourceProvider(session);
    }

    @Override
    public void init(Scope config) {
    }

    @Override
    public void postInit(KeycloakSessionFactory factory) {
    }

    @Override
    public void close() {
    }

}

• 定義一個資源的具體實現

public class WeixinUserResourceProvider implements RealmResourceProvider {

    private final KeycloakSession session;

    WeixinUserResourceProvider(KeycloakSession session) {
        this.session = session;
    }

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

    @Override
    public void close() {
    }
}

• 具體資源里公開的rest接口

public class WeixinUserResource {
 
    private final KeycloakSession session;
    private final EntityManager em;
    private final RealmModel realm;

    public WeixinUserResource(KeycloakSession session) {
        this.session = session;
        realm = session.getContext().getRealm();
        this.em = session.getProvider(JpaConnectionProvider.class).getEntityManager();
    }


@GET
@NoCache
@Produces(APPLICATION_JSON)
@Path("user-detail")
public UserDetail userDetail(@HeaderParam("Authorization") String authorization, @QueryParam("userId") String userId) {
//....
}

對於上面的資源，我們可以通過{kc-host}/auth/realms/{realm-name}/weixin-api/user-detail地址去訪問它，其中，weixin-api表示當前spi factory的ID。

如果希望你的rest接口通過token授權才能訪問，需要讓WeixinUserResource繼承這個抽象類AbstractSecuredLocalService

• 向kc注冊spi
  添加文件resources/META-INF/services/org.keycloak.services.resource.RealmResourceProviderFactory，內容如下

keycloak.services.social.weixin.rest.WeixinUserResourceProviderFactory

• 文件結構如下