C#—ASP.NET:集成極光推送（Push API v3）

 

C#—ASP.NET:集成極光推送（Push API v3）

原文地址： https://blog.csdn.net/CXLLLK/article/details/86489994

 

 

1、極光推送官網（https://www.jpush.cn/）申請一個賬號。

2、服務中心，開發者服務中，創建一個新的應用，輸入正確的Android的包名

3、獲取到了一個AppKey 和一個 Master Secret，這兩個參數比較重要，驗證權限使用。

4、去官網找到下載C# SDK的包https://docs.jiguang.cn/jpush/resources/

     Github 源碼:https://github.com/jpush/jpush-api-csharp-client

5、源碼生成DLL

6、項目引用DLL,新建類 using Jiguang.JPush.Model;

7、代碼封裝HTTP 調用官方API,轉載地址為pohreb博客:https://www.cnblogs.com/yangwujun/p/5973120.html

 

/// 極光推送的最新版：PUSH-API-V3

/// 參考地址 http://docs.jpush.cn/display/dev/Push-API-v3

1. #region 基礎方法
2. /// <summary>
3. /// 應用標識：極光推送的用戶名
4. /// </summary>
5. private const string AppKey = "填寫你應用的AppKey";
6. /// <summary>
7. /// 極光推送的密碼
8. /// </summary>
9. private const string MasterSecret = "填寫你的MasterSecret";
10. ///// <summary>
11. ///// 極光推送請求的url地址
12. ///// </summary>
13. private const string RequestUrl = "https://api.jpush.cn/v3/push";
14. //private const string RequestUrl = "https://bjapi.push.jiguang.cn/v3/push";
15. /// <summary>
16. /// 查詢推送結果請求的Url地址
17. /// </summary>
18. private const string ReceivedUrl = "https://report.jpush.cn/v3/received";
19. /// <summary>
20. /// 發送推送請求到JPush，使用HttpWebRequest
21. /// </summary>
22. /// <param name="method">傳入POST或GET</param>
23. /// <param name="url">固定地址</param>
24. /// <param name="auth">用戶名AppKey和密碼MasterSecret形成的Base64字符串</param>
25. /// <param name="reqParams">請求的json參數，一般由Platform(平台)、Audience(設備對象標識)、Notification(通知)、Message(自定義消息)、Options(推送可選項)組成</param>
26. /// <returns></returns>
27. private static string SendRequest(String method, String url, String auth, String reqParams)
28. {
29. string resultJson = "";
30. HttpWebRequest myReq = null;
31. HttpWebResponse response = null;
32. try
33. {
34. myReq = (HttpWebRequest)WebRequest.Create(url);
35. myReq.Method = method;
36. myReq.ContentType = "application/json";
37. if (!String.IsNullOrEmpty(auth))
38. {
39. myReq.Headers.Add( "Authorization", "Basic " + auth);
40. }
41. if (method == "POST")
42. {
43. byte[] bs = UTF8Encoding.UTF8.GetBytes(reqParams);
44. myReq.ContentLength = bs.Length;
45. using (Stream reqStream = myReq.GetRequestStream())
46. {
47. reqStream.Write(bs, 0, bs.Length);
48. reqStream.Close();
49. }
50. }
51. response = (HttpWebResponse)myReq.GetResponse();
52. HttpStatusCode statusCode = response.StatusCode;
53. if (Equals(response.StatusCode, HttpStatusCode.OK))
54. {
55. using (StreamReader reader = new StreamReader(response.GetResponseStream(), System.Text.Encoding.UTF8))
56. {
57. resultJson = reader.ReadToEnd();
58. try
59. {
60. object json = Newtonsoft.Json.JsonConvert.DeserializeObject(resultJson);
61. }
62. catch
63. {
64. resultJson = string.Format("{{\"error\": {{\"message\": \"{0}\", \"code\": 10086}}}}", "響應的結果不是正確的json格式");
65. }
66. }
67. }
68. }
69. catch (WebException ex)
70. {
71. if (ex.Status == WebExceptionStatus.ProtocolError)
72. {
73. HttpStatusCode errorCode = ((HttpWebResponse)ex.Response).StatusCode;
74. string statusDescription = ((HttpWebResponse)ex.Response).StatusDescription;
75. using (StreamReader sr = new StreamReader(((HttpWebResponse)ex.Response).GetResponseStream(), System.Text.Encoding.UTF8))
76. {
77. resultJson = sr.ReadToEnd();
78. //{"errcode":404,"errmsg":"request api doesn't exist"}
79. Dictionary< string, object> dict = JsonToDictionary(resultJson);
80. string errCode = "10086";
81. string errMsg = "發送推送的請求地址不存在或無法連接";
82. if (dict.ContainsKey("errcode"))
83. {
84. errCode = dict[ "errcode"].ToString();
85. }
86. if (dict.ContainsKey("errmsg"))
87. {
88. errMsg = dict[ "errmsg"].ToString();
89. }
90. resultJson = string.Format("{{\"error\": {{\"message\": \"{0}\", \"code\": {1}}}}}", errMsg, errCode);
91. }
92. }
93. else
94. {
95. //這里一定是error作為鍵名（自定義錯誤號10086），和極光推送失敗時的json格式保持一致 如 {"error": {"message": "Missing parameter", "code": 1002}}
96. resultJson = string.Format("{{\"error\": {{\"message\": \"{0}\", \"code\": 10086}}}}", ex.Message.Replace("\"", " ").Replace("'", " "));
97. }
98. }
99. catch (System.Exception ex)
100. {
101. resultJson = string.Format("{{\"error\": {{\"message\": \"{0}\", \"code\": 10086}}}}", ex.Message.Replace("\"", " ").Replace("'", " "));
102. }
103. finally
104. {
105. if (response != null)
106. {
107. response.Close();
108. }
109. if (myReq != null)
110. {
111. myReq.Abort();
112. }
113. }
114. return resultJson;
115. }
116. /// <summary>
117. /// 通過用戶名AppKey和密碼獲取驗證碼
118. /// </summary>
119. /// <returns></returns>
120. private static string GetBase64Auth()
121. {
122. string str = AppKey + ":" + MasterSecret;
123. byte[] bytes = Encoding.Default.GetBytes(str);
124. return Convert.ToBase64String(bytes);
125. }
126. /// <summary>
127. /// 發送推送請求到JPush
128. /// </summary>
129. /// <param name="method">POST或GET</param>
130. /// <param name="reqParams">請求的json參數，一般由Platform(平台)、Audience(設備對象標識)、Notification(通知)、Message(自定義消息)、Options(推送可選項)組成</param>
131. /// <returns></returns>
132. public static string SendRequest(String method, String reqParams)
133. {
134. string auth = GetBase64Auth();
135. return SendRequest(method, RequestUrl, auth, reqParams);
136. }
137. /// <summary>
138. /// 發送Post請求
139. /// </summary>
140. /// <param name="reqParams">請求的json參數，一般由Platform(平台)、Audience(設備對象標識)、Notification(通知)、Message(自定義消息)、Options(推送可選項)組成</param>
141. /// <returns></returns>
142. public static string SendPostRequest(String reqParams)
143. {
144. string auth = GetBase64Auth();
145. return SendRequest("POST", RequestUrl, auth, reqParams);
146. }
147. /// <summary>
148. /// 發送Get請求
149. /// </summary>
150. /// <param name="reqParams">請求的json參數，一般由Platform(平台)、Audience(設備對象標識)、Notification(通知)、Message(自定義消息)、Options(推送可選項)組成</param>
151. /// <returns></returns>
152. public static string SendGetRequest(String reqParams)
153. {
154. string auth = GetBase64Auth();
155. return SendRequest("GET", RequestUrl, auth, reqParams);
156. }
157. /*
158. * 生成唯一的sendNo的方法： 取序列號
159. * 查看返回結果的方法
160. */
161. /// <summary>
162. /// 查詢推送的結果
163. /// </summary>
164. /// <param name="msg_ids">生成的json信息唯一id</param>
165. /// <returns></returns>
166. public static string GetReceivedResult(String msg_ids)
167. {
168. string url = ReceivedUrl + "?msg_ids=" + msg_ids;
169. String auth = GetBase64Auth();
170. return SendRequest("GET", url, auth, null);
171. }
172. /*
173. * 1.正確時返回結果{"sendno":"123456","msg_id":"1799597405"}
174. * 或者 {"sendno":"0","msg_id":"351403900"}
175. * 2.入參json完全正確，但找不到要到達的設備。錯誤時：返回
176. * {"msg_id": 3125719446, "error": {"message": "cannot find user by this audience", "code": 1011}}
177. * 3.傳入空字符串 或者 非json格式，或者沒有必須的選項：{"error": {"message": "Missing parameter", "code": 1002}}
178. * 傳入的鍵（鍵區分大小寫）、值不符合要求 {"error": {"message": "Audience value must be JSON Array format!", "code": 1003}}
179. */
180. /// <summary>
181. /// 將返回的json轉換為Hashtable對象
182. /// </summary>
183. /// <param name="jsonString"></param>
184. /// <returns></returns>
185. public static Hashtable JsonToHashtable(string jsonString)
186. {
187. /*
188. * 正確時返回結果{"sendno":"123456","msg_id":"1799597405"}
189. * {"sendno":"0","msg_id":"351403900"}
190. * 入參json完全正確，但找不到要到達的設備。錯誤時：返回 {"msg_id": 3125719446, "error": {"message": "cannot find user by this audience", "code": 1011}}
191. * 傳入空字符串 或者 非json格式，或者沒有必須的選項：{"error": {"message": "Missing parameter", "code": 1002}}
192. * 傳入的鍵值不符合要求 {"error": {"message": "Audience value must be JSON Array format!", "code": 1003}} 鍵區分大小寫
193. */
194. Hashtable ht = new Hashtable();
195. object json = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonString);
196. //返回的結果一定是一個json對象
197. Newtonsoft.Json.Linq.JObject jsonObject = json as Newtonsoft.Json.Linq.JObject;
198. if (jsonObject == null)
199. {
200. return ht;
201. }
202. foreach (Newtonsoft.Json.Linq.JProperty jProperty in jsonObject.Properties())
203. {
204. Newtonsoft.Json.Linq.JToken jToken = jProperty.Value;
205. string value = "";
206. if (jToken != null)
207. {
208. value = jToken.ToString();
209. }
210. ht.Add(jProperty.Name, value);
211. }
212. return ht;
213. }
214. /// <summary>
215. /// 根據json返回的結果判斷是否推送成功
216. /// </summary>
217. /// <param name="jsonString">響應的json</param>
218. /// <param name="errorMessage">錯誤信息</param>
219. /// <param name="errorCode">錯誤號</param>
220. /// <returns></returns>
221. public static bool IsSuccess(string jsonString, out string errorMessage, out string errorCode)
222. {
223. Hashtable ht = JsonToHashtable(jsonString);
224. errorMessage = "";
225. errorCode = "";
226. foreach (string key in ht.Keys)
227. {
228. //如果存在error鍵,說明推送出錯
229. if (key == "error")
230. {
231. string errJson = ht[key].ToString();
232. Hashtable htError = JsonToHashtable(errJson);
233. errorMessage = htError[ "message"].ToString();
234. errorCode = htError[ "code"].ToString();
235. return false;
236. }
237. }
238. return true;
239. }
240. /// <summary>
241. /// 根據返回的響應json來判斷推送是否成功，成功時記錄sendno與msg_id。
242. /// 失敗時記錄錯誤信息errorMessage、錯誤號errCode等
243. /// </summary>
244. /// <param name="jsonString">響應的json</param>
245. /// <param name="errorMessage">錯誤信息</param>
246. /// <param name="errorCode">錯誤號</param>
247. /// <param name="sendno">用戶自定義的推送編號（從序列號中獲取），不設置則為0，成功后返回該編號</param>
248. /// <param name="msg_id">極光服務器處理后返回的信息編號</param>
249. /// <returns></returns>
250. public static bool IsSuccess(string jsonString, out string errorMessage, out string errorCode, out string sendno, out string msg_id)
251. {
252. bool result = IsSuccess(jsonString, out errorMessage, out errorCode);
253. Hashtable ht = JsonToHashtable(jsonString);
254. sendno = "";
255. msg_id = "";
256. if (result) //推送成功時，只有鍵sendno、msg_id
257. {
258. sendno = ht[ "sendno"].ToString();
259. msg_id = ht[ "msg_id"].ToString();
260. }
261. else //如果失敗時存在msg_id鍵，則記錄msg_id的值
262. {
263. if (ht.ContainsKey("msg_id"))
264. {
265. msg_id = ht[ "msg_id"].ToString();
266. }
267. }
268. return result;
269. }
270. /// <summary>
271. /// 將返回的json轉換為字典Dictionary對象
272. /// </summary>
273. /// <param name="jsonString"></param>
274. /// <returns></returns>
275. public static Dictionary<string, object> JsonToDictionary(string jsonString)
276. {
277. Dictionary< string, object> ht = new Dictionary<string, object>();
278. object json = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonString);
279. //返回的結果一定是一個json對象
280. Newtonsoft.Json.Linq.JObject jsonObject = json as Newtonsoft.Json.Linq.JObject;
281. if (jsonObject == null)
282. {
283. return ht;
284. }
285. foreach (Newtonsoft.Json.Linq.JProperty jProperty in jsonObject.Properties())
286. {
287. Newtonsoft.Json.Linq.JToken jToken = jProperty.Value;
288. string value = "";
289. if (jToken != null)
290. {
291. value = jToken.ToString();
292. }
293. ht.Add(jProperty.Name, value);
294. }
295. return ht;
296. }
297. #endregion

8、其中我們主要使用registration_id的方式推送，也就是通過APP上的用戶Token推送。

新增兩個實體類一個存儲APP用戶Token，以及設備平台(安卓,蘋果)，一個存儲推送記錄，其實極光官網也有推送記錄。

 

因為需要推送多個用戶情況，新添List存儲registration_id

新建返回對象存儲返回信息

 

擴展方法使用，根據文檔實現JSON格式並調用基本方法實現推送https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/

 

/// <summary>

/// 推送消息並保存到已發送表

1. /// </summary>
2. /// <param name="RegistrationIDList">推送TokenID集合</param>
3. /// <param name="title">標題</param>
4. /// <param name="senduser">作者</param>
5. /// <param name="toid">推送對象ID</param>
6. /// <param name="contype">推送對象</param>
7. /// <param name="dataid"></param>
8. /// <param name="strMsg">推送內容</param>
9. /// <param name="is_production"></param>
10. /// <param name="strLog">返回日志</param>
11. /// <returns></returns>
12. public static bool SendPushV2(List<string> RegistrationIDList, string title, string senduser, string toid,int contype,string dataid, string strMsg, bool is_production, out string strLog)
13. {
14. try
15. {
16. var parmARR = new Dictionary<string, object>();
17. parmARR.Add( "dataid", dataid);
18. var mm = new M_PushRegistration();
19. mm.registration_id = RegistrationIDList;
20. //生成JSON格式參數
21. PushPayload pushPayload = new PushPayload()
22. {
23. Platform = new List<string> { "android", "ios" },//推送平台
24. Audience = mm, //推送對象
25. Notification = new Notification
26. {
27. Alert = strMsg,
28. Android = new Android
29. {
30. Alert = strMsg,
31. Title = "你的標題",
32. Extras = parmARR
33. },
34. IOS = new IOS
35. {
36. Alert = strMsg,
37. Badge = "+1",
38. Extras = parmARR
39. }
40. },
41. Options = new Options
42. {
43. IsApnsProduction = true // 設置 iOS 推送生產環境。不設置默認為開發環境。
44. }
45. };
46. var strParms = pushPayload.Exp_ModelToJson();
47. strParms.WriteFile( "log/push");
48. var result = JPushHelperV3.SendPostRequest(strParms);
49. var retM = result.Exp_JsonToModel<M_PushReturn>(1);
50. strLog = "";
51. strLog += "result=" + result + "&&retModel=" + retM.Exp_ModelToJson();
52. strLog.WriteFile( "log/push");
53. if (retM.error == null)
54. {
55. //保存推送信息
56. string[] teacherArr = toid.Split(',');
57. for (int i = 0; i < teacherArr.Length; i++)
58. {
59. D_T_PushMsg_Exp pushmsgDal = new D_T_PushMsg_Exp();
60. M_T_PushMsg pushmsgModel = new M_T_PushMsg();
61. pushmsgModel.Title = title;
62. pushmsgModel.MsgAuthor = senduser;
63. pushmsgModel.MsgContent = strMsg;
64. pushmsgModel.Flag = true;
65. pushmsgModel.IsRead = false;
66. pushmsgModel.IsSend = true;
67. pushmsgModel.Contype = contype;
68. pushmsgModel.Remark1 = teacherArr[i].Exp_IntTryParse(); //發送給誰
69. pushmsgModel.AddTime = DateTime.Now;
70. pushmsgModel.SendTime = DateTime.Now;
71. pushmsgModel.Remark2 = "";
72. pushmsgModel.Remark3 = false;
73. pushmsgDal.Admin_Add(pushmsgModel);
74. }
75. strLog = "向設備推送消息成功\r\n請求參數=" + strParms + "\r\n";
76. return true;
77. }
78. else
79. {
80. strLog = "推送失敗，錯誤碼：" + retM.error.code + "，錯誤信息：" + retM.error.message;
81. return false;
82. }
83. }
84. catch (Exception ex)
85. {
86. strLog = "推送異常：" + ex.Message;
87. ex.Exp_WriteErrorLog();
88. return false;
89. }
90. }

調用該方法即可實現推送。

9、調試，注意事項。

需改進：該基本方法，返回的錯誤信息不知什么原因並不是官方給出的錯誤信息，他判斷的是HTTP Status Code 返回的異常，容易迷惑以為授權失敗。具體錯誤信息可以去官網查看。或者使用https://api.jpush.cn/v3/push/validate校驗API

擴展方法中的Exp_、Admin_方法為自己封裝DLL功能，可根據要求自行編寫，只是記錄思路。

 開發者服務中-應用設置-推送設置，IOS需要你填寫授權方式，Android下可以快速集成掃描下載安裝包。

https://docs.jiguang.cn/jpush/client/Android/android_3m/

安裝應用並運行，點擊 即可看見分配給本機的RegId

 測試接口中可以填寫該RegId，進行測試。需要手機能聯網，部分機型可能收不到推送（努比亞部分機型？）
調用測試后可以在極光開發者服務-推送-推送歷史中查看API類型的推送。

該RegId需要為極光分配給該應用下的該用戶設備RegId，所以APP端也需要集成極光推送注冊用戶為極光推送對象，如果不是原生的開發，看你的需要選擇：https://docs.jiguang.cn/jpush/client/client_plugins/

 

以上為接口端集成。 

---

擴展記錄——APICloud客戶端集成極光推送（並點擊推送消息跳轉相應頁面）

1、APICloud開發APP應用中端開發需要添加極光推送模塊

2、APP應用中config.xml，加入配置app_key對應的APPKEY

3、 在應用打開時Index.html頁面中加入注冊RegId。

 

setToken=function() {

var token = $api.getStorage('user.token');//獲取用戶信息

1. //console.log('jpush:start==>token=' + token);
2. var jpush = api.require('ajpush');//加載jpush模塊
3. if ('ios' == api.systemType) {
4. jpush.getRegistrationId( function(ret) {
5. //console.log('ios jpush getRegistrationId:' + JSON.stringify(ret));
6. var registrationId = ret.id;
7. $api.setStorage( 'user.token', ret.id);
8. });
9. } else {
10. jpush.init( function(ret0, err0) {//安卓需要初始化jpush
11. // console.log('android jpush.init:' + JSON.stringify(ret0)+"|||||"+JSON.stringify(err0));
12. if (ret0.status == 1) {
13. jpush.getRegistrationId( function(ret) {//獲取極光該應用該設備下的Regid
14. // console.log('android jpush getRegistrationId:' + JSON.stringify(ret));
15. var registrationId = ret.id;//保存Regid
16. $api.setStorage( 'user.token', ret.id);//保存Regid到用戶信息,保存推送對象
17. });
18. }
19. });
20. }
21. }

 4、登陸時需要將該用戶的（Regid）Token，更新到服務器端用戶對應的推送下，也就是上面集成C#中的M_T_PushToken數據表中，方便推送時在里面尋找對象。

---

擴展更新——APICloud客戶端推送，傳遞自定義參數，用來點擊通知跳轉頁面。

1、主要是更改發送的參數配置即可，更新c#集成的SendPushV2方法中的部分代碼，極光推送文檔https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#notification

 

PushPayload pushPayload = new PushPayload()

{

Platform = new List<string> { "android", "ios" },

Audience = mm,

Notification = new Notification

{

Alert = strMsg,

Android = new Android

{

Alert = strMsg,//內容

Title = title,//標題

Style = 1,//樣式

BigText = strMsg,//大文本

Extras = parmARR

},

IOS = new IOS

{

Alert = strMsg,

Badge = "+1",

Extras = parmARR

}

},

Options = new Options

{

IsApnsProduction = true // 設置 iOS 推送生產環境。不設置默認為開發環境。

}

};

 2、中的Extras數據應為JSON格式數據，c#中  var parmARR = new Dictionary<string, object>();方法實現

3、檢查接口端推送數據格式是否正確后，可以登陸極光官網，（極光開發者服務-相應應用推送-發送通知）中模擬推送，選擇需要的通知樣式。選擇大段文本樣式，可以解決推送內容過多顯示不全情況。

 4、接口端配置完成后，需要在客戶端監聽通知點擊事件。注意點擊后的跳轉地址即可。

 

var jpush = api.require('ajpush');

//安卓端監聽

api.addEventListener({name:'appintent'}, function(ret,err) {

// alert('通知被點擊，收到數據：\n' + JSON.stringify(ret));//監聽通知被點擊后收到的數據

var data=ret.appParam.ajpush.extra;

openWinExp(data.DWin,data.Win,{"TypeID":data.TypeID});

})

//IOS端監聽

api.addEventListener({name:'noticeclicked'}, function(ret,err) {

// alert('通知被點擊，收到數據：\n' + JSON.stringify(ret));//監聽通知被點擊后收到的數據

var data=ret.appParam.ajpush.extra;

openWinExp(data.DWin,data.Win,{"TypeID":data.TypeID});

})

//因為在Index下，所以注意跳轉地址。

openWinExp=function(dir,name, parms) {

//console.log("openWin===>dir=" + dir + "&name=" + name + "&parms=" + JSON.stringify(parms));

api.openWin({

name: name,

url: strurl='html/'+ dir + '/' + name + '.html',//注意跳轉地址

bounces: false,

rect: {

x: 0,

y: 0,

w: 'auto',

h: 'auto'

},

delay: 0,

reload: true,

slidBackEnabled: false,

animation: {

type: stnet.setting.animation.type,

duration: 300,

subType: (parms && parms.type) ? 'from_' + parms.type : stnet.setting.animation.subType

},

pageParam: parms

});

}