Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

alecthomas/go_serialization_benchmarks

Repository files navigation

Benchmarks of Go serialization methods

This is a test suite for benchmarking various Go serialization methods.

Current Serialization Results

https://alecthomas.github.io/go_serialization_benchmarks

Running the benchmarks

To benchmark and validate, without cloning the repository, replace the . from the commands below with github.com/alecthomas/go_serialization_benchmarks@latest.

go run .

To validate the correctness of the serializers:

go run . --validate

To update the benchmark report:

go run . --genreport

To update the benchmark report with a longer benchmark run (to get more accurate results):

go test -tags genreport -run TestGenerateReport -benchtime 10s -timeout 1h #--validate

Recommendation

If correctness and interoperability are the most important factors JSON or Protobuf are your best options.

But as always, make your own choice based on your requirements.

Adding New Serializers

Review the following instructions before opening the PR to add a new serializer:

  • Create all the required serializer code in internal/.
  • Add an entry to the serializer in benchmarks.go.
  • If the serializer supports both reusing/not reusing its marshalling buffer:
    • Add both a serializer and serializer/reuse entries, each one respectively reusing/not reusing the resulting marshalling buffer. Set the BufferReuseMarshal flag accordingly.
  • If the serializer supports both safe and unsafe string unmarshalling:
    • Add both a serializer and serializer/unsafe entries, each one respectively unmarshalling into safe and unsafe strings. Set the UnsafeStringUnmarshal flag accordingly.
  • If the serializer supports both marshalling buffer reuse and unsafe string unmarshalling, merge both options into a single serializer/unsafe_reuse entry (check the baseline serializer for an example).
  • Regenerate the report by running:
go run . --genreport
  • Include the updated report data in your PR

Data

The data being serialized is the following structure with randomly generated values:

type A struct {
Name string
BirthDay time.Time
Phone string
Siblings int
Spouse bool
Money float64
}

About

Benchmarks of Go serialization methods

Topics

Resources

Readme

Stars

Watchers

Forks

Contributors 45