C#微信公眾號開發 -- (四)獲取API呼叫所需的全域性唯一票據access_token
access_token是公眾號的全域性唯一票據,公眾號呼叫各介面時都需使用access_token。開發者需要進行妥善儲存。access_token的儲存至少要保留512個字元空間。access_token的有效期目前為2個小時,需定時重新整理,重複獲取將導致上次獲取的access_token失效。
獲取access_token請求說明
是以http請求的GET方式通過訪問:
https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
引數說明
引數 | 是否必須 | 說明 |
---|---|---|
grant_type | 是 | 獲取access_token填寫client_credential |
appid | 是 | 第三方使用者唯一憑證 |
secret | 是 | 第三方使用者唯一憑證金鑰,即appsecret |
訪問完成之後,如果成功則微信會返回JSON包,JSON包格式為:
{"access_token":"ACCESS_TOKEN","expires_in":7200}
如果JSON包返回的結果是{"errcode":40013,"errmsg":"invalid appid"}則說明AppID無效。
引數 | 說明 |
---|---|
access_token | 獲取到的憑證 |
expires_in | 憑證有效時間,單位:秒 |
由此可以看出來,我們需要處理微信返回過來的JSON資料,access_token做快取。
先建一個Access_Token類,程式碼如下:
public class Access_token { public Access_token() { // //TODO: 在此處新增建構函式邏輯 // } string _access_token; string _expires_in; /// <summary> /// 獲取到的憑證 /// </summary> public string access_token { get { return _access_token; } set { _access_token = value; } } /// <summary> /// 憑證有效時間,單位:秒 /// </summary> public string expires_in { get { return _expires_in; } set { _expires_in = value; } } }
再將access_token做快取,建立一個XML檔案儲存(或儲存在資料庫中,根據自己的程式設計愛好),XML格式如下:
<?xml version="1.0" encoding="utf-8"?>
<xml>
<Access_Token>第一次可以隨便寫</Access_Token>
<Access_YouXRQ>2016/2/21 20:15:49</Access_YouXRQ>
</xml>
剛建好的XML,Access_Token節點中的資料可以隨便寫,Access_YouXRQ節點中的資料寫一個之前兩小時的時間就可以了(推薦直接寫前一天的23:59:59)
獲取的邏輯是:當需要用到Access_Token的時候,直接呼叫IsExistAccess_Token()方法即可,以下是IsExistAccess_Token()方法實現的程式碼:
/// <summary> /// 根據當前日期 判斷Access_Token 是否超期 如果超期返回新的Access_Token 否則返回之前的Access_Token /// </summary> /// <param name="datetime"></param> /// <returns></returns> private static string IsExistAccess_Token() { string Token = string.Empty; DateTime YouXRQ; // 讀取XML檔案中的資料,並顯示出來 ,注意檔案路徑 string filepath = HttpContext.Current.Server.MapPath(".") + "\\AccessToken.xml"; StreamReader str = new StreamReader(filepath, Encoding.UTF8); XmlDocument xml = new XmlDocument(); xml.Load(str); str.Close(); str.Dispose(); Token = xml.SelectSingleNode("xml").SelectSingleNode("Access_Token").InnerText; YouXRQ = Convert.ToDateTime(xml.SelectSingleNode("xml").SelectSingleNode("Access_YouXRQ").InnerText); //TimeSpan st1 = new TimeSpan(YouXRQ.Ticks); //最後重新整理的時間 //TimeSpan st2 = new TimeSpan(DateTime.Now.Ticks); //當前時間 //TimeSpan st = st2 - st1; //兩者相差時間 if (DateTime.Now > YouXRQ) { DateTime _youxrq = DateTime.Now; Access_token mode = GetAccess_token(); xml.SelectSingleNode("xml").SelectSingleNode("Access_Token").InnerText = mode.access_token; _youxrq = _youxrq.AddSeconds(int.Parse(mode.expires_in)); xml.SelectSingleNode("xml").SelectSingleNode("Access_YouXRQ").InnerText = _youxrq.ToString(); xml.Save(filepath); Token = mode.access_token; } return Token; } /// <summary> /// 獲取Access_token /// </summary> /// <returns></returns> private static Access_token GetAccess_token() { string appid = "你自己微信公眾測試號的appID"; //微信公眾號appid string secret = "你自己微信公眾測試號的appsecret"; //微信公眾號appsecret string strUrl = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=" + appid + "&secret=" + secret; Access_token mode = new Access_token(); HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create(strUrl); //用GET形式請求指定的地址 req.Method = "GET"; using (WebResponse wr = req.GetResponse()) { //HttpWebResponse myResponse = (HttpWebResponse)req.GetResponse(); StreamReader reader = new StreamReader(wr.GetResponseStream(), Encoding.UTF8); string content = reader.ReadToEnd(); reader.Close(); reader.Dispose(); //在這裡對Access_token 賦值 Access_token token = new Access_token(); token = JsonHelper.ParseFromJson<Access_token>(content); mode.access_token = token.access_token; mode.expires_in = token.expires_in; } return mode; }
可以看出來上面的GetAccess_token()方法裡面使用了JsonHelper類,這個類可以在網上下載,也可以自己寫,下面是我自己寫的JsonHelper類供參考:
public class JsonHelper { /// <summary> /// 生成Json格式 /// </summary> /// <typeparam name="T"></typeparam> /// <param name="obj"></param> /// <returns></returns> public static string GetJson<T>(T obj) { DataContractJsonSerializer json = new DataContractJsonSerializer(obj.GetType()); using (MemoryStream stream = new MemoryStream()) { json.WriteObject(stream, obj); string szJson = Encoding.UTF8.GetString(stream.ToArray()); return szJson; } } /// <summary> /// 獲取Json的Model /// </summary> /// <typeparam name="T"></typeparam> /// <param name="szJson"></param> /// <returns></returns> public static T ParseFromJson<T>(string szJson) { T obj = Activator.CreateInstance<T>(); using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(szJson))) { DataContractJsonSerializer serializer = new DataContractJsonSerializer(obj.GetType()); return (T)serializer.ReadObject(ms); } } }
至此就可以生成帶快取功能的Access_Token,呼叫的時候string token=IsExistAccess_Token();