.net/c# Google Protocol Buffers 使用教程

小渣渣

.net/c# Google Protocol Buffers 快速入门
http://www.itsvse.com/thread-3626-1-1.html
(出处: 架构师)

上篇文章，我们学习了“.net/c# Google Protocol Buffers 快速入门”的课程。。。


这篇文章，我们学习如何在.net/c#使用他。


1：首先，安装引用包：

1. Install-Package Google.ProtocolBuffers

复制代码

2：.proto文件转成.cs文件，转换方法，上篇文章已经说了，我就不重复说了，下面转换完成的.cs文件：

1. // Generated by ProtoGen, Version=2.4.1.555, Culture=neutral, PublicKeyToken=55f7125234beb589.  DO NOT EDIT!
   
2. #pragma warning disable 1591, 0612, 3021
   
3. #region Designer generated code
   
4. 
   
5. using pb = global::Google.ProtocolBuffers;
   
6. using pbc = global::Google.ProtocolBuffers.Collections;
   
7. using pbd = global::Google.ProtocolBuffers.Descrip{过滤}tors;
   
8. using scg = global::System.Collections.Generic;
   
9. [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
   
10. public static partial class ProtoMyRequest {
    
11. 
    
12.   #region Extension registration
    
13.   public static void RegisterAllExtensions(pb::ExtensionRegistry registry) {
    
14.   }
    
15.   #endregion
    
16.   #region Static variables
    
17.   internal static pbd::MessageDescrip{过滤}tor internal__static_MyRequest__Descrip{过滤}tor;
    
18.   internal static pb::FieldAccess.FieldAccessorTable<global::MyRequest, global::MyRequest.Builder> internal__static_MyRequest__FieldAccessorTable;
    
19.   #endregion
    
20.   #region Descrip{过滤}tor
    
21.   public static pbd::FileDescrip{过滤}tor Descrip{过滤}tor {
    
22.     get { return descrip{过滤}tor; }
    
23.   }
    
24.   private static pbd::FileDescrip{过滤}tor descrip{过滤}tor;
    
25.   
    
26.   static ProtoMyRequest() {
    
27.     byte[] descrip{过滤}torData = global::System.Convert.FromBase64String(
    
28.         string.Concat(
    
29.           "ChRQcm90b015UmVxdWVzdC5wcm90byJhCglNeVJlcXVlc3QSDwoHdmVyc2lv",
    
30.           "bhgBIAIoBRIMCgRuYW1lGAIgAigJEicKB3dlYnNpdGUYAyABKAk6Fmh0dHA6",
    
31.         "Ly93d3cuaXRzdnNlLmNvbS8SDAoEZGF0YRgEIAEoDA=="));
    
32.     pbd::FileDescrip{过滤}tor.InternalDescrip{过滤}torAssigner assigner = delegate(pbd::FileDescrip{过滤}tor root) {
    
33.       descrip{过滤}tor = root;
    
34.       internal__static_MyRequest__Descrip{过滤}tor = Descrip{过滤}tor.MessageTypes[0];
    
35.       internal__static_MyRequest__FieldAccessorTable =
    
36.           new pb::FieldAccess.FieldAccessorTable<global::MyRequest, global::MyRequest.Builder>(internal__static_MyRequest__Descrip{过滤}tor,
    
37.               new string[] { "Version", "Name", "Website", "Data", });
    
38.       return null;
    
39.     };
    
40.     pbd::FileDescrip{过滤}tor.InternalBuildGeneratedFileFrom(descrip{过滤}torData,
    
41.         new pbd::FileDescrip{过滤}tor[] {
    
42.         }, assigner);
    
43.   }
    
44.   #endregion
    
45.   
    
46. }
    
47. #region Messages
    
48. [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
    
49. public sealed partial class MyRequest : pb::GeneratedMessage<MyRequest, MyRequest.Builder> {
    
50.   private MyRequest() { }
    
51.   private static readonly MyRequest defaultInstance = new MyRequest().MakeReadOnly();
    
52.   private static readonly string[] _myRequestFieldNames = new string[] { "data", "name", "version", "website" };
    
53.   private static readonly uint[] _myRequestFieldTags = new uint[] { 34, 18, 8, 26 };
    
54.   public static MyRequest DefaultInstance {
    
55.     get { return defaultInstance; }
    
56.   }
    
57.   
    
58.   public override MyRequest DefaultInstanceForType {
    
59.     get { return DefaultInstance; }
    
60.   }
    
61.   
    
62.   protected override MyRequest ThisMessage {
    
63.     get { return this; }
    
64.   }
    
65.   
    
66.   public static pbd::MessageDescrip{过滤}tor Descrip{过滤}tor {
    
67.     get { return global::ProtoMyRequest.internal__static_MyRequest__Descrip{过滤}tor; }
    
68.   }
    
69.   
    
70.   protected override pb::FieldAccess.FieldAccessorTable<MyRequest, MyRequest.Builder> InternalFieldAccessors {
    
71.     get { return global::ProtoMyRequest.internal__static_MyRequest__FieldAccessorTable; }
    
72.   }
    
73.   
    
74.   public const int VersionFieldNumber = 1;
    
75.   private bool hasVersion;
    
76.   private int version_;
    
77.   public bool HasVersion {
    
78.     get { return hasVersion; }
    
79.   }
    
80.   public int Version {
    
81.     get { return version_; }
    
82.   }
    
83.   
    
84.   public const int NameFieldNumber = 2;
    
85.   private bool hasName;
    
86.   private string name_ = "";
    
87.   public bool HasName {
    
88.     get { return hasName; }
    
89.   }
    
90.   public string Name {
    
91.     get { return name_; }
    
92.   }
    
93.   
    
94.   public const int WebsiteFieldNumber = 3;
    
95.   private bool hasWebsite;
    
96.   private string website_ = "http://www.itsvse.com/";
    
97.   public bool HasWebsite {
    
98.     get { return hasWebsite; }
    
99.   }
    
100.   public string Website {
     
101.     get { return website_; }
     
102.   }
     
103.   
     
104.   public const int DataFieldNumber = 4;
     
105.   private bool hasData;
     
106.   private pb::ByteString data_ = pb::ByteString.Empty;
     
107.   public bool HasData {
     
108.     get { return hasData; }
     
109.   }
     
110.   public pb::ByteString Data {
     
111.     get { return data_; }
     
112.   }
     
113.   
     
114.   public override bool IsInitialized {
     
115.     get {
     
116.       if (!hasVersion) return false;
     
117.       if (!hasName) return false;
     
118.       return true;
     
119.     }
     
120.   }
     
121.   
     
122.   public override void WriteTo(pb::ICodedOutputStream output) {
     
123.     CalcSerializedSize();
     
124.     string[] field_names = _myRequestFieldNames;
     
125.     if (hasVersion) {
     
126.       output.WriteInt32(1, field_names[2], Version);
     
127.     }
     
128.     if (hasName) {
     
129.       output.WriteString(2, field_names[1], Name);
     
130.     }
     
131.     if (hasWebsite) {
     
132.       output.WriteString(3, field_names[3], Website);
     
133.     }
     
134.     if (hasData) {
     
135.       output.WriteBytes(4, field_names[0], Data);
     
136.     }
     
137.     UnknownFields.WriteTo(output);
     
138.   }
     
139.   
     
140.   private int memoizedSerializedSize = -1;
     
141.   public override int SerializedSize {
     
142.     get {
     
143.       int size = memoizedSerializedSize;
     
144.       if (size != -1) return size;
     
145.       return CalcSerializedSize();
     
146.     }
     
147.   }
     
148.   
     
149.   private int CalcSerializedSize() {
     
150.     int size = memoizedSerializedSize;
     
151.     if (size != -1) return size;
     
152.    
     
153.     size = 0;
     
154.     if (hasVersion) {
     
155.       size += pb::CodedOutputStream.ComputeInt32Size(1, Version);
     
156.     }
     
157.     if (hasName) {
     
158.       size += pb::CodedOutputStream.ComputeStringSize(2, Name);
     
159.     }
     
160.     if (hasWebsite) {
     
161.       size += pb::CodedOutputStream.ComputeStringSize(3, Website);
     
162.     }
     
163.     if (hasData) {
     
164.       size += pb::CodedOutputStream.ComputeBytesSize(4, Data);
     
165.     }
     
166.     size += UnknownFields.SerializedSize;
     
167.     memoizedSerializedSize = size;
     
168.     return size;
     
169.   }
     
170.   public static MyRequest ParseFrom(pb::ByteString data) {
     
171.     return ((Builder) CreateBuilder().MergeFrom(data)).BuildParsed();
     
172.   }
     
173.   public static MyRequest ParseFrom(pb::ByteString data, pb::ExtensionRegistry extensionRegistry) {
     
174.     return ((Builder) CreateBuilder().MergeFrom(data, extensionRegistry)).BuildParsed();
     
175.   }
     
176.   public static MyRequest ParseFrom(byte[] data) {
     
177.     return ((Builder) CreateBuilder().MergeFrom(data)).BuildParsed();
     
178.   }
     
179.   public static MyRequest ParseFrom(byte[] data, pb::ExtensionRegistry extensionRegistry) {
     
180.     return ((Builder) CreateBuilder().MergeFrom(data, extensionRegistry)).BuildParsed();
     
181.   }
     
182.   public static MyRequest ParseFrom(global::System.IO.Stream input) {
     
183.     return ((Builder) CreateBuilder().MergeFrom(input)).BuildParsed();
     
184.   }
     
185.   public static MyRequest ParseFrom(global::System.IO.Stream input, pb::ExtensionRegistry extensionRegistry) {
     
186.     return ((Builder) CreateBuilder().MergeFrom(input, extensionRegistry)).BuildParsed();
     
187.   }
     
188.   public static MyRequest ParseDelimitedFrom(global::System.IO.Stream input) {
     
189.     return CreateBuilder().MergeDelimitedFrom(input).BuildParsed();
     
190.   }
     
191.   public static MyRequest ParseDelimitedFrom(global::System.IO.Stream input, pb::ExtensionRegistry extensionRegistry) {
     
192.     return CreateBuilder().MergeDelimitedFrom(input, extensionRegistry).BuildParsed();
     
193.   }
     
194.   public static MyRequest ParseFrom(pb::ICodedInputStream input) {
     
195.     return ((Builder) CreateBuilder().MergeFrom(input)).BuildParsed();
     
196.   }
     
197.   public static MyRequest ParseFrom(pb::ICodedInputStream input, pb::ExtensionRegistry extensionRegistry) {
     
198.     return ((Builder) CreateBuilder().MergeFrom(input, extensionRegistry)).BuildParsed();
     
199.   }
     
200.   private MyRequest MakeReadOnly() {
     
201.     return this;
     
202.   }
     
203.   
     
204.   public static Builder CreateBuilder() { return new Builder(); }
     
205.   public override Builder ToBuilder() { return CreateBuilder(this); }
     
206.   public override Builder CreateBuilderForType() { return new Builder(); }
     
207.   public static Builder CreateBuilder(MyRequest prototype) {
     
208.     return new Builder(prototype);
     
209.   }
     
210.   
     
211.   [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
     
212.   public sealed partial class Builder : pb::GeneratedBuilder<MyRequest, Builder> {
     
213.     protected override Builder ThisBuilder {
     
214.       get { return this; }
     
215.     }
     
216.     public Builder() {
     
217.       result = DefaultInstance;
     
218.       resultIsReadOnly = true;
     
219.     }
     
220.     internal Builder(MyRequest cloneFrom) {
     
221.       result = cloneFrom;
     
222.       resultIsReadOnly = true;
     
223.     }
     
224.    
     
225.     private bool resultIsReadOnly;
     
226.     private MyRequest result;
     
227.    
     
228.     private MyRequest PrepareBuilder() {
     
229.       if (resultIsReadOnly) {
     
230.         MyRequest original = result;
     
231.         result = new MyRequest();
     
232.         resultIsReadOnly = false;
     
233.         MergeFrom(original);
     
234.       }
     
235.       return result;
     
236.     }
     
237.    
     
238.     public override bool IsInitialized {
     
239.       get { return result.IsInitialized; }
     
240.     }
     
241.    
     
242.     protected override MyRequest MessageBeingBuilt {
     
243.       get { return PrepareBuilder(); }
     
244.     }
     
245.    
     
246.     public override Builder Clear() {
     
247.       result = DefaultInstance;
     
248.       resultIsReadOnly = true;
     
249.       return this;
     
250.     }
     
251.    
     
252.     public override Builder Clone() {
     
253.       if (resultIsReadOnly) {
     
254.         return new Builder(result);
     
255.       } else {
     
256.         return new Builder().MergeFrom(result);
     
257.       }
     
258.     }
     
259.    
     
260.     public override pbd::MessageDescrip{过滤}tor Descrip{过滤}torForType {
     
261.       get { return global::MyRequest.Descrip{过滤}tor; }
     
262.     }
     
263.    
     
264.     public override MyRequest DefaultInstanceForType {
     
265.       get { return global::MyRequest.DefaultInstance; }
     
266.     }
     
267.    
     
268.     public override MyRequest BuildPartial() {
     
269.       if (resultIsReadOnly) {
     
270.         return result;
     
271.       }
     
272.       resultIsReadOnly = true;
     
273.       return result.MakeReadOnly();
     
274.     }
     
275.    
     
276.     public override Builder MergeFrom(pb::IMessage other) {
     
277.       if (other is MyRequest) {
     
278.         return MergeFrom((MyRequest) other);
     
279.       } else {
     
280.         base.MergeFrom(other);
     
281.         return this;
     
282.       }
     
283.     }
     
284.    
     
285.     public override Builder MergeFrom(MyRequest other) {
     
286.       if (other == global::MyRequest.DefaultInstance) return this;
     
287.       PrepareBuilder();
     
288.       if (other.HasVersion) {
     
289.         Version = other.Version;
     
290.       }
     
291.       if (other.HasName) {
     
292.         Name = other.Name;
     
293.       }
     
294.       if (other.HasWebsite) {
     
295.         Website = other.Website;
     
296.       }
     
297.       if (other.HasData) {
     
298.         Data = other.Data;
     
299.       }
     
300.       this.MergeUnknownFields(other.UnknownFields);
     
301.       return this;
     
302.     }
     
303.    
     
304.     public override Builder MergeFrom(pb::ICodedInputStream input) {
     
305.       return MergeFrom(input, pb::ExtensionRegistry.Empty);
     
306.     }
     
307.    
     
308.     public override Builder MergeFrom(pb::ICodedInputStream input, pb::ExtensionRegistry extensionRegistry) {
     
309.       PrepareBuilder();
     
310.       pb::UnknownFieldSet.Builder unknownFields = null;
     
311.       uint tag;
     
312.       string field_name;
     
313.       while (input.ReadTag(out tag, out field_name)) {
     
314.         if(tag == 0 && field_name != null) {
     
315.           int field_ordinal = global::System.Array.BinarySearch(_myRequestFieldNames, field_name, global::System.StringComparer.Ordinal);
     
316.           if(field_ordinal >= 0)
     
317.             tag = _myRequestFieldTags[field_ordinal];
     
318.           else {
     
319.             if (unknownFields == null) {
     
320.               unknownFields = pb::UnknownFieldSet.CreateBuilder(this.UnknownFields);
     
321.             }
     
322.             ParseUnknownField(input, unknownFields, extensionRegistry, tag, field_name);
     
323.             continue;
     
324.           }
     
325.         }
     
326.         switch (tag) {
     
327.           case 0: {
     
328.             throw pb::InvalidProtocolBufferException.InvalidTag();
     
329.           }
     
330.           default: {
     
331.             if (pb::WireFormat.IsEndGroupTag(tag)) {
     
332.               if (unknownFields != null) {
     
333.                 this.UnknownFields = unknownFields.Build();
     
334.               }
     
335.               return this;
     
336.             }
     
337.             if (unknownFields == null) {
     
338.               unknownFields = pb::UnknownFieldSet.CreateBuilder(this.UnknownFields);
     
339.             }
     
340.             ParseUnknownField(input, unknownFields, extensionRegistry, tag, field_name);
     
341.             break;
     
342.           }
     
343.           case 8: {
     
344.             result.hasVersion = input.ReadInt32(ref result.version_);
     
345.             break;
     
346.           }
     
347.           case 18: {
     
348.             result.hasName = input.ReadString(ref result.name_);
     
349.             break;
     
350.           }
     
351.           case 26: {
     
352.             result.hasWebsite = input.ReadString(ref result.website_);
     
353.             break;
     
354.           }
     
355.           case 34: {
     
356.             result.hasData = input.ReadBytes(ref result.data_);
     
357.             break;
     
358.           }
     
359.         }
     
360.       }
     
361.       
     
362.       if (unknownFields != null) {
     
363.         this.UnknownFields = unknownFields.Build();
     
364.       }
     
365.       return this;
     
366.     }
     
367.    
     
368.    
     
369.     public bool HasVersion {
     
370.       get { return result.hasVersion; }
     
371.     }
     
372.     public int Version {
     
373.       get { return result.Version; }
     
374.       set { SetVersion(value); }
     
375.     }
     
376.     public Builder SetVersion(int value) {
     
377.       PrepareBuilder();
     
378.       result.hasVersion = true;
     
379.       result.version_ = value;
     
380.       return this;
     
381.     }
     
382.     public Builder ClearVersion() {
     
383.       PrepareBuilder();
     
384.       result.hasVersion = false;
     
385.       result.version_ = 0;
     
386.       return this;
     
387.     }
     
388.    
     
389.     public bool HasName {
     
390.       get { return result.hasName; }
     
391.     }
     
392.     public string Name {
     
393.       get { return result.Name; }
     
394.       set { SetName(value); }
     
395.     }
     
396.     public Builder SetName(string value) {
     
397.       pb::ThrowHelper.ThrowIfNull(value, "value");
     
398.       PrepareBuilder();
     
399.       result.hasName = true;
     
400.       result.name_ = value;
     
401.       return this;
     
402.     }
     
403.     public Builder ClearName() {
     
404.       PrepareBuilder();
     
405.       result.hasName = false;
     
406.       result.name_ = "";
     
407.       return this;
     
408.     }
     
409.    
     
410.     public bool HasWebsite {
     
411.       get { return result.hasWebsite; }
     
412.     }
     
413.     public string Website {
     
414.       get { return result.Website; }
     
415.       set { SetWebsite(value); }
     
416.     }
     
417.     public Builder SetWebsite(string value) {
     
418.       pb::ThrowHelper.ThrowIfNull(value, "value");
     
419.       PrepareBuilder();
     
420.       result.hasWebsite = true;
     
421.       result.website_ = value;
     
422.       return this;
     
423.     }
     
424.     public Builder ClearWebsite() {
     
425.       PrepareBuilder();
     
426.       result.hasWebsite = false;
     
427.       result.website_ = "http://www.itsvse.com/";
     
428.       return this;
     
429.     }
     
430.    
     
431.     public bool HasData {
     
432.       get { return result.hasData; }
     
433.     }
     
434.     public pb::ByteString Data {
     
435.       get { return result.Data; }
     
436.       set { SetData(value); }
     
437.     }
     
438.     public Builder SetData(pb::ByteString value) {
     
439.       pb::ThrowHelper.ThrowIfNull(value, "value");
     
440.       PrepareBuilder();
     
441.       result.hasData = true;
     
442.       result.data_ = value;
     
443.       return this;
     
444.     }
     
445.     public Builder ClearData() {
     
446.       PrepareBuilder();
     
447.       result.hasData = false;
     
448.       result.data_ = pb::ByteString.Empty;
     
449.       return this;
     
450.     }
     
451.   }
     
452.   static MyRequest() {
     
453.     object.ReferenceEquals(global::ProtoMyRequest.Descrip{过滤}tor, null);
     
454.   }
     
455. }
     
456. 
     
457. #endregion
     
458. 
     
459. 
     
460. #endregion Designer generated code
     

复制代码

3：下面是我们的客户端代码，如下：

1. using System;
   
2. using System.Collections.Generic;
   
3. using System.Linq;
   
4. using System.Net;
   
5. using System.Net.Sockets;
   
6. using System.Text;
   
7. using System.Threading;
   
8. 
   
9. namespace ProtobufDemo
   
10. {
    
11.         class Program
    
12.         {
    
13.                 private static TcpListener server;
    
14.                 static void Main(string[] args)
    
15.                 {
    
16.                         //启动服务端
    
17.                         server = new TcpListener(IPAddress.Parse("127.0.0.1"), 12345);
    
18.                         server.Start();
    
19.                         new Thread(new ThreadStart(ServiceRun)) { IsBackground = true }.Start();
    
20.                         Console.WriteLine("SERVER : 开启监听 ---");
    
21.                         Console.ReadKey();
    
22.                 }
    
23. 
    
24.                 private static void ServiceRun()
    
25.                 {
    
26.                         while (true)
    
27.                         {
    
28.                                 TcpClient client = server.AcceptTcpClient();//接受一个Client  
    
29.                                 //用用户连接进来
    
30.                                 ThreadPool.QueueUserWorkItem(clientConnected, client);
    
31.                         }
    
32.                 }
    
33. 
    
34.                 private static void clientConnected(object obj)
    
35.                 {
    
36.                         TcpClient client = (TcpClient)obj;
    
37.                         Console.WriteLine("SERVER : 客户端已连接，数据读取中 --- ");
    
38.                         byte[] myRequestBuffer = new byte[1024];
    
39.                         try
    
40.                         {
    
41.                                 //获取网络流  
    
42.                                 using (NetworkStream stream = client.GetStream())
    
43.                                 {
    
44.                                         //读取网络流中的数据
    
45.                                         int myRequestLength = 0;
    
46.                                         do
    
47.                                         {
    
48.                                                 myRequestLength = stream.Read(myRequestBuffer, 0, myRequestBuffer.Length);
    
49.                                         }
    
50.                                         while (stream.DataAvailable);
    
51.                                         myRequestBuffer = myRequestBuffer.RemoveEmptyByte(myRequestLength);
    
52.                                         //反序列化
    
53.                                         MyRequest request = MyRequest.ParseFrom(myRequestBuffer);
    
54.                                 }
    
55.                         }
    
56.                         catch (Exception ex)
    
57.                         {
    
58.                                 Console.WriteLine(System.Text.Encoding.UTF8.GetString(myRequestBuffer));
    
59.                                 Console.WriteLine(ex.Message);
    
60.                         }
    
61.                         //关闭client
    
62.                         client.Close();
    
63.                        
    
64.                 }
    
65.         }
    
66. 
    
67.         /// <summary>
    
68.         /// 扩展方法
    
69.         /// </summary>
    
70.         public static class ExtensionClass
    
71.         {
    
72.                 public static byte[] RemoveEmptyByte(this byte[] by, int length)
    
73.                 {
    
74.                         byte[] returnByte = new byte[length];
    
75. 
    
76.                         for (int i = 0; i < length; i++)
    
77.                         {
    
78.                                 returnByte[i] = by[i];
    
79.                         }
    
80.                         return returnByte;
    
81. 
    
82.                 }
    
83.         }
    
84. }
    

复制代码