Criando seu próprio framework de persistência Objeto-Relacional no Delphi XE

Veja neste artigo como criar um framework de persist�ncia em Delphi.

Para o desenvolvimento de softwares, atualmente, a arquitetura mais disseminada � a multicamadas. Geralmente divida em tr�s camadas: banco de dados, camada de neg�cios e interface (apresenta��o) (Figura 1).

O fator complicador nesse modelo de arquitetura est� no acesso aos dados que � realizada pela camada de neg�cios atrav�s do acesso nativo a camada de dados. Para minimizar esta situa��o, nos deparamos com a necessidade de intercalar nessas camadas uma camada de persist�ncia de dados (Figura 2).

**Figura 2**. Arquitetura multicamadas com camada de persist�ncia de dados

As opera��es b�sicas da camada de persist�ncia s�o conhecidas como opera��es de CRUD (Create, Retrieve (ou Read), Update e Delete). Assim sendo, a camada de persist�ncia deve realizar estas opera��es de forma transparente a aplica��o e conseq�entemente livrar a camada de neg�cios das preocupa��es relativas ao acesso a dados.

Portanto, o objetivo deste artigo � justamente mostrar como os desenvolvedores que trabalham com arquitetura multicamadas, podem criar o seu pr�prio framework de persist�ncia objeto-relacional em Delphi XE, levando suas aplica��es a um n�vel de abstra��o de dados necess�rio a produtividade do desenvolvimento.

Criando as Classes de Entidades

Quando se pensa em camada de persist�ncia primeiramente se pensa em criar as classes de entidades. E quem seriam estas classes? Seriam exatamente espelhos das entidades, ou tabelas, do esquema da base de dados usado na aplica��o. Para ilustrar a cria��o do framework de persist�ncia objeto-relacional, primeiramente ser� necess�rio criar uma tabela no Firebird (Listagem 1).

 
CREATE TABLE TB_CAD_ALUNO (
  MATRICULA   VARCHAR(10) NOT NULL,
  NOME_ALUNO  VARCHAR(100) NOT NULL,
  ENDERECO    VARCHAR(200),
  TELEFONE    VARCHAR(20),
  CPF         VARCHAR(11)
);
ALTER TABLE TB_CAD_ALUNO ADD CONSTRAINT TB_CAD_ALUNO_PK PRIMARY KEY (MATRICULA);

Listagem 1. Script de cria��o da tabela TB_CAD_ALUNO

Depois de criada a tabela, cria-se um novo projeto no Delphi XE para come�ar a implementar os artefatos necess�rios a camada de persist�ncia. Assim sendo:

Crie um novo projeto no Delphi XE do tipo VCL Forms Applications. Salve o projeto. Crie junto com os fontes deste projeto uma pasta chamada Framework. Esta ser� a pasta onde os fontes necess�rios ao Framework de persist�ncia ser�o arquivados, objeto de estudo deste artigo (Figura 3).

**Figura 3**. Exemplo da �rvore do projeto

Usa-se o conceito de RTTI (Run-time Type Information) [2] para criar as classes de entidades. Assim sendo, adicione uma nova Unit ao seu projeto e d� a ela o nome de TEntity.pas, salve-a dentro da pasta Framework e implemente-a de acordo com a Listagem 2. Esta classe ser� a classe gen�rica para qualquer classe de entidade presente em qualquer esquema de banco de dados.


unit TEntity;

interface

Uses RTTI;

type
  TGenericEntity = class(TObject)
  end;

implementation


end.

Listagem 2. TEntity.pas

Agora crie a classe de entidade referente � tabela TB_CAD_ALUNO (Listagem 1). Para tal crie uma nova Unit e salve-a dentro da pasta Framework como tblAluno.pas e implemente-a de acordo com a Listagem 3.


unit tblAluno;

interface

Uses  TEntity;

type
//nome da classe de entidade
  TAluno = class(TGenericEntity)
  private
    //colocar aqui todas as propriedades privadas da classe de acordo com
    //os campos da tabela
    FMatricula:string;
    FNomeAluno:string;
    FEndereco:string;
    FTelefone:string;
    FCPF:string;

  //colocar aqui todos os m�todos sets para cada uma das propriedades acima
    procedure setFMatricula(value:string);
    procedure setFNomeAluno(value:string);
    procedure setFEndereco(value:string);
    procedure setFTelefone(value:string);
    procedure setFCPF(value:string);

  public
    //colocar aqui todas as propriedades p�blicas de acesso aos objetos dessa
    //classe
    property Matricula: string read FMatricula write setFMatricula;

    property Nome:string read FNomeAluno write setFNomeAluno;

    property Endereco:string read FEndereco write setFEndereco;

    property Telefone:string read FTelefone write setFTelefone;

    property CPF:string read FCPF write setFCPF;

    function ToString:string; override;
end;

implementation

procedure TAluno.setFMatricula(value:string);
begin
  FMatricula:= value;
end;

procedure TAluno.setFNomeAluno(value:string);
begin
  FNomeAluno:= value;
end;

procedure TAluno.setFEndereco(value:string);
begin
  FEndereco:= value;
end;

procedure TAluno.setFTelefone(value:string);
begin
  FTelefone:= value;
end;

procedure TAluno.setFCPF(value:string);
begin
  FCPF:= value;
end;


function TAluno.toString;
begin
  result := '''' Matricula: ''''+ Matricula + '''' Nome: ''''+ Nome +
  '''' Endereco: '''' + Endereco +
  '''' Fone: '''' + Telefone + '''' CPF: '''' + CPF;
end;


end.

Listagem 3. TblAluno.pas

Agora � necess�rio customizar a classe TAluno usando conceitos de Custom Attributes [3]. O que ser� realizado � simplesmente colocar Custom Attributes para cada elemento da classe TAluno de forma que seja poss�vel tirar proveito deles atrav�s da RTTI e criar o DAO (Data Access Object).

Primeiro crie os Custom Attributes necess�rios para identificar dentro da classe de entidade a tabela do banco de dados e seus campos. Crie, portanto, uma nova Unit, chamada de CAtribEntity e salve-a dentro de Framework, implementando-a conforme a Listagem 4.


unit CAtribEntity;

interface

//atributo para determinar o nome da tabela na entidade a ser usada
type //nome da tabela
  TableName = class(TCustomAttribute)
  private
    FName: String;
  public
    constructor Create(aName: String);
    property Name: String read FName write FName;
  end;

type //determinar se o campo � um campo chave
  KeyField = class(TCustomAttribute)
  private
    FName: String;
  public
    constructor Create(aName: String);
    property Name: String read FName write FName;
  end;

type  //nome do campo na tabela
  FieldName = class(TCustomAttribute)
  private
    FName: String;
  public
    constructor Create(aName: String);
    property Name: String read FName write FName;
  end;


implementation

constructor TableName.Create(aName: String);
begin
  FName := aName
end;

constructor KeyField.Create(aName: String);
begin
  FName := aName;
end;

constructor FieldName.Create(aName: String);
begin
  FName := aName;
end;

end.

Listagem 4. CAtribEntity.pas

Depois customize a classe de entidade TAluno com os Custom Attributes necess�rios, alterando a implementa��o da classe conforme a Listagem 5. Dessa forma, tem-se neste exato momento o mapeamento objeto-relacional usando para isso os Custom Attributes.


unit tblAluno;

interface

Uses  TEntity,  CAtribEntity;

type
//nome da classe de entidade
  [TableName(''''TB_CAD_ALUNO'''')]
  TAluno = class(TGenericEntity)
  private
    //colocar aqui todas as propriedades privadas da classe de acordo com
    //os campos da tabela
    FMatricula:string;
    FNomeAluno:string;
    FEndereco:string;
    FTelefone:string;
    FCPF:string;

  //colocar aqui todos os m�todos sets para cada uma das propriedades acima
    procedure setFMatricula(value:string);
    procedure setFNomeAluno(value:string);
    procedure setFEndereco(value:string);
    procedure setFTelefone(value:string);
    procedure setFCPF(value:string);

  public
    //colocar aqui todas as propriedades p�blicas de acesso aos objetos dessa
    //classe
    [KeyField(''''MATRICULA'''')]
    [FieldName(''''MATRICULA'''')]
    property Matricula: string read FMatricula write setFMatricula;

    [FieldName(''''NOME_ALUNO'''')]
    property Nome:string read FNomeAluno write setFNomeAluno;

    [FieldName(''''ENDERECO'''')]
    property Endereco:string read FEndereco write setFEndereco;

    [FieldName(''''TELEFONE'''')]
    property Telefone:string read FTelefone write setFTelefone;

    [FieldName(''''CPF'''')]
    property CPF:string read FCPF write setFCPF;

    function ToString:string; override;
end;

implementation

procedure TAluno.setFMatricula(value:string);
begin
  FMatricula:= value;
end;

procedure TAluno.setFNomeAluno(value:string);
begin
  FNomeAluno:= value;
end;

procedure TAluno.setFEndereco(value:string);
begin
  FEndereco:= value;
end;

procedure TAluno.setFTelefone(value:string);
begin
  FTelefone:= value;
end;

procedure TAluno.setFCPF(value:string);
begin
  FCPF:= value;
end;


function TAluno.toString;
begin
  result := '''' Matricula: ''''+ Matricula + '''' Nome: ''''+ Nome 
  + '''' Endereco: '''' + Endereco +
            '''' Fone: '''' + Telefone + '''' CPF: '''' + CPF;
end;


end.

Listagem 5. tblAluno.pas � altera��o usando os Custom Attributes

Criando o DAO

DAO (Data Access Object) � um padr�o de desenvolvimento de softwares que trata da persist�ncia de objetos separando a camada de dados da camada de neg�cios [4]. Para entender melhor a implementa��o do DAO � necess�rio conhecer os conceitos de Generics [4, 5]. Este recurso nos permite trabalhar com uma estrutura gen�rica, o que faz muita diferen�a em linguagens fortemente tipada como o Delphi, podendo definir-se uma estrutura gen�rica customizada, ou melhor, tipada de acordo com a necessidade.

Primeiro crie um DataModule com o nome de srvModBaseDados e salve tamb�m dentro da pasta Framework. Este DataModule ser� respons�vel por fazer a interface entre a camada de dados e o DAO da camada de persist�ncia, ou seja, neste ponto j� se cria a primeira independ�ncia de projeto em rela��o ao SGBD utilizado. Coloque TDSServerModuleBaseDados na propriedade name do DataModule. Veja na Figura 4 os componentes visuais necess�rios ao DataModule.

**Figura 4**. Data Module: srvModBaseDados

Configure o componente TSQLConnection para acesso ao banco de dados criado neste artigo. E depois configure o Componente TSQLDataSet para o respectivo TSQLConnection do DataModule. Depois crie os m�todos necess�rios � conex�o com o banco e os m�todos necess�rios ao CRUD (Listagem 6).


unit srvModBaseDados;

interface

uses
  SysUtils, Classes, DBXFirebird, DBXPool, FMTBcd, DB, SqlExpr;

type
  TDSServerModuleBaseDados = class(TDataModule)
    LSCONEXAO: TSQLConnection;
    SQLDSServidor: TSQLDataSet;
  private
    { Private declarations }
  public
    { Public declarations }
    //fun��es para o banco de dados
    function Conectar:boolean;
    function Desconectar:boolean;

    //fun��es para manipular as entidades
    function getDataSet(strQry:string): TDataSet;
    function execSql(strQry:string): boolean;
  end;

var
  DSServerModuleBaseDados: TDSServerModuleBaseDados;

implementation

{$R *.dfm}

//fun��es para o banco de dados
function TDSServerModuleBaseDados.Conectar:boolean;
begin
  try
    LSCONEXAO.Connected := true;
    result := true;
  except
    result := false;
  end;
end;

function TDSServerModuleBaseDados.Desconectar:boolean;
begin
  try
    LSCONEXAO.Connected := false;
    result := true;
  except
    result := false;
  end;
end;


//fun��es para manipular as entidades
function TDSServerModuleBaseDados.getDataSet(strQry:string): TDataSet;
begin
  SQLDSServidor.Close;
  SQLDSServidor.Params.Clear;
  SQLDSServidor.CommandType := ctQuery;
  SQLDSServidor.CommandText := strQry;
  SQLDSServidor.Open;
  result := SQLDSServidor;
end;

function TDSServerModuleBaseDados.execSql(strQry:string): boolean;
Var
  msgErro:string;
begin
  result := false;
  SQLDSServidor.Close;
  SQLDSServidor.Params.Clear;
  SQLDSServidor.CommandType := ctQuery;
  SQLDSServidor.CommandText := strQry;
  try
    SQLDSServidor.ExecSQL;
    result := true;
  except
   on e: Exception do begin
     raise Exception.Create(e.Message)
   end;
  end;
end;

end.

Listagem 6. srvModBaseDados.pas

Assim sendo, crie outra Unit ao seu projeto, salvando tamb�m dentro de Framework com o nome de GenericDao. A Unit GenericDao consolida todos os conceitos de Generics, Rtti, DAO para que seja poss�vel manipular determinada classe de entidade fazendo o mapeamento objeto-relacional (Listagem 7).


unit GenericDao;

interface

Uses Db, Rtti, CAtribEntity, TypInfo, SysUtils, srvModBaseDados;

type
  TGenericDAO = class
    private
      class function GetTableName<T: class>(Obj: T): String;
    public
      //procedimentos para o crud
      class function Insert<T: class>(Obj: T):boolean;
      class function GetAll<T: class>(Obj: T): TDataSet;
  end;


implementation

class function TGenericDAO.GetTableName<T>(Obj: T): String;
var
  Contexto: TRttiContext;
  TypObj: TRttiType;
  Atributo: TCustomAttribute;
  strTable: String;
begin
  Contexto := TRttiContext.Create;
  TypObj := Contexto.GetType(TObject(Obj).ClassInfo);
  for Atributo in TypObj.GetAttributes do
  begin
    if Atributo is TableName then
      Exit(TableName(Atributo).Name);
  end;
end;


//fun��es para manipular as entidades
class function TGenericDAO.Insert<T>(Obj: T):boolean;
var
  Contexto: TRttiContext;
  TypObj: TRttiType;
  Prop: TRttiProperty;
  strInsert, strFields, strValues: String;
  Atributo: TCustomAttribute;

begin
  strInsert := '''''''';
  strFields := '''''''';
  strValues := '''''''';

  strInsert := ''''INSERT INTO '''' + GetTableName(Obj);

  Contexto := TRttiContext.Create;
  TypObj := Contexto.GetType(TObject(Obj).ClassInfo);

  for Prop in TypObj.GetProperties do begin
    for Atributo in Prop.GetAttributes do begin
        if Atributo is FieldName then begin
           strFields := strFields + FieldName(Atributo).Name  
           + '''','''';
           case Prop.GetValue(TObject(Obj)).Kind of

             tkWChar, tkLString, tkWString, tkString,
             tkChar, tkUString:

               strValues := strValues +
               QuotedStr(Prop.GetValue(TObject(Obj)).AsString) 
               + '''','''';

             tkInteger, tkInt64:

               strValues := strValues +
               IntToStr(Prop.GetValue(TObject(Obj)).AsInteger) 
               + '''','''';

             tkFloat:

               strValues := strValues +
               FloatToStr(Prop.GetValue(TObject(Obj)).AsExtended) 
               + '''','''';

             else
               raise Exception.Create(''''Type not Supported'''');
           end;
       end;
     end;
  end;
  strFields := Copy(strFields, 1, Length(strFields) - 1);
  strValues := Copy(strValues, 1, Length(strValues) - 1);
  strInsert := strInsert + '''' ( '''' + strFields + '''' )  
  VALUES ( '''' + strValues + '''' )'''';

  result := DSServerModuleBaseDados.execSql(strInsert);
end;


class function TGenericDAO.GetAll<T>(Obj: T): TDataSet;
begin
  result := DSServerModuleBaseDados.getDataSet(''''SELECT T1.* '''' +
    '''' FROM '''' + GetTableName(Obj) + '''' T1 '''' );
end;


end.

Listagem 7. GenericDao.pas

Portanto, at� este ponto o seu Framework de persist�ncia est� criado. No pr�ximo t�pico vamos integr�-lo a aplica��o Delphi criada no inicio deste artigo. A pasta Framework poder� ser copiada para qualquer aplicativo e usada sem necessidades de reescrita de c�digo, ou poder� ficar em �rea p�blica a todos os seus projetos.

Usando a Camada de Persist�ncia

Agora que a camada de persist�ncia est� criada cria-se o aplicativo para us�-la. O projeto do aplicativo foi criado no in�cio deste artigo, portanto, ser� constru�da uma interface simples apenas para mostrar o uso do framework (Figura 5).

**Figura 5**. Interface demonstrando o uso da camada de persist�ncia

Veja a implementa��o dos bot�es "Inserir" e "GetAll" (Listagem 8).


procedure TForm5.btnInserirClick(Sender: TObject);
Var
 aluno:TAluno;
begin

  aluno := TAluno.Create();
  aluno.Matricula := edMatricula.Text;
  aluno.Nome      := edNome.Text;
  aluno.Endereco  := edEndereco.Text;
  aluno.Telefone  := edTelefone.Text;
  aluno.CPF       := edCPF.Text;

  if TGenericDAO.Insert(aluno) then begin
    ShowMessage(''''Aluno inserido!'''');
  end else begin
    ShowMessage(''''Aluno n�o inserido!'''')
  end;

end;

procedure TForm5.btnGetAllClick(Sender: TObject);
begin
  ClientDataSet1.Close;
  DataSetProvider1.DataSet := TGenericDAO.GetAll(TAluno.Create());
  ClientDataSet1.Open;
end;

Listagem 8. Implementa��o da chamada dos m�todos da camada de persist�ncia

Conclus�o

Conclui-se portanto que os desenvolvedores devem estar atento as novas implementa��es e recursos dispon�veis em seus ambientes de desenvolvimento. Isso torna o trabalho de produ��o de softwares n�o t�o �rduo e � not�ria a necessidade cada vez mais inerente desta �rea em promover as boas pr�ticas no desenvolvimento de softwares.

Refer�ncias Bibliogr�ficas:

Granaty, Jones. Introdu��o ao Modelo Multicamadas. Acesso em 01 jul. 2013.
Leonhardt, Rodrigo. RTTI (Run-time Type Information). Acesso em 01 jul. 2013.
Guedes, Jos� M�rio Silva. Trabalhando com Atributos (Custom Attributes). Acesso em 01 jul. 2013.
Mour�o, Rodrigo Carreiro. DataSnap XE, Generics, RTTI e DAO. Acesso em 01 jul. 2013.
Embarcadero, docwik. Overview of Generics. Acesso em 01 jul. 2013.

Confira outros conte�dos:

Instalando o ACBr

Mapeamento Objeto-Relacional com TMS...

Introdu��o aos componentes JEDI

Por Leandra Em 2013

Coment�rios nesta publica��o Escrever um coment�rio sobre conte�do

Associa��o Campinas

N�vel

Muito bom o post. Por�m como funciona quando existir chave estrangeira?

há +1 ano

Ver coment�rios anteriores (7)

H�lio Devmedia

DevMedia

Ol� demovo amigo, eu j� havia respondido mas agora descobri que minha resposta n�o gravou corretamente. Talvez voc� j� tenha at� resolvido sozinho, assim pe�o desculpas.

O seu c�digo est� bem elaborado por�m n�o � correto setar um valor da forma como voc� est� usando porque voc� n�o est� inicializando o TValue para passar para o m�todo setValue;

o correto seria assim:

Aproveitando que voc� j� est� no for...in pode acessar dessa forma:
var
vFK: TValue;

begin
...
//aqui vc est� dentro do for...in
vFk := vFk.From(Dados.FieldByName(nfk).AsVariant);
// nessa linha eu n�o sei como voc� trata mas � poss�vel que n�o est� inicializando o
// vFK corretamente, pressupondo que vFK � do tipo TValue;
//eu particularmente prefiro tratar individualmente cada tipo de valor atrav�s da
//propriedade vFK.Kind dentro do case. Exemplo:

vFK:= RttiProp.GetValue(classe); //para inicializar o TValue;

case vFK.kind of
tkString: vFK:= Dados.FieldByName(nfk).AsString;
tkInteger: vFK:= Dados.FieldByName(nfk).AsInteger;
end;

//Al�m disso, estive olhando a documenta��o do Delphi (vers�o tokio) e ele disse que
//a sintaxe correta do vFK.From<T>(valor igual a T), exemplo:
// vFK.From<integer>(Dados.FieldByName(nfk).Asinteger);

//assim que a quest�o do TValue for acertado basta fazer assim:
pfk.SetValue(v,vFk)
//porque voc� est� dentro do ForIn e n�o � muito correto acessar o Field, s� em casos
//raros, o certo � acessar pela propriedade.

end;

Eu realmente espero ter te ajudado. Um forte abra�o e fique com Deus.

há +1 ano

Black November

Desconto exclusivo para as primeiras 200 matrículas!

Pagamento anual

12x no cartão

De: R$ 69,00

Por: R$ 54,90

Total: R$ 658,80

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
12 meses de acesso

Pagamento recorrente

Cobrado mensalmente no cartão

De: R$ 79,00

Por: R$ 54,90 /mês

Total: R$ 658,80

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
Fidelidade de 12 meses
Não compromete o limite do seu cartão

<Perguntas frequentes>

Carreira

Metodologia

Assinatura e Pagamentos

Cadastro

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

Criando seu pr�prio framework de persist�ncia Objeto-Relacional no Delphi XE

Veja neste artigo como criar seu pr�prio framework de persist�ncia Objeto-Relacional no Delphi XE.