• Home
• com.wl4g
• infra-common
• 3.1.72
• source code
• DingtalkAPI.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.wl4g.infra.common.notification.dingtalk.internal.DingtalkAPI Maven / Gradle / Ivy

/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong James Wong 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.infra.common.notification.dingtalk.internal;

import static com.wl4g.infra.common.lang.Assert2.hasTextOf;
import static com.wl4g.infra.common.lang.Assert2.notNullOf;
import static com.wl4g.infra.common.lang.EnvironmentUtil.getBooleanProperty;
import static com.wl4g.infra.common.lang.EnvironmentUtil.getIntProperty;
import static com.wl4g.infra.common.serialize.JacksonUtils.parseToNode;
import static java.lang.String.format;
import static java.lang.System.currentTimeMillis;
import static java.util.Objects.isNull;

import java.net.URI;
import java.util.Map;
import java.util.function.Consumer;

import javax.annotation.Nullable;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.JsonNode;
import com.wl4g.infra.common.remoting.HttpRequestEntity;
import com.wl4g.infra.common.remoting.HttpResponseEntity;
import com.wl4g.infra.common.remoting.Netty4ClientHttpRequestFactory;
import com.wl4g.infra.common.remoting.RestClient;
import com.wl4g.infra.common.remoting.standard.HttpHeaders;

import io.netty.handler.codec.http.HttpMethod;
import lombok.Builder.Default;
import lombok.CustomLog;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.SuperBuilder;

/**
 * {@link DingtalkAPI}
 * 
 * @author James Wong
 * @version 2023-01-06
 * @since v3.0.0
 */
@CustomLog
public class DingtalkAPI {
    private final RestClient restClient;

    public DingtalkAPI() {
        final String configPrefix = DingtalkAPI.class.getSimpleName().toLowerCase();
        final boolean debug = getBooleanProperty(configPrefix + ".debug", false);
        final int connectTimeoutMs = getIntProperty(configPrefix + ".connectTimeout", 0);
        final int readTimeoutMs = getIntProperty(configPrefix + ".readTimeout", 0);
        final int maxResponseSize = getIntProperty(configPrefix + ".maxResponseSize", 0);
        this.restClient = new RestClient(
                new Netty4ClientHttpRequestFactory(debug, connectTimeoutMs, readTimeoutMs, maxResponseSize));
    }

    public DingtalkAPI(final @NotNull RestClient restClient) {
        this.restClient = notNullOf(restClient, "restClient");
    }

    public AccessTokenResult getAccessToken(final @NotNull AccessToken request) {
        return doRequest(ACCESS_TOKEN_URI, HttpMethod.POST, null, request, AccessTokenResult.class, true, false);
    }

    public GetUserIdByMobileResult getUserIdByMobile(final @NotBlank String accessToken, final @NotNull String mobile) {
        return doRequest(format(GET_USERID_BY_MOBILE_URI, accessToken, mobile), HttpMethod.GET, null, null,
                GetUserIdByMobileResult.class, false, false);
    }

    public CreateSceneGroupV2Result createSceneGroupV2(
            final @NotBlank String accessToken,
            final @NotNull CreateSceneGroupV2 request) {
        return doRequest(format(CREATE_GROUP_V2_URI, accessToken), HttpMethod.POST, null, request, CreateSceneGroupV2Result.class,
                true, false);
    }

    public RobotGroupMessagesSendResult sendRobotGroupMessages(
            final @NotBlank String accessToken,
            final @NotNull RobotGroupMessagesSend request) {
        return doRequest(SEND_GROUP_MESSAGE_URI, HttpMethod.POST, accessToken, request, RobotGroupMessagesSendResult.class, true,
                true);
    }

    /**
     * Validation and processing the subscribed group event callback request.
     * 
     * @param aesToken
     * @param aesKey
     * @param corpId
     *            1. 开发者后台配置的订阅事件为应用级事件推送，此时OWNER_KEY为应用的APP_KEY. 

     *            2. 调用订阅事件接口订阅的事件为企业级事件推送,
     *            此时OWNER_KEY为：企业的appkey（企业内部应用）或SUITE_KEY（三方应用）
     * @param signature
     * @param timestamp
     * @param nonce
     * @param bodyJson
     * @return
     * @see https://open.dingtalk.com/document/orgapp-server/configure-event-subcription
     * @see https://github.com/open-dingtalk/dingtalk-callback-Crypto?spm=ding_open_doc.document.0.0.6ecd7008UVMrZc
     */
    public Map processCallback(
            final @NotBlank String aesToken,
            final @NotBlank String aesKey,
            final @NotBlank String corpId,
            final @NotBlank String signature,
            final @NotBlank String timestamp,
            final @NotBlank String nonce,
            final @NotBlank String bodyJson,
            final @NotNull Consumer process) {
        hasTextOf(aesToken, "aesToken");
        hasTextOf(aesKey, "aesKey");
        hasTextOf(corpId, "corpId");
        hasTextOf(timestamp, "timestamp");
        hasTextOf(nonce, "nonce");
        hasTextOf(bodyJson, "bodyJson");
        notNullOf(process, "process");

        try {
            final JsonNode json = parseToNode(bodyJson);
            final String encryptMsg = json.requiredAt("/encrypt").asText();

            final DingCallbackCrypto crypto = new DingCallbackCrypto(aesToken, aesKey, corpId);
            final String decryptMsg = crypto.getDecryptMsg(signature, timestamp, nonce, encryptMsg);

            // 提取回调请求的明文事件JSON数据
            final JsonNode eventJson = parseToNode(decryptMsg);
            log.debug("Received event: {}", eventJson.requiredAt("/EventType").asText());

            // 处理事件消息
            process.accept(eventJson);

            // 返回success的加密数据
            return crypto.getEncryptedMap("success");
        } catch (Exception e) {
            throw new IllegalArgumentException("Failed to validation subscribed callback request.", e);
        }
    }

     R doRequest(
            final @NotBlank String url,
            final @NotNull HttpMethod method,
            final @Nullable String accessToken,
            final @Nullable T request,
            final @NotNull Class resultClass,
            final boolean addContentJson,
            final boolean addAccessToken) {
        notNullOf(method, "method");
        notNullOf(resultClass, "resultClass");
        final HttpHeaders headers = new HttpHeaders();
        if (addContentJson) {
            headers.add("Content-Type", "application/json");
        }
        if (addAccessToken) {
            headers.add("x-acs-dingtalk-access-token", accessToken);
        }
        final HttpRequestEntity