基於.NET Socket API 通訊的綜合應用

時間 2019-12-10

原文原文鏈接

閒談一下，最近和客戶進行對接Scoket 本地的程序做爲請求方以及接受方，對接Scoket 的難度實在比較大，由於涉及到響應方返回的報文的不一致性，對於返回的報文的格式我須要作反序列化的難度增大了很多，下面我就談談若是基於進行對接Scoket API 的接口的。方便你們，節省時間，少走彎路。大大的提升本身的開發的效率，固然我介紹的只是基於.NET Scoket API 的應用。程序員

一.Scoket 的簡介以及和WebServices WCF的區別編程

1.網絡上常常經過程序進行雙方的通訊，可是在這個過程當中，須要進行數據的交換。那麼在這個過程當中，須要進行創建網絡的通信。windows

2.經過請求方發出一段報文，給響應方，進行接收，並返回請求報文的結果。服務器

3.因此基於Socket本質是編程接口(API)，對TCP/IP的封裝，TCP/IP也要提供可供程序員作網絡開發所用的接口（通過3次握手），這個就是所謂的Socket編程接口。網絡

4.基於Scoket API 的編程的接口與WebServices 以及 WebAPI不一樣的後者都是基於HTTP請求的，可是WCF整合了原有的windows通信的 .NET Remoting，WebService，Socket的機制，並融合有HTTP 和FTP 的相關技術。進行面向數據通訊的程序框架。框架

5.Socket是面向客戶以及服務器模型而設計。 tcp

二：Scoket 的綜合的應用ide

1.Scoket流程圖post

2.首先請求方進行發送一段報文。ui

 1 <?xml version="1.0" encoding="GBK"?>
 2 <Service>
 3     <Service_Header>
 4         <requester_id></requester_id>
 5         <branch_id ></branch_id>
 6         <service_time></service_time>
 7         <version_id></version_id>
 8     </Service_Header>
 9     <Service_Body>
10         <request>
11             <channel_type></channel_type>
12       <cert_type></cert_type>
13       <cert_no></cert_no>
14       <query_type></query_type>
15       <fr_id></fr_id>
16             <pos_id></pos_id>
17             <shop_id></shop_id>
18         </request>
19     </Service_Body>
20 </Service>

請求的報文

3.響應方返回的報文的格式

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<Service>
  <Service_Header>
    <reply_qmgr>FT1_IN01</reply_qmgr>
    <service_response>
      <code>0000</code>
      <desc>成功</desc>
      <status>COMPLETE</status>
    </service_response>
    <msglog></msglog>
    <timeout>150</timeout>
    <name>積分查詢</name>
    <start_time>1466155364977</start_time>
    <start_timestamp>2016-06-17 17:22:44.976</start_timestamp>
    <service_id>05170000000001</service_id>
    <requester_id>0324</requester_id>
    <branch_id>1</branch_id>
    <service_time>20160617</service_time>
    <version_id>001</version_id>
    <trace_msg>Reply to responseQ - IBM.SERVICE.RESPONSE.OUT.AFA: FT1_IN01</trace_msg>
    <end_timestamp>2016-06-17 09:22:45.327</end_timestamp>
  </Service_Header>
  <Service_Body>
    <request>
      <channel_type>01</channel_type>
      <card_num>6224520110000004232</card_num>
      <mobie_phone></mobie_phone>
      <pos_id></pos_id>
      <shop_id></shop_id>
    </request>
    <response>
      <result_code>0000</result_code>
      <result_info>成功</result_info>
      <ims_serial_no/>
      <total_num>101.0</total_num>
      <score_num>101.0</score_num>
      <freeze_num>0.0</freeze_num>
    </response>
  </Service_Body>
</Service>

響應的報文

三.經過序列化以及反序列化進行解析報文

1.響應的報文的序列化類

 1  [Serializable]  2     public class ScoreDetailResponse : ApiResponse  3  {  4         /// <summary>
 5         /// 結果代碼  6         /// </summary>
 7         public string result_code { get;set; }  8 
 9         /// <summary>
10         /// 結果說明 11         /// </summary>
12         public string result_info { get;set; } 13 
14         /// <summary>
15         /// 交易日期 16         /// </summary>
17         public string tran_date { get;set; } 18 
19         /// <summary>
20         /// 交易時間 21         /// </summary>
22         public string tran_timestamp { get;set; } 23 
24          /// <summary>
25          ///交易積分數 26          /// </summary>
27          public string transfer_score { get;set; } 28          
29          /// <summary>
30          /// 剩餘積分數 31          /// </summary>
32          public string surplus_score { get;set; } 33          
34          /// <summary>
35          /// 備註 36          /// </summary>
37          public string remark { get;set; } 38 
39 
40  } 41  [Serializable] 42     [XmlRoot("Service")] 43     public class MyScoreDetailResponse 44  { 45         public List<ScoreDetailResponse> _ScoreDetailResponse = new List<ScoreDetailResponse>(); 46         [XmlArray("Service_Body")] 47         [XmlArrayItem("response")] 48         public List<ScoreDetailResponse> ScoreDetailResponse { get;set; } 49     }

Serializable 類

2.序列化繼承的接口和方法

 1 [XmlRoot("Service")]  2     public  class ApiResponse  3  {  4         [XmlElement("errCode")]  5         public string ErrCode;  6 
 7         [XmlElement("errMsg")]  8         public string ErrMsg;  9 
 10         public string Body { get; set; }  11  }  12 
 13 
 14    [XmlRoot("IFReturn")]  15         public class IApiRequest { }  16         [XmlRoot("IFReturn")]  17         public class ApiRequest<T> : IApiRequest where T : ApiResponse  18  {  19             [XmlElement("channel_type")]  20             public string channel_type { get; set; }  21 
 22             [XmlElement("shop_id")]  23             public string  shop_id { get; set; }  24 
 25             [XmlElement("post_id")]  26             public string post_id { get; set; }  27  }  28 
 29 
 30  public interface IParser  31  {  32         /// <summary>
 33         /// 把響應字符串解釋成相應的領域對象。  34         /// </summary>
 35         /// <typeparam name="T">領域對象</typeparam>
 36         /// <param name="body">響應字符串</param>
 37         /// <returns>領域對象</returns>
 38         T XMLParse<T>(string body) where T : ApiResponse;  39 
 40         /// <summary>
 41         /// 將對象轉換爲XML  42         /// </summary>
 43         /// <typeparam name="T"></typeparam>
 44         /// <param name="body"></param>
 45         /// <returns></returns>
 46         string Parse<T>(T body) where T : IApiRequest;  47  }  48 
 49 
 50 
 51 public class XmlParse:IParser  52  {  53         #region Field
 54         private static readonly Regex regex = new Regex("<(\\w+?)[ >]", RegexOptions.Compiled);  55         private static readonly ReaderWriterLock rwLock = new ReaderWriterLock();  56         private static readonly Dictionary<string, XmlSerializer> parsers = new Dictionary<string, XmlSerializer>();  57         #endregion
 58 
 59         #region Members
 60         /// <summary>
 61         /// 將XML轉換爲對象  62         /// </summary>
 63         /// <typeparam name="T"></typeparam>
 64         /// <param name="body"></param>
 65         /// <returns></returns>
 66         public T ParseDeserialize<T>(string body) where T : ApiResponse  67  {  68             Type type = typeof(T);  69             string rootTagName = GetRootElement(body);  70 
 71             string key = type.FullName;  72             if (Constants.ERROR_RESPONSE.Equals(rootTagName))  73  {  74                 key += ("_" + Constants.ERROR_RESPONSE);  75  }  76 
 77             XmlSerializer serializer = null;  78             bool incl = false;  79 
 80             rwLock.AcquireReaderLock(50);  81             try
 82  {  83                 if (rwLock.IsReaderLockHeld)  84  {  85                     incl = parsers.TryGetValue(key, out serializer);  86  }  87  }  88             finally
 89  {  90                 if (rwLock.IsReaderLockHeld)  91  {  92  rwLock.ReleaseReaderLock();  93  }  94  }  95 
 96             if (!incl || serializer == null)  97  {  98                 XmlAttributes rootAttrs = new XmlAttributes();  99                 rootAttrs.XmlRoot = new XmlRootAttribute(rootTagName); 100 
101                 XmlAttributeOverrides attrOvrs = new XmlAttributeOverrides(); 102  attrOvrs.Add(type, rootAttrs); 103 
104                 serializer = new XmlSerializer(type, attrOvrs); 105 
106                 rwLock.AcquireWriterLock(50); 107                 try
108  { 109                     if (rwLock.IsWriterLockHeld) 110  { 111                         parsers[key] = serializer; 112  } 113  } 114                 finally
115  { 116                     if (rwLock.IsWriterLockHeld) 117  { 118  rwLock.ReleaseWriterLock(); 119  } 120  } 121  } 122             object obj = null; 123             using (System.IO.Stream stream = new MemoryStream(Encoding.UTF8.GetBytes(body))) 124  { 125                 obj = serializer.Deserialize(stream); 126  } 127 
128             T rsp = (T)obj; 129             if (rsp != null) 130  { 131                 rsp.Body = body; 132  } 133             return rsp; 134  } 135 
136         /// <summary>
137         /// 將對象轉換爲XML 138         /// </summary>
139         /// <typeparam name="T"></typeparam>
140         /// <param name="obj"></param>
141         /// <returns></returns>
142         public string Parse<T>(T obj) where T : IApiRequest 143  { 144             XmlSerializer serializer = null; 145 
146             serializer = new XmlSerializer(obj.GetType()); 147             XmlSerializerNamespaces xmlns = new XmlSerializerNamespaces(); 148             xmlns.Add("", ""); 149 
150             string xml = null; 151             using (MemoryStream stream = new MemoryStream()) 152  { 153  serializer.Serialize(stream, obj, xmlns); 154                 xml = Encoding.UTF8.GetString(stream.ToArray()); 155  } 156 
157             return xml; 158  } 159         #endregion
160 
161         /// <summary>
162         /// 獲取XML響應的根節點名稱 163         /// </summary>
164         private string GetRootElement(string body) 165  { 166             Match match = regex.Match(body); 167             if (match.Success) 168  { 169                 return match.Groups[1].ToString(); 170  } 171             else
172  { 173                 throw new Exception("Invalid XML response format!"); 174  } 175  } 176 
177         public T XMLParse<T>(string body) where T : ApiResponse 178  { 179             throw new NotImplementedException(); 180  } 181 
182 
183         /// <summary>
184         /// 將XML文件進行反序列話進行對象 185         /// </summary>
186         /// <typeparam name="T">結果對象類型</typeparam>
187         /// <param name="s">包含對象的XML字符串</param>
188         /// <param name="encoding">編碼方式</param>
189         /// <returns>反序列化獲得的對象</returns>
190         public  T XmlDeserialize<T>(string s) 191  { 192             if (string.IsNullOrEmpty(s)) 193  { 194                 throw new ArgumentNullException("s"); 195  } 196             XmlSerializer mySerializer = new XmlSerializer(typeof(T)); 197             using (MemoryStream ms = new MemoryStream(Encoding.GetEncoding("utf-8").GetBytes(s))) 198  { 199                 using (StreamReader sr = new StreamReader(ms, Encoding.GetEncoding("utf-8"))) 200  { 201                     return (T)mySerializer.Deserialize(sr); 202  } 203  } 204  } 205 
206  } 207 
208 
209    public sealed class Constants 210  { 211        public const string DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss"; 212 
213        public const string SIGN_METHOD_MD5 = "md5"; 214 
215        public const string ACCEPT_ENCODING = "Accept-Encoding"; 216        public const string CONTENT_ENCODING = "Content-Encoding"; 217        public const string CONTENT_ENCODING_GZIP = "gzip"; 218 
219        public const string ERROR_RESPONSE = "error_response"; 220        public const string ERROR_CODE = "code"; 221        public const string ERROR_MSG = "msg"; 222    }

反序列化進行解析代碼

3.經過控制檯應用進行調用

 1  #region 獲取TCPClient 返回的結果
 2         /// <summary>
 3         /// 獲取TCPClient 返回的結果  4         /// </summary>
 5         /// <param name="s"></param>
 6         /// <param name="trans_id">服務器交易碼</param>
 7         /// <returns></returns>
 8         private string GetTcpClientResult(MemoryStream s, string trans_id)  9  { 10             byte[] bufTemp = s.ToArray(); 11             string xmlContent = bufTemp.Length.ToString().PadLeft(10, '0') + "xxxx" + trans_id + Encoding.GetEncoding("GBK").GetString(bufTemp); 12             byte[] buf = Encoding.GetEncoding("GBK").GetBytes(xmlContent); 13             string svrAddr = Properties.Settings.Default.TCP_IP;//對方服務器的IP
14             int svrPort = Properties.Settings.Default.TCP_PORT;//請求的服務器的端口
15 
16             using (TcpClient tcpClient = new TcpClient(svrAddr, svrPort)) 17  { 18                 var tcpStream = tcpClient.GetStream(); 19                 tcpStream.Write(buf, 0, buf.Length); 20                 byte[] recv = new byte[4096]; 21                 int recvLen = tcpStream.Read(recv, 0, recv.Length); 22                 string result = Encoding.GetEncoding("GBK").GetString(recv, 0, recvLen); 23  tcpClient.Close(); 24                 return result; 25  } 26  } 27         #endregion