Por que eu devo ler este artigo:Este artigo é útil para desenvolvedores que desejam aprender ou aprimorar seus conhecimentos na geração de relatórios em aplicações ASP.NET MVC, aproveitando todos os recursos de formatação e responsividade do Bootstrap. Este artigo traz uma abordagem baseada nos principais recursos dos plug-ins PagedList, para possibilitar a geração de relatórios no ASP.NET MVC, e Rotativa, que transforma páginas HTML em arquivos PDF.

O uso de software para gestão empresarial está presente nas mais variadas empresas que atuam no mercado, sejam elas de pequeno ou grande porte. Os gestores necessitam consultar e analisar dados gerados pelo sistema de gestão, que por sua vez pode integrar informações de vários setores da empresa, como vendas, financeiro, estoque, compras, fiscal, contábil, dentre outros. Com base neste cenário complexo, é necessário ter ferramentas que possam gerar relatórios para que o gestor de negócio possa analisar os dados e tomar decisões referentes aos mais variados processos de negócio, dentro e fora da empresa.

O desenvolvimento de relatórios em aplicações web, no entanto, nem sempre é uma tarefa fácil, visto que estamos na era da mobilidade e por isso precisamos oferecer aos usuários soluções que possam ser acessadas também por dispositivos móveis, como smartphones e tablets.

Para tornar possível o desenvolvimento de relatórios nesse cenário, iremos aprender neste artigo a trabalhar com os plug-ins PagedList e Rotativa em uma aplicação ASP.NET MVC. Além disso, utilizaremos os recursos do Bootstrap para oferecer uma interface elegante e responsiva, compatível com os principais browsers da atualidade.

Criando o projeto ASP.NET MVC

Para iniciar nossa aplicação de relatórios, começaremos criando um novo projeto do tipo ASP.NET Web Application no Visual Studio, que nomearemos aqui como “Relatorios-ASPNET-MVC”. Na tela seguinte devemos selecionar o template MVC e na opção Change Authentication marcar o item “No Authentication”, pois não iremos trabalhar com o sistema de autenticação padrão do ASP.NET. Clicamos então em OK para que o Visual Studio possa criar o projeto com todos os arquivos necessários para o projeto que segue o padrão MVC.

Após o projeto ter sido criado, o segundo passo é adicionar a versão mais recente da biblioteca Entity Framework, que fará o Mapeamento Objeto-Relacional das classes do domínio da nossa aplicação para gerar, a partir delas, o banco de dados SQL Server. Aqui utilizaremos a abordagem Code First, em que realizamos toda a modelagem das entidades a partir de classes POCO (Plain Old CLR Object), sem utilizar a ferramenta de modelagem visual comum na abordagem Model First, ou começando o desenvolvimento pela criação das tabelas no banco (Database First).

Para adicionar o Entity Framework, devemos clicar no menu Tools>Nuget Package Manager> Package Manager Console e assim baixar a biblioteca diretamente do repositório do NuGet, que é a ferramenta de gerenciamento de pacotes integrada ao Visual Studio. Digite o comando 'Install-Package EntityFramework' no console e pressione Enter para que a biblioteca seja instalada, conforme mostra a Figura 1.

Como gerar Relatórios no ASP.NET MVC

abrir imagem em nova janela

Figura 1. Instalação do Entity Framework no Package Manager Console.

Criando as classes POCO para entidades

O Entity Framework Code First trabalha baseado em classes POCO que representam as entidades do mundo real a serem mapeadas para o banco de dados, desta forma, precisaremos criar algumas classes que irão modelar o cenário do sistema de vendas.

A Figura 2 representa o DER (Diagrama Entidade Relacionamento) do sistema de vendas proposto para geração dos relatórios. Perceba que a base de dados será composta por quatro tabelas: Cliente, Produto, Pedido Cabeçalho e Item Pedido. Seguindo esse contexto precisaremos criar uma classe para cada tabela.

Como gerar Relatórios no ASP.NET MVC

Figura 2. Diagrama Entidade Relacionamento do sistema de vendas.

O projeto criado anteriormente no Visual Studio é do tipo ASP.NET MVC, assim sendo iremos concentrar as classes modelo dentro da pasta Model presente no Solution Explorer.

Para adicionar a primeira classe clique com o botão direito nessa pasta e depois na opção Add>Class. Nomeie como Cliente e logo em seguida clique em Add para que o arquivo seja criado.

Com a classe cliente criada, adicione o código presente na Listagem 1.

Listagem 1. Implementação da classe Cliente

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Linq;
  04 using System.Web;
  05
  06 namespace Relatorios_ASPNET_MVC.Models
  07 {
  08    public class Cliente
  09    {
  10        public Cliente()
  11        {
  12            this.PedidoCabecalho = new List<PedidoCabecalho>();
  13        }
  14        public int ClienteId { get; set; }
  15        public string Nome { get; set; }
  16        public string CpfCnpj { get; set; }
  17        public string Endereco { get; set; }
  18        public string Bairro { get; set; }
  19        public string Cidade { get; set; }
  20        public string Cep { get; set; }
  21        public string Email { get; set; }
  22        public string Telefone { get; set; }
  23        public string StatusCliente { get; set; }
  24        public DateTime DataCadastro { get; set; }
  25        public virtual ICollection<PedidoCabecalho> PedidoCabecalho { get; set; }
  26    }
  27 }

A implementação traz algumas particularidades:

· Linhas 10 a 13: Neste intervalo foi criado um construtor para a classe Cliente que instancia uma lista de objetos do tipo PedidoCabecalho (declarada na linha 25) que iremos criar mais à frente. Esta propriedade irá representar, em tempo de execução, a relação entre a classe Cliente e PedidoCabecalho para que possamos facilmente acessar os pedidos de um cliente com o LINQ (Language-Integrated Query);

· Linha 14: Aqui o atributo referente ao id do cliente foi definido como ClienteId ao invés de IdCliente, por exemplo. Essa é uma convenção de nomenclatura que o Entity Framework usa para identificar uma chave primária em uma classe (<nome_entidade>Id).

As demais propriedades dispensam maiores comentários, uma vez que se tratam apenas de tipos nativos do framework e possuem nomes sugestivos.

Na sequência, crie outra classe chamada de Produto e implemente o código presente na Listagem 2.

Listagem 2. Implementação da classe Produto

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Linq;
  04 using System.Web;
  05
  06 namespace Relatorios_ASPNET_MVC.Models
  07 {
  08    public class Produto
  09    {
  10        public Produto()
  11        {
  12            this.ItemPedido = new List<ItemPedido>();
  13        }
  14        public int ProdutoId { get; set; }
  15        public string Descricao { get; set; }
  16        public Nullable<decimal> PrecoCompra { get; set; }
  17        public Nullable<decimal> PrecoVenda { get; set; }
  18        public Nullable<int> QtdeEstoque { get; set; }
  19        public Nullable<System.DateTime> DataCadastro { get; set; }
  20        public string StatusProduto { get; set; }
  21        public virtual ICollection<ItemPedido> ItemPedido { get; set; }
  22    }
  23 }

Essa implementação é bem similar à da classe Cliente, sendo instanciado um objeto do tipo List<ItemPedido> no construtor para representar o relacionamento desta classe com a de itens do pedido. Novamente foi seguida a convenção para a nomenclatura da chave primária (linha 12).

Siga os mesmos passos descritos anteriormente e insira uma nova classe chamada de PedidoCabecalho e, em seguida, implemente a mesma conforme a Listagem 3. Essa classe representa os principais dados a respeito do pedido, tais como valor total, cliente e data.

Listagem 3. Implementação da classe PedidoCabecalho

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Linq;
  04 using System.Web;
  05
  06 namespace Relatorios_ASPNET_MVC.Models
  07 {
  08    public class PedidoCabecalho
  09    {
  10        public PedidoCabecalho()
  11        {
  12            this.ItemPedido = new List<ItemPedido>();
  13        }
  14
  15        public int PedidoCabId { get; set; }
  16        public int ClienteId { get; set; }
  17        public Nullable<decimal> ValorTotalPedido { get; set; }
  18        public Nullable<int> QtdeItens { get; set; }
  19        public string StatusPedido { get; set; }
  20        public Nullable<System.DateTime> DataPedido { get; set; }
  21        public virtual Cliente Cliente { get; set; }
  22        public virtual ICollection<ItemPedido> ItemPedido { get; set; }
  23    }
  24 }

Nessa classe temos, na linha 16, uma referência ao ID do cliente ao qual pertence esse pedido. Na linha 21 temos uma propriedade do tipo Cliente. Em tempo de execução, isso permitirá que o Entity Framework preencha o objeto Cliente com todos os dados deste, sem que precisemos realizar outra consulta a essa entidade para que tenhamos suas informações.

A última classe a ser criada é a ItemPedido, que se relaciona com o produto e com o cabeçalho do pedido. Crie a mesma e a implemente conforme a Listagem 4.

Listagem 4. Implementação da classe ItemPedido.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Linq;
  04 using System.Web;
  05
  06 namespace Relatorios_ASPNET_MVC.Models
  07 {
  08    public class ItemPedido
  09    {
  10        public int ItemPedidoId { get; set; }
  11        public int PedidoCabId { get; set; }
  12        public int ProdutoId { get; set; }
  13        public Nullable<int> Quantidade { get; set; }
  14        public Nullable<decimal> ValorUnitario { get; set; }
  15        public Nullable<decimal> Subtotal { get; set; }
  16        public string StatusItem { get; set; }
  17        public virtual PedidoCabecalho PedidoCabecalho { get; set; }
  18        public virtual Produto Produto { get; set; }
  19    }
  20 }

A única coisa a se destacar é a linha 17 que contém uma propriedade virtual do tipo PedidoCabecalho para realizar a referência entre as classes e obter o pedido ao qual o item se refere.

Definindo as classes de mapeamento com Fluent API

O próximo passo em nosso projeto será criar as classes que irão mapear as tabelas a serem geradas pelo Entity Framework Code First. Este processo é realizado com a Fluent API, uma biblioteca que faz parte do Entity Framework com função semelhante às Data Annotations, porém mais ampla em recursos.

A Fluent API é utilizada para mapear as entidades que irão compor o banco de dados da aplicação, com ela é possível definir as colunas de uma tabela, chave primária, tamanho máximo de uma coluna, nome, ordem das colunas, colunas anuláveis, propriedades da entidade que não farão parte da tabela, relacionamento entre tabelas, nome de uma tabela, dentre outros recursos. Além disso, o uso dessa API faz com que o domínio fique desacoplado de qualquer tecnologia de acesso a dados, o que não ocorreria se usássemos as Data Annotations nas classes e suas propriedades.

Para cada entidade teremos uma classe de mapeamento, e a primeira a ser criada será a ClienteMap. Adicione essa nova classe dentro do diretório Model e observe, na Listagem 5, como deve ficar seu código. Atente aos namespaces que precisam ser importados no topo da classe para que tenhamos acesso às classes e métodos do mapeamento.

Listagem 5. Implementação da classe ClienteMap.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Data.Entity.ModelConfiguration;
  04 using System.Linq;
  05 using System.Web;
  06
  07 namespace Relatorios_ASPNET_MVC.Models
  08 {
  09    public class ClienteMap : EntityTypeConfiguration<Cliente>
  10    {
  11        public ClienteMap()
  12        {            
  13            this.HasKey(t => t.ClienteId);
  14            this.Property(t => t.Nome).HasMaxLength(100);
  15            this.Property(t => t.CpfCnpj).HasMaxLength(18);
  16            this.Property(t => t.Endereco).HasMaxLength(200);
  17            this.Property(t => t.Bairro).HasMaxLength(40);
  18            this.Property(t => t.Cidade).HasMaxLength(40);
  19            this.Property(t => t.Cep).HasMaxLength(10);
  20            this.Property(t => t.Email).HasMaxLength(50);
  21            this.Property(t => t.Telefone).HasMaxLength(15);
  22            this.Property(t => t.StatusCliente).HasMaxLength(20);
  23
  24            this.ToTable("Cliente");
  25            this.Property(t => t.ClienteId).HasColumnName("ClienteId");
  26            this.Property(t => t.Nome).HasColumnName("Nome");
  27            this.Property(t => t.CpfCnpj).HasColumnName("CpfCnpj");
  28            this.Property(t => t.Endereco).HasColumnName("Endereco");
  29            this.Property(t => t.Bairro).HasColumnName("Bairro");
  30            this.Property(t => t.Cidade).HasColumnName("Cidade");
  31            this.Property(t => t.Cep).HasColumnName("Cep");
  32            this.Property(t => t.Email).HasColumnName("Email");
  33            this.Property(t => t.Telefone).HasColumnName("Telefone");
  34            this.Property(t => t.StatusCliente).HasColumnName("StatusCliente");
  35            this.Property(t => t.DataCadastro).HasColumnName("DataCadastro");
  36        }
  37    }
  38 }

Alguns detalhes com relação a essa classe merecem destaque:

· Linha 9: Nesta linha consta o primeiro passo para se trabalhar com a Fluent API, ou seja, a classe de mapeamento ClienteMap deve herdar da classe EntityTypeConfiguration, recebendo como tipo genérico a classe que será mapeada. É importante destacar que as classes de mapeamento serão informadas ao criarmos o DbContext mais à frente neste artigo;

· Linha 11: Aqui é criado o construtor da classe ClienteMap, que, após ser utilizado pelo Entity Framework Code First, no momento da criação da base de dados, irá construir o mapeamento da entidade Cliente;

· Linha 13: Neste ponto é definida a chave primária da tabela Cliente através do método HasKey da classe EntityTypeConfiguration. Perceba que ele recebe uma expressão lambda “t => t.ClienteId” como parâmetro, onde t representa a classe Cliente e o atributo ClienteId será a chave primária da tabela;

· Linhas 14 a 22: Neste intervalo é definido o tamanho máximo de cada coluna que irá compor a tabela cliente. Veja que é utilizado o método Property com uma expressão lambda para definir a coluna e em seguida é chamado o método HasMaxLength com o tamanho máximo;

· Linha 24: Nesta linha é definido o nome da tabela a ser criada com uso do método ToTable. Aqui o nome da tabela não precisa ser o mesmo da classe;

· Linhas 25 a 25: Neste intervalo é definido o nome das colunas da tabela Cliente através dos métodos Property e HasColumnName. Além disso, o nome da coluna não precisa ser necessariamente o mesmo nome da propriedade.

A próxima classe a ser mapeada será a Produto, assim sendo, crie uma nova classe chamada ProdutoMap e a implemente conforme consta na Listagem 6, que segue o mesmo formato da classe anterior.

Listagem 6. Implementação da classe ProdutoMap.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Data.Entity.ModelConfiguration;
  04 using System.Linq;
  05 using System.Web;
  06
  07 namespace Relatorios_ASPNET_MVC.Models
  08 {
  09    public class ProdutoMap : EntityTypeConfiguration<Produto>
  10    {
  11        public ProdutoMap()
  12        {
  13            this.HasKey(t => t.ProdutoId);
  14
  15            this.Property(t => t.Descricao).HasMaxLength(100);
  16            this.Property(t => t.StatusProduto).HasMaxLength(20);
  17
  18            this.ToTable("Produto");
  19            this.Property(t => t.ProdutoId).HasColumnName("ProdutoId");
  20            this.Property(t => t.Descricao).HasColumnName("Descricao");
  21            this.Property(t => t.PrecoCompra).HasColumnName("PrecoCompra");
  22            this.Property(t => t.PrecoVenda).HasColumnName("PrecoVenda");
  23            this.Property(t => t.QtdeEstoque).HasColumnName("QtdeEstoque");
  24            this.Property(t => t.DataCadastro).HasColumnName("DataCadastro");
  25            this.Property(t => t.StatusProduto).HasColumnName("StatusProduto");
  26        }
  27    }
  28 }

Nessa listagem utilizamos as mesmas classes e métodos da anterior, alterando apenas os nomes da tabela e colunas. Podemos então criar a classe PedidoCabecalhoMap para fazer o mapeamento da tabela PedidoCabecalho, de acordo com a Listagem 7.

Listagem 7. Implementação da classe PedidoCabecalhoMap.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Data.Entity.ModelConfiguration;
  04 using System.Linq;
  05 using System.Web;
  06
  07 namespace Relatorios_ASPNET_MVC.Models
  08
  09    public class PedidoCabecalhoMap : EntityTypeConfiguration<PedidoCabecalho>
  10    {
  11        public PedidoCabecalhoMap()
  12        {
  13            this.HasKey(t => t.PedidoCabId);
  14            this.Property(t => t.StatusPedido).HasMaxLength(20);
  15
  16            this.ToTable(“PedidoCabecalho”);
  17            this.Property(t => t.PedidoCabId).HasColumnName(“PedidoCabId”);
  18            this.Property(t => t.ClienteId).HasColumnName(“ClienteId”);
  19            this.Property(t => t.ValorTotalPedido).HasColumnName(“ValorTotalPedido”);
  20            this.Property(t => t.QtdeItens).HasColumnName(“QtdeItens”);
  21            this.Property(t => t.StatusPedido).HasColumnName(“StatusPedido”);
  22            this.Property(t => t.DataPedido).HasColumnName(“DataPedido”);
  23
  24            this.HasRequired(t => t.Cliente)
  25                .WithMany(t => t.PedidoCabecalho)
  26                .HasForeignKey(d => d.ClienteId);
  27        }
  28    }
  29 }

Essa classe novamente usa as mesmas classes e métodos que já vimos, porém ela possui alguns detalhes que merecem destaque:

· Linhas 24 a 26: O primeiro ponto a se destacar é o método HasRequired, que informa que um cliente é necessário para o cadastro do pedido. Na sequência é chamado o método WithMany, que informa que há um relacionamento de Um-Para-Muitos entre o cliente e o cabeçalho do pedido. Por fim é chamado o método HasForeignKey que define a chave estrangeira como sendo a primária ClienteId da classe Cliente.

Para finalizar o mapeamento, a última classe a ser implementada é a ItemPedidoMap, cujo código encontra-se na Listagem 8.

Listagem 8. Implementação da classe ItemPedidoMap.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Data.Entity.ModelConfiguration;
  04 using System.Linq;
  05 using System.Web;
  06
  07 namespace Relatorios_ASPNET_MVC.Models
  08 {
  09    public class ItemPedidoMap : EntityTypeConfiguration<ItemPedido>
  10    {
  11        public ItemPedidoMap()
  12        {
  13            this.HasKey(t => t.ItemPedidoId);
  14            this.Property(t => t.StatusItem).HasMaxLength(20);
  15
  16            this.ToTable("ItemPedido");
  17            this.Property(t => t.ItemPedidoId).HasColumnName("ItemPedidoId");
  18            this.Property(t => t.PedidoCabId).HasColumnName("PedidoCabId");
  19            this.Property(t => t.ProdutoId).HasColumnName("ProdutoId");
  20            this.Property(t => t.Quantidade).HasColumnName("Quantidade");
  21            this.Property(t => t.ValorUnitario).HasColumnName("ValorUnitario");
  22            this.Property(t => t.Subtotal).HasColumnName("Subtotal");
  23            this.Property(t => t.StatusItem).HasColumnName("StatusItem");
  24
  25            this.HasRequired(t => t.PedidoCabecalho).WithMany(t => t.ItemPedido)
  26                .HasForeignKey(d => d.PedidoCabId);
  27
  28            this.HasRequired(t => t.Produto).WithMany(t => t.ItemPedido)
  29                .HasForeignKey(d => d.ProdutoId);
  30        }
  31    }
  32 }

Observe que no intervalo das linhas 25 a 29 temos as definições dos relacionamentos Um-Par-Muitos através do uso do método WithMany entre as classes ItemPedido, PedidoCabecalho e Produto.

Criando o DbContext para o EF Code First

Para podermos trabalhar de fato com o Entity Framework Code First e gerar o banco de dados, será necessário criar uma classe que herde de DbContext e na qual será configurado o nome do banco de dados a ser gerado, as tabelas que irão compor a base, e por fim determinar que seja usado o mapeamento que realizamos anteriormente com a Fluent API.

Insira então uma nova classe chamada VendaRelatorioDbContext dentro da pasta Model e a implemente conforme a Listagem 9.

Listagem 9. Implementação da classe VendaRelatorioDbContext.

  01 using System;
  02 using System.Collections.Generic;
  03 using System.Data.Entity;
  04 using System.Linq;
  05 using System.Web;
  06 
  07 namespace Relatorios_ASPNET_MVC.Models
  08 {
  09    public class VendaRelatorioDbContext: DbContext
  10    {
  11        static VendaRelatorioDbContext()
  12        {
  13            Database.SetInitializer<VendaRelatorioDbContext>(null);
  14        }
  15
  16        public VendaRelatorioDbContext()
  17            : base("Name=VendaRelatorioDbContext")
  18        {
  19        }
  20
  21        public DbSet<Cliente> Clientes { get; set; }
  22        public DbSet<ItemPedido> ItemPedidos { get; set; }
  23        public DbSet<PedidoCabecalho> PedidoCabecalhos { get; set; }
  24        public DbSet<Produto> Produtos { get; set; }
  25
  26        protected override void OnModelCreating(DbModelBuilder modelBuilder)
  27        {
  28            modelBuilder.Configurations.Add(new ClienteMap());
  29            modelBuilder.Configurations.Add(new ItemPedidoMap());
  30            modelBuilder.Configurations.Add(new PedidoCabecalhoMap());
  31            modelBuilder.Configurations.Add(new ProdutoMap());
  32        }
  33    }
  34 }

Essa classe representa o DbContext, classe central utilizada pelo EF Code First para obtermos acesso ao banco de dados, armazenando as coleções de entidades que serão mapeadas. Alguns pontos sobre essa classe merecem destaque:

· Linha 13: Aqui definimos que a própria classe deve ser utilizada para inicializar o banco de dados;

· Linha 17: Nesta linha temos que informar o nome da conexão de acesso a dados, conforme consta na seção Connection Strings no arquivo WebConfig, que pode ser vista na Listagem 10. Perceba que o nome da Connection String é o mesmo nome de nosso contexto;

· Linhas 21 a 24: Neste intervalo devemos informar todas as classes que farão parte do mapeamento objeto-relacional através de uma propriedade do tipo DbSet, que representa uma coleção de objetos com tipagem genérica que serão persistidos e recuperados do banco de dados automaticamente pelo Entity Framework;

· Linhas 26 a 32: Neste intervalo informamos as classes de mapeamento da Fluent API através de uma instância do DbModelBuilder que é recebida por parâmetro no método sobrescrito OnModelCreating do DbContext. Com isso, quando o modelo for criado, essas classes serão utilizadas para realizar o mapeamento.

Listagem 10. Connection Strings WebConfig.

  01  <connectionStrings>
  02      <add name="VendaRelatorioDbContext"
  03           connectionString="Data Source=.\SQLEXPRESS;Initial   Catalog=VendaRelatorioDbContext;Persist Security Info=True;User  ID=sa;Password=SuaSenha;MultipleActiveResultSets=True"
  04           providerName="System.Data.SqlClient" />
  05  </connectionStrings>

Na Connection String, é importante perceber que o nome do servidor pode variar. Aqui foi utilizada a instância padrão do SQLEXPRESS, mas caso seja necessário, basta indicar no parâmetro Data Source qual servidor deve ser utilizado. Os demais parâmetros, em geral, devem permanecer os mesmos.

Habilitando o Migrations para gerar o banco

Após toda a estrutura necessária para trabalharmos com o Entity Framework Code First ter sido criada, precisaremos agora gerar o banco de dados no SQL Server 2014 Express. Para isso utilizaremos o sistema de versionamento de banco de dados do próprio EF chamado Migrations. Esse recurso permite que façamos alterações nas classes modelo da aplicação e depois atualizemos a base de dados diretamente pelo Visual Studio, sem precisar escrever código SQL para refletir essas mudanças.

Para utilizamos o Migrations, primeiramente é necessário habilitar esse recurso no projeto, para isso digite o seguinte comando no Package Manager Console: Enable-Migrations.

Caso tenha corrido tudo bem na instalação, será apresentada uma mensagem informando que o Migrations foi habilitado no projeto. Além disso, será criada uma nova pasta no projeto chamada Migrations e uma classe chamada Configuration, onde podemos realizar algumas configurações sobre as alterações a serem realizadas no banco. Nessa classe devemos definir como true a propriedade AutomaticMigrationsEnabled, localizado dentro do construtor, para que o próprio Migrations fique responsável por atualizar a base de dados sempre que realizarmos uma alteração em nosso modelo.

Para finalizar e gerar o banco de dados, digite o seguinte comando no Package Manager Console: Update-Database. Isso fará com que, baseado no modelo de classes que construímos, o banco de dados seja gerado.

Agora podemos abrir o SQL Server Management Studio e verificar se o banco de dados foi criado, conforme mostra a Figura 3.

Como gerar Relatórios no ASP.NET MVC

Figura 3. Banco de dados gerado com o Migrations

Relatório de listagem de Clientes

Para de fato iniciarmos o desenvolvimento do primeiro relatório, precisaremos primeiro instalar dois plugins através do Nuget. O primeiro é o PagedList, que nos dará a possibilidade de paginação e totalização do relatório. O segundo plugin é o Rotativa, que converte HTML e CSS para PDF usando o motor WebKit.

Abra o Package Manager Console e instale os dois plug-ins utilizando os seguintes comandos:

 
  Install-Package PagedList.MVC 

  Install-Package Rotativa

Após a execução desses comandos teremos as referências adicionadas na pasta References. Agora vamos criar o controller que será responsável por conter todas as actions referentes aos relatórios de nosso projeto. Para isso, clique com botão direito na pasta Controller>Add>Controller e selecione a opção “MVC 5 Controller – Empty”. Clique em Add e nomeie o controller como Relatorios.

Por padrão esse controller será criado apenas com uma action Index, porém iremos realizar algumas modificações e implementar a action ListagemClientes, que tratará de gerar nosso primeiro relatório. Implemente o controller Relatorios conforme o código presente na Listagem 11.

Listagem 11. Implementação do controller Relatorios para a Listagem de Clientes.

  01 using Relatorios_ASPNET_MVC.Models;
  02 using System;
  03 using System.Collections.Generic;
  04 using System.Linq;
  05 using System.Web;
  06 using System.Web.Mvc;
  07 using PagedList;
  08 using Rotativa;
  09 using Rotativa.Options;
  10
  11 namespace Relatorios_ASPNET_MVC.Controllers
  12 {
  13    public class RelatoriosController : Controller
  14    {
  15        private VendaRelatorioDbContext db = new VendaRelatorioDbContext();
  16        public ActionResult ListagemClientes(int? pagina, Boolean? gerarPDF)
  17        {
  18            var listagemClientes = db.Clientes.OrderBy(n => n.ClienteId).ToList<Cliente>();
  19
  20            if (gerarPDF != true)
  21            {
  22                //Definindo a paginação              
  23                int paginaQdteRegistros = 10;
  24                int paginaNumeroNavegacao = (pagina ?? 1);
  25
  26                return View(listagemClientes.ToPagedList(paginaNumeroNavegacao, paginaQdteRegistros));
  27            }
  28            else
  29            {
  30                int paginaNumero = 1;
  31                
  32                var pdf = new ViewAsPdf
  33                {
  34                    ViewName = "ListagemClientes",
  35                    PageSize = Size.A4,
  36                    IsGrayScale = true,
  37                    Model = listagemClientes.ToPagedList(paginaNumero, listagemClientes.Count)
  38                };
  39                return pdf;
  40            }
  41        }
  42    }
  43 }

Observe alguns detalhes importantes sobre esse controller:

· Linhas 7 a 9: Adicionamos as referências necessárias para usar as bibliotecas do PagedList e Rotativa;

· Linha 15: aqui declaramos um objeto do tipo VendaRelatorioDbContext, que nos permitirá acessar os dados da aplicação;

· Linha 16: Aqui é definida a action ListagemClientes, que recebe como parâmetro o número da página a ser navegada para utilizarmos na paginação e outro parâmetro chamado gerarPDF, que informa através de um Boolean se o Rotativa deve gerar o relatório em PDF ou o mesmo deve apenas ser renderizado normalmente pelo browser e ser paginado com PagedList;

· Linha 18: Realizamos uma consulta com o EF para obter a listagem de clientes e compor o relatório, armazenando o resultado em uma variável chamada listagemClientes;

· Linhas 20 a 27: Neste primeiro bloco temos uma estrutura condicional que verifica se a variável gerarPDF é diferente de true, caso seja, então definimos a quantidade de registros a serem exibidos por página com PagedList, verificando qual página deve ser retornada. Por fim é retornada a listagem utilizando o método ToPagedList, passando o número da página de navegação e a quantidade a ser exibida por página;

· Linhas 28 a 40: Este bloco será executado caso a variável gerarPDF seja true, assim definimos o valor da variável paginaNumero como 1 para o PagedList gerar apenas uma página HTML. Na sequência criamos uma variável chamada pdf, que recebe uma instância da classe ViewAsPdf referente ao Rotativa para gerarmos o relatório em PDF. Veja que no ViewAsPdf são definidos alguns atributos referentes ao nome da view que irá renderizar o relatório, o tamanho da página do PDF, escala e Model, que recebe a listagem de clientes através do PagedList.

Com essa action pronta para retornar a listagem de clientes, agora precisamos criar a view que de fato irá renderizar a página HTML com alguns recursos do Bootstrap. Para criar a view, clique com o botão direito sobre a action e depois em Add View. Em seguida será apresentada uma nova janela, conforme a Figura 4, onde você deve clicar em Add para finalizar e o Visual Studio criará o arquivo ListagemClientes.cshtml dentro da pasta Views/Relatorios.

Como gerar Relatórios no ASP.NET MVC

Figura 4. Criando a view ListagemClientes.

Implemente então a view ListagemClientes.cshtml conforme o código da Listagem 12, onde usamos o Bootstrap para montar nossa interface.

Listagem 12. Implementação da view ListagemClientes.cshtml.

  01 @model PagedList.IPagedList<Relatorios_ASPNET_MVC.Models.Cliente>
  02
  03 @{ ViewBag.Title = "ListagemClientes";
  04 Layout = "~/Views/Shared/_Layout.cshtml"; }
  05
  06 <div class="panel panel-default">
  07    <div class="panel-heading"><h5>Relatório Listagem de Clientes</h5></div>
  08    <div class="panel-body">
  09        <div class="row">
  10            <div class="col-md-12">
  11                <table class="table">
  12                    <tr>
  13                        <th>ID </th><th>Nome </th><th>CPF/CNPJ </th><th>Endereço </th><th>Bairro </th><th>Cidade </th>
  14                        <th>CEP </th><th>Email </th><th>Telefone </th><th>Status </th><th>Data cadastro </th>
  15                    </tr>
  16                    @foreach (var item in Model)
  17                    {
  18                        <tr>
  19                            <td>@Html.DisplayFor(modelItem => item.ClienteId)</td>
  20                            <td>@Html.DisplayFor(modelItem => item.Nome)</td>
  21                            <td>@Html.DisplayFor(modelItem => item.CpfCnpj)</td>
  22                            <td>@Html.DisplayFor(modelItem => item.Endereco)</td>
  23                            <td>@Html.DisplayFor(modelItem => item.Bairro)</td>
  24                            <td>@Html.DisplayFor(modelItem => item.Cidade)</td>
  25                            <td>@Html.DisplayFor(modelItem => item.Cep)</td>
  26                            <td>@Html.DisplayFor(modelItem => item.Email)</td>
  27                            <td>@Html.DisplayFor(modelItem => item.Telefone)</td>
  28                            <td>@Html.DisplayFor(modelItem => item.StatusCliente)</td>
  29                            <td>@Html.DisplayFor(modelItem => item.DataCadastro)</td>
  30                        </tr> }
  31                    <tr>
  32                        <td><b>@Model.Count registos de @Model.TotalItemCount</b></td>
  33                        <td><a href="/Relatorios/ListagemClientes?gerarPDF=true"><b>GERAR PDF</b></a></td>
  34                    </tr>
  35                </table>
  36            </div>
  37        </div>
  38        @{
  39            if (Model.TotalItemCount != Model.Count)
  40            {
  41                <div class="row">
  42                    <div class="col-md-12">
  43                        Página @(Model.PageCount < Model.PageNumber ? 0 : Model.PageNumber) de @Model.PageCount
  44
  45                        @if (Model.HasPreviousPage)
  46                        {
  47                            @Html.ActionLink("<<", "ListagemClientes", new { pagina = 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter })
  48                            @Html.Raw(" ");
  49                            @Html.ActionLink("< Anterior", "ListagemClientes", new { pagina = Model.PageNumber - 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter })
  50                        }
  51                        else
  52                        {
  53                            @:<<
  54                            @Html.Raw(" ");
  55                            @:< Anterior
  56                           }
  57
  58                        @if (Model.HasNextPage)
  59                        {
  60                            @Html.ActionLink("Próxima >", "ListagemClientes", new { pagina = Model.PageNumber + 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter })
  61                            @Html.Raw(" ");
  62                            @Html.ActionLink(">>", "ListagemClientes", new { pagina = Model.PageCount, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter })
  63                        }
  64                        else
  65                        {
  66                            @:Próxima >
  67                            @Html.Raw(" ")
  68                            @:>>
  69                    }
  70                    </div>
  71                </div>
  72            }
  73        }
  74    </div>
  75 </div>

Com relação a essa view, temos de observar alguns pontos importantes:

· Linha 1: Aqui é informado o model que irá representar a listagem de clientes na view, perceba que o mesmo é gerado a partir da interface IPagedList;

· Linhas 6 a 10: Neste intervalo é definido um painel para agrupar os campos do relatório através da classe panel e sistema de grids do Bootstrap;

· Linhas 11 a 15: Aqui é criada uma tabela utilizando a classe table do Bootstrap e em seguida é definido o cabeçalho da tabela;

· Linhas 16 a 30: Neste bloco é utilizado o foreach para iterar sobre os itens do model e exibir a listagem de clientes, criando uma nova linha (tr) na tabela para cada registro na coleção;

· Linhas 32 e 33: Primeiramente são utilizadas as propriedades Count e TotalItemCount que o PagedList fornece para obtermos a quantidade de registros da página e o total da listagem. Na sequência é criado um link para a action ListagemClientes, passando como parâmetro o gerarPDF como true para que o Rotativa possa gerar o relatório em PDF;

· Linhas 39 a 69: Neste bloco verificamos se o relatório deve ser paginado com uso de alguns atributos do PagedList, ou se o mesmo será gerado com o Rotativa e não precisará da paginação. Em seguida, caso seja realmente necessário, será implementada a paginação do relatório na página web com recursos do PagedList.

Para testar o relatório, insira alguns dados na tabela Cliente no banco de dados e execute o projeto para visualizar os dados com paginação e, logo depois, clique no link em 'GERAR PDF' para o Rotativa gerar o mesmo e possibilitar os recursos de impressão e gravação em disco. Veja as Figuras 5 e 6 que correspondem ao relatório em execução.

Como gerar Relatórios no ASP.NET MVC

abrir imagem em nova janela

Figura 5. Relatório com paginação do PagedList.

Como gerar Relatórios no ASP.NET MVC

abrir imagem em nova janela

Figura 6. Relatório gerado em PDF com o Rotativa.

Relatório com agrupamento, subtotais e passagem de parâmetro

Criaremos agora um relatório um pouco mais complexo, para exibir as vendas agrupando-as por pedido, informando o cliente ao qual a venda pertence e quais itens compõem o pedido. É importante frisar que o relatório deve ter subtotal nas quantidades vendidas e valores referentes aos itens de cada pedido de venda.

O primeiro passo para o desenvolvimento do relatório será criar um formulário para que o usuário possa informar o intervalo de datas referente ao período que deseja exibir no mesmo. Então, no controller Relatorios inclua mais uma action chamada FormVendasPorPedido, conforme mostra a Listagem 13.

Listagem 13. Action FormVendasPorPedido.

  01 public ActionResult FormVendasPorPedido()
  02 {
  03    return View();
  04 }

Repita o processo feito anteriormente para adicionar uma view referente a essa action e altere sua implementação de acordo com a Listagem 14.

Listagem 14. Implementação da view FormVendasPorPedido.cshtml

  01 @model Relatorios_ASPNET_MVC.Models.PedidoCabecalho
  02
  03 @{
  04    ViewBag.Title = "FormVendasPorPedido";
  05    Layout = "~/Views/Shared/_Layout.cshtml";
  06 }
  07
  08 <div class="panel panel-default">
  09    <div class="panel-heading">
  10        <h2>Relatório Venda por Pedido/Período</h2>
  11    </div>
  12    <div class="panel-body">
  13        <form method="post" action="/Relatorios/RelVendasPorPeriodo" id="frmVenda" class="form-horizontal">
  14
  15            <div class="form-group">
  16                <label for="dataInicial" class="col-sm-2 control-label">Data Inicial:</label>
  17                <div class="col-sm-10">
  18                    <input type="date" class="form-control" id="dataInicial" name="dataInicial" required>
  19                </div>
  20            </div>
  21            <div class="form-group">
  22                <label for="dataFinal" class="col-sm-2 control-label">Data Final</label>
  23                <div class="col-sm-10">
  24                    <input type="date" class="form-control" id="dataFinal" name="dataFinal" required>
  25                </div>
  26            </div>
  27
  28            <div class="form-group">
  29                <div class="col-sm-offset-2 col-sm-10">
  30                    <button type="submit" class="btn btn-default">Gerar Relatório</button>
  31                </div>
  32            </div>
  33        </form>
  34    </div>
  35 </div>

Aqui novamente utilizamos os recursos do Bootstrap para otimizar a interface, mas vale ainda destacar alguns pontos.

· Linha 13: Nesta linha é criado um form HTML que realiza uma requisição via método POST à action RelVendasPorPeriodo do controller Relatorios, que ainda será criada. Esta nova action será responsável por buscar os dados no banco de dados e retornar para a view que renderiza o relatório;

· Linha 15 a 32: Neste bloco foram criados os inputs para o usuário informar a data inicial e final do período de vendas.

Se executarmos o projeto neste momento iremos visualizar a página que é ilustrada na Figura 7, porém não podemos ainda submeter o formulário, pois iremos criar a action e view que irão de fato gerar o relatório.

Como gerar Relatórios no ASP.NET MVC

Figura 7. Formulário para definição do período para geração do relatório

Após ter sido desenvolvida a página para que o usuário possa informar o intervalo de datas, agora precisamos criar a action que irá receber esses parâmetros e realizar a consulta no banco de dados. Assim, insira no controller Relatorios o código da Listagem 15, onde temos a nova action RelVendasPorPeriodo.

Listagem 15. Implementação da action RelVendasPorPeriodo.

  01 public ActionResult RelVendasPorPeriodo(DateTime dataInicial, DateTime dataFinal, int? pagina, Boolean? gerarPDF)
  02 {
  03    var vendas = db.PedidoCabecalhos.Where(i => i.DataPedido >= dataInicial && i.DataPedido <= dataFinal).OrderBy(p=>p.PedidoCabId).ToList<PedidoCabecalho>();
  04
  05    ViewBag.dataInicial = dataInicial;
  06    ViewBag.dataFinal = dataFinal;
  07
  08    if (gerarPDF != true)
  09    {
  10 //Definindo a paginação      
  11 int paginaQdteRegistros = 2;
  12 int paginaNumeroNavegacao = (pagina ?? 1);
  13
  14 return View(vendas.ToPagedList(paginaNumeroNavegacao, paginaQdteRegistros));
  15    }
  16    else
  17    {
  18 int paginaNumero = 1;
  19
  20 var pdf = new ViewAsPdf
  21 {
  22    ViewName = "RelVendasPorPeriodo",
  23    PageSize = Size.A4,
  24    IsGrayScale = true,
  25    Model = vendas.ToPagedList(paginaNumero, vendas.Count),    
  26 };
  27 return pdf;
  28    }
  29 }

Vejamos alguns detalhes sobre a implementação dessa listagem.

· Linha 1: Aqui temos a definição da action RelVendasPorPeriodo, que recebe como parâmetro a dataInicial e dataFinal;

· Linha 3: Aqui é realizada a consulta ao banco de dados, já filtrando o relatório referente ao intervalo das vendas, através do método Where que recebe uma expressão lambda como argumento;

· Linha 5 e 6: Aqui foram criadas duas propriedades na ViewBag para transferirmos para a view as datas de filtragem dos pedidos.

Nas linhas 8 a 28 basicamente repetimos o procedimento realizado no relatório anterior, verificando se deve ser gerado o PDF, ou se devemos retornar a view convencional com os dados a serem exibidos em tela. O último passo para finalizar este relatório será criar a view correspondente ao mesmo, cujo código encontra-se nas Listagens 16 e 17.

Listagem 16. Implementação da view RelVendasPorPeriodo.cshtml.

  01 @model PagedList.IPagedList<Relatorios_ASPNET_MVC.Models.PedidoCabecalho>
  02
  03 @{ ViewBag.Title = "Relatório de Vendas";
  04 Layout = "~/Views/Shared/_Layout.cshtml"; }
  05
  06 <div class="panel panel-default">
  07    <div class="panel-heading"><h4><b>Relatório Venda por Pedido/Período De: @ViewBag.dataInicial á @ViewBag.dataFinal</b></h4></div>
  08    <div class="panel-body">
  09        <div class="row">
  10            <div class="col-md-12">
  11                <table class="table">
  12                    <tr>
  13                        <th>Pedido </th>
  14                        <th>Item </th>
  15                        <th>Descrição </th>
  16                        <th>Quantidade </th>
  17                        <th>Valor Unitário </th>
  18                        <th>Sub Total </th>
  19                        <th>Status Item </th>
  20                        <th>Data Venda</th>
  21                    </tr>
  22                    @{
  23                        foreach (var item in Model)
  24                        {
  25                            foreach (var itens in item.ItemPedido)
  26                            {
  27                                <tr>
  28                                    <td>@Html.DisplayFor(modelItem => itens.PedidoCabecalho.PedidoCabId)</td>
  29                                    <td>@Html.DisplayFor(modelItem => itens.ItemPedidoId)</td>
  30                                    <td>@Html.DisplayFor(modelItem => itens.Produto.Descricao)</td>
  31                                    <td>@Html.DisplayFor(modelItem => itens.Quantidade)</td>
  32                                    <td>@Html.DisplayFor(modelItem => itens.ValorUnitario)</td>
  33                                    <td>@Html.DisplayFor(modelItem => itens.Subtotal)</td>
  34                                    <td>@Html.DisplayFor(modelItem => itens.StatusItem)</td>
  35                                    <td>@Html.DisplayFor(modelItem => itens.PedidoCabecalho.DataPedido)</td>
  36                                </tr>
  37                            }
  38                            <tr>
  39                                <th>Cliente</th><th>@item.Cliente.Nome</th><th></th><th>@item.QtdeItens</th>
  40                                <th></th><th>@item.ValorTotalPedido</th><th></th><th></th>
  41                            </tr>
  42                        }
  43                   }
  44                    <tr>
  45                        <th></th>
  46                        <th></th>
  47                        <th>Total Itens:</th>
  48                        <th>@Model.Sum(t => t.QtdeItens)</th>
  49                        <th>Total Geral:</th>
  50                        <th>@Model.Sum(t => t.ValorTotalPedido)</th>
  51                        <th></th>
  52                        <th></th>
  53                    </tr>
  54                    <tr>
  55                        <td><b>@Model.Count registos de @Model.TotalItemCount</b></td>
  56                        <td>@Html.ActionLink("GERAR PDF", "RelVendasPorPeriodo", new { gerarPDF = true, dataInicial = ViewBag.dataInicial, dataFinal = ViewBag.dataFinal })</td>
  57                    </tr>
  58                </table>
  59            </div>
  60        </div>

Vejamosva seguir alguns detalhes importantes sobre esse trecho da view.

· Linhas 11 a 21:Neste bloco é criada uma tabela para exibir os dados e informado o cabeçalho de cada coluna do relatório;

· Linhas 23 a 55: Neste intervalo temos dois foreach aninhados para que possamos exibir o subtotal da venda e itens do pedido;

· Linhas 48 e 59: Aqui são calculados os totais e exibidos no rodapé da tabela;

· Linha 56: Geramos o link que irá redirecionar para a mesma action, porém passando o argumento gerarPDF como true, para ativar a funcionalidade do plug-in Rotativa.

Listagem 17. Implementação da paginação na view RelVendasPorPeriodo.cshtml .

  01        @{
  02            if (Model.TotalItemCount != Model.Count)
  03            {
  04                <div class="row">
  05                    <div class="col-md-12">
  06                        Página @(Model.PageCount < Model.PageNumber ? 0 : Model.PageNumber) de @Model.PageCount
  07
  08                        @if (Model.HasPreviousPage)
  09                        {
  10                            @Html.ActionLink("<<", "RelVendasPorPeriodo", new { pagina = 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter, dataInicial = ViewBag.dataInicial, dataFinal = @ViewBag.dataFinal })
  11                            @Html.Raw(" ");
  12                            @Html.ActionLink("< Anterior", "RelVendasPorPeriodo", new { pagina = Model.PageNumber - 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter, dataInicial = ViewBag.dataInicial, dataFinal = ViewBag.dataFinal })
  13                        }
  14                        else
  15                        {
  16                            @:<<
  17                            @Html.Raw(" ");
  18                            @:< Anterior
  19                           }
  20
  21                        @if (Model.HasNextPage)
  22                        {
  23                            @Html.ActionLink("Próxima >", "RelVendasPorPeriodo", new { pagina = Model.PageNumber + 1, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter, dataInicial = ViewBag.dataInicial, dataFinal = ViewBag.dataFinal })
  24                            @Html.Raw(" ");
  25                            @Html.ActionLink(">>", "RelVendasPorPeriodo", new { pagina = Model.PageCount, sortOrder = ViewBag.CurrentSort, currentFilter = ViewBag.CurrentFilter, dataInicial = ViewBag.dataInicial, dataFinal = ViewBag.dataFinal })
  26                        }
  27                        else
  28                        {
  29                            @:Próxima >
  30                            @Html.Raw(" ")
  31                            @:>>
  32                    }
  33                    </div>
  34                </div>
  35            }
  36        }
  37    </div>
  38</div>

Nessa listagem estamos implementando a funcionalidade de paginação da tabela, adicionando links dinamicamente para avançar entre os registros de acordo com a quantidade total de linhas e a quantidade a ser exibida por página. Nos blocos que se iniciam nas linhas 8 e 21, respectivamente, utilizamos os recursos oferecidos pelo PagedList para verificar se devemos permitir ao usuário navegar para a página anterior e para a próxima.

Ao executar o projeto, iremos direto para a página do formulário de datas do período de vendas, e logo após informá-las, devemos clicar no botão 'Gerar Relatório' para que o sistema possa apresentar o mesmo, como na Figura 8.

Como gerar Relatórios no ASP.NET MVC

abrir imagem em nova janela

Figura 8. Relatório de vendas.

Clicando no botão 'GERAR PDF' novamente, teremos o resultado visto na Figura 9.

Como gerar Relatórios no ASP.NET MVC
abrir imagem em nova janela

Figura 9. Relatório de vendas em PDF.

A criação de relatórios no ASP.NET MVC é facilitada pelo fato de trabalharmos com as próprias views do sistema, gerando-as em HTML e podendo utilizar recursos como o Bootstrap para oferecer a melhor visualização em resoluções de telas distintas, além de garantir a compatibilidade com os principais browsers modernos.

Neste artigo não foram explorados todos os recursos disponíveis nos plug-ins PagedList e Rotativa, ficando como sugestão para o leitor buscar maiores detalhes sobre o que é possível fazer com essas ferramentas na página oficial de cada uma delas, disponível na seção Links.