钉钉自定义机器人无法指定正向代理问题解决

问题发生背景：

由于正式环境的机器，无法直接访问外网，需要通过正向代理来实现钉钉自定义机器人发送消息的功能。很简单的一个需求，但是实现的时候发现钉钉自定义机器人提供的SDK有个bug，无法使用proxy。

代码环境：

SDK

         <dependency><groupId>com.aliyun</groupId><artifactId>alibaba-dingtalk-service-sdk</artifactId><version>1.0.1</version></dependency>

问题复现：

首先我们通过利用SDK提供的DefaultDingTalkClient 类来调用发送消息的接口，而DefaultDingTalkClient这个类继承于DefaultTaobaoClient， DefaultTaobaoClient 有 Proxy属性

public class DefaultDingTalkClient extends DefaultTaobaoClient implements DingTalkClient {****** 省略了代码
}public class DefaultTaobaoClient implements TaobaoClient {****** 省略了代码private Proxy proxy; //代理类public Proxy getProxy() {return proxy;}public void setProxy(Proxy proxy) {this.proxy = proxy;}
}

那么我们遇到的问题解决方案看似很简单，直接setProxy，将代理设置好即可实现。
实际操作后，发现报错如下

Caused by: java.net.SocketTimeoutException: connect timed outat java.net.PlainSocketImpl.socketConnect(Native Method)at java.net.AbstractPlainSocketImpl.doConnect(AbstractPlainSocketImpl.java:350)at java.net.AbstractPlainSocketImpl.connectToAddress(AbstractPlainSocketImpl.java:206)at java.net.AbstractPlainSocketImpl.connect(AbstractPlainSocketImpl.java:188)

超时了？登上服务器后，ping了代理的地址，是没问题的，那么问题肯定出在并没有真的使用代理去访问外网。

问题探索：

出了问题，那么看下源码怎么回事吧。跟随断点进去，DefaultDingTalkClient复写了几个DefaultTaobaoClient的方法，复写的方法中，最终要不就是调用父类，要不就是调用com.dingtalk.api.DefaultDingTalkClient#executeOApi(com.taobao.api.TaobaoRequest<T>, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) 这个方法，

public class DefaultDingTalkClient extends DefaultTaobaoClient implements DingTalkClient {public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request, String accessKey, String accessSecret) throws ApiException {return execute(request, accessKey, accessSecret, null,null);}public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request, String accessKey, String accessSecret, String suiteTicket) throws ApiException {return execute(request, accessKey, accessSecret, suiteTicket,null);}public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request, String session) throws ApiException {if(request.getTopApiCallType() == null || request.getTopApiCallType().equals(DingTalkConstants.CALL_TYPE_TOP)) {return super.execute(request, session);} else {return executeOApi(request, session);}}public <T extends TaobaoResponse> T execute(TaobaoRequest<T> request, String accessKey, String accessSecret, String suiteTicket, String corpId) throws ApiException {if(request.getTopApiCallType() == null || request.getTopApiCallType().equals(DingTalkConstants.CALL_TYPE_TOP)) {return super.execute(request,null);} else {return executeOApi(request,null, accessKey, accessSecret,suiteTicket, corpId);}}private <T extends TaobaoResponse> T executeOApi(TaobaoRequest<T> request, String session) throws ApiException {return executeOApi(request, session, null, null, null, null);}private <T extends TaobaoResponse> T executeOApi(TaobaoRequest<T> request, String session, String accessKey, String accessSecret, String suiteTicket, String corpId) throws ApiException {*****省略代码if("GET".equals(request.getTopHttpMethod())) {data = WebV2Utils.doGet(fullUrl, appParams, connectTimeout, readTimeout);} else {// 是否需要上传文件if (request instanceof TaobaoUploadRequest) {TaobaoUploadRequest<T> uRequest = (TaobaoUploadRequest<T>) request;Map<String, FileItem> fileParams = TaobaoUtils.cleanupMap(uRequest.getFileParams());data = WebV2Utils.doPost(fullUrl, appParams, fileParams, Constants.CHARSET_UTF8, connectTimeout, readTimeout, request.getHeaderMap());} else {Map<String, Object> jsonParams = new HashMap<String, Object>();for (Map.Entry<String, String> paramEntry : appParams.entrySet()) {String key = paramEntry.getKey();String value = paramEntry.getValue();if(value.startsWith("[") && value.endsWith("]")) {List<Map<String, Object>> childMap = (List<Map<String, Object>>)TaobaoUtils.jsonToObject(value);jsonParams.put(key, childMap);} else if(value.startsWith("{") && value.endsWith("}")) {Map<String, Object> childMap = (Map<String, Object>)TaobaoUtils.jsonToObject(value);jsonParams.put(key, childMap);} else {jsonParams.put(key, value);}}data = WebV2Utils.doPostWithJson(fullUrl, jsonParams, Constants.CHARSET_UTF8, connectTimeout, readTimeout);}}}
}

我们选择其中一个分支来分析，另一个分支同理。
可以看到WebV2Utils.doPostWithJson 这个方法才是执行的关键，这个方法内部跟进去看看。

 public static HttpResponseData doPostWithJson(String url, Map<String, Object> params, String charset, int connectTimeout, int readTimeout) throws IOException {String ctype = "application/json;charset=" + charset;byte[] content = {};String body = TaobaoUtils.objectToJson(params);if (body != null) {content = body.getBytes(charset);}return _doPost(url, ctype, content, connectTimeout, readTimeout, null, null);}private static HttpResponseData _doPost(String url, String ctype, byte[] content, int connectTimeout, int readTimeout, Map<String, String> headerMap, Proxy proxy) throws IOException {***** 省略代码}

看到了吗， 他直接将Proxy参数，传了null，而非从赋值的属性中获取。

解决方案：

既然发现是他自作主张，将Proxy直接传入了null，那么我们只需要自己复写一个方法，传入赋值好的Proxy即可。

public class DefaultProxyDingTalkClient extends DefaultDingTalkClient {private <T extends TaobaoResponse> T executeOApi(TaobaoRequest<T> request, String session, String accessKey, String accessSecret, String suiteTicket, String corpId) throws ApiException {*****省略代码if("GET".equals(request.getTopHttpMethod())) {data = WebV2Utils.doGet(fullUrl, appParams, connectTimeout, readTimeout);} else {// 是否需要上传文件if (request instanceof TaobaoUploadRequest) {TaobaoUploadRequest<T> uRequest = (TaobaoUploadRequest<T>) request;Map<String, FileItem> fileParams = TaobaoUtils.cleanupMap(uRequest.getFileParams());data = WebV2Utils.doPost(fullUrl, appParams, fileParams, Constants.CHARSET_UTF8, connectTimeout, readTimeout, request.getHeaderMap());} else {Map<String, Object> jsonParams = new HashMap<String, Object>();for (Map.Entry<String, String> paramEntry : appParams.entrySet()) {String key = paramEntry.getKey();String value = paramEntry.getValue();if(value.startsWith("[") && value.endsWith("]")) {List<Map<String, Object>> childMap = (List<Map<String, Object>>)TaobaoUtils.jsonToObject(value);jsonParams.put(key, childMap);} else if(value.startsWith("{") && value.endsWith("}")) {Map<String, Object> childMap = (Map<String, Object>)TaobaoUtils.jsonToObject(value);jsonParams.put(key, childMap);} else {jsonParams.put(key, value);}}data = doPostWithJson(fullUrl, jsonParams, Constants.CHARSET_UTF8, connectTimeout, readTimeout);}}}}
}private HttpResponseData doPostWithJson(String url, Map<String, Object> params, String charset, int connectTimeout, int readTimeout) throws IOException {String ctype = "application/json;charset=" + charset;byte[] content = {};String body = TaobaoUtils.objectToJson(params);if (body != null) {content = body.getBytes(charset);}return WebV2Utils.doPost(url, ctype, content, connectTimeout, readTimeout, null, this.getProxy());}

完美解决问题。

附上自己封装好的钉钉自定义机器人代码

地址

接入步骤：

引入依赖

    <dependency><groupId>com.aliyun</groupId><artifactId>alibaba-dingtalk-service-sdk</artifactId><version>1.0.1</version></dependency>

配置webhook 和正向代理（非必填，不填时使用默认发送）

ding:webhook: 钉钉机器人复制的webhookproxyIpList: "host1:port1,host2:port2"#proxyIpList: "host1:port1"

更改DingNotifyManager#DINGDING_PREFIX
把前缀改成钉钉机器人配置的自定义关键词

使用：
使用方法封装了三个较常用的

发送纯文本 DingNotifyManager#sendCleanText
发送带连接的通知 DingNotifyManager#sendLink
发送markdown格式通知 DingNotifyManager#sendMarkdown