Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add EmptyCollections config option for maps and slices #656

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add EmptyCollections config option for maps and slices #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions config.go
View file
Open in desktop
Expand Up @@ -25,6 +25,7 @@ type Config struct {
ValidateJsonRawMessage bool
ObjectFieldMustBeSimpleString bool
CaseSensitive bool
EmptyCollections bool
}

// API the public interface of this package.
Expand Down Expand Up @@ -80,6 +81,7 @@ type frozenConfig struct {
streamPool *sync.Pool
iteratorPool *sync.Pool
caseSensitive bool
emptyCollections bool
}

func (cfg *frozenConfig) initCache() {
Expand Down Expand Up @@ -134,6 +136,7 @@ func (cfg Config) Froze() API {
onlyTaggedField: cfg.OnlyTaggedField,
disallowUnknownFields: cfg.DisallowUnknownFields,
caseSensitive: cfg.CaseSensitive,
emptyCollections: cfg.EmptyCollections,
}
api.streamPool = &sync.Pool{
New: func() interface{} {
Expand Down
17 changes: 17 additions & 0 deletions misc_tests/jsoniter_array_test.go
View file
Open in desktop
Expand Up @@ -226,6 +226,23 @@ func Test_decode_large_slice(t *testing.T) {
should.Equal([]int{1, 2, 3, 4, 5, 6, 7, 8, 9}, slice)
}

func Test_encode_nil_slice(t *testing.T) {
should := require.New(t)
var nilSlice []string
output, err := jsoniter.MarshalToString(nilSlice)
should.NoError(err)
should.Equal(`null`, output)
}

func Test_encode_nil_as_empty_slice(t *testing.T) {
should := require.New(t)
json := jsoniter.Config{EmptyCollections: true}.Froze()
var nilSlice []string
output, err := json.MarshalToString(nilSlice)
should.NoError(err)
should.Equal(`[]`, output)
}

func Benchmark_jsoniter_array(b *testing.B) {
b.ReportAllocs()
input := []byte(`[1,2,3,4,5,6,7,8,9]`)
Expand Down
9 changes: 9 additions & 0 deletions misc_tests/jsoniter_map_test.go
View file
Open in desktop
Expand Up @@ -50,3 +50,12 @@ func Test_encode_nil_map(t *testing.T) {
should.NoError(err)
should.Equal(`null`, output)
}

func Test_encode_nil_as_empty_map(t *testing.T) {
should := require.New(t)
json := jsoniter.Config{EmptyCollections: true}.Froze()
var nilMap map[string]string
output, err := json.MarshalToString(nilMap)
should.NoError(err)
should.Equal(`{}`, output)
}
36 changes: 24 additions & 12 deletions reflect_map.go
View file
Open in desktop
Expand Up @@ -27,15 +27,17 @@ func encoderOfMap(ctx *ctx, typ reflect2.Type) ValEncoder {
mapType := typ.(*reflect2.UnsafeMapType)
if ctx.sortMapKeys {
return &sortKeysMapEncoder{
mapType: mapType,
keyEncoder: encoderOfMapKey(ctx.append("[mapKey]"), mapType.Key()),
elemEncoder: encoderOfType(ctx.append("[mapElem]"), mapType.Elem()),
mapType: mapType,
keyEncoder: encoderOfMapKey(ctx.append("[mapKey]"), mapType.Key()),
elemEncoder: encoderOfType(ctx.append("[mapElem]"), mapType.Elem()),
emptyCollections: ctx.emptyCollections,
}
}
return &mapEncoder{
mapType: mapType,
keyEncoder: encoderOfMapKey(ctx.append("[mapKey]"), mapType.Key()),
elemEncoder: encoderOfType(ctx.append("[mapElem]"), mapType.Elem()),
mapType: mapType,
keyEncoder: encoderOfMapKey(ctx.append("[mapKey]"), mapType.Key()),
elemEncoder: encoderOfType(ctx.append("[mapElem]"), mapType.Elem()),
emptyCollections: ctx.emptyCollections,
}
}

Expand Down Expand Up @@ -246,13 +248,18 @@ func (encoder *dynamicMapKeyEncoder) IsEmpty(ptr unsafe.Pointer) bool {
}

type mapEncoder struct {
mapType *reflect2.UnsafeMapType
keyEncoder ValEncoder
elemEncoder ValEncoder
mapType *reflect2.UnsafeMapType
keyEncoder ValEncoder
elemEncoder ValEncoder
emptyCollections bool
}

func (encoder *mapEncoder) Encode(ptr unsafe.Pointer, stream *Stream) {
if *(*unsafe.Pointer)(ptr) == nil {
if encoder.emptyCollections {
stream.WriteEmptyObject()
return
}
stream.WriteNil()
return
}
Expand Down Expand Up @@ -280,13 +287,18 @@ func (encoder *mapEncoder) IsEmpty(ptr unsafe.Pointer) bool {
}

type sortKeysMapEncoder struct {
mapType *reflect2.UnsafeMapType
keyEncoder ValEncoder
elemEncoder ValEncoder
mapType *reflect2.UnsafeMapType
keyEncoder ValEncoder
elemEncoder ValEncoder
emptyCollections bool
}

func (encoder *sortKeysMapEncoder) Encode(ptr unsafe.Pointer, stream *Stream) {
if *(*unsafe.Pointer)(ptr) == nil {
if encoder.emptyCollections {
stream.WriteEmptyObject()
return
}
stream.WriteNil()
return
}
Expand Down
11 changes: 8 additions & 3 deletions reflect_slice.go
View file
Open in desktop
Expand Up @@ -16,16 +16,21 @@ func decoderOfSlice(ctx *ctx, typ reflect2.Type) ValDecoder {
func encoderOfSlice(ctx *ctx, typ reflect2.Type) ValEncoder {
sliceType := typ.(*reflect2.UnsafeSliceType)
encoder := encoderOfType(ctx.append("[sliceElem]"), sliceType.Elem())
return &sliceEncoder{sliceType, encoder}
return &sliceEncoder{sliceType, encoder, ctx.emptyCollections}
}

type sliceEncoder struct {
sliceType *reflect2.UnsafeSliceType
elemEncoder ValEncoder
sliceType *reflect2.UnsafeSliceType
elemEncoder ValEncoder
emptyCollections bool
}

func (encoder *sliceEncoder) Encode(ptr unsafe.Pointer, stream *Stream) {
if encoder.sliceType.UnsafeIsNil(ptr) {
if encoder.emptyCollections {
stream.WriteEmptyArray()
return
}
stream.WriteNil()
return
}
Expand Down