protobuf-net - Protocol Buffers library for idiomatic .NET

1. PROTOBUF-NET
Larry Nung

2. AGENDA
Introduction
Getting started
Decorate class
ProtoContract
DataContract
RuntimeTypeModel
Serialize /DeSerialize Data
Serialize /DeSerialize stream
Serialize /DeSerialize text
Serialize /DeSerialize file
Generate proto file
Reference
Q & A 2

3. INTRODUCTION
3

4. INTRODUCTION
 Protocol Buffers library for idiomatic .NET
 Contract based serializer for .NET code
4

5. GETTING STARTED
5

6. GETTING STARTED
Reference
library
Decorate
class
Serialize
/DeSerialize
Data
6

7. REFERENCE LIBRARY
7

8. REFERENCE LIBRARY
8

9. DECORATE CLASS
[ProtoContract]
class Person {
[ProtoMember(1)]
public int Id {get;set;}
[ProtoMember(2)]
public string Name {get;set:}
[ProtoMember(3)]
public Address Address {get;set;} } [ProtoContract]
class Address {
[ProtoMember(1)]
public string Line1 {get;set;}
[ProtoMember(2)]
public string Line2 {get;set;}
}
9

10. SERIALIZE DATA
var person = new Person {
Id = 12345, Name = "Fred",
Address = new Address {
Line1 = "Flat 1",
Line2 = "The Meadows"
}
};
using (var file = File.Create("person.bin")) {
Serializer.Serialize(file, person);
} 10

11. DESERIALIZE DATA
Person newPerson;
using (var file = File.OpenRead("person.bin")) {
newPerson = Serializer.Deserialize<Person>(file);
}
11

12. DECORATE CLASS
12

13. PROTOCONTRACT
[ProtoContract]
class Person {
[ProtoMember(1)]
public int Id {get;set;}
[ProtoMember(2)]
public string Name {get;set:}
[ProtoMember(3)]
public Address Address {get;set;} } [ProtoContract]
class Address {
[ProtoMember(1)]
public string Line1 {get;set;}
[ProtoMember(2)]
public string Line2 {get;set;}
}
13

14. PROTOCONTRACT
[ProtoContract]
[ProtoInclude(10, typeof(Male))]
[ProtoInclude(11, typeof(Female))]
class Person {
[ProtoMember(1)]
public string Name { get; set; }
}
[ProtoContract]
class Male : Person { }
[ProtoContract]
class Female : Person { } 14

15. PROTOCONTRACT
[ProtoContract(SkipConstructor = true, ImplicitFields =
ImplicitFields.AllFields)]
class Person {
public string Name { get; set; }
public Person(string name) {
Name = name;
}
[ProtoAfterDeserialization]
void Validate() {
if (string.IsNullOrEmpty(Name))
throw new Exception("Empty name");
}
}
15

16. DATACONTRACT
[DataContract]
class Person {
[DataMember(Order = 1)]
public string Name { get; set; }
}
16

17. RUNTIMETYPEMODEL
class Person {
public string Name { get; set; }
}
…
RuntimeTypeModel.Default
.Add(typeof(Person), false);
.Add(1, "Name");
17

18. SERIALIZE /DESERIALIZE DATA
18

19. SERIALIZE /DESERIALIZE STREAM
private static void SerializeToStream<T>(T obj,
Stream stream) {
Serializer.Serialize(stream, obj);
}
private static T DeSerializeFromStream<T>(Stream
stream) {
return Serializer.Deserialize<T>(stream);
}
19

20. SERIALIZE /DESERIALIZE TEXT
private static string SerializeToText<T>(T obj) {
using (var ms = new MemoryStream(1024)) {
SerializeToStream(obj, ms);
return Convert.ToBase64String(ms.ToArray());
}
}
private static T DeSerializeFromText<T>(string text) {
var buffer = Convert.FromBase64String(text);
using (var ms = new MemoryStream(buffer)) {
return DeSerializeFromStream<T>(ms);
}
} 20

21. SERIALIZE /DESERIALIZE FILE
public virtual void SerializeToFile<T>(T obj, String file, Int32 bufferSize =
1024) {
using (var fs = File.Open(file, FileMode.Create, FileAccess.Write)) {
using (var bs = new BufferedStream(fs, bufferSize)) {
SerializeToStream(obj, bs);
bs.Flush();
}
}
}
public virtual T DeSerializeFromFile<T>(String file, Int32 bufferSize) {
using (var fs = File.Open(file, FileMode.Open, FileAccess.Read,
FileShare.ReadWrite)) {
using (var bs = new BufferedStream(fs, bufferSize)) {
return DeSerializeFromStream<T>(bs);
}
}
}
21

22. GENERATE PROTO FILE
22

23. GENERATE PROTO FILE
private static void GenerateProtoFile<T>(string file)
{
File.WriteAllText(file,Serializer.GetProto<T>());
}
23

24. REFERENCE
24

25. REFERENCE
 NuGet Gallery | protobuf-net 2.1.0
 https://www.nuget.org/packages/protobuf-net/
25

26. Q&A
26

27. QUESTION & ANSWER
27