Repository files navigation

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

https://alecthomas.github.io/go_serialization_benchmarks

To benchmark and validate, without cloning the repository, replace the. from the commands below withgithub.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):

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

If correctness and interoperability are the mostimportant factorsJSON orProtobuf are your best options.

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

Review the following instructionsbefore opening the PR to add a newserializer:

• Create all the required serializer code ininternal/<short serializer name>.
• Add an entry to the serializer inbenchmarks.go.
• If the serializer supports both reusing/not reusing its marshalling buffer:
  • Add both aserializer andserializer/reuse entries, each onerespectively reusing/not reusing the resulting marshalling buffer. Set theBufferReuseMarshal flag accordingly.
• If the serializer supports both safe and unsafe string unmarshalling:
  • Add both aserializer andserializer/unsafe entries, each onerespectively unmarshalling into safe and unsafe strings. Set theUnsafeStringUnmarshal flag accordingly.
• If the serializer supports both marshalling buffer reuse and unsafe stringunmarshalling, merge both options into a singleserializer/unsafe_reuseentry (check the baseline serializer for an example).
• Regenerate the report by running:

go run . --genreport

• Include the updated report data in your PR

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

typeAstruct {NamestringBirthDay time.TimePhonestringSiblingsintSpouseboolMoneyfloat64}