[jsonSerializer] more accesible serializer options

Author: exilon

Quick.Json.Serializer.pas

@@ -7,7 +7,7 @@
   Author      : Kike Pérez
   Version     : 1.12
   Created     : 21/05/2018
-  Modified    : 18/02/2022
+  Modified    : 17/05/2022
 
   This file is part of QuickLib: https://github.com/exilon/QuickLib
 
@@ -86,6 +86,8 @@   TCommentProperty = class(TCustomAttribute)
     property Comment : string read fComment;
   end;
 
+  TSerializerOptions = Quick.Serializer.Intf.TSerializerOptions;
+
   TCustomNameProperty = class(TCustomAttribute)
   private
     fName : string;
@@ -130,6 +132,9 @@   TRTTIJson = class
     fUseJsonCaseSense : Boolean;
     fUseBase64Stream : Boolean;
     fUseNullStringsAsEmpty : Boolean;
+    fUseGUIDWithBrackets : Boolean;
+    fUseGUIDLowercase : Boolean;
+    fOptions : TSerializerOptions;
     function GetValue(aAddr: Pointer; aType: TRTTIType): TValue; overload;
     {$IFDEF FPC}
     function GetValue(aAddr: Pointer; aTypeInfo: PTypeInfo): TValue; overload;
@@ -151,12 +156,17 @@   TRTTIJson = class
     function CreateInstance(aClass: TClass): TValue; overload;
     function CreateInstance(aType: TRttiType): TValue; overload;
     {$ENDIF}
+    function GUIDToStringFormated(const aGUID : TGUID) : string;
   public
     constructor Create(aSerializeLevel : TSerializeLevel; aUseEnumNames : Boolean = True);
+    destructor Destroy; override;
     property UseEnumNames : Boolean read fUseEnumNames write fUseEnumNames;
     property UseJsonCaseSense : Boolean read fUseJsonCaseSense write fUseJsonCaseSense;
     property UseBase64Stream : Boolean read fUseBase64Stream write fUseBase64Stream;
     property UseNullStringsAsEmpty : Boolean read fUseNullStringsAsEmpty write fUseNullStringsAsEmpty;
+    property UseGUIDWithBrackets : Boolean read fUseGUIDWithBrackets write fUseGUIDWithBrackets;
+    property UseGUIDLowercase : Boolean read fUseGUIDLowercase write fUseGUIDLowercase;
+    property Options : TSerializerOptions read fOptions write fOptions;
     function GetJsonPairValueByName(aJson : TJSONObject; const aName : string) : TJsonValue;
     function GetJsonPairByName(aJson : TJSONObject; const aName : string) : TJSONPair;
     function IsGenericList(aObject : TObject) : Boolean;
@@ -197,6 +207,8 @@   TJsonSerializer = class(TInterfacedObject,IJsonSerializer)
     fUseJsonCaseSense : Boolean;
     fUseBase64Stream : Boolean;
     fUseNullStringsAsEmpty : Boolean;
+    fUseGUIDWithBrackets: Boolean;
+    fUseGUIDLowercase: Boolean;
     fRTTIJson : TRTTIJson;
   private
     procedure SetUseEnumNames(const Value: Boolean);
@@ -205,6 +217,8 @@   TJsonSerializer = class(TInterfacedObject,IJsonSerializer)
     procedure SetUseBase64Stream(const Value: Boolean);
     //Only Delphi -> Workaround, use this when something passes : {Test : "Null"} but we expect : {Test : ""}
     procedure SetUseNullStringsAsEmpty(const Value : Boolean);
+    procedure SetUseGUIDLowerCase(const Value: Boolean);
+    procedure SetUseGUIDWithBrackets(const Value: Boolean);
   public
     constructor Create(aSerializeLevel: TSerializeLevel; aUseEnumNames : Boolean = True; aUseNullStringsAsEmpty : Boolean = False);
     destructor Destroy; override;
@@ -213,6 +227,8 @@   TJsonSerializer = class(TInterfacedObject,IJsonSerializer)
     property UseJsonCaseSense : Boolean read fUseJsonCaseSense write SetUseJsonCaseSense;
     property UseBase64Stream : Boolean read fUseBase64Stream write SetUseBase64Stream;
     property UseNullStringsAsEmpty : Boolean read fUseNullStringsAsEmpty write SetUseNullStringsAsEmpty;
+    property UseGUIDWithBrackets : Boolean read fUseGUIDWithBrackets write SetUseGUIDWithBrackets;
+    property UseGUIDLowerCase : Boolean read fUseGUIDLowercase write SetUseGUIDLowerCase;
     function JsonToObject(aType : TClass; const aJson: string) : TObject; overload;
     function JsonToObject(aObject : TObject; const aJson: string) : TObject; overload;
     function JsonStreamToObject(aObject : TObject; aJsonStream : TStream) : TObject;
@@ -227,6 +243,7 @@   TJsonSerializer = class(TInterfacedObject,IJsonSerializer)
     function JsonToArray<T>(const aJson : string) : TArray<T>;
     function JsonToValue(const aJson: string): TValue;
     {$ENDIF}
+    function Options : TSerializerOptions;
   end;
 
   EJsonSerializerError = class(Exception);
@@ -458,7 +475,7 @@ function TRTTIJson.DeserializeStream(aObject: TObject; const aJson: TJSONValue):
 var
  stream : TStringStream;
 begin
-  if fUseBase64Stream then stream := TStringStream.Create(Base64Decode(aJson.Value),TEncoding.Ansi)
+  if fOptions.UseBase64Stream then stream := TStringStream.Create(Base64Decode(aJson.Value),TEncoding.Ansi)
     else stream := TStringStream.Create({$IFNDEF FPC}aJson.Value{$ELSE}string(aJson.Value){$ENDIF},TEncoding.Ansi);
   try
     TStream(aObject).CopyFrom(stream,stream.Size);
@@ -470,10 +487,24 @@ function TRTTIJson.DeserializeStream(aObject: TObject; const aJson: TJSONValue):
 
 constructor TRTTIJson.Create(aSerializeLevel : TSerializeLevel; aUseEnumNames : Boolean = True);
 begin
+  fOptions := TSerializerOptions.Create;
   fSerializeLevel := aSerializeLevel;
   fUseEnumNames := aUseEnumNames;
   fUseJsonCaseSense := False;
   fUseBase64Stream := True;
+  fUseGUIDWithBrackets := False;
+  fUseGUIDLowerCase := True;
+  fOptions.UseEnumNames := aUseEnumNames;
+  fOptions.UseJsonCaseSense := False;
+  fOptions.UseBase64Stream := True;
+  fOptions.UseGUIDLowercase := False;
+  fOptions.UseGUIDLowercase := True;
+end;
+
+destructor TRTTIJson.Destroy;
+begin
+  fOptions.Free;
+  inherited;
 end;
 
 {$IFNDEF FPC}
@@ -721,6 +752,7 @@ procedure TRTTIJson.DeserializeXArray(Instance : TObject; aRecord : TValue; aPro
   if not rValue.IsEmpty then rField.SetValue(aRecord.GetReferenceToRawData,rValue);
   aProperty.SetValue(Instance,aRecord);
 end;
+
 {$ENDIF}
 
 function StringToGUIDEx(const aGUID : string) : TGUID;
@@ -729,6 +761,13 @@ function StringToGUIDEx(const aGUID : string) : TGUID;
     else Result := System.SysUtils.StringToGUID(aGUID);
 end;
 
+function TRTTIJson.GUIDToStringFormated(const aGUID : TGUID) : string;
+begin
+  if fOptions.UseGUIDWithBrackets then Result := System.SysUtils.GUIDToString(aGUID)
+    else Result := GetSubString(System.SysUtils.GUIDToString(aGUID),'{','}');
+  if fOptions.UseGUIDLowercase then Result := Result.ToLower;
+end;
+
 function TRTTIJson.DeserializeProperty(aObject : TObject; const aName : string; aProperty : TRttiProperty; const aJson : TJSONObject) : TObject;
 var
   rValue : TValue;
@@ -855,7 +894,7 @@ function TRTTIJson.DeserializeType(aObject : TObject; aType : TTypeKind; aTypeIn
     case aType of
       tkString, tkLString, tkWString, tkUString :
         begin
-          if fUseNullStringsAsEmpty and (CompareText(value, 'null') = 0) then
+          if fOptions.UseNullStringsAsEmpty and (CompareText(value, 'null') = 0) then
             Result := ''
           else
             Result := value;
@@ -1060,7 +1099,7 @@ function TRTTIJson.GetJsonPairValueByName(aJson: TJSONObject; const aName: strin
   candidate : TJSONPair;
   i : Integer;
 begin
-  if fUseJsonCaseSense then
+  if fOptions.UseJsonCaseSense then
   begin
     Result := aJson.GetValue(aName);
     Exit;
@@ -1081,7 +1120,7 @@ function TRTTIJson.GetJsonPairByName(aJson: TJSONObject; const aName: string): T
 var
   i : Integer;
 begin
-  if fUseJsonCaseSense then
+  if fOptions.UseJsonCaseSense then
   begin
     Result := TJSONPair(aJson.GetValue(aName));
     Exit;
@@ -1478,7 +1517,7 @@ function TRTTIJson.SerializeStream(aObject: TObject): TJSONValue;
   Result := nil;
   try
      stream := TStream(aObject);
-    if fUseBase64Stream then Result := TJSONString.Create(Base64Encode(StreamToString(stream,TEncoding.Ansi)))
+    if fOptions.UseBase64Stream then Result := TJSONString.Create(Base64Encode(StreamToString(stream,TEncoding.Ansi)))
       else Result := TJSONString.Create(StreamToString(stream,TEncoding.Ansi));
   except
     on E : Exception do
@@ -1542,7 +1581,7 @@ function TRTTIJson.SerializeRecord(const aValue : TValue) : TJSONValue;
     rRec := ctx.GetType(aValue.TypeInfo).AsRecord;
     if aValue.TypeInfo = System.TypeInfo(TGUID) then
     begin
-      Result := TJSONString.Create(GUIDToString(aValue.AsType<TGUID>));
+      Result := TJSONString.Create(GUIDToStringFormated(aValue.AsType<TGUID>));
     end
     else
     begin
@@ -1722,9 +1761,9 @@ constructor TJsonSerializer.Create(aSerializeLevel: TSerializeLevel; aUseEnumNam
   fUseBase64Stream := True;
   fUseNullStringsAsEmpty := aUseNullStringsAsEmpty;
   fRTTIJson := TRTTIJson.Create(aSerializeLevel,aUseEnumNames);
-  fRTTIJson.UseJsonCaseSense := fUseJsonCaseSense;
-  fRTTIJson.UseBase64Stream := fUseBase64Stream;
-  fRTTIJson.UseNullStringsAsEmpty := fUseNullStringsAsEmpty;
+  fRTTIJson.Options.UseJsonCaseSense := fUseJsonCaseSense;
+  fRTTIJson.Options.UseBase64Stream := fUseBase64Stream;
+  fRTTIJson.Options.UseNullStringsAsEmpty := fUseNullStringsAsEmpty;
 end;
 
 destructor TJsonSerializer.Destroy;
@@ -1852,6 +1891,11 @@ function TJsonSerializer.ObjectToJsonString(aObject : TObject; aIndent : Boolean
   end;
 end;
 
+function TJsonSerializer.Options: TSerializerOptions;
+begin
+  Result := fRTTIJson.Options;
+end;
+
 function TJsonSerializer.ValueToJson(const aValue: TValue; aIndent: Boolean): string;
 var
   json: TJSONValue;
@@ -1995,25 +2039,37 @@ procedure TJsonSerializer.SetSerializeLevel(const Value: TSerializeLevel);
 procedure TJsonSerializer.SetUseBase64Stream(const Value: Boolean);
 begin
   fUseBase64Stream := Value;
-  if Assigned(fRTTIJson) then fRTTIJson.UseBase64Stream := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseBase64Stream := Value;
 end;
 
 procedure TJsonSerializer.SetUseEnumNames(const Value: Boolean);
 begin
   fUseEnumNames := Value;
-  if Assigned(fRTTIJson) then fRTTIJson.UseEnumNames := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseEnumNames := Value;
+end;
+
+procedure TJsonSerializer.SetUseGUIDLowerCase(const Value: Boolean);
+begin
+  fUseGUIDLowercase := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseGUIDLowerCase := Value;
+end;
+
+procedure TJsonSerializer.SetUseGUIDWithBrackets(const Value: Boolean);
+begin
+  fUseGUIDWithBrackets := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseGUIDWithBrackets := Value;
 end;
 
 procedure TJsonSerializer.SetUseJsonCaseSense(const Value: Boolean);
 begin
-  fUseJsonCaseSense := Value;
-  if Assigned(fRTTIJson) then fRTTIJson.UseJsonCaseSense := Value;
+  fRTTIJson.Options.UseJsonCaseSense := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseJsonCaseSense := Value;
 end;
 
 procedure TJsonSerializer.SetUseNullStringsAsEmpty(const Value: Boolean);
 begin
   fUseNullStringsAsEmpty := Value;
-  if Assigned(fRTTIJson) then fRTTIJson.fUseNullStringsAsEmpty := Value;
+  if Assigned(fRTTIJson) then fRTTIJson.Options.UseNullStringsAsEmpty := Value;
 end;
 
 {$IFNDEF FPC}

Quick.Serializer.Intf.pas

@@ -12,12 +12,30 @@ interface
   {$ENDIF}
 
 type
+  TSerializerOptions = class
+  private
+    fUseEnumNames : Boolean;
+    fUseJsonCaseSense : Boolean;
+    fUseBase64Stream : Boolean;
+    fUseNullStringsAsEmpty : Boolean;
+    fUseGUIDWithBrackets: Boolean;
+    fUseGUIDLowercase: Boolean;
+  public
+    property UseEnumNames : Boolean read fUseEnumNames write fUseEnumNames;
+    property UseJsonCaseSense : Boolean read fUseJsonCaseSense write fUseJsonCaseSense;
+    property UseBase64Stream : Boolean read fUseBase64Stream write fUseBase64Stream;
+    property UseNullStringsAsEmpty : Boolean read fUseNullStringsAsEmpty write fUseNullStringsAsEmpty;
+    property UseGUIDWithBrackets : Boolean read fUseGUIDWithBrackets write fUseGUIDWithBrackets;
+    property UseGUIDLowercase : Boolean read fUseGUIDLowercase write fUseGUIDLowercase;
+  end;
+
   ISerializer = interface
   ['{CA26F7AE-F1FE-41BE-9C23-723A687F60D1}']
     function JsonToObject(aType: TClass; const aJson: string): TObject; overload;
     function JsonToObject(aObject: TObject; const aJson: string): TObject; overload;
     function ObjectToJson(aObject : TObject; aIndent : Boolean = False): string;
     function ValueToJson(const aValue : TValue; aIndent : Boolean = False) : string;
+    function Options : TSerializerOptions;
   end;
 
 implementation