dataset serialize

DataSet Serialize para Delphi e Lazarus (FPC)

O conjunto de dados serializa é um conjunto de recursos para tornar o trabalho com JSON e o conjunto de dados simples. Possui recursos como exportar ou importar registros para um conjunto de dados, validar se o JSON tiver todos os atributos necessários (anteriormente inseridos no conjunto de dados), exportando ou importando a estrutura dos campos de conjunto de dados no formato JSON. Além de gerenciar o JSON aninhado por meio de detalhes mestres ou usar o TDatasetfield (você escolhe a maneira como melhor lhe convém). Tudo isso usando ajudantes de classe, o que o torna ainda mais simples e fácil de usar.

Pré -requisitos para Delphi

• [Optional] Para facilitar, recomendo o uso do chefe (Gerenciador de dependência da Delphi) para instalação, simplesmente executando o comando abaixo em um terminal (Windows PowerShell, por exemplo):

 boss install github.com/viniciussanchez/dataset-serialize

Instalação manual para Delphi

Se você optar por instalar manualmente, basta adicionar as seguintes pastas ao seu projeto, em Projeto> Opções> Construindo> Delphi Compiler> Caminho de pesquisa

 ../dataset-serialize/src

Começando

Todos os recursos oferecidos pela DataSet Serialize estão localizados no auxiliar de classe no conjunto de dados da unidade.Serialize. Para iniciar seu projeto, basta adicionar sua referência onde sua funcionalidade é necessária. Aqui está um exemplo:

 uses DataSet.Serialize;

Agora vamos olhar para cada recurso, suas regras e peculiaridades, para oferecer o melhor para todos os usuários.

Conjunto de dados para JSON

Criar um objeto JSON com informações de um registro do conjunto de dados parece uma tarefa muito simples. Mas essa tarefa ficou mais fácil. O conjunto de dados serializa tem duas funções para isso, a saber, TojsonObject e TojsonArray. Vejamos o uso das funções:

 var
  LJSONArray: TJSONArray;
  LJSONObject: TJSONObject;  
begin
  LJSONObject := qrySamples.ToJSONObject(); // export a single record
  LJSONArray := qrySamples.ToJSONArray(); // export all records 
end ;

Qual é a diferença entre as duas funções? O TojsonObject apenas converterá o registro do conjunto de dados atual em um TJsonObject. TojsonArray será convertido em um TJSONArray todos os registros do conjunto de dados e não apenas o registro selecionado.

Parâmetros

• AChildRecords - indica se deve ou não exportar registros infantis (por meio de detalhes mestre ou TDatasetfield).
• AOnlyUpdatedRecords - indica se deve exportar apenas registros que foram modificados (registros adicionados, alterados ou excluídos). Esse recurso está disponível apenas ao usar o FIREDAC. A propriedade CacheDupdates deve ser verdadeira;

TojsonObject

• Se o conjunto de dados estiver vazio ou não, um objeto JSON em branco ( {} ) será retornado;
• O campo que não possui a propriedade visível (verdadeira) será ignorada.
• O nome do atributo no JSON sempre será o nome do campo em minúsculas, mesmo que o nome do campo esteja no caso superior;
• Se o campo é do tipo Tdatasetfield, um JSON aninhado é gerado (JsonObject se for apenas um registro infantil, ou JsonArray, se for mais de um). A maneira mais adequada para esse tipo de situação é criar um detalhe mestre;
• Todos os registros infantis serão exportados como um JsonArray;
• Ao usar o parâmetro AonlyUpdatedRecords do método TojsonObject ou TojsonArray, o item JSON é adicionado a uma propriedade "object_state" responsável por definir o que aconteceu com o registro (excluído, incluído ou alterado);
• Quando uma matriz JSON é criada para representar um JSON aninhado usando detalhes mestre, o nome do conjunto de dados será o nome do atributo JSON gerado. Existe uma regra em que, se o nome do conjunto de dados começar com Qry (consulta) ou MT (Memtable), essas iniciais serão ignoradas, deixando apenas o restante como o nome do atributo no JSON.

TojsonArray

• Se o conjunto de dados estiver vazio ou não, uma matriz JSON em branco ( [] ) será retornada;
• Segue as mesmas regras que TojsonObject;

Salvar e carregar estrutura

Um recurso não muito útil, mas importante, é o SAVESTRUCTURTURA e a estrutura de carga. Como o nome já disse, é possível salvar toda a estrutura dos campos configurados no conjunto de dados e também carregar uma estrutura no formato JSON. Aqui está um exemplo de como carregar e exportar campos de conjunto de dados:

 var
  LJSONArray: TJSONArray;
begin
  LJSONArray := qrySamples.SaveStructure;
  qrySamples.LoadStructure(LJSONArray, True);
end ;

As seguintes propriedades são controladas:

Alignment, FieldName, DisplayLabel, DataType, Size, Key, Origin, Required, Visible, ReadOnly, and AutoGenerateValue ;

Parâmetros

• AOwns - indica quem é responsável por destruir o JSON aprovado como um parâmetro.

SAVESTUTURE

• Se a contagem de campos do conjunto de dados for igual a zero, uma matriz JSON em branco ( [] ) será retornada;

Estrutura de carga

• O conjunto de dados não pode ser ativado e não deve ter campos definidos;

Validar JSON

A função validatejson é muito útil quando queremos validar em um servidor, por exemplo, se o JSON que recebemos na solicitação tiver todas as informações necessárias. Praticamente, todos os campos do conjunto de dados são atravessados, verificando se os campos necessários foram inseridos no JSON. Se o campo for necessário e não tiver sido inserido no JSON, ele será adicionado à matriz JSON devolvida pela função. Veja o exemplo abaixo:

 begin
  LJSONArray := qrySamples.ValidateJSON( ' {"country":"Brazil"} ' );
end ;

Ao receber {"country": "Brazil"} , assumindo que nosso conjunto de dados possui 3 campos (ID, First_Name, Country), e o campo ID e First_Name são necessários, o seguinte será devolvido:

 [{"field":"id","error":"Id not informed"},{"field":"firstName","error":"Name not informed"}]

Parâmetros

• ALang - Responsável por alterar o idioma usado na montagem de mensagens (o padrão é inglês);
• AOwns - indica quem é responsável por destruir o JSON aprovado como um parâmetro;

Validatejson

• Se JSON não for atribuído ou a contagem de campos é igual a zero, uma exceção será levantada.
• O idioma padrão das mensagens é o inglês;
• Mesmo que todos os campos necessários sejam inseridos, uma matriz JSON vazia ( [] ) é retornada;
• Um campo necessário deve ter sua propriedade necessária igual a verdadeiro.
• A propriedade DisplayLabel pode ser usada para personalizar a mensagem;

Carga de JSON

O DataSet Serializa permite carregar um conjunto de dados com um JsonObject, JsonArray e até um JSON aninhado, todos resumidos em um método: loadfromjson (). Aqui está um exemplo de como usá -lo:

 begin
  qrySamples.LoadFromJSON( ' {"firstName":"Vinicius Sanchez","country":"Brazil"} ' );
end ;

Parâmetros

• AOwns - indica quem é responsável por destruir o JSON aprovado como um parâmetro;

LoadFromjson

• Se o JSON ou o conjunto de dados não tiver sido atribuído, nada será feito;
• Se o conjunto de dados não for ativado e não for uma classe tfdmemtable, nada será feito;
• Se o conjunto de dados for do tipo tfdmemtable, ele não estiver ativo e a contagem de campos é igual a zero, os campos serão criados de acordo com a necessidade JSON. O tipo de dados será igual a ftstring e tamanho igual a 4096;
• Quando a propriedade "object_state" está em JSON, as seguintes validações são feitas:
  • Se igual ao inserido, um anexo é realizado no conjunto de dados;
  • Se for modificado ou excluído, uma localização será feita no conjunto de dados para encontrar o registro a ser manipulado. Se o registro não for encontrado, nada será feito. Para executar o Locate, uma busca por campos -chave é feita no JSON;
  • Se modificado é igual ao método de edição do conjunto de dados;
  • Se excluído é igual ao método de exclusão do conjunto de dados;
• Se a propriedade "object_state" não for encontrada no JSON, o método Apênd é chamado;
• Ao carregar um conjunto de dados com JSON, os campos que são rerontados ou visíveis (falsos) são ignorados;
• Se um atributo não for encontrado no JSON com o nome do campo (não sensível ao caso), ou é Nullo, o campo será ignorado (nullo / vazio);
• Ao carregar um conjunto de dados com um JSON contendo JSON aninhado usando detalhes mestre, por convenção, o nome do conjunto de dados infantil deve ser o mesmo que o nome do atributo json que representa a lista de crianças a serem carregadas. O nome do conjunto de dados infantil ainda pode ter as iniciais QRY (consulta) ou MT (memorável), pois estes serão ignorados;

Merge de JSON

Com o conjunto de dados serializando, você ainda pode alterar o registro do conjunto de dados simplesmente usando o MergeFromjsonObject. A função é semelhante ao loadfromjson. Um exemplo de uso é para servidores REST quando o verbo usado na solicitação é colocado (não necessariamente), neste caso, não queremos incluir um novo registro, mas alterar o registro atual.

 begin
  qrySamples.MergeFromJSONObject( ' {"firstName":"Vinicius","country":"United States"} ' );
end ;

Parâmetros

• AOwns - indica quem é responsável por destruir o JSON aprovado como um parâmetro;

MergeFromjsonObject

• O mesmo que o LoadFromjson Vallações;

Configurações

Você pode personalizar alguns recursos do DataSet-Serialize:

• A entrada de data é UTC (fuso horário)

TDataSetSerializeConfig.GetInstance.DateInputIsUTC := True;

• Exportar valores nulos

  TDataSetSerializeConfig.GetInstance. Export .ExportNullValues := True;

• Tenta converter uma string em json quando a string começa com {ou [

  TDataSetSerializeConfig.GetInstance. Export .TryConvertStringToJson := True;

• Exportar apenas campos visíveis

  TDataSetSerializeConfig.GetInstance. Export .ExportOnlyFieldsVisible := True;

• Exportar o conjunto de dados Child como objeto JSON (quando você tem apenas 1 registro)

  TDataSetSerializeConfig.GetInstance. Export .ExportChildDataSetAsJsonObject := False;

• Exportar LargeInt como string

  TDataSetSerializeConfig.GetInstance. Export .ExportLargeIntAsString := False;

• Exportar BCD como flutuação

  TDataSetSerializeConfig.GetInstance. Export .ExportBCDAsFloat := False;

• Importar apenas campos visíveis

  TDataSetSerializeConfig.GetInstance. Import .ImportOnlyFieldsVisible := True;

• Base64 decodificar campos de blob na importação

  TDataSetSerializeConfig.GetInstance. Import .DecodeBase64BlobField := True;

• Remova o espaço em branco no nome do campo

  TDataSetSerializeConfig.GetInstance.RemoveBlankSpaceFieldName := True; // default

• Definição do nome do caso

  // cndNone, cndLower, cndUpper, cndLowerCamelCase, cndUpperCamelCase
  TDataSetSerializeConfig.GetInstance.CaseNameDefinition := TCaseNameDefinition.cndLowerCamelCase;
  
  TCaseNameDefinition.cndNone:
  [ { "MOB_ICADASTRO":11795,"MOB_EMI_REG":6,"CODIGODOCLIENTE":1,"CDOCUMEN1":"999999" } ]
  
  TCaseNameDefinition.cndLower:
  [ { "mob_icadastro":11795,"mob_emi_reg":6,"codigodocliente":1,"cdocumen1":"999999" } ]

  TCaseNameDefinition.cndUpper:
  [ { "MOB_ICADASTRO":11795,"MOB_EMI_REG":6,"CODIGODOCLIENTE":1,"CDOCUMEN1":"999999" } ]

  TCaseNameDefinition.cndLowerCamelCase:
  [ { "mobIcadastro":11795,"mobEmiReg":6,"codigodocliente":1,"cdocumen1":"999999" } ]

  TCaseNameDefinition.cndUpperCamelCase:
  [ { "MobIcadastro":11795,"MobEmiReg":6,"Codigodocliente":1,"Cdocumen1":"999999" } ]  

• Data de formato (para o tipo de campo de exportação é igual a ftdate)

  TDataSetSerializeConfig.GetInstance. Export .FormatDate := ' YYYY-MM-DD ' ;

• Moeda de formato (para o tipo de campo de exportação é igual a ftcurrency)

  TDataSetSerializeConfig.GetInstance. Export .FormatCurrency := ' 0.00## ' ;

• Formato Float (para o tipo de campo de exportação é igual a ftfloat)

  TDataSetSerializeConfig.GetInstance. Export .FormatFloat := ' ,0.00 ' ;

• Defina prefixos de dados

  TDataSetSerializeConfig.GetInstance.DataSetPrefix := [ ' mt ' , ' qry ' ];

Amostras

Confira nosso projeto de amostra para cada situação apresentada acima em operação. Se você tiver alguma dúvida ou sugestão, entre em contato, faça sua solicitação de tração ou crie um problema.

Contribuintes de código

Licença

DataSet-Serialize é um software gratuito e de código aberto licenciado sob a licença do MIT.

Sozinho nós vamos mais rápido. Juntos, vamos mais longe.