Conforme nossos softwares vai ficando mais complexo, e conforme vamos isolando a camada de domínio da camada de apresentação e das APIs vai surgindo a necessidade de se criar muitas classes, a maioria anêmica, com o objetivo apenas de se transitar dados entre as camadas.
Isso acaba gerando uma explosão de DTOs, ViewModels e até de tuples com o objetivo de combinar ou agrupar diferentes combinações de propriedades e levar os dados entre as camadas da aplicação.
Isso pode ser consequencia dos bad smells Primitive Obsession e de não se aplicar o princípio do Tell-Don't-Ask mas não vamos entrar nesse mérito, o objetivo é criar um tipo de objeto que possa ser usado dinamicamente mas com alguns benefícios da tipagem estática, para que você possa usar no seu projeto mesmo que ele seja uma baderna, eu não julgo. Na verdade quero é favorecer a baderna.
A idéia é que qualquer objeto deveria poder ser usado como Bag igual o ViewBag do Razor.
O .net framework tem uma série de classes para lidar com isso:
Quero retornar dos meus métodos e apis objetos de domínio, objetos anônimos e projeções (selects feitos com linq) sem me importar com que tipo de objetos que são.
Dado um objeto do meu domínio quero adicionar propriedades a ele que são transitórias / importantes para apenas uma etapa do processo (um timestamp, marcador de usuário, propriedade customizada, marcador de novo, o que for necessário)
Dado um objeto anônimo / projeção quero adicionar propriedades transitórias a ele assim como no cenário 2.
Poder converter para JSON ou de JSON corretamente.
Basicamente queremos misturar os benefícios de DynamicObject com ExpandoObject
Quero retornar para minhas actions ou serializar em Json objetos vujo tipo eu não conheço e acessar suas propriedades e métodos.
use dynamic, comporta qualquer tipo e você pode passar pra lá e pra cá na sua aplicação e serializar para JSON.
Soluciona apenas o cenário 1 e 4, mas não o 2 e 3.
Mas ...
com dynamic eu não posso adicionar novas propriedades e métodos igual o fazemos em linguagens dinâmicas tipo javascript. Quero ser capaz de adicionar propriedades dinamicamente que sejam usadas só em um determinado momento do processo.
Use ExpandoObject, você pode adicionar propriedades e métodos na hora e trabalhar com ele quase como se fosse um objeto javascript.
Soluciona parcialmente apenas o cenário 3, ExpandoObject nunca vai ser um objeto do seu domínio. Mesmo que você adicione todas as propriedades a ele, os métodos não serão adicionados.
E para projeções, você precisa criar o new ExpandoObject e adicionar cada uma das propriedades.
Mas ...
O ExpandoObject não me atende completamente. Eu não posso usar como objeto de domínio, ele é sealed, não posso criar um descendente dele, e tem a necessidade de copiar todas as propriedades (do domínio e da projeção), eu não aproveito as propriedades que eu já tinha, tenho que passar cada uma delas, e é fracamente tipado, não há nenhuma assistência de código da parte da IDE.
Outro problema é que o ExpandoObject é serializado para javascript como se fosse um dictionary ou collection de KeyValuePair.
Para serializar corretamente em Json é necessário usar o Newtonsoft.JSON ou criar um converter customizado.
Existe um objeto no C# chamado DynamicObject que não pode ser instanciado (deve ser herdado) e que tem suporte a propriedades declaradas e pode ser associada a um dicionário para suportar propriedades dinâmicas como o ExpandoObject e mesmo assim ser uma classe do seu domínio com métodos e propriedades declarados.
Parece atender bem os cenários 1, 2 e 4, o cenário 3 não
Mas ...
Não pode ser usado como Dictionary, não expõe seu dictionary interno, não se pode iterar pelas propriedades ou acessar as propriedades via reflection. Ele traz as propriedades declaradas e esquece das dinâmicas.
Necessidade de implementar GetDynamicMemberNames() juntando as propriedades declaradas com as dinâmicas caso contrário ele não serializa corretamente, não encontra essas propriedades.
Pra que simplificar se podemos complicar? Vamos criar uma classe chamada BaseElasticObject derivada de DynamicObject mas que também se comporte como ExpandoObject, suporte JSON e possa ser usada como DomainModel/EntityModel, inclusive com suporte a EF (e outros ORM's) e com suporte a bancos nosql como LiteDb e MongoDb
- Criar uma classe chamada BaseElasticObject que implemente todas as interfaces de
DynamicObject e ExpandoObject e que possa atuar como as duas,
funcionando como um ExpandoObject não sealed e com suporte a herança e que possa favorecer:
- Flexibilidade de uso igual linguagens dinâmicas / fracamente tipadas como Javascript, mas com suporte de algumas das vantagens de tipagem estática/forte
- Eliminar a necessidade de se criar tantos ViewModels diferentes com combinações diferentes de propriedades do meu domínio
- Eliminar a necessidade de se criar tantos DTOs diferentes para movimentar os dados entre as camadas
- Simplificar a sintaxe
- Ter verificações de tipo forte / estático e assistência de código da IDE quando não estiver sendo usado como dinâmico
- Ter possibilidade de adicionar propriedades como se fosse um objeto dinâmico
- suporte tanto propriedades declaradas para termos a verificação de tipo em design time quanto acessar propriedades dinâmicas em runtime. O objeto precisa parecer dinâmico mas também funcionar como um objeto estaticamente/fortemente tipado do seu domínio e suportar herança
- ser conversível para dynamic ou de volta de dynamic pra ela
- Os métodos que implementam a interface IDictionary, o GetDynamicMemberNames() e os métodos que implementam IEnumerable devem usar as propriedades contidas no dicionário mescladas com as propriedades declaradas, levando-as em conta
- Suporte a conversão para Json gerando um objeto json "de verdade" e não um dictionary ou vetor de key / value
- Poder ser usado como Bag ou Dictionary
- Apoiar o uso fácil de apis, objetos dinâmicos, COM interop, serializar a partir de um objeto JSON deve gerar um objeto válido, e suportar propriedades que ele não tinha e foram adicionadas no JSON
- Funcionar com EF inclusive mapear propriedades que não foram declaradas
- Funcionar com MongoDb e LiteDb
- adicionar item existente (VIA INTERFACE IDICTIONARY) deveria disparar exception?
- mudar via reflection valor de propriedade readonly deveria disparar exception ?
- remove deveria fazer o que com propriedades do proprio objeto? Limpar e voltar para o valor default?
- add do dictionary deveria setar variavel estática de igual valor (para não ter diferença entre o valor armazenado no tictionary e o armazenado na property declarada)
- acessar uma propriedade não definida estaticamente (declarada) e não definida dinamicamente deveria retornar null ou disparar uma exception ? (isso mudaria o roadmap com relação aos testes em que tem que passar/falhar)
- Deveria ter alguma propriedade imutável ? Um Identificador Universal ?
- Deveria implementar os overrides de ToString / Equals / GetHashCode ? GetHashCode deveria se basear em qual propriedade para gerar o hash ? Ou no serializado total?
- Expor o cenário geral e os cenários 1, 2 e 3 na forma de casos de uso e estórias de usuário
- O BaseElasticObject deve se comportar como qualquer outro objeto da linguagem C# com suporte a herança e polimorfismo E ainda suportar tudo o que o ExpandoObject suportar
- O BaseElasticObject em um primeiro momento deve passar em todos os testes unitários que o ExpandoObject passaria E que um objeto do seu domínio passaria
- O BaseElasticObject deve passar em todos os testes unitários que um DynamicObject passaria
- O BaseElasticObject deve implementar as mesmas interfaces que o ExpandoObject e que o DynamicObject
- O BaseElasticObject deve passar nos mesmos testes que o ExpandoObject e que o DynamicObject passariam visando-se as interfaces ICollection<KeyValuePair<string,object>>, IDictionary<string,object> e IEnumerable
- Criar testes unitários que explorem e mostrem possiveis falhas em todos os métodos sobrecarregados / overrides de DynamicObject exceto os já implementados TryGetMember, TrySetMember e TryInvokeMember
- Criar o xmldoc dos métodos
- Criar suporte a GetHashCode / Equals / ToString()
- Implementar algo que suporte completamente o cenário 3, talvez um helper ou extension method ?
- Fazer testes com MongoDb e LiteDb
- Fazer testes comparativos entre dynamic, ExpandoObject, implementação básica de DynamicObject, BaseElasticObject
- Testar com .net core
- Implementar um objeto chamadao CasaDaMaeJoana onde pode tudo: que possa adicionar valores pela interface de dictionary sem disparar exception / obter valores inexistentes retornando null sem disparar exception e setar valores de propriedades readonly
O objetivo desse projeto é meramente didático. A quem ele se destina? Principalmente a mim, que estou aprendendo.
Não use em ambiente de produção, pois ele vai explodir a qualquer momento.
Ou melhor, use em ambiente de produção e me fale dos erros que encontrou, faça PR com suas soluções e testes que falharam, assim eu posso aprender com os seus erros.
Esse é meu primeiro projeto no GitHub com alguns testes unitários e com uma página de apresentação readme.md bonitinha, e é um projeto de uma classe só, basicamente. Por favor gostaria de críticas construtuvas quanto a essa apresentação e quanto aos testes unitários, se estão construídos corretamente.
Abaixo lista de links que eu pesquisei no Stack Overflow e outros sites que me ajudaram a chegar nessa solução:
- Adventures with C# 4.0 dynamic - ExpandoObject, ElasticObject, and a Twitter client in 10 minutes - Obrigado Anoop Pillai pelo seu código que eu e mais uns milhares de pessoas copiamos, foi da sua ideia que copiei o nome desta classe
- How can I make Json.NET serialize and deserialize declared properties of custom dynamic types that also implement IDictionary<string, object>?
- DynamicObject.GetDynamicMemberNames Method
- Serialize instance of a class deriving from DynamicObject class
- My own dynamic class usingIDynamicMetaObjectProvider Implementation? - parece que eu não fui o único a pensar nisso
- C# How to serialize (JSON, XML) normal properties on a class that inherits from DynamicObject
- Serialization Guide
- Working with the Dynamic Type in C#
- Dynamic in C# 4.0: Creating Wrappers with DynamicObject
- C# merge dictionary and other tricks
- Walkthrough: Creating and Using Dynamic Objects
- Como o ElasticObject pode ser um wrapper para um dynamic e resolver o Cenário 3
- Custom Dynamic Behavior using DynamicObject
- Using DynamicObject to Implement General Proxy Classes
Manja um objeto dynamic ? você pode colocar qualquer coisa na variável dynamic, mas depois só pode ler / gravar as propriedades que já existem, certo?
Se vc adicionar uma propriedade que não existe ele dá pau.
É bom pra trabalhar com saídas de métodos quando a saída é uma projeção ou objeto anônimo (Cenário3) mas você não pode criar uma propriedade do nada igual vc faz no javascript tipoobj.Pirlimpimpim = "laranja"isso estoura erro no dynamic mas tem uma classe especial pra isso, chamada ExpandoObject, que com ele você pode fazer
obj.Pirlimpimpim = "laranja"sem dar erro. Ele cria a propriedade Pirlimpimpim com o valor "laranja"
na hora como se sempre tivesse existido e não dá pau, igual vc faria no javascript, declara a propriedade na hora q vai usar (internamente ele guarda em um dictionary).Só que o objeto ExpandoObject é sealed/final, ele não pode ser herdado, ele não pode ter propriedades normais declaradas como um objeto normal (estaticamente tipadas como um new Pessoa() da vida) então estou tentando criar uma classe que junta a elasticidade do ExpandoObject com a versatilidade do dynamic pra ver o mundo pegar fogo.