work.gaigeshen.tripartite.ding.openapi.client.DefaultDingClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tripartite-ding-openapi Show documentation
There is a newer version: 1.22.0
Show newest version
package work.gaigeshen.tripartite.ding.openapi.client;

import work.gaigeshen.tripartite.core.client.*;
import work.gaigeshen.tripartite.core.client.accesstoken.AccessToken;
import work.gaigeshen.tripartite.core.client.accesstoken.AccessTokenHelper;
import work.gaigeshen.tripartite.core.client.accesstoken.AccessTokenManager;
import work.gaigeshen.tripartite.core.client.accesstoken.AccessTokenManagerException;
import work.gaigeshen.tripartite.core.client.config.ConfigException;
import work.gaigeshen.tripartite.core.client.parameters.ClientParameters;
import work.gaigeshen.tripartite.core.client.response.ClientResponse;
import work.gaigeshen.tripartite.core.header.Headers;
import work.gaigeshen.tripartite.core.interceptor.AbstractInterceptor;
import work.gaigeshen.tripartite.core.interceptor.InterceptingException;
import work.gaigeshen.tripartite.core.ratelimiter.RateLimiterService;
import work.gaigeshen.tripartite.ding.openapi.config.DingConfig;
import work.gaigeshen.tripartite.ding.openapi.parameters.DingApiParameters;
import work.gaigeshen.tripartite.ding.openapi.parameters.DingOapiParameters;
import work.gaigeshen.tripartite.ding.openapi.parameters.api.DingAccessTokenParameters;
import work.gaigeshen.tripartite.ding.openapi.parameters.api.DingAuthCorpAccessTokenParameters;
import work.gaigeshen.tripartite.ding.openapi.response.DingApiResponse;
import work.gaigeshen.tripartite.ding.openapi.response.DingOapiResponse;
import work.gaigeshen.tripartite.ding.openapi.response.api.DingAccessTokenResponse;
import work.gaigeshen.tripartite.ding.openapi.response.api.DingAuthCorpAccessTokenResponse;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * 默认的钉钉接口客户端
 *
 * @author gaigeshen
 */
public class DefaultDingClient extends AbstractWebExecutorClient implements DingClient {

    private final DingConfig config;

    private final AccessTokenManager accessTokenManager;

    private final RateLimiterService rateLimiterService;

    protected DefaultDingClient(DingConfig config, AccessTokenManager accessTokenManager) {
        if (Objects.isNull(config)) {
            throw new IllegalArgumentException("config cannot be null");
        }
        if (Objects.isNull(accessTokenManager)) {
            throw new IllegalArgumentException("access token manager cannot be null");
        }
        this.config = config;
        this.accessTokenManager = accessTokenManager;
        this.rateLimiterService = RateLimiterService.create(16);
    }

    /**
     * 创建默认的钉钉接口客户端，需要钉钉配置信息和访问令牌管理器
     *
     * @param config 钉钉配置信息
     * @param accessTokenManager 访问令牌管理器
     * @return 钉钉接口客户端
     */
    static DefaultDingClient create(DingConfig config, AccessTokenManager accessTokenManager) {
        return new DefaultDingClient(config, accessTokenManager);
    }

    /**
     * 调用此方法将获取新的访问令牌，定制应用的情况下，获取方式有所不同
     *
     * @return 获取到的访问令牌
     * @throws ClientException 无法获取访问令牌
     */
    public AccessToken getNewAccessToken() throws ClientException {
        boolean hasAuthCorpId = Objects.nonNull(config.getAuthCorpId());
        String path = hasAuthCorpId ? "/v1.0/oauth2/corpAccessToken" : "/v1.0/oauth2/accessToken";
        if (hasAuthCorpId) {
            DingAuthCorpAccessTokenParameters parameters = new DingAuthCorpAccessTokenParameters();
            parameters.suiteKey = config.getAppKey();
            parameters.suiteSecret = config.getAppSecret();
            parameters.authCorpId = config.getAuthCorpId();
            parameters.suiteTicket = "none";
            DingAuthCorpAccessTokenResponse response = execute(parameters, DingAuthCorpAccessTokenResponse.class, path);
            String accessToken = response.accessToken;
            Long expireIn = response.expireIn;
            if (Objects.isNull(accessToken) || Objects.isNull(expireIn)) {
                throw new ClientException("acquired access token is invalid: " + config);
            }
            return AccessTokenHelper.createAccessToken(config, accessToken, expireIn);
        }
        DingAccessTokenParameters parameters = new DingAccessTokenParameters();
        parameters.appKey = config.getAppKey();
        parameters.appSecret = config.getAppSecret();
        DingAccessTokenResponse response = execute(parameters, DingAccessTokenResponse.class, path);
        String accessToken = response.accessToken;
        Long expireIn = response.expireIn;
        if (Objects.isNull(accessToken) || Objects.isNull(expireIn)) {
            throw new ClientException("acquired access token is invalid: " + config);
        }
        return AccessTokenHelper.createAccessToken(config, accessToken, expireIn);
    }

    @Override
    protected void initInternal() throws ClientException {
        try {
            accessTokenManager.addNewAccessToken(config, getNewAccessToken());
        } catch (AccessTokenManagerException e) {
            throw new ClientException(e.getMessage(), e);
        }
    }

    @Override
    protected List createInterceptors() {
        return Collections.singletonList(new AbstractInterceptor() {
            @Override
            protected void updateRequest(Request request) throws InterceptingException {
                String accessTokenValue = getAccessTokenValue();
                if (Objects.isNull(accessTokenValue)) {
                    return;
                }
                Headers headers = request.headers();
                headers.putValue("x-acs-dingtalk-access-token", accessTokenValue);
            }
            @Override
            protected void validateResponse(Request request, Response response) throws InterceptingException {
            }
        });
    }

    @Override
    public DingConfig getConfig() throws ConfigException {
        return config;
    }

    @Override
    public AccessTokenManager getAccessTokenManager() {
        return accessTokenManager;
    }

    @Override
    public RateLimiterService getRateLimiterService() {
        return rateLimiterService;
    }

    @Override
    protected  R validateResponse(R response) throws ClientException {
        R preValidated = super.validateResponse(response);
        if (preValidated instanceof DingOapiResponse) {
            DingOapiResponse dingOapiResponse = (DingOapiResponse) preValidated;
            if (!Objects.equals(0, dingOapiResponse.errcode)) {
                throw new ClientException("[ " + dingOapiResponse.errcode + " ] - [ " + dingOapiResponse.errmsg + " ]");
            }
        }
        return preValidated;
    }

    @Override
    public ServerHost getServerHost(ClientParameters parameters, Class responseClass) throws ServerHostException {
        if (parameters instanceof DingApiParameters || DingApiResponse.class.isAssignableFrom(responseClass)) {
            return ServerHost.create(config.getApiServerHost());
        }
        else if (parameters instanceof DingOapiParameters || DingOapiResponse.class.isAssignableFrom(responseClass)) {
            return ServerHost.create(config.getOapiServerHost());
        }
        throw new ServerHostException("could not determine server host: " + parameters + ", " + responseClass);
    }

    @Override
    public Collection getServerHosts() throws ServerHostException {
        return ServerHosts.create(config.getApiServerHost(), config.getOapiServerHost());
    }
}