protobuf-net.Protogen
3.2.42
Prefix Reserved
dotnet tool install --global protobuf-net.Protogen --version 3.2.42
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local protobuf-net.Protogen --version 3.2.42
#tool dotnet:?package=protobuf-net.Protogen&version=3.2.42
nuke :add-package protobuf-net.Protogen --version 3.2.42
<img src="https://protogen.marcgravell.com/images/protobuf-net.svg" alt="protobuf-net logo" width="45" height="45"> protobuf-net
protobuf-net is a contract based serializer for .NET code, that happens to write data in the "protocol buffers" serialization format engineered by Google. The API, however, is very different to Google's, and follows typical .NET patterns (it is broadly comparable, in usage, to XmlSerializer
, DataContractSerializer
, etc). It should work for most .NET languages that write standard types and can use attributes.
Release Notes
Change history and pending changes are here.
Supported Runtimes
- .NET 6.0+ (.NET 5 etc will use .NET Standard 2.1)
- .NET Standard 2.0, 2.1
- .NET Framework 4.6.2+
Build tools
Build tools to help you use protobuf-net correctly are available via protobuf-net.BuildTools
Runtime Installation
All stable and some pre-release packages are available on NuGet. CI Builds are available via MyGet (feed URL: https://www.myget.org/F/protobuf-net/api/v3/index.json
).
You can use the following command in the Package Manager Console:
Install-Package protobuf-net
Package | NuGet Stable | NuGet Pre-release | Downloads | MyGet |
---|---|---|---|---|
protobuf-net |
Basic usage
1 First Decorate your classes
[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;}
}
Note that unlike XmlSerializer, the member-names are not encoded in the data - instead, you must pick an integer to identify each member. Additionally, to show intent it is necessary to show that we intend this type to be serialized (i.e. that it is a data contract).
2 Serialize your data
This writes a 32 byte file to "person.bin" :
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);
}
3 Deserialize your data
This reads the data back from "person.bin" :
Person newPerson;
using (var file = File.OpenRead("person.bin")) {
newPerson = Serializer.Deserialize<Person>(file);
}
Notes
Notes for Identifiers
- they must be positive integers (for best portability, they should be
<= 536870911
and not in the range19000-19999
) - they must be unique within a single type but the same numbers can be re-used in sub-types if inheritance is enabled
- the identifiers must not conflict with any inheritance identifiers (discussed later)
- lower numbers take less space - don't start at 100,000,000
- the identifier is important; you can change the member-name, or shift it between a property and a field, but changing the identifier changes the data
Advanced subjects
Inheritance
Inheritance must be explicitly declared, in a similar way that it must for XmlSerializer and DataContractSerializer. This is done via [ProtoInclude(...)] on each type with known sub-types:
[ProtoContract]
[ProtoInclude(7, typeof(SomeDerivedType))]
class SomeBaseType {...}
[ProtoContract]
class SomeDerivedType {...}
There is no special significance in the 7 above; it is an integer key, just like every [ProtoMember(...)]. It must be unique in terms of SomeBaseType (no other [ProtoInclude(...)] or [ProtoMember(...)] in SomeBaseType can use 7), but does not need to be unique globally.
.proto file
As an alternative to writing your classes and decorating them, You can generate your types from a .proto schema using protogen
;
the protogen
tool is available as a zip from that location, or as a "global tool" (multi-platform).
Alternative to attributes
In v2+, everything that can be done with attributes can also be configured at runtime via RuntimeTypeModel
. The Serializer.* methods are basically just shortcuts to RuntimeTypeModel.Default., so to manipulate the behaviour of Serializer., you must configure RuntimeTypeModel.Default.
Support
I try to be responsive to Stack Overflow questions in the protobuf-net
tag, issues logged on GitHub, email, etc. I don't currently offer a paid support channel. If I've helped you, feel free to buy me a coffee or see the "Sponsor" link at the top of the GitHub page.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
3.2.42 | 2,282 | 5/7/2024 |
3.2.12 | 7,629 | 3/4/2023 |
3.2.8 | 492 | 2/27/2023 |
3.2.0 | 431 | 2/20/2023 |
3.1.33 | 1,229 | 1/30/2023 |
3.1.25 | 1,662 | 11/9/2022 |
3.1.22 | 2,342 | 9/21/2022 |
3.1.17 | 3,276 | 6/26/2022 |
3.0.101 | 5,486 | 3/19/2021 |
3.0.73 | 11,541 | 12/2/2020 |
3.0.62 | 5,418 | 11/13/2020 |
3.0.52 | 915 | 10/3/2020 |
3.0.29 | 1,371 | 7/8/2020 |
3.0.27 | 611 | 7/6/2020 |
3.0.24 | 674 | 7/6/2020 |
3.0.21 | 636 | 7/5/2020 |
3.0.0 | 1,000 | 6/9/2020 |
3.0.0-alpha.155 | 264 | 6/8/2020 |
3.0.0-alpha.154 | 273 | 6/8/2020 |
3.0.0-alpha.152 | 271 | 6/5/2020 |
3.0.0-alpha.150 | 387 | 5/29/2020 |
3.0.0-alpha.143 | 319 | 4/5/2020 |
3.0.0-alpha.128 | 360 | 12/10/2019 |
3.0.0-alpha.122 | 376 | 10/29/2019 |
3.0.0-alpha.103 | 280 | 10/18/2019 |
3.0.0-alpha.91 | 307 | 10/14/2019 |
2.3.17 | 29,524 | 8/3/2018 |
2.3.16 | 1,195 | 8/2/2018 |
1.0.10 | 1,204 | 7/24/2018 |
1.0.9 | 1,312 | 6/22/2018 |
1.0.8 | 1,859 | 6/10/2018 |
1.0.6 | 1,293 | 6/8/2018 |