feature: allow customizing enum value serialization via annotations #251
Conversation
|
Question for reviewers (@natebosch , @jakemac53 ) Should I create another annotation class –
|
|
Just to give some reasoning: Integers are the default representation of enums in many other languages (e.g. C#, Kotlin, TypeScript), and it's also common to serialize enum values as integers, as it is a very efficient format. |
* Require the latest Dart SDK Annotated enums fail without the CFE * Require the latest pkg:analyzer Enum metadata parsing was just recently added * Require the latest pkg:source_gen Uses multiple return values to allow generating shared helpers * Removed several helpers in json_annotation They can now be generated as part of the source, which minimizes versioning issues with helpers. * Small, but breaking changes to Generator API to return multiple values * Added `addMember` API to Context classes to allow helpers to be generated. * Updated integration test code to include an annotated enum * Updated yaml test code to remove now superfluous convert logic and use annotated enums instead Fixes #38
kevmoo
force-pushed
the
i38_enum_annotations
branch
from
21b6749 to
dd8f50b
Compare
|
@sir-boformer – added @jakemac53 – ready for review |
| /// | ||
| /// Can be a [String] or an [int]. | ||
| final dynamic value; | ||
| const JsonValue(this.value); |
There was a problem hiding this comment.
nit: newline above here?
| return null; | ||
| } | ||
|
|
||
| context.addMember(_enumDecodeHelper); |
There was a problem hiding this comment.
So we will actually be adding one of these each time this helper is called right? Is that once per field using the enum or more than that?
There was a problem hiding this comment.
once per field using the enum – but then they are collapsed.
The storage is a set, so it's only recorded once.
json_serializable/lib/src/utils.dart
Outdated
| /// If [targetType] is not an enum, `null` is returned. | ||
| Map<FieldElement, dynamic> enumFieldsMap(DartType targetType) { | ||
| if (targetType is InterfaceType && targetType.element.isEnum) { | ||
| var value = _enumMapExpando[targetType]; |
There was a problem hiding this comment.
nit: return _enumMapExpando[targetType] ??= ...?
There was a problem hiding this comment.
also, I would consider taking moving big anonymous closure out to a private method or even just a local variable so its easier to reason about what is happening here
|
@jakemac53 – PTAL |
feature: allow customizing enum value serialization via annotations
Require the latest Dart SDK
Annotated enums fail without the CFE
Require the latest pkg:analyzer
Enum metadata parsing was just recently added
Require the latest pkg:source_gen
Uses multiple return values to allow generating shared helpers
Removed several helpers in json_annotation
They can now be generated as part of the source, which minimizes
versioning issues with helpers.
Small, but breaking changes to Generator API to return multiple
values
Added
addMemberAPI to Context classes to allow helpers to begenerated.
Updated integration test code to include an annotated enum
Updated yaml test code to remove now superfluous convert logic and use
annotated enums instead
Fixes #38