什么是Protocol Buffer就不介绍了,网上资料很多,简单说一下在asp.net环境下的使用。
要想在.net环境下使用,可以选择Protobuf的.net版本,即Protobuf-net。首先下载Protobuf-net,我使用的是Protobuf-net r640,下载过后直接解压即可,不用再编译以生成ProtoGen.exe、Protobuf-net.dll等文件,因为解压后文件夹中已经有这些了。接下来,正文开始:
第一种方式:
1.新建一个项目,控制台或者Web应用程序都可以,然后在项目中引用Protobuf-net.dll。
2.既然要序列化肯定得有要序列化的目标,所以,定义类。
[ProtoContract]
public class Person
{
[ProtoMember(1)]
public string Name { get; set; }
[ProtoMember(2)]
public int Age { get; set; }
[ProtoMember(3)]
public Address address { get; set; }
}
[ProtoContract]
public class Address
{
[ProtoMember(1)]
public string Prov { get; set; }
[ProtoMember(2)]
public string City { get; set; }
}
可以看到在Person类前有ProtoContract特性,类中每个成员前都有ProtoMember特性,需要注意的是,ProtoMember必须有参数,而且参数是唯一的不可重复的整型值,最好从1开始。不同类中ProtoMember的参数没有关联,即在各个类中ProtoMember的参数都是从1开始的。
3.序列化和反序列化。
Person p = new Person() { Name = "Kevin", Age = 20, address = new Address() { Prov = "四川", City = "成都" } };
MemoryStream ms = new MemoryStream();
Serializer.Serialize<Person>(ms, p);
string result = Encoding.UTF8.GetString(ms.ToArray());
Serialize方法有很多重载,可以根据实际情况使用。
好了,序列化这样就完成了。封装一下使用起来会方便许多:
public class ProtoHelper
{
//序列化
public static string Serialize<T>(T t)
{
MemoryStream ms = new MemoryStream();
Serializer.Serialize<T>(ms, t);
return Encoding.UTF8.GetString(ms.ToArray());
}
//反序列化
public static T DeSerialize<T>(string content)
{
MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(content));
T t = Serializer.Deserialize<T>(ms);
return t;
}
}
试验一下:
protected void Page_Load(object sender, EventArgs e)
{
List<Person> list = new List<Person>();
Person p1 = new Person() { Name = "Leon", Age = 20, address = new Address() { Prov = "四川", City = "成都" } };
Person p2 = new Person() { Name = "Kevin", Age = 30, address = new Address() { Prov = "广东", City = "深圳" } };
list.Add(p1);
list.Add(p2);
string s1 = ProtoHelper.Serialize<List<Person>>(list);
List<Person> list1 = ProtoHelper.DeSerialize<List<Person>>(s1);
foreach (Person p in list1)
{
Response.Write(p.Name + "," + p.Age + "岁," + p.address.Prov + p.address.City + "<br />");
}
}
成功!
第二种方式:
1.编写一个.proto文件,定义协议的格式。
在ProtoGen目录下有一个descriptor.proto文件,可以先看看,然后用这个当模板来写我们自己的Person.proto文件。那么开始:
message Person {
required string Name=1;
required int32 Age=2;
required Address address=3;
}
message Address{
required string Prov=1;
required string City=2;
}
语法就和定义类差不多,message对应class,required表示不可增加或刪除的字段,必須初始化;除了required,还有可选字段optional,可刪除,可以不初始化;repeated可重复字段。Name=1,Age=2…对应ProtoMember(1),ProtoMember(2)…
2.生成Person.cs文件。
在cmd中进入ProtoGen文件夹,执行以下命令:
protogen -i:Person.proto -o:Person.cs -ns:UGE.Metadata -p:import=UGE
这句命令的意思是通过Person.proto来生成Person.cs,namespace为UGE.Metadata,引用UGE。查看Person.cs就能发现,其实就是自动生成了Person和Address两个类,最终达成的效果和第一种方式是一样的。什么?你说第一种方式没有required,optional或者repeated修饰?那么这样就可以了:
[ProtoMember(1), IsRequired = true]
public string Name { get; set; }
3.序列化和反序列化。
方法和第一种方式完全一样,就不需要多说了。
两种方式各有优缺点,看情况使用吧!
以上。