Data Definition Language: Como criar uma DLL pelo Microsoft Visual Studio

O objetivo principal desse artigo � aprimorar t�cnicas existentes de programaç�o para que, no futuro, tenhamos uma eficiente e correta comunicaç�o entre a DLL criada e um projeto de ambiente web

Para que seja desenvolvida a DLL � preciso, inicialmente, supor que ela assuma alguma funcionalidade e, nesse caso, ela ser� respons�vel por controlar as transaç�es do aplicativo web para um banco de dados que, por padr�o, pode ser o Microsoft SQL Server, desde que tenha instalado seu gerenciador, o chamado SQL Server Management Studio.

A proposta � criar um novo banco de dados com o nome de ServiceDesk (nome pr�prio que identificar� facilmente a nova base de dados) e em sequ�ncia a tabela Funcionario, de acordo com o modelo de diagrama de classe apresentado na Figura 1.

Figura 1. Diagrama de Classe inicial para a criaç�o da tabela Funcionario para o banco de dados

Criando Tabela no SQL Server

Para criar a tabela Funcionario no SQL Server Management Studio, caso a vers�o instalada esteja em ingl�s, � s� clicar em New Query (nova consulta) e depois colocar o c�digo descrito na Listagem 1. Finalmente, clique em Execute (localizado no canto superior) ou pressione a tecla F5 - que � a tecla de atalho para execuç�o de comandos SQL.


CREATE TABLE [dbo].[Funcionario](
      [fun_codigo] [int] IDENTITY(1,1) NOT NULL,
      [fun_nome] [varchar](70) NOT NULL,
      [fun_dtcontratacao] [datetime] NOT NULL,
      [fun_dtdemissao] [datetime] NOT NULL,
      [fun_ativo] [char](1) NOT NULL,
      [fun_senha] [varchar](15) NOT NULL,
      [fun_tipo] [char](1) NOT NULL,
 CONSTRAINT [PK_Funcionario] PRIMARY KEY CLUSTERED 
(
      [fun_codigo] ASC
)WITH (PAD_INDEX  = OFF, IGNORE_DUP_KEY = OFF) ON [PRIMARY]
) ON [PRIMARY]

Listagem 1. Comandos para a criaç�o da tabela e da chave prim�ria

Nota: Comandos descritos na Listagem 1 foram executados no SQL Management Studio 2005.

Ap�s isso, � necess�rio que sejam inseridas algumas informaç�es no interior do banco de dados, pois posteriormente a aplicaç�o web pode ser respons�vel por trazer para o usu�rio ou enviar essas informaç�es para a tabela e, com nenhuma informaç�o, a aplicaç�o retornar� nula ou com erro.

Criando um Novo Projeto

Agora, depois de ter o Microsoft Visual Studio instalado, � preciso criar um novo projeto para a criaç�o da DLL. Neste exemplo ser� utilizado a vers�o 10 deste ambiente de desenvolvimento. No menu superior (se a vers�o estiver em ingl�s) v� em File → New → Project (Arquivo → Novo → Projeto). Ap�s isso, aparecer� uma janela para escolha da forma de um novo projeto: selecione a aba Windows para abrir o menu Windows Forms Control Library. D� um Name (nome), Location (localizaç�o) e um Solution name (nome para soluç�o), deixando selecionado a opç�o �Create directory for solution� (dizendo que � para criar um diret�rio para soluç�o) e clique em OK, como mostra a Figura 2.

Figura 2. Janela de configuraç�es para a criaç�o de um novo projeto Windows Forms Control Library (Visual C#)

Depois, aparecer� um arquivo chamado UserControl1.cs que � padr�o na hora da criaç�o de um novo projeto Windows Forms Control Library. Esse arquivo criado e presente no Solution Explorer pode ser exclu�do do projeto.

Feito isso, � preciso criar tr�s pastas (Folders): uma com o nome de Controller (que ser� a respons�vel pelo Controlador), a segunda com o nome de DAO (que ser� a respons�vel pelo acesso, envio e manipulaç�o de dados) e a terceira com o nome de Model (que ser� a respons�vel pelo Modelo), como mostra a Figura 3.

Figura 3. Hierarquia do projeto no Solution Explorer, com as pastas criadas

Criaç�o se Classes

A proposta agora � criar as classes dentro de cada pasta, na qual cada uma � respons�vel por fazer sua funcionalidade.

Na pasta DAO ser�o criadas as classes: Banco.cs e FuncionarioBD.cs , onde a classe FuncionarioBD.cs ser� respons�vel pela manipulaç�o de dados e comandos de SQL (insert, update, delete), e a classe Banco.cs ser� respons�vel por conectar com o banco de dados.

Para a classe Banco.cs podemos implementar os c�digos referentes a Listagem 2.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Data.SqlClient;
using System.Data;
 
namespace ServiceDesk.DAO
{
    internal class Banco
    {
        private string _strConexao;
        private SqlCommand _comandoSQL;
        protected SqlCommand ComandoSQL
        {
            get { return _comandoSQL; }
            set { _comandoSQL = value; }
        }
        private SqlConnection _conn;
        private SqlTransaction _transacao;
        protected Banco()
        {
            _strConexao = @"Data Source=localhost\sqlexpress;Initial Catalog=ServiceDesk;
            Persist Security Info=True;User ID=sa;Password=a12345z";
            _conn = new SqlConnection(_strConexao);
            _comandoSQL = new SqlCommand();
            _comandoSQL.Connection = _conn;
        }
        protected Banco(string stringConexao)
        {
            _strConexao = stringConexao;
            _conn = new SqlConnection(_strConexao);
            _comandoSQL = new SqlCommand();
            _comandoSQL.Connection = _conn;
        }
        protected bool AbreConexao(bool transacao)
        {
            try
            {
                _conn.Open();
                if (transacao)
                {
                    _transacao = _conn.BeginTransaction();
                    _comandoSQL.Transaction = _transacao;
                }
                return true;
            }
            catch
            {
                return false;
            }
        }
        protected bool FechaConexao()
        {
            try
            {
                if (_conn.State == ConnectionState.Open)
                    _conn.Close();
                return true;
            }
            catch
            {
                return false;
            }
        }
        protected void FinalizaTransacao(bool commit)
        {
            if (commit)
                _transacao.Commit();
            else
                _transacao.Rollback();
            FechaConexao();
        }
        ~Banco()
        {
            FechaConexao();
        }
        protected int ExecutaComando(bool transacao)
        {
            if (_comandoSQL.CommandText.Trim() == string.Empty)
                throw new Exception("N�o h� instruç�o SQL a ser executada.");
 
            int retorno;
            AbreConexao(transacao);
            try
            {
                retorno = _comandoSQL.ExecuteNonQuery();
            }
            catch(Exception ex)
            {
                retorno = -1;
                throw new Exception("Erro ao executar o comando SQL:", ex);
            }
            finally
            {
                if (!transacao)
                    FechaConexao();
            }
            return retorno;
        }
        protected int ExecutaComando(bool transacao, out int ultimoCodigo)
        {
            if (_comandoSQL.CommandText.Trim() == string.Empty)
                throw new Exception("N�o h� instruç�o SQL a ser executada.");
 
            int retorno;
            ultimoCodigo = 0;
            AbreConexao(transacao);
            try
            {
                ultimoCodigo = Convert.ToInt32(_comandoSQL.ExecuteScalar());
                retorno = 1;
            }
            catch(Exception ex)
            {
                retorno = -1;
                throw new Exception("Erro ao executar o comando SQL: ", ex);
            }
            finally
            {
                if (!transacao)
                    FechaConexao();
            }
            return retorno;
        }
        protected DataTable ExecutaSelect()
        {
            if (_comandoSQL.CommandText.Trim() == string.Empty)
                throw new Exception("N�o h� instruç�o SQL a ser executada.");
 
            AbreConexao(false);
            DataTable dt = new DataTable();
            try
            {
                dt.Load(_comandoSQL.ExecuteReader());
            }
            catch(Exception ex)
            {
                dt = null;
                throw new Exception("Erro ao executar o comando SQL: ", ex);
            }
            finally
            {
                FechaConexao();
            }
            return dt;
        }
        protected double ExecutaScalar()
        {
            if (_comandoSQL.CommandText.Trim() == string.Empty)
                throw new Exception("N�o h� instruç�o SQL a ser executada.");
 
            AbreConexao(false);
            double retorno;
            try
            {
                retorno = Convert.ToDouble(_comandoSQL.ExecuteScalar());
            }
            catch(Exception ex)
            {
                retorno = -1;
                throw new Exception("Erro ao executar o comando SQL: ", ex);
            }
            finally
            {
                FechaConexao();
            }
            return retorno;
        }
    }
}

Listagem 2. Classe respons�vel pela conex�o com o banco de dados e execuç�o de comandos de SQL, enviar, retornar e manipular conex�o com tratamentos de erros

Vamos entender a l�gica por traz da Listagem 2:

O campo _strConexao � respons�vel pela definiç�o da string de conex�o;
O campo _comandoSQL � respons�vel pelo comando de SQL a ser executado;
A propriedade ComandoSQL � que exp�e o campo para definiç�o do comando de SQL a ser executado;
O campo _conn define o objeto de conex�o;
O campo _transacao define o objeto de transaç�o;
O construtor Banco() define uma string de conex�o fixa e cria os objetos de conex�o e para cada configuraç�o do banco de dados h� um ID e Password (senha);
O construtor Banco(string stringConexao) recebe por par�metro a string de conex�o a ser utilizada e cria os objetos de comando e conex�o;
O m�todo AbreConexao(bool transacao) abre a conex�o com o banco de dados;
O m�todo FechaConexao() fecha a conex�o com o banco de dados;
O m�todo FinalizaTransacao(bool commit) finaliza uma transaç�o;
O destrutor ~Banco() fecha a conex�o com o banco de dados;
O m�todo ExecutaComando(bool transacao) � respons�vel pela execuç�o dos comandos de Insert, Update e Delete e Retorna um n�mero inteiro que indica a quantidade de linhas afetadas;
O m�todo ExecutaComando(bool transacao, out int ultimoCodigo) � respons�vel pela execuç�o dos comandos de Insert com retorno do �ltimo c�digo cadastrado e Retorna um n�mero inteiro que indica a quantidade de linhas afetadas;
O m�todo ExecutaSelect() � respons�vel pela execuç�o dos comandos de Select e Retorna um DataTable com o resultado da operaç�o;
O m�todo ExecutaScalar() � que executa comandos de Select para retornos escalares, ou seja, retorna a primeira linha e primeira coluna do resultado do comando de Select. Para esse exemplo, esse valor � convertido para Double. Ao final, retorna a primeira linha e primeira coluna do resultado comando de Select;

Para a classe FuncionarioBD.cs ser� implementado os c�digos referentes a Listagem 3.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using ServiceDesk.Model;
using System.Data;
 
namespace ServiceDesk.DAO
{
    internal class FuncionarioBD : Banco
    {
        internal FuncionarioBD() { }
 
        internal Funcionario Autenticar(int codigo, string senha)
        {
            ComandoSQL.Parameters.Clear();
            ComandoSQL.CommandText = @"select * from FUNCIONARIO
                    where fun_codigo = @codigo and fun_senha = @senha";
            ComandoSQL.Parameters.AddWithValue("@codigo", codigo);
            ComandoSQL.Parameters.AddWithValue("@senha", senha);
            DataTable dt = ExecutaSelect();
            if (dt != null && dt.Rows.Count > 0)
            {
                Funcionario f = new Funcionario();
                f.Codigo = Convert.ToInt32(dt.Rows[0]["fun_codigo"]);
                f.Nome = dt.Rows[0]["fun_nome"].ToString();
                f.DataContratacao = Convert.ToDateTime(dt.Rows[0]["fun_dtcontratacao"]);
                if (dt.Rows[0]["fun_dtdemissao"] == DBNull.Value)
                    f.DataDemissao = null;
                else
                    f.DataDemissao = Convert.ToDateTime(dt.Rows[0]["fun_dtdemissao"]);
                f.Ativo = Convert.ToChar(dt.Rows[0]["fun_ativo"]);
                f.Senha = dt.Rows[0]["fun_senha"].ToString();
                f.Tipo = Convert.ToChar(dt.Rows[0]["fun_tipo"]);
 
                return f;
            }
            else
                return null;
        }
 
        internal int Gravar(Funcionario func)
        {
            ComandoSQL.Parameters.Clear();
            if (func.Codigo == 0) //Novo registro
            ComandoSQL.CommandText = @"insert into Funcionario 
                    (fun_nome, fun_dtcontratacao, fun_ativo, fun_senha, fun_tipo)
                    values (@nome, @datacontratacao, @ativo, @senha, @tipo)";
            else //Alteraç�o
            {
                ComandoSQL.CommandText = @"update FUNCIONARIO
                    set fun_nome = @nome, fun_dtcontratacao = @datacontratacao, fun_dtdemissao = 
                    @datademissao, 
                        fun_ativo = @ativo, fun_senha = @senha, fun_tipo = @tipo
                        where fun_codigo = @codigo";
                ComandoSQL.Parameters.AddWithValue("@codigo", func.Codigo);
                if (func.DataDemissao == null)
                    ComandoSQL.Parameters.AddWithValue("@datademissao", DBNull.Value);
                else
                    ComandoSQL.Parameters.AddWithValue("@datademissao", func.DataDemissao);
            }
            ComandoSQL.Parameters.AddWithValue("@nome", func.Nome);
            ComandoSQL.Parameters.AddWithValue("@datacontratacao", func.DataContratacao);
            ComandoSQL.Parameters.AddWithValue("@ativo", func.Ativo);
            ComandoSQL.Parameters.AddWithValue("@senha", func.Senha);
            ComandoSQL.Parameters.AddWithValue("@tipo", func.Tipo);
 
            return ExecutaComando(false);
        }
 
        internal List<Funcionario> Obter(string palavraChave, char ativo)
        {
            ComandoSQL.Parameters.Clear();
            ComandoSQL.CommandText = @"select fun_codigo, fun_nome, fun_dtcontratacao, 
            fun_dtdemissao, fun_ativo, fun_senha, fun_ativo, fun_tipo
                        from Funcionario
                        where fun_ativo = @ativo and fun_nome like @palavra order by fun_nome";
            ComandoSQL.Parameters.AddWithValue("@ativo", ativo);
            ComandoSQL.Parameters.AddWithValue("@palavra", "%"+palavraChave+"%");
 
            DataTable dt = ExecutaSelect();
            List<Funcionario> dados = null;
            if (dt != null && dt.Rows.Count > 0)
            {
                dados = new List<Funcionario>();
                foreach(DataRow linha in dt.Rows)
                {
                    Funcionario f = new Funcionario();
                    f.Codigo = Convert.ToInt32(linha["fun_codigo"]);
                    f.Nome = linha["fun_nome"].ToString();
                    f.DataContratacao = Convert.ToDateTime(linha["fun_dtcontratacao"]);
                    if (linha["fun_dtdemissao"] == DBNull.Value)
                        f.DataDemissao = null;
                    else
                        f.DataDemissao = Convert.ToDateTime(linha["fun_dtdemissao"]);
                    f.Ativo = Convert.ToChar(linha["fun_ativo"]);
                    f.Senha = linha["fun_senha"].ToString();
                    f.Tipo = Convert.ToChar(linha["fun_tipo"]);
 
                    dados.Add(f);
                }
            }
            return dados;
        }
 
        internal int Demitir(int codigoFuncionario)
        {
            ComandoSQL.Parameters.Clear();
            ComandoSQL.CommandText = @"update Funcionario set fun_ativo = 'N',
                    fun_demissao = @data where fun_codigo = @codigo";
            ComandoSQL.Parameters.AddWithValue("@data", DateTime.Now);
            ComandoSQL.Parameters.AddWithValue("@codigo", codigoFuncionario);
 
            return ExecutaComando(false);
        }
 
        internal Funcionario Obter(int codigoFuncionario)
        {
            ComandoSQL.Parameters.Clear();
            ComandoSQL.CommandText = @"select fun_codigo, fun_nome, fun_dtcontratacao, 
            fun_dtdemissao, fun_ativo, fun_senha, fun_ativo, fun_tipo
                        from Funcionario
                        where fun_codigo = @codigo";
            ComandoSQL.Parameters.AddWithValue("@codigo", codigoFuncionario);
 
            DataTable dt = ExecutaSelect();
            if (dt != null && dt.Rows.Count > 0)
            {
                Funcionario f = new Funcionario();
                f.Codigo = Convert.ToInt32(dt.Rows[0]["fun_codigo"]);
                f.Nome = dt.Rows[0]["fun_nome"].ToString();
                f.DataContratacao = Convert.ToDateTime(dt.Rows[0]["fun_dtcontratacao"]);
                if (dt.Rows[0]["fun_dtdemissao"] == DBNull.Value)
                    f.DataDemissao = null;
                else
                    f.DataDemissao = Convert.ToDateTime(dt.Rows[0]["fun_dtdemissao"]);
                f.Ativo = Convert.ToChar(dt.Rows[0]["fun_ativo"]);
                f.Senha = dt.Rows[0]["fun_senha"].ToString();
                f.Tipo = Convert.ToChar(dt.Rows[0]["fun_tipo"]);
 
                return f;
            }
            else
                return null;
        }
    }
}

Listagem 3. Classe FunionarioBD que cont�m m�todos para autenticaç�o de funcion�rio, gravaç�o, listagem, consulta (obtenç�o) de acordo com suas atividades

Agora, na pasta Controller, ser� criada a classe: FuncionarioController.cs, respons�vel por controlar a sua tabela, definindo as aç�es e regras de acesso, como se fosse uma validaç�o interna entre a sa�da e entrada de dados. A classe FuncionarioController.cs ser� implementada conforme o c�digo da Listagem 4.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using ServiceDesk.Model;
using ServiceDesk.DAO;
 
namespace ServiceDesk.Controller
{
    public class FuncionarioController
    {
        FuncionarioBD bd = new FuncionarioBD();
 
        public Funcionario Autenticar(int codigo, string senha)
        {
            if (codigo > 0 && senha.Trim().Length > 0)
                return new FuncionarioBD().Autenticar(codigo, senha);
            else
                return null;
        }
        public FuncionarioController() { }
        public int Gravar(Funcionario func)
        {
            if (func.Nome.Trim().Length >= 3 &&
                func.Ativo == 'S')
            {
                return bd.Gravar(func);
            }
            else
                return -1;
        }
        public List<Funcionario> Obter(char ativo = 'S')
        {
            if (ativo == 'S' || ativo == 'N')
                return bd.Obter("",ativo);
            else
                return null;
        }
 
        public Funcionario Obter(int codigoFuncionario)
        {
            return codigoFuncionario > 0 ? bd.Obter(codigoFuncionario) : null;
        }
 
        public int Demitir(int codigoFuncionario)
        {
            return bd.Demitir(codigoFuncionario);
        }
    }
}

Listagem 4. Classe controladora respons�vel por fazer validaç�es, operaç�es e m�todos como na autenticaç�o, pesquisa, gravaç�o e alteraç�o antes que os dados sejam manipulados

J� na pasta Model ser� criada a classe Funcionario.cs, onde modelar� as regras de neg�cio como se fosse um intermedi�rio entre o lado Cliente e o lado Servidor e cada propriedade � respons�vel por receber e/ou enviar as informaç�es. A classe Funcionario.cs ser� implementada de acordo com a Listagem 5.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
 
namespace ServiceDesk.Model
{
    public class Funcionario
    {
        public Funcionario() { _codigo = 0; }
 
        #region Propriedades do Funcionario
        private int _codigo;
        public int Codigo
        {
            get
            {
                return _codigo;
            }
            set
            {
                _codigo = value;
            }
        }
        private string _nome;
 
        public string Nome
        {
            get 
            {
                return _nome; 
            }
            set { _nome = value; }
        }
        private DateTime _dataContratacao;
 
        public DateTime DataContratacao
        {
            get { return _dataContratacao; }
            set { _dataContratacao = value; }
        }
        private DateTime? _dataDemissao;
 
        public DateTime? DataDemissao
        {
            get { return _dataDemissao; }
            set { _dataDemissao = value; }
        }
        private char _ativo;
 
        public char Ativo
        {
            get { return _ativo; }
            set { _ativo = value; }
        }
        private string _senha;
 
        public string Senha
        {
            get { return _senha; }
            set { _senha = value; }
        }
        private char _tipo;
 
        public char Tipo
        {
            get { return _tipo; }
            set { _tipo = value; }
        }
        #endregion
    }
}

Listagem 5. Classe respons�vel por obter ou enviar informaç�es do Funcion�rio via Get e Set

Por fim, ap�s ter criado todas as classes relativas a tabela Funcion�rio, o layout dos arquivos ficar� como mostra a Figura 4.

Figura 4. Hierarquia do projeto, com as pastas e suas respectivas classes

Criando a DLL ServiceDesk

Finalmente, para que o projeto se transforme em uma DLL, basta dar um Build e salvar. Com isso, ela pode ser utilizada em qualquer projeto web ASP .NET.

Para anexar essa DLL criada a um projeto web ASP .NET, basta clicar com o bot�o direito em References do novo projeto e clicar em Add Reference..., como ilustra a Figura 5.

Figura 5. Caminho para referenciar a DLL criada para um novo projeto web

Feito isso, aparecer� uma janela, conforme mostra na Figura 6.

Figura 6. Janela de opç�es e confirmaç�o de anexo de Referencias (que no caso � uma referencia a DLL)

Ap�s ter selecionado o Project Name, basta dar OK e a DLL criada estar� na futura aplicaç�o web ASP . NET.

Nota: Sempre que houver quaisquer alteraç�es na DLL durante a implementaç�o do projeto web ASP .NET, � obrigat�rio dar um Build na DLL para que a mesma n�o apresente erros.

Como criar uma DLL pelo Microsoft Visual Studio

Veja nesse artigo como criar e desenvolver uma Data Definition Language (DLL) através do ambiente de desenvolvimento Microsoft Visual Studio em conjunto com o padrão MVC (Model � View � Controller).

Criando Tabela no SQL Server

Criando um Novo Projeto

Criaç�o se Classes

Criando a DLL ServiceDesk

Artigos relacionados