1. 程式人生 > >ASP.NET WEB API微信支付通知介面,返回xml資料,微信伺服器不識別問題

ASP.NET WEB API微信支付通知介面,返回xml資料,微信伺服器不識別問題

最近開發微信小程式中用到了微信支付功能,介面開發用的ASP.NET WEB API;

在支付成功後,介面接受到微信伺服器的支付通知結果,處理完資料,介面返回給微信服務資料時出現了問題。

微信伺服器識別不到返回的資料,導致重複通知。

最終解決程式碼如下:

        protected virtual HttpResponseMessage RetMessage(object msg)
        {
            return new HttpResponseMessage
            {
                Content =  new StringContent(msg.ToString(),new UTF8Encoding(false)
                  , "text/plain")
            };

        }
        [HttpPost]
        public HttpResponseMessage Wx_Notify()
        {
                    //業務處理程式碼,以下為返回
                    WxPayData res = new WxPayData();
                    res.SetValue("return_code", "SUCCESS");
                    res.SetValue("return_msg", "OK");
                    return RetMessage(res.ToXml());
         }

WxPayData 為騰訊官方提供原始碼中的類

namespace WxPayAPI
{
    /// <summary>
    /// 微信支付協議介面資料類,所有的API介面通訊都依賴這個資料結構,
    /// 在呼叫介面之前先填充各個欄位的值,然後進行介面通訊,
    /// 這樣設計的好處是可擴充套件性強,使用者可隨意對協議進行更改而不用重新設計資料結構,
    /// 還可以隨意組合出不同的協議資料包,不用為每個協議設計一個數據包結構
    /// </summary>
    public class WxPayData
    {
        public WxPayData()
        {

        }

        //採用排序的Dictionary的好處是方便對資料包進行簽名,不用再簽名之前再做一次排序
        private SortedDictionary<string, object> m_values = new SortedDictionary<string, object>();

        /**
        * 設定某個欄位的值
        * @param key 欄位名
         * @param value 欄位值
        */
        public void SetValue(string key, object value)
        {
            m_values[key] = value;
        }

        /**
        * 根據欄位名獲取某個欄位的值
        * @param key 欄位名
         * @return key對應的欄位值
        */
        public object GetValue(string key)
        {
            object o = null;
            m_values.TryGetValue(key, out o);
            return o;
        }

        /**
         * 判斷某個欄位是否已設定
         * @param key 欄位名
         * @return 若欄位key已被設定,則返回true,否則返回false
         */
        public bool IsSet(string key)
        {
            object o = null;
            m_values.TryGetValue(key, out o);
            if (null != o)
                return true;
            else
                return false;
        }

        /**
        * @將Dictionary轉成xml
        * @return 經轉換得到的xml串
        * @throws WxPayException
        **/
        public string ToXml()
        {
            //資料為空時不能轉化為xml格式
            if (0 == m_values.Count)
            {
                Log.Error(this.GetType().ToString(), "WxPayData資料為空!");
                throw new WxPayException("WxPayData資料為空!");
            }

            string xml = "<xml>";
            foreach (KeyValuePair<string, object> pair in m_values)
            {
                //欄位值不能為null,會影響後續流程
                if (pair.Value == null)
                {
                    Log.Error(this.GetType().ToString(), "WxPayData內部含有值為null的欄位!");
                    throw new WxPayException("WxPayData內部含有值為null的欄位!");
                }

                if (pair.Value.GetType() == typeof(int))
                {
                    xml += "<" + pair.Key + ">" + pair.Value + "</" + pair.Key + ">";
                }
                else if (pair.Value.GetType() == typeof(string))
                {
                    xml += "<" + pair.Key + ">" + "<![CDATA[" + pair.Value + "]]></" + pair.Key + ">";
                }
                else//除了string和int型別不能含有其他資料型別
                {
                    Log.Error(this.GetType().ToString(), "WxPayData欄位資料型別錯誤!");
                    throw new WxPayException("WxPayData欄位資料型別錯誤!");
                }
            }
            xml += "</xml>";
            return xml;
        }

        /**
        * @將xml轉為WxPayData物件並返回物件內部的資料
        * @param string 待轉換的xml串
        * @return 經轉換得到的Dictionary
        * @throws WxPayException
        */
        public SortedDictionary<string, object> FromXml(string xml)
        {
            if (string.IsNullOrEmpty(xml))
            {
                Log.Error(this.GetType().ToString(), "將空的xml串轉換為WxPayData不合法!");
                throw new WxPayException("將空的xml串轉換為WxPayData不合法!");
            }

            XmlDocument xmlDoc = new XmlDocument();
            xmlDoc.LoadXml(xml);
            XmlNode xmlNode = xmlDoc.FirstChild;//獲取到根節點<xml>
            XmlNodeList nodes = xmlNode.ChildNodes;
            foreach (XmlNode xn in nodes)
            {
                XmlElement xe = (XmlElement)xn;
                m_values[xe.Name] = xe.InnerText;//獲取xml的鍵值對到WxPayData內部的資料中
            }
			
            try
            {
				//2015-06-29 錯誤是沒有簽名
				if(m_values["return_code"] != "SUCCESS")
				{
					return m_values;
				}
                CheckSign();//驗證簽名,不通過會拋異常
            }
            catch(WxPayException ex)
            {
                throw new WxPayException(ex.Message);
            }

            return m_values;
        }

        /**
        * @Dictionary格式轉化成url引數格式
        * @ return url格式串, 該串不包含sign欄位值
        */
        public string ToUrl()
        {
            string buff = "";
            foreach (KeyValuePair<string, object> pair in m_values)
            {
                if (pair.Value == null)
                {
                    Log.Error(this.GetType().ToString(), "WxPayData內部含有值為null的欄位!");
                    throw new WxPayException("WxPayData內部含有值為null的欄位!");
                }

                if (pair.Key != "sign" && pair.Value.ToString() != "")
                {
                    buff += pair.Key + "=" + pair.Value + "&";
                }
            }
            buff = buff.Trim('&');
            return buff;
        }


        /**
        * @Dictionary格式化成Json
         * @return json串資料
        */
        public string ToJson()
        {
            string jsonStr = Json.ToJson(m_values);
            return jsonStr;
        }

        /**
        * @values格式化成能在Web頁面上顯示的結果(因為web頁面上不能直接輸出xml格式的字串)
        */
        public string ToPrintStr()
        {
            string str = "";
            foreach (KeyValuePair<string, object> pair in m_values)
            {
                if (pair.Value == null)
                {
                    Log.Error(this.GetType().ToString(), "WxPayData內部含有值為null的欄位!");
                    throw new WxPayException("WxPayData內部含有值為null的欄位!");
                }

                str += string.Format("{0}={1}<br>", pair.Key, pair.Value.ToString());
            }
            Log.Debug(this.GetType().ToString(), "Print in Web Page : " + str);
            return str;
        }

        /**
        * @生成簽名,詳見簽名生成演算法
        * @return 簽名, sign欄位不參加簽名
        */
        public string MakeSign()
        {
            //轉url格式
            string str = ToUrl();
            //在string後加入API KEY
            str += "&key=" + WxPayConfig.KEY;
            //MD5加密
            var md5 = MD5.Create();
            var bs = md5.ComputeHash(Encoding.UTF8.GetBytes(str));
            var sb = new StringBuilder();
            foreach (byte b in bs)
            {
                sb.Append(b.ToString("x2"));
            }
            //所有字元轉為大寫
            return sb.ToString().ToUpper();
        }

        /**
        * 
        * 檢測簽名是否正確
        * 正確返回true,錯誤拋異常
        */
        public bool CheckSign()
        {
            //如果沒有設定簽名,則跳過檢測
            if (!IsSet("sign"))
            {
               Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!");
               throw new WxPayException("WxPayData簽名存在但不合法!");
            }
            //如果設定了簽名但是簽名為空,則拋異常
            else if(GetValue("sign") == null || GetValue("sign").ToString() == "")
            {
                Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!");
                throw new WxPayException("WxPayData簽名存在但不合法!");
            }

            //獲取接收到的簽名
            string return_sign = GetValue("sign").ToString();

            //在本地計算新的簽名
            string cal_sign = MakeSign();

            if (cal_sign == return_sign)
            {
                return true;
            }

            Log.Error(this.GetType().ToString(), "WxPayData簽名驗證錯誤!");
            throw new WxPayException("WxPayData簽名驗證錯誤!");
        }

        /**
        * @獲取Dictionary
        */
        public SortedDictionary<string, object> GetValues()
        {
            return m_values;
        }
    }
}