Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alecthomas/Go_serialization_benchmarks
Benchmarks of Go serialization methods
https://github.com/alecthomas/Go_serialization_benchmarks
benchmarking go golang
Last synced: 14 days ago
JSON representation
Benchmarks of Go serialization methods
- Host: GitHub
- URL: https://github.com/alecthomas/Go_serialization_benchmarks
- Owner: alecthomas
- Created: 2013-01-18T16:03:58.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T21:31:12.000Z (2 months ago)
- Last Synced: 2024-10-22T16:13:30.419Z (16 days ago)
- Topics: benchmarking, go, golang
- Language: Go
- Homepage: https://alecthomas.github.io/go_serialization_benchmarks/
- Size: 727 KB
- Stars: 1,568
- Watchers: 42
- Forks: 159
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Benchmarks of Go serialization methods
[](https://gitter.im/alecthomas/Lobby)
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`.
```bash
go run .
```
To validate the correctness of the serializers:
```bash
go run . --validate
```
To update the benchmark report:
```bash
go run . --genreport
```
To update the benchmark report with a longer benchmark run (to get more accurate results):
```bash
go test -tags genreport -run TestGenerateReport -benchtime 10s -timeout 1h #--validate
```
## Recommendation
If correctness and interoperability are the most
important factors [JSON](http://golang.org/pkg/encoding/json/) or [Protobuf](https://google.golang.org/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](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:
```go
type A struct {
Name string
BirthDay time.Time
Phone string
Siblings int
Spouse bool
Money float64
}
```