Adding Protobuf Support

Protobuf (Protocol Buffers) is a language-neutral, platform-neutral, extensible serialization format for structured data developed by Google, used for communication protocols, data storage, and more.

To enable Protobuf support in your project, follow these steps:

Install the protobuf-net package:

dotnet add protobuf-net

Add the ProtobufContentProcessor content processor:

1234567891011121314151617181920212223242526272829303132333435

public class ProtobufContentProcessor : HttpContentProcessorBase{    /// <inheritdoc />    public override bool CanProcess(HttpContentProcessorContext context) =>        context.ContentType == "application/x-protobuf";    /// <inheritdoc />    public override HttpContent? Process(HttpContentProcessorContext context)    {        // Attempt to resolve the HttpContent type        if (TryProcess(context, out var httpContent))        {            return httpContent;        }        byte[] content;        if (context.RawContent is byte[] bytes)        {            content = bytes;        }        else        {            // Convert the raw request content to a byte array            using var ms = new MemoryStream();            Serializer.Serialize(ms, context.RawContent);            content = ms.ToArray();        }        // Initialize a ByteArrayContent instance        var byteArrayContent = new ByteArrayContent(content);        byteArrayContent.Headers.ContentType = new MediaTypeHeaderValue(context.ContentType) { CharSet = context.Encoding?.WebName };        return byteArrayContent;    }}

Apply the ProtobufContentProcessor content processor:

Per-request configuration:

HttpRequestBuilder.Post("https://furion.net/")    .AddHttpContentProcessors(() => [ new ProtobufContentProcessor() ])    .SetContent(new MyProtobufMessage { Id = 1, Name = "Furion" }, "application/x-protobuf");

Note

To use protobuf-net for serialization, your model class must add the ProtoContract attribute, and its properties must add the ProtoMember attribute. For detailed documentation, refer to the protobuf-net official repository. However, types are usually defined and generated via .proto files:

Define the my_message.proto file as follows:

123456789

syntax = "proto3"; // Specify using the proto3 syntaxpackage mynamespace; // Optional: defines the package name (corresponding to the C# namespace)// Defines the MyProtobufMessage message typemessage MyProtobufMessage {  int32 id = 1;     // Integer field with tag number 1  string name = 2;  // String field with tag number 2}

Use the Google.Protobuf command-line tool to generate the corresponding C# class, as follows:

protoc -I=./ --csharp_out=./Generated ./my_message.proto

The generated C# class may look like the following (with the ProtoContract and ProtoMember attributes already added):

123456789

[ProtoContract]public class MyProtobufMessage{    [ProtoMember(1)]    public int Id { get; set; }    [ProtoMember(2)]    public string Name { get; set; }}

Global configuration:

In the Startup.cs or Program.cs file, configure and register the HttpRemote service to enable the ProtobufContentProcessor content processor:

services.AddHttpRemote(builder =>{    builder.AddHttpContentProcessors(() => [ new ProtobufContentProcessor() ]);});

This way you can send data in the application/x-protobuf format via HTTP remote requests in your project.