.NET微信網頁開發之JS-SDK使用步驟和配置信息timestamp(時間戳),nonceStr(隨機串),signature(簽名),access_token(接口調用憑據)的生成獲取講解


 前言:

  因為接下來會有幾篇關於微信JS-SDK功能使用的文章,主要會對微信分享,獲取設備信息,獲取地理位置,微信掃一掃這幾個功能進行講解。而這幾個功能都是圍繞着微信JS-SDK實現的,首先使用微信JS-SDK時我們需要生成對應的配置信息,才能夠成功的調用微信JS-SDK。看了下微信官方文檔對於accessToken和jsapi_ticket的生成示例代碼並沒有看到咱們大.Net的,所以為了幫助那些剛接觸微信開發的同學,在這里我會把自己在使用微信JS-SDK的一些步驟和配置信息生成的方法展示出來,希望能夠和大家相互學習共同進步。

微信JS-SDK詳情說明請移步微信官方文檔:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115

JSSDK使用步驟:

步驟一、綁定安全域名:

先登錄微信公眾平台進入“公眾號設置”的“功能設置”里填寫“JS接口安全域名”。

步驟二、引入JS文件:

在需要調用JS接口的頁面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.4.0.js

項目中: 

<script src="http://res.wx.qq.com/open/js/jweixin-1.4.0.js"></script>

步驟三、通過config接口注入權限驗證配置:  

注意:所有需要使用JS-SDK的頁面必須先注入配置信息,否則將無法調用(同一個url僅需調用一次,對於變化url的SPA的web app可在每次url變化時進行調用,目前Android微信客戶端不支持pushState的H5新特性,所以使用pushState來實現web app的頁面會導致簽名失敗,此問題會在Android6.2中修復)。

wx.config({
    debug: true, // 開啟調試模式,調用的所有api的返回值會在客戶端alert出來,若要查看傳入的參數,可以在pc端打開,參數信息會通過log打出,僅在pc端時才會打印。
    appId: '', // 必填,公眾號的唯一標識
    timestamp: , // 必填,生成簽名的時間戳
    nonceStr: '', // 必填,生成簽名的隨機串
    signature: '',// 必填,簽名
    jsApiList: [] // 必填,需要使用的JS接口列表,如需要調用分享給朋友的話我們填寫為["onMenuShareTimeline"]
});

步驟四、通過ready接口處理成功驗證:

注意:假如需要在頁面加載時就調用的話,需要把對應的執行函數放到wx.ready(function(){});方法里面加載執行,之前我調用加載就獲取地理位置的接口就是因為沒有放到這里面所以一直沒有獲取到用戶當前經緯度坐標

wx.ready(function(){
    // config信息驗證后會執行ready方法,所有接口調用都必須在config接口獲得結果之后,config是一個客戶端的異步操作,所以如果需要在頁面加載時就調用相關接口,則須把相關接口放在ready函數中調用來確保正確執行。對於用戶觸發時才調用的接口,則可以直接調用,不需要放在ready函數中。
});  

步驟五、通過error接口處理失敗驗證:

wx.error(function(res){
    // config信息驗證失敗會執行error函數,如簽名過期導致驗證失敗,具體錯誤信息可以打開config的debug模式查看,也可以在返回的res參數中查看,對於SPA可以在這里更新簽名。
});

接口調用說明請查看微信開發文檔:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115 

獲取access_token(公眾號的全局唯一接口調用憑據):

詳細概述:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183

*注意,關於請求返回值說明:

正常情況下(即請求成功時),微信只會返回下述JSON數據包給公眾號:

{"access_token":"ACCESS_TOKEN","expires_in":7200}

錯誤時微信會返回錯誤碼等信息,JSON數據包示例如下(該示例為AppID無效錯誤):

{"errcode":40013,"errmsg":"invalid appid"}

通過接口獲取:

        /// <summary>
        /// 獲取微信公眾號全局唯一接口憑證
        /// </summary>
        /// <returns></returns>
        public static string RequestAccessToken()
        {   // 設置參數
            string appid=WxAppId;//第三方用戶唯一憑證
            string appsecret=WxAppSecret;//第三方用戶唯一憑證密鑰,即appsecret
            
            //請求接口獲取
            string _url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=" + appid + "&secret=" + appsecret;
            string method = "GET";
            HttpWebRequest request = WebRequest.Create(_url) as HttpWebRequest;
            CookieContainer cookieContainer = new CookieContainer();
            request.CookieContainer = cookieContainer;
            request.AllowAutoRedirect = true;
            request.Method = method;
            request.ContentType = "text/html";
            request.Headers.Add("charset", "utf-8");

            //發送請求並獲取響應數據
            HttpWebResponse response = request.GetResponse() as HttpWebResponse;
            Stream responseStream = response.GetResponseStream();
            StreamReader sr = new StreamReader(responseStream, Encoding.UTF8);
            //獲取返回過來的結果
            string content = sr.ReadToEnd();

            dynamic resultContent=JsonConvert.DeserializeObject(content,new { access_token="", expires_in="", errcode="", errmsg="" }.GetType());
            if (resultContent!=null&&!string.IsNullOrWhiteSpace(resultContent.access_token)) //注意:請求成功時是不會有errcode=0返回,判斷access_token是否有值即可
            {
                return resultContent.access_token;//返回請求唯一憑證
            }
            else
            {
                //請求失敗,返回為空
                return "";
            }
        }

 

獲取jsapi_ticket微信公眾號調用微信JS接口的臨時票據(前提是:獲取到了公眾號全局唯一接口調用憑據):

        /// <summary>
        /// 獲取jsapi_ticket微信公眾號調用微信JS接口的臨時票據
        /// </summary>
        /// <param name="accessToken">微信公眾號的全局唯一接口調用憑證</param>
        /// <returns></returns>
        public static string RequestJsapi_ticket(string accessToken)
        {
            string content = "";
            try
            {
                //TODO:注意api_ticket 是用於調用微信卡券JS API的臨時票據,有效期為7200 秒,通過access_token 來獲取。

                string url = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=" + accessToken + "&type=jsapi";
                string method = "GET";
                HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
                CookieContainer cookieContainer = new CookieContainer();
                request.CookieContainer = cookieContainer;
                request.AllowAutoRedirect = true;
                request.Method = method;
                request.ContentType = "text/html";
                request.Headers.Add("charset", "utf-8");
                //發送請求並獲取響應數據
                HttpWebResponse response = request.GetResponse() as HttpWebResponse;
                Stream responseStream = response.GetResponseStream();
                StreamReader sr = new StreamReader(responseStream, Encoding.UTF8);
                //獲取返回過來的結果
                content = sr.ReadToEnd();
                dynamic resultStr = JsonConvert.DeserializeObject(content,new { errcode="", errmsg="",ticket="", expires_in=""}.GetType());

                //請求成功
                if (resultStr.errcode=="0"&&resultStr.errmsg=="ok")
                {
                    content=resultStr.ticket;
                }
                else
                {
                    content = "";
                }
               
                return content;
            }
            catch (Exception ex)
            {
                content = ex.Message;
                return content;
            }
        }

生成簽名的隨機串(nonceStr):

        /// <summary>
        /// 隨機字符串數組集合
        /// </summary>
        private static readonly string[] NonceStrings = new string[]
                                    {
                                    "a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z",
                                    "A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"
                                    };

        /// <summary>
        /// 生成簽名的隨機串
        /// </summary>
        /// <returns></returns>
        public static string CreateNonceStr()
        {
            Random random = new Random();
            var sb = new StringBuilder();
            var length = NonceStrings.Length;

            //生成15位數的隨機字符串,當然也可以通過控制對應字符串大小生成,但是至多不超過32位
            for (int i = 0; i < 15; i++)
            {
                sb.Append(NonceStrings[random.Next(length - 1)]);//通過random獲得的隨機索引到,NonceStrings數組中獲取對應數組值
            }
            return sb.ToString();
        }

生成簽名時間戳(timestamp):

        /// <summary>
        /// 獲取當前時間戳
        /// </summary>
        /// <returns></returns>
        public static long GetCurrentUinxTime()
        {
            DateTime currentDate = DateTime.Now;//當前時間
            //轉化為時間戳
            DateTime localTime = TimeZone.CurrentTimeZone.ToLocalTime(new DateTime(1970, 1, 1));
            return long.Parse((currentDate - localTime).TotalSeconds.ToString().Split('.')[0]);
        }

獲取當前網頁URL:

注意:一定要是在安全域名內,否則生成的是無效的簽名。

        //獲取當前網頁URL
        string currentWebUrl = Request.Url.ToString();

生成簽名(signature):

微信JS-SDK使用權限簽名算法詳細概述:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115

        /// <summary>
        /// 獲取簽名
        /// </summary>
        /// <param name="jsapi_ticket">微信公眾號調用微信JS臨時票據</param>
        /// <param name="nonceStr">隨機串</param>
        /// <param name="timestamp">時間戳</param>
        /// <param name="url">當前網頁URL</param>
        /// <returns></returns>
        public static string GetSignature(string jsapi_ticket, string nonceStr, long timestamp, string url)
        {

            var string1Builder = new StringBuilder();
            //注意這里參數名必須全部小寫,且必須有序
            string1Builder.Append("jsapi_ticket=").Append(jsapi_ticket).Append("&")
                          .Append("noncestr=").Append(nonceStr).Append("&")
                          .Append("timestamp=").Append(timestamp).Append("&")
                          .Append("url=").Append(url.IndexOf("#") >= 0 ? url.Substring(0, url.IndexOf("#")) : url);

            return Sha1(string1Builder.ToString(),Encoding.UTF8);
        }

        /// <summary>
        /// 簽名加密,使用SHA加密所得
        /// </summary>
        /// <param name="content">簽名加密參數</param>
        /// <param name="encode">編碼UTF-8</param>
        /// <returns></returns>
        public static string Sha1(string content, Encoding encode)
        {
            try
            {
                SHA1 sha1 = new SHA1CryptoServiceProvider();
                byte[] bytesIn = encode.GetBytes(content);
                byte[] bytesOut = sha1.ComputeHash(bytesIn);
                sha1.Dispose();
                string result = BitConverter.ToString(bytesOut);
                result = result.Replace("-", "");
                return result;
            }
            catch (Exception ex)
            {
                throw new Exception("SHA1加密出錯:" + ex.Message);
            }
        }

總結:

  最后要總結一下關於對接第三方的一些心得,有的時候我們在實際項目開發中也許會對接一些我們之前從來都沒有對接過的第三方軟件公司的一些功能比如最為常見的是微信,支付寶,QQ等,在對接之前我們第一步要做的是明確自己的需求,有目的性的去閱讀第三方對接開發文檔,因為一般對接文檔都是有對應的功能詳細說明,你不可能把所有的文檔都看完了再去對接,這樣的話你的項目開發進度肯定是會延期的。學會使用第三方提供的demo示例,因為這將會在很大的程度上幫助你了解功能的實現原理。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM