https://github.com/markrosemaker/jsonutil
Provides custom JSON v2 marshaling and unmarshaling functions for specific data types, e.g. JSON encoding and decoding for types like time.Duration and url.URL.
https://github.com/markrosemaker/jsonutil
golang json json-v2 marshal marshaller time-duration unmarshal unmarshaller url
Last synced: about 1 month ago
JSON representation
Provides custom JSON v2 marshaling and unmarshaling functions for specific data types, e.g. JSON encoding and decoding for types like time.Duration and url.URL.
- Host: GitHub
- URL: https://github.com/markrosemaker/jsonutil
- Owner: MarkRosemaker
- License: mit
- Created: 2024-11-21T14:56:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-28T16:04:00.000Z (over 1 year ago)
- Last Synced: 2025-01-09T16:24:16.792Z (over 1 year ago)
- Topics: golang, json, json-v2, marshal, marshaller, time-duration, unmarshal, unmarshaller, url
- Language: Go
- Homepage:
- Size: 567 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON v2 Utilities
[](https://pkg.go.dev/github.com/MarkRosemaker/jsonutil)
[](https://goreportcard.com/report/github.com/MarkRosemaker/jsonutil)
[](./LICENSE)
`jsonutil` is a Go package that provides custom [JSON v2](https://pkg.go.dev/encoding/json/v2) marshaling and unmarshaling functions for specific data types.
This package is particularly useful when you need to handle JSON encoding and decoding for types like `time.Duration` and `url.URL` in a customized manner.
## Features
* Custom marshaler and unmarshaler for `url.URL`:
* `URLMarshal` marshals `url.URL` as a string.
* `URLUnmarshal` unmarshals `url.URL` from a string.
* Custom marshaler and unmarshaler for `time.Duration`:
* `DurationMarshalIntSeconds` marshals `time.Duration` as an integer representing seconds.
* `DurationUnmarshalIntSeconds` unmarshals `time.Duration` from an integer assuming it represents seconds.
* Custom marshaler for maps with ordered keys:
* `OrderedMapMarshal[M ~map[K]V, K cmp.Ordered, V any]` marshals `M` so that the keys are sorted.
* Custom marshaler for `http.Header`:
* `HTTPHeaderMarshal` marshals the values of `http.Header` as single strings.
* `HTTPHeaderUnmarshal` unmarshals the values of `http.Header` from single strings.
## Installation
To install the library, use the following command:
```shell
go get github.com/MarkRosemaker/jsonutil
```
## Usage
### Custom Marshaling and Unmarshaling for `url.URL`
To use the custom marshaler and unmarshaler for `url.URL`, you can import the package and use the provided functions:
```go
package main
import (
"encoding/json/v2"
"fmt"
"net/url"
"github.com/MarkRosemaker/jsonutil"
)
var jsonOpts = json.JoinOptions(
json.WithMarshalers(json.NewMarshalers(json.MarshalToFunc(jsonutil.URLMarshal))),
json.WithUnmarshalers(json.NewUnmarshalers(json.UnmarshalFromFunc(jsonutil.URLUnmarshal))),
)
type MyStruct struct {
Foo string `json:"foo"`
Link url.URL `json:"link"`
}
func main() {
out := &MyStruct{}
if err := json.Unmarshal([]byte(`{"foo":"bar","link":"https://example.com/"}`), out, jsonOpts); err != nil {
panic(err)
}
if out.Link.String() != "https://example.com/" {
panic("something went wrong")
}
res, err := json.Marshal(MyStruct{
Foo: "baz",
Link: url.URL{Scheme: "http", Host: "example.com", Path: "/some-path"},
}, jsonOpts)
if err != nil {
panic(err)
}
fmt.Println(string(res))
// Output: {"foo":"baz","link":"http://example.com/some-path"}
}
```
### Custom Marshaling and Unmarshaling for `time.Duration`
To use the custom marshaler and unmarshaler for `time.Duration`, you can import the package and use the provided functions:
```go
package main
import (
"encoding/json/v2"
"fmt"
"time"
"github.com/MarkRosemaker/jsonutil"
)
var jsonOpts = json.JoinOptions(
json.WithMarshalers(json.MarshalToFunc(jsonutil.DurationMarshalIntSeconds)),
json.WithUnmarshalers(json.UnmarshalFromFunc(jsonutil.DurationUnmarshalIntSeconds)),
)
type MyStruct struct {
Foo string `json:"foo"`
Duration time.Duration `json:"duration"`
}
func main() {
out := &MyStruct{}
if err := json.Unmarshal([]byte(`{"foo":"bar","duration":3}`), out, jsonOpts); err != nil {
panic(err)
}
if out.Duration != 3*time.Second {
panic("something went wrong")
}
res, err := json.Marshal(MyStruct{
Foo: "baz",
Duration: time.Minute,
}, jsonOpts)
if err != nil {
panic(err)
}
fmt.Println(string(res))
// Output: {"foo":"baz","duration":60}
}
```
### Custom Marshaling for Maps with Ordered Keys
To use the custom marshaler for `M` where `[M ~map[K]V, K cmp.Ordered, V any]`, you can import the package and use the provided functions:
```go
package main
import (
"encoding/json/v2"
"fmt"
"github.com/MarkRosemaker/jsonutil"
)
type myMap map[string]int
var jsonOpts = json.JoinOptions(
json.WithMarshalers(json.MarshalToFunc(jsonutil.OrderedMapMarshal[myMap])),
)
func main() {
res, err := json.Marshal(myMap{
"foo": 1,
"bar": 2,
}, jsonOpts)
if err != nil {
panic(err)
}
fmt.Println(string(res))
// Output: {"bar":2,"bar":1}
}
```
### Custom Marshaling and Unmarshaling for `http.Header`
To use the custom marshaler and unmarshaler for `http.Header`, you can import the package and use the provided functions:
```go
package main
import (
"encoding/json/v2"
"fmt"
"net/http"
"github.com/MarkRosemaker/jsonutil"
)
var jsonOpts = json.JoinOptions(
json.WithMarshalers(json.MarshalToFunc(jsonutil.HTTPHeaderMarshal)),
json.WithUnmarshalers(json.UnmarshalFromFunc(jsonutil.HTTPHeaderUnmarshal)),
)
func main() {
out := &http.Header{}
if err := json.Unmarshal([]byte(`{"foo":"bar","baz":"quux"}`), out, jsonOpts); err != nil {
panic(err)
}
res, err := json.Marshal(http.Header{
"foo": []string{"bar"},
"baz": []string{"quux"},
}, jsonOpts)
if err != nil {
panic(err)
}
fmt.Println(string(res))
// Output: {"Foo":"bar","Baz":"quux"}
}
```
## Contributing
If you have any contributions to make, please submit a pull request or open an issue on the [GitHub repository](https://github.com/MarkRosemaker/jsonutil).
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.