ASP.NET WEB API微信支付通知接口，返回xml數據，微信服務器不識別問題

原文: ASP.NET WEB API微信支付通知接口，返回xml數據，微信服務器不識別問題

版權聲明：本文爲博主原創文章，未經博主容許不得轉載。 https://blog.csdn.net/MrTraum/article/details/80897239

最近開發微信小程序中用到了微信支付功能，接口開發用的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;
        }
    }
}