DefaultDingTalkClient.cs 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. using FastJSON;
  2. using System;
  3. using System.Collections;
  4. using System.Collections.Generic;
  5. using System.Xml;
  6. using Top.Api.Parser;
  7. using Top.Api.Util;
  8. using Top.Api;
  9. using Top.Api.DingTalk;
  10. namespace DingTalk.Api
  11. {
  12. /// <summary>
  13. /// 基于REST的TOP客户端。
  14. /// </summary>
  15. public class DefaultDingTalkClient : IDingTalkClient
  16. {
  17. internal string serverUrl;
  18. internal string format = Constants.FORMAT_XML;
  19. internal DateTime dt1970 = new DateTime(1970, 1, 1, 0, 0, 0, 0);
  20. internal WebUtils webUtils;
  21. internal ITopLogger topLogger;
  22. internal bool disableParser = false; // 禁用响应结果解释
  23. internal bool disableTrace = false; // 禁用日志调试功能
  24. internal bool useSimplifyJson = false; // 是否采用精简化的JSON返回
  25. internal bool useGzipEncoding = true; // 是否启用响应GZIP压缩
  26. internal bool useJsonString = false; // 是否采用JsonString生成
  27. internal IDictionary<string, string> systemParameters; // 设置所有请求共享的系统级参数
  28. #region DefaultDingTalkClient Constructors
  29. public DefaultDingTalkClient(string serverUrl)
  30. {
  31. this.serverUrl = serverUrl;
  32. this.webUtils = new WebUtils();
  33. this.topLogger = Top.Api.Log.Instance;
  34. }
  35. public DefaultDingTalkClient(string serverUrl,string format)
  36. : this(serverUrl)
  37. {
  38. this.format = format;
  39. }
  40. #endregion
  41. public void SetTimeout(int timeout)
  42. {
  43. this.webUtils.Timeout = timeout;
  44. }
  45. public void SetReadWriteTimeout(int readWriteTimeout)
  46. {
  47. this.webUtils.ReadWriteTimeout = readWriteTimeout;
  48. }
  49. public void SetDisableParser(bool disableParser)
  50. {
  51. this.disableParser = disableParser;
  52. }
  53. public void SetDisableTrace(bool disableTrace)
  54. {
  55. this.disableTrace = disableTrace;
  56. }
  57. public void SetUseSimplifyJson(bool useSimplifyJson)
  58. {
  59. this.useSimplifyJson = useSimplifyJson;
  60. }
  61. public void SetUseGzipEncoding(bool useGzipEncoding)
  62. {
  63. this.useGzipEncoding = useGzipEncoding;
  64. }
  65. public void SetIgnoreSSLCheck(bool ignore)
  66. {
  67. this.webUtils.IgnoreSSLCheck = ignore;
  68. }
  69. public void SetSystemParameters(IDictionary<string, string> systemParameters)
  70. {
  71. this.systemParameters = systemParameters;
  72. }
  73. #region IDingTalkClient Members
  74. public virtual T Execute<T>(IDingTalkRequest<T> request) where T : DingTalkResponse
  75. {
  76. return DoExecute<T>(request, null, DateTime.Now);
  77. }
  78. public virtual T Execute<T>(IDingTalkRequest<T> request, string session) where T : DingTalkResponse
  79. {
  80. return DoExecute<T>(request, session, DateTime.Now);
  81. }
  82. public virtual T Execute<T>(IDingTalkRequest<T> request, string session, DateTime timestamp) where T : DingTalkResponse
  83. {
  84. return DoExecute<T>(request, session, timestamp);
  85. }
  86. public T Execute<T>(IDingTalkRequest<T> request, string accessKey, string accessSecret) where T : DingTalkResponse
  87. {
  88. return Execute<T>(request, accessKey, accessSecret, null, null);
  89. }
  90. public T Execute<T>(IDingTalkRequest<T> request, string accessKey, string accessSecret, string suiteTicket) where T : DingTalkResponse
  91. {
  92. return Execute<T>(request, accessKey, accessSecret, suiteTicket, null);
  93. }
  94. public T Execute<T>(IDingTalkRequest<T> request, string accessKey, string accessSecret, string suiteTicket, string corpId) where T : DingTalkResponse
  95. {
  96. if (request.GetApiCallType() == null || request.GetApiCallType().Equals(DingTalkConstants.CALL_TYPE_TOP))
  97. {
  98. return DoExecuteTop(request, null, DateTime.Now);
  99. }
  100. else
  101. {
  102. return DoExecuteOApi(request, null, accessKey, accessSecret, suiteTicket, corpId, DateTime.Now);
  103. }
  104. }
  105. #endregion
  106. private T DoExecute<T>(IDingTalkRequest<T> request, string session, DateTime timestamp) where T : DingTalkResponse
  107. {
  108. if(request.GetApiCallType() == null || request.GetApiCallType().Equals(DingTalkConstants.CALL_TYPE_TOP)) {
  109. return DoExecuteTop(request, session, timestamp);
  110. } else {
  111. return DoExecuteOApi(request, session, null, null, null, null, timestamp);
  112. }
  113. }
  114. private T DoExecuteTop<T>(IDingTalkRequest<T> request, string session, DateTime timestamp) where T : DingTalkResponse
  115. {
  116. long start = DateTime.Now.Ticks;
  117. // 提前检查业务参数
  118. try
  119. {
  120. request.Validate();
  121. }
  122. catch (TopException e)
  123. {
  124. return CreateErrorResponse<T>(e.ErrorCode, e.ErrorMsg);
  125. }
  126. // 添加协议级请求参数
  127. TopDictionary txtParams = new TopDictionary(request.GetParameters());
  128. txtParams.Add(Constants.METHOD, request.GetApiName());
  129. txtParams.Add(Constants.VERSION, "2.0");
  130. txtParams.Add(Constants.FORMAT, format);
  131. txtParams.Add(Constants.PARTNER_ID, GetSdkVersion());
  132. txtParams.Add(Constants.TIMESTAMP, timestamp);
  133. txtParams.Add(Constants.SESSION, session);
  134. txtParams.AddAll(this.systemParameters);
  135. if (this.useSimplifyJson)
  136. {
  137. txtParams.Add(Constants.SIMPLIFY, "true");
  138. }
  139. // 添加头部参数
  140. if (this.useGzipEncoding)
  141. {
  142. request.GetHeaderParameters()[Constants.ACCEPT_ENCODING] = Constants.CONTENT_ENCODING_GZIP;
  143. }
  144. string realServerUrl = GetServerUrl(this.serverUrl, request.GetApiName(), session);
  145. string reqUrl = WebUtils.BuildRequestUrl(realServerUrl, txtParams);
  146. try
  147. {
  148. string body;
  149. if (request is IDingTalkUploadRequest<T>) // 是否需要上传文件
  150. {
  151. IDingTalkUploadRequest<T> uRequest = (IDingTalkUploadRequest<T>)request;
  152. IDictionary<string, FileItem> fileParams = TopUtils.CleanupDictionary(uRequest.GetFileParameters());
  153. body = webUtils.DoPost(realServerUrl, txtParams, fileParams, request.GetHeaderParameters());
  154. }
  155. else
  156. {
  157. body = webUtils.DoPost(realServerUrl, txtParams, request.GetHeaderParameters());
  158. }
  159. // 解释响应结果
  160. T rsp;
  161. if (disableParser)
  162. {
  163. rsp = Activator.CreateInstance<T>();
  164. rsp.Body = body;
  165. }
  166. else
  167. {
  168. if (Constants.FORMAT_XML.Equals(format))
  169. {
  170. ITopParser<T> tp = new TopXmlParser<T>();
  171. rsp = tp.Parse(body);
  172. }
  173. else
  174. {
  175. ITopParser<T> tp;
  176. if (useSimplifyJson)
  177. {
  178. tp = new TopSimplifyJsonParser<T>();
  179. }
  180. else
  181. {
  182. tp = new TopJsonParser<T>();
  183. }
  184. rsp = tp.Parse(body);
  185. }
  186. }
  187. // 追踪错误的请求
  188. if (rsp.IsError)
  189. {
  190. TimeSpan latency = new TimeSpan(DateTime.Now.Ticks - start);
  191. TraceApiError(request.GetApiName(), serverUrl, txtParams, latency.TotalMilliseconds, rsp.Body);
  192. }
  193. return rsp;
  194. }
  195. catch (Exception e)
  196. {
  197. TimeSpan latency = new TimeSpan(DateTime.Now.Ticks - start);
  198. TraceApiError(request.GetApiName(), serverUrl, txtParams, latency.TotalMilliseconds, e.GetType() + ": " + e.Message);
  199. throw e;
  200. }
  201. }
  202. private T DoExecuteOApi<T>(IDingTalkRequest<T> request, string session, string accessKey, string accessSecret, string suiteTicket, string corpId, DateTime timestamp) where T : DingTalkResponse
  203. {
  204. long start = DateTime.Now.Ticks;
  205. // 提前检查业务参数
  206. try
  207. {
  208. request.Validate();
  209. }
  210. catch (TopException e)
  211. {
  212. return CreateErrorResponse<T>(e.ErrorCode, e.ErrorMsg);
  213. }
  214. this.format = Constants.FORMAT_JSON;
  215. // 添加协议级请求参数
  216. TopDictionary txtParams = new TopDictionary(request.GetParameters());
  217. txtParams.Add(DingTalkConstants.ACCESS_TOKEN, session);
  218. // 添加头部参数
  219. if (this.useGzipEncoding)
  220. {
  221. request.GetHeaderParameters()[Constants.ACCEPT_ENCODING] = Constants.CONTENT_ENCODING_GZIP;
  222. }
  223. string realServerUrl = null;
  224. // 签名优先
  225. if (accessKey != null)
  226. {
  227. long dingTimestamp = GetTimestamp(DateTime.UtcNow);
  228. // 验证签名有效性
  229. String canonicalString = DingTalkSignatureUtil.GetCanonicalStringForIsv(dingTimestamp, suiteTicket);
  230. String signature = DingTalkSignatureUtil.ComputeSignature(accessSecret, canonicalString);
  231. IDictionary<String, String> ps = new Dictionary<String, String>();
  232. ps.Add("accessKey", accessKey);
  233. ps.Add("signature", signature);
  234. ps.Add("timestamp", dingTimestamp + "");
  235. if (suiteTicket != null)
  236. {
  237. ps.Add("suiteTicket", suiteTicket);
  238. }
  239. if (corpId != null)
  240. {
  241. ps.Add("corpId", corpId);
  242. }
  243. String queryStr = DingTalkSignatureUtil.ParamToQueryString(ps, "utf-8");
  244. if (this.serverUrl.IndexOf("?") > 0)
  245. {
  246. realServerUrl = this.serverUrl + "&" + queryStr;
  247. }
  248. else
  249. {
  250. realServerUrl = this.serverUrl + "?" + queryStr;
  251. }
  252. }
  253. else
  254. {
  255. if (this.serverUrl.IndexOf("?") > 0)
  256. {
  257. realServerUrl = this.serverUrl + (session != null && session != "" ? ("&access_token=" + session) : "");
  258. }
  259. else
  260. {
  261. realServerUrl = this.serverUrl + (session != null && session != "" ? ("?access_token=" + session) : "");
  262. }
  263. }
  264. try
  265. {
  266. string body;
  267. if(request.GetHttpMethod() == "POST")
  268. {
  269. if (request is IDingTalkUploadRequest<T>) // 是否需要上传文件
  270. {
  271. IDingTalkUploadRequest<T> uRequest = (IDingTalkUploadRequest<T>)request;
  272. IDictionary<string, FileItem> fileParams = TopUtils.CleanupDictionary(uRequest.GetFileParameters());
  273. body = webUtils.DoPost(realServerUrl, null, fileParams, request.GetHeaderParameters());
  274. }
  275. else
  276. {
  277. IDictionary<String, Object> jsonParams = new Dictionary<String, Object>();
  278. foreach (string key in request.GetParameters().Keys)
  279. {
  280. string value = request.GetParameters()[key];
  281. if(useJsonString)
  282. {
  283. jsonParams.Add(key, value);
  284. }
  285. else
  286. {
  287. if (value.StartsWith("[") && value.EndsWith("]"))
  288. {
  289. IList childMap = (IList)TopUtils.JsonToObject(value);
  290. jsonParams.Add(key, childMap);
  291. }
  292. else if (value.StartsWith("{") && value.EndsWith("}"))
  293. {
  294. IDictionary<string, Object> childMap = (IDictionary<string, Object>)TopUtils.JsonToObject(value);
  295. jsonParams.Add(key, childMap);
  296. }
  297. else
  298. {
  299. jsonParams.Add(key, value);
  300. }
  301. }
  302. }
  303. body = webUtils.DoPostWithJson(realServerUrl, jsonParams, request.GetHeaderParameters());
  304. }
  305. } else
  306. {
  307. body = webUtils.DoGet(realServerUrl, request.GetParameters());
  308. }
  309. // 解释响应结果
  310. T rsp;
  311. if (disableParser)
  312. {
  313. rsp = Activator.CreateInstance<T>();
  314. rsp.Body = body;
  315. }
  316. else
  317. {
  318. ITopParser<T> tp = new DingTalkJsonParser<T>();
  319. rsp = tp.Parse(body);
  320. }
  321. // 追踪错误的请求
  322. if (rsp.IsError)
  323. {
  324. TimeSpan latency = new TimeSpan(DateTime.Now.Ticks - start);
  325. TraceApiError(request.GetApiName(), serverUrl, txtParams, latency.TotalMilliseconds, rsp.Body);
  326. }
  327. return rsp;
  328. }
  329. catch (Exception e)
  330. {
  331. TimeSpan latency = new TimeSpan(DateTime.Now.Ticks - start);
  332. TraceApiError(request.GetApiName(), serverUrl, txtParams, latency.TotalMilliseconds, e.GetType() + ": " + e.Message);
  333. throw e;
  334. }
  335. }
  336. internal virtual string GetServerUrl(string serverUrl, string apiName, string session)
  337. {
  338. return serverUrl;
  339. }
  340. internal virtual string GetSdkVersion()
  341. {
  342. return Constants.SDK_VERSION;
  343. }
  344. internal T CreateErrorResponse<T>(string errCode, string errMsg) where T : DingTalkResponse
  345. {
  346. T rsp = Activator.CreateInstance<T>();
  347. rsp.ErrCode = errCode;
  348. rsp.ErrMsg = errMsg;
  349. if (Constants.FORMAT_XML.Equals(format))
  350. {
  351. XmlDocument root = new XmlDocument();
  352. XmlElement bodyE = root.CreateElement(Constants.ERROR_RESPONSE);
  353. XmlElement codeE = root.CreateElement(Constants.ERROR_CODE);
  354. codeE.InnerText = errCode;
  355. bodyE.AppendChild(codeE);
  356. XmlElement msgE = root.CreateElement(Constants.ERROR_MSG);
  357. msgE.InnerText = errMsg;
  358. bodyE.AppendChild(msgE);
  359. root.AppendChild(bodyE);
  360. rsp.Body = root.OuterXml;
  361. }
  362. else
  363. {
  364. IDictionary<string, object> errObj = new Dictionary<string, object>();
  365. errObj.Add(Constants.ERROR_CODE, errCode);
  366. errObj.Add(Constants.ERROR_MSG, errMsg);
  367. IDictionary<string, object> root = new Dictionary<string, object>();
  368. root.Add(Constants.ERROR_RESPONSE, errObj);
  369. string body = JSON.ToJSON(root);
  370. rsp.Body = body;
  371. }
  372. return rsp;
  373. }
  374. internal void TraceApiError(string apiName, string url, Dictionary<string, string> parameters, double latency, string errorMessage)
  375. {
  376. if (!disableTrace)
  377. {
  378. this.topLogger.TraceApiError("dingtalk",apiName, url, parameters, latency, errorMessage);
  379. }
  380. }
  381. private long GetTimestamp(DateTime dateTime)
  382. {
  383. return (dateTime.Ticks - dt1970.Ticks) / 10000;
  384. }
  385. }
  386. }