Parte 2, adicionar um modelo a um aplicativo Razor Pages no ASP.NET Core

Neste tutorial, classes são adicionadas para o gerenciamento de filmes em um banco de dados. As classes de modelo do aplicativo usam o Entity Framework Core (EF Core) para trabalhar com o banco de dados. EF Core é um O/RM (mapeador relacional de objetos) que simplifica o acesso a dados. Você escreve as classes de modelo primeiro e o EF Core cria o banco de dados.

As classes de modelo são conhecidas como classes POCO (de "Objetos CLR Básicos") porque não têm dependência do EF Core. Elas definem as propriedades dos dados que são armazenados no banco de dados.

Adicionar um modelo de dados

Visual Studio

1. No Gerenciador de Soluções, clique com o botão direito do mouse no projeto RazorPagesMovie>Adicionar>Nova Pasta. Nomeie a pasta Models.

2. Clique com o botão direito do mouse na pasta Models. Selecione Adicionar>Classe. Dê à classe o nome Movie.

3. Adicione as seguintes propriedades à classe Movie:

   using System.ComponentModel.DataAnnotations;
   
   namespace RazorPagesMovie.Models;
   
   public class Movie
   {
       public int Id { get; set; }
       public string? Title { get; set; }
       [DataType(DataType.Date)]
       public DateTime ReleaseDate { get; set; }
       public string? Genre { get; set; }
       public decimal Price { get; set; }
   }
   

A classe Movie contém:

• O campo ID é necessário para o banco de dados para a chave primária.

• Um atributo [DataType] que especifica o tipo de dados na propriedade ReleaseDate. Com esse atributo:

  • O usuário não precisa inserir informações de horário no campo de data.
  • Somente a data é exibida, não as informações de tempo.

• O ponto de interrogação após string indica que a propriedade permite valor nulo. Para obter mais informações, confira Tipos de referência anuláveis.

DataAnnotations são abordados em um tutorial posterior.

Crie o projeto para verificar se não há erros de compilação.

Visual Studio Code

1. Adicione uma pasta chamada Models.
2. Adicione uma classe à pasta Models nomeada Movie.cs.

Adicione as seguintes propriedades à classe Movie:

using System.ComponentModel.DataAnnotations;

namespace RazorPagesMovie.Models;

public class Movie
{
    public int Id { get; set; }
    public string? Title { get; set; }
    [DataType(DataType.Date)]
    public DateTime ReleaseDate { get; set; }
    public string? Genre { get; set; }
    public decimal Price { get; set; }
}

A classe Movie contém:

• Um campo ID para fornecer uma chave primária para o banco de dados.

• Um atributo [DataType] para especificar o tipo de dados no campo ReleaseDate. Com esse atributo:

  • O usuário não precisa inserir informações de tempo no campo de data.
  • Somente a data é exibida, não as informações de tempo.

• O ponto de interrogação após string indica que a propriedade permite valor nulo. Para obter mais informações, confira Tipos de referência anuláveis.

DataAnnotations são abordados em um tutorial posterior.

Adicionar pacotes NuGet e ferramentas de EF

Execute os seguintes comandos da CLI do .NET:

dotnet tool uninstall --global dotnet-aspnet-codegenerator
dotnet tool install --global dotnet-aspnet-codegenerator
dotnet tool uninstall --global dotnet-ef
dotnet tool install --global dotnet-ef
dotnet add package Microsoft.EntityFrameworkCore.Design
dotnet add package Microsoft.EntityFrameworkCore.SQLite
dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Tools

Os comandos anteriores adicionam:

• As ferramentas da CLI (interface de linha de comando) para EF Core
• A ferramenta de scaffolding aspnet-codegenerator.
• Ferramentas de tempo de design para EF Core
• O provedor do EF Core SQLite, que instala o pacote EF Core como uma dependência.
• Pacotes necessários para scaffolding: Microsoft.VisualStudio.Web.CodeGeneration.Design e Microsoft.EntityFrameworkCore.SqlServer.

Para obter diretrizes sobre várias configurações de ambiente que permitem que um aplicativo configure seus contextos de banco de dados por ambiente, consulte Usar vários ambientes no ASP.NET Core.

Observação

Por padrão, a arquitetura dos binários do .NET a serem instalados representa a arquitetura do SO sendo executado no momento. Para especificar uma arquitetura de SO diferente, consulte instalação da ferramenta dotnet, opção --arch. Para obter mais informações, confira o problema dotnet/AspNetCore.Docs #29262 do GitHub.

No Visual Studio Code, pressione Ctrl+F5 (Windows) ou ⌘+F5 (macOS) para executar o aplicativo sem depuração.

No Painel abaixo da região do editor, selecione a guia PROBLEMAS ou, no menu Exibir, selecione Problemas, se não estiver em exibição no momento. Verifique se não há erros de compilação.

Visual Studio para Mac

1. Na Janela Ferramentas de Solução, pressione Ctrl e clique no projeto RazorPagesMovie e selecione Adicionar>Nova Pasta.... Nomeie a pasta Models.

2. Pressione Control e clique na pasta Models e selecione Adicionar>Nova Classe....

3. Na caixa de diálogo Novo Arquivo:

   1. Selecione Geral no painel esquerdo.
   2. Selecione Classe Vazia no painel central.
   3. Nomeie a classe Movie e selecione Criar.

4. Adicione as seguintes propriedades à classe Movie:

   using System.ComponentModel.DataAnnotations;
   
   namespace RazorPagesMovie.Models;
   
   public class Movie
   {
       public int Id { get; set; }
       public string? Title { get; set; }
       [DataType(DataType.Date)]
       public DateTime ReleaseDate { get; set; }
       public string? Genre { get; set; }
       public decimal Price { get; set; }
   }
   

A classe Movie contém:

• Um campo ID para fornecer uma chave primária para o banco de dados.

• Um atributo [DataType] para especificar o tipo de dados no campo ReleaseDate. Com esse atributo:

  • O usuário não precisa inserir informações de horário no campo de data.
  • Somente a data é exibida, não as informações de tempo.

DataAnnotations são abordados em um tutorial posterior.

Crie o projeto para verificar se não há erros de compilação.

Fazer scaffold do modelo de filme

Nesta seção, é feito o scaffold do modelo de filme. Ou seja, a ferramenta de scaffolding gera páginas para operações de CRUD (Criar, Ler, Atualizar e Excluir) para o modelo do filme.

Visual Studio

1. Crie a pasta Pages/Movies:

   1. Clique com o botão direito do mouse na pasta Pages>Adicionar>Nova Pasta.
   2. Dê à pasta o nome Movies.

2. Clique com o botão direito do mouse na pasta Pages/Movies>Adicionar>Novo item com scaffold.

   

3. No diálogo Adicionar Scaffold, selecione Razor Pages usando o Entity Framework (CRUD)>Adicionar.

   

4. Conclua a caixa de diálogo Adicionar Razor Pages usando o Entity Framework (CRUD):

   1. Na lista suspensa Classe de modelo, selecione Filme (RazorPagesMovie.Models).
   2. Na linha Classe de contexto de dados, selecione o sinal + (adição).
      1. Na caixa de diálogo Adicionar contexto de dados, o nome da classe RazorPagesMovie.Data.RazorPagesMovieContext é gerado.
      2. Na lista suspensa Provedor de banco de dados, selecione SQL Server.
   3. Selecione Adicionar.

   

O arquivo appsettings.json é atualizado com a cadeia de conexão usada para se conectar a um banco de dados local.

Visual Studio Code

• Abra um shell de comando no diretório do projeto, que contém os arquivos Program.cs e .csproj. Execute o seguinte comando:

  dotnet aspnet-codegenerator razorpage -m Movie -dc RazorPagesMovie.Data.RazorPagesMovieContext -udl -outDir Pages/Movies --referenceScriptLibraries --databaseProvider sqlite
  

A tabela a seguir detalha as opções do gerador de código do ASP.NET Core.

Opção	Descrição
-m	O nome do modelo.
-dc	A classe DbContext a ser usada, incluindo namespace.
-udl	Use o layout padrão.
-outDir	O caminho da pasta de saída relativa para criar as exibições.
--referenceScriptLibraries	Adiciona _ValidationScriptsPartial para editar e criar páginas

Use a opção -h para obter ajuda sobre o comando dotnet aspnet-codegenerator razorpage:

dotnet aspnet-codegenerator razorpage -h

Para saber mais, confira dotnet aspnet-codegenerator.

Usar SQLite para desenvolvimento, SQL Server para produção

Quando o SQLite é selecionado, o código gerado pelo modelo está pronto para desenvolvimento. O código a seguir mostra como selecionar a cadeia de conexão SQLite em desenvolvimento e SQL Server em produção.

using Microsoft.EntityFrameworkCore;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext")));
}
else
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlServer(builder.Configuration.GetConnectionString("ProductionMovieContext")));
}

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

O código anterior não chama UseDeveloperExceptionPage em desenvolvimento porque WebApplication chama UseDeveloperExceptionPage no modo de desenvolvimento.

Visual Studio para Mac

1. Adicione o pacote NuGet Microsoft.EntityFrameworkCore.Sqlite, que é necessário para a ferramenta de scaffolding.

   1. Na Janela Ferramentas de Solução, pressione Ctrl e clique no projeto RazorPagesMovie e selecione Abrir no Terminal.

   A janela Terminal é aberta com o prompt de comando no diretório do projeto, que contém os arquivos Program.cs e .csproj.

   1. Execute os seguintes comandos da CLI do .NET:

     dotnet add package Microsoft.EntityFrameworkCore.SQLite
   

2. Crie uma pasta Pages/Movies:

   1. Pressione Control e clique na pasta Pages>Adicionar>Nova Pasta.
   2. Dê à pasta o nome Movies.

3. Pressione Control e clique na pasta Pages/Movies>Adicionar>Novo scaffolding....

   

4. No diálogo Novo scaffolding, selecione Razor Pages usando o Entity Framework (CRUD)>Avançar.

   

5. Conclua a caixa de diálogo Adicionar Razor Pages usando o Entity Framework (CRUD):

   1. Na linha Classe do modelo a ser usada:, insira Movie.
   2. Na Classe DbContext a ser usada: linha, nomeie a classe RazorPagesMovie.Data.RazorPagesMovieContext.
   3. Selecione Concluir.

   

O processo de scaffolding pode levar algum tempo para ser concluído, pois os pacotes necessários são baixados e adicionados automaticamente ao projeto.

O arquivo appsettings.json é atualizado com a cadeia de conexão usada para se conectar a um banco de dados local.

Usar SQLite para desenvolvimento, SQL Server para produção

Quando o SQLite é selecionado, o código gerado pelo modelo está pronto para desenvolvimento. O código a seguir mostra como selecionar a cadeia de conexão SQLite em desenvolvimento e SQL Server em produção.

using Microsoft.EntityFrameworkCore;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext")));
}
else
{
    builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
        options.UseSqlServer(builder.Configuration.GetConnectionString("ProductionMovieContext")));
}

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

O código anterior não chama UseDeveloperExceptionPage em desenvolvimento porque WebApplication chama UseDeveloperExceptionPage no modo de desenvolvimento.

Arquivos criados e atualizados

O processo de scaffold cria os arquivos a seguir:

• Pages/Movies: Create, Delete, Details, Edit e Index.
• Data/RazorPagesMovieContext.cs

Os arquivos criados são explicados no próximo tutorial.

O processo de scaffold adiciona o seguinte código realçado ao arquivo Program.cs:

Visual Studio

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

Visual Studio Code/Visual Studio para Mac

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

As alterações Program.cs são explicadas posteriormente neste tutorial.

Criar o esquema de banco de dados inicial usando o recurso de migração do EF

O recurso de migrações no Entity Framework Core fornece uma maneira de:

• Crie o esquema inicial do banco de dados.
• Atualize incrementalmente o esquema de banco de dados para mantê-lo em sincronia com o modelo de dados do aplicativo. Os dados existentes no banco de dados são preservados.

Visual Studio

Nesta seção, a janela do PMC (Console de Gerenciador de Pacotes) é usada para:

• Adicione uma migração inicial.
• Atualize o banco de dados com a migração inicial.

1. No menu Ferramentas, selecione Gerenciador de Pacotes NuGet>Console do Gerenciador de Pacotes.

   

2. No PMC, insira os seguintes comandos:

   Add-Migration InitialCreate
   Update-Database
   

• O comando Add-Migration gera código para criar o esquema de banco de dados inicial. O esquema é baseado no modelo especificado em DbContext. O argumento InitialCreate é usado para nomear a migração. Qualquer nome pode ser usado, mas, por convenção, um nome que descreve a migração é selecionado.

• O comando Update-Database executa o método Up em migrações que não foram aplicadas. Nesse caso, o comando executa o método Up no arquivo Migrations/<time-stamp>_InitialCreate.cs, que cria o banco de dados.

Visual Studio Code

• Clique com o botão direito do mouse no projeto RazorPagesMovie.csproj e selecione Abrir no Terminal Integrado.

  A janela Terminal é aberta com o prompt de comando no diretório do projeto, que contém os arquivos Program.cs e .csproj.

• Execute os seguintes comandos da CLI do .NET:

  dotnet ef migrations add InitialCreate
  dotnet ef database update
  

• O comando migrations gera código para criar o esquema de banco de dados inicial. O esquema é baseado no modelo especificado em DbContext. O argumento InitialCreate é usado para nomear as migrações. Qualquer nome pode ser usado, mas, por convenção, um nome que descreve a migração é selecionado.

• O comando update executa o método Up em migrações que não foram aplicadas. Nesse caso, update executa o método Up no arquivo Migrations/<time-stamp>_InitialCreate.cs, que cria o banco de dados.

Observação

Para SQLite, o tipo de coluna para o campo Price é definido como TEXT. Isso é resolvido em uma etapa posterior.

Visual Studio para Mac

• Pressione Control e clique no projeto RazorPagesMovie e selecione Abrir no Terminal.

  A janela Terminal é aberta com o prompt de comando no diretório do projeto, que contém os arquivos Program.cs e .csproj.

• Execute os seguintes comandos da CLI do .NET:

  dotnet tool uninstall --global dotnet-ef
  dotnet tool install --global dotnet-ef
  dotnet ef migrations add InitialCreate
  dotnet ef database update
  

• Os comandos tool instalam as ferramentas mais recentes do Entity Framework Core depois de desinstalar qualquer versão anterior, se houver.

  Observação

  Por padrão, a arquitetura dos binários do .NET a serem instalados representa a arquitetura do SO sendo executado no momento. Para especificar uma arquitetura de SO diferente, consulte instalação da ferramenta dotnet, opção --arch. Para obter mais informações, confira o problema dotnet/AspNetCore.Docs #29262 do GitHub.

• O comando migrations gera código para criar o esquema de banco de dados inicial. O esquema é baseado no modelo especificado em DbContext. O argumento InitialCreate é usado para nomear as migrações. Qualquer nome pode ser usado, mas, por convenção, um nome que descreve a migração é selecionado.

• O comando update executa o método Up em migrações que não foram aplicadas. Nesse caso, update executa o método Up no arquivo Migrations/<time-stamp>_InitialCreate.cs, que cria o banco de dados.

Observação

Para SQLite, o tipo de coluna para o campo Price é definido como TEXT. Isso é resolvido em uma etapa posterior.

O seguinte aviso é exibido, que é abordado em uma etapa posterior:

Nenhum tipo foi especificado para a coluna decimal 'Preço' no tipo de entidade 'Filme'. Isso fará com que valores sejam truncados silenciosamente se não couberem na precisão e na escala padrão. Especifique explicitamente o tipo de coluna do SQL Server que pode acomodar todos os valores usando 'HasColumnType()'.

O contexto de dados RazorPagesMovieContext:

• Deriva de Microsoft.EntityFrameworkCore.DbContext.
• Especifica quais entidades são incluídas no modelo de dados.
• Coordena a funcionalidade EF Core, como Criar, Ler, Atualizar e Excluir, para o modelo Movie.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using RazorPagesMovie.Models;

namespace RazorPagesMovie.Data
{
    public class RazorPagesMovieContext : DbContext
    {
        public RazorPagesMovieContext (DbContextOptions<RazorPagesMovieContext> options)
            : base(options)
        {
        }

        public DbSet<RazorPagesMovie.Models.Movie> Movie { get; set; } = default!;
    }
}

O código anterior cria uma propriedade DbSet<Movie> para o conjunto de entidades. Na terminologia do Entity Framework, um conjunto de entidades normalmente corresponde a uma tabela de banco de dados. Uma entidade corresponde a uma linha da tabela.

O nome da cadeia de conexão é passado para o contexto com a chamada de um método em um objeto DbContextOptions. Para o desenvolvimento local, o Sistema de configuração lê a cadeia de conexão do arquivo appsettings.json.

Testar o aplicativo

1. Executar o aplicativo e acrescentar /Movies à URL no navegador (http://localhost:port/movies).

   Você receberá a seguinte mensagem de erro:

   SqlException: Cannot open database "RazorPagesMovieContext-GUID" requested by the login. The login failed.
   Login failed for user 'User-name'.
   

   Você perdeu a etapa de migrações.

2. Teste o link Criar.

   

   Observação

   Talvez você não consiga inserir casas decimais ou vírgulas no campo Price. Para dar suporte à validação do jQuery para localidades com idiomas diferentes do inglês que usam uma vírgula (",") para um ponto decimal e formatos de data diferentes do inglês dos EUA, o aplicativo precisa ser globalizado. Para obter instruções sobre a globalização, consulte esse problema no GitHub.

3. Teste os links Editar, Detalhes e Excluir.

O tutorial a seguir explica os arquivos criados por scaffolding.

Examinar o contexto registrado com a injeção de dependência

O ASP.NET Core é construído com a injeção de dependência. Serviços, como o contexto de banco de dados do EF Core, são registrados com injeção de dependência durante a inicialização do aplicativo. Os componentes que exigem esses serviços (por exemplo, o Razor Pages) são fornecidos por meio dos parâmetros do construtor. O código de construtor que obtém uma instância de contexto do banco de dados é mostrado mais adiante no tutorial.

A ferramenta de scaffolding criou automaticamente um contexto de banco de dados e o registrou no contêiner da injeção de dependência. O código realçado a seguir é adicionado ao arquivo Program.cs pelo scaffolder:

Visual Studio

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

Visual Studio Code/Visual Studio para Mac

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
    options.UseSqlite(builder.Configuration.GetConnectionString("RazorPagesMovieContext") ?? throw new InvalidOperationException("Connection string 'RazorPagesMovieContext' not found.")));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

Solução de problemas com o exemplo concluído

Se você encontrar um problema que não possa resolver, compare seu código com o projeto concluído. Exibir ou baixar projeto concluído (como baixar).

Próximas etapas

Anterior: IntroduçãoPróximo: Razor Pages gerados por scaffolding