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

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

As classes de modelo são conhecidas como classes POCO (de "Plain-Old CLR Objects") porque não têm uma dependência de EF Core. Eles definem as propriedades dos dados armazenados no banco de dados.

Adicionar um modelo de dados

Estúdio Visual

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 rato na pasta Models. Selecione Adicionar>classe. Dê o nome à classe Filme.

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 é exigido pelo banco de dados para a chave primária.

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

  • O usuário não é obrigado a inserir informações de hora no campo de data.
  • Apenas a data é exibida, não as informações de hora.

• O ponto de interrogação após string indica que a propriedade é anulável. Para obter mais informações, consulte 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.

1. Adicione uma pasta chamada Models.
2. Adicione uma classe à pasta Models chamada 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 [DataType] atributo para especificar o tipo de dados no campo ReleaseDate. Com este atributo:

  • O usuário não é obrigado a inserir informações de hora no campo de data.
  • Apenas a data é exibida, não as informações de hora.

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

DataAnnotations são abordados em um tutorial posterior.

Adicionar pacotes NuGet e ferramentas 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 de interface de linha de comando (CLI) para EF Core
• A ferramenta de andaime aspnet-codegenerator .
• Ferramentas de tempo de design para EF Core
• O provedor SQLite EF Core, que instala o pacote EF Core como dependência.
• Materiais necessários para andaimes: Microsoft.VisualStudio.Web.CodeGeneration.Design e Microsoft.EntityFrameworkCore.SqlServer.

Para obter orientação sobre a configuração de vários ambientes que permite que um aplicativo configure seus contextos de banco de dados por ambiente, consulte ASP.NET Core runtime environments.

Note

Por padrão, a arquitetura dos binários do .NET a serem instalados representa a arquitetura do sistema operacional em execução no momento. Para especificar uma arquitetura de sistema operacional diferente, consulte dotnet tool install, --arch option. Para mais informações, consulte a issue do GitHub dotnet/AspNetCore.Docs #29262.

No Visual Studio Code, pressione Ctrl+F5 para executar o aplicativo sem depuração.

No painel abaixo da região do editor, selecione a guia PROBLEMAS ou, no menu Ver, selecione Problemas se não estiver atualmente visível. Verifique se não há erros de compilação.

Andaime o modelo do filme

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

Estúdio Visual

1. Crie a pasta Pages/Movies:

   1. Clique com o botão direito do rato na pasta Páginas>Adicionar>Nova Pasta.
   2. Nomeie a pasta Filmes.

2. Clique com o botão direito do rato na pasta Pages/Movies>Adicionar>Novo Item Estruturado.

   

3. Na caixa de diálogo Adicionar Novo Andaime, selecione Razor Páginas usando o Entity Framework (CRUD)>Adicionar.

   

4. Complete a caixa de diálogo Adicionar Razor Páginas usando o Entity Framework (CRUD).

   1. No menu pendente da classe Model , selecione Filme (RazorPagesMovie.Models).
   2. Na classe de contexto Data, na linha, selecione o sinal + de adição (mais).
      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.

• Abra um shell de comando para o 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 ASP.NET Core.

Option	Description
-m	O nome do modelo.
-dc	A classe DbContext a utilizar, incluindo o espaço de nomes.
-udl	Use o layout padrão.
-outDir	O caminho relativo da pasta de saída para criar as exibições.
--referenceScriptLibraries	Adiciona _ValidationScriptsPartial a 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 obter mais informações, consulte dotnet aspnet-codegenerator.

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

Quando 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 o 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 no modo de desenvolvimento porque WebApplication chama UseDeveloperExceptionPage no modo de desenvolvimento.

Warning

Este artigo usa um banco de dados local que não exige que o usuário seja autenticado. Os aplicativos de produção devem usar o fluxo de autenticação mais seguro disponível. Para obter mais informações sobre autenticação para aplicativos de teste e produção implantados, consulte Fluxos de autenticação seguros.

Arquivos criados e atualizados

O processo de andaime cria os seguintes ficheiros:

• Páginas/Filmes: Criar, Excluir, Detalhes, Editar e Indexar.
• Data/RazorPagesMovieContext.cs

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

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

Estúdio Visual

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.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

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.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.MapStaticAssets();
app.MapRazorPages();

app.Run();

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

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 de banco de dados inicial.
• Atualize incrementalmente o esquema do banco de dados para mantê-lo sincronizado com o modelo de dados do aplicativo. Os dados existentes na base de dados são preservados.

Estúdio Visual

Nesta seção, a janela Package Manager Console (PMC) é usada para:

• Adicione uma migração inicial.

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

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

  

• No PMC, digite o seguinte comando:

  Add-Migration InitialCreate
  

• 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 é selecionado um nome que descreve a migração.

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 os valores sejam truncados silenciosamente se não se ajustarem à precisão e escala padrão. Especifique explicitamente o tipo de coluna do servidor SQL que pode acomodar todos os valores usando 'HasColumnType()'.

• No PMC, digite o seguinte comando:

  Update-Database
  

  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.

• 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 o seguinte comando da CLI do .NET:

  dotnet ef migrations add InitialCreate
  

  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 é selecionado um nome que descreve a migração.

• Execute o seguinte comando da CLI do .NET:

  dotnet ef database update
  

  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.

Note

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

O contexto dos 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 Eliminar, para o modelo Movie.

A classe RazorPagesMovieContext no arquivo gerado Data/RazorPagesMovieContext.cs:

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 na tabela.

O nome da cadeia de conexão é passado para o contexto ao chamar um método num objeto DbContextOptions. Para o desenvolvimento local, o sistema de configuração lê a cadeia de conexão do arquivo appsettings.json.

Testar a aplicação

1. Execute o aplicativo e anexe /Movies ao URL no navegador (http://localhost:port/movies).

   Se você receber o seguinte erro:

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

   Você perdeu a etapa migrações .

2. Teste o link Criar Novo.

   

   Note

   Talvez não seja possível inserir vírgulas decimais no campo Price. Para oferecer suporte a de validação do jQuery para localidades diferentes do inglês que usam uma vírgula (",") para um ponto decimal e para formatos de data não US-English, o aplicativo deve ser globalizado. Para obter instruções sobre globalização, consulte este problema do GitHub.

3. Teste o Editar, Detalhese Excluir links.

O próximo tutorial explica os ficheiros criados por scaffolding.

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

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

A ferramenta de scaffolding criou automaticamente um contexto de base de dados e registou-o com o contentor de injeção de dependência. O seguinte código realçado é adicionado ao arquivo Program.cs pelo scaffolder:

Estúdio Visual

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.UseRouting();

app.UseAuthorization();

app.MapStaticAssets();
app.MapRazorPages();

app.Run();

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.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.MapStaticAssets();
app.MapRazorPages();

app.Run();

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

Se você encontrar um problema que não pode resolver, compare seu código com o projeto concluído. Ver ou descarregar o do projeto finalizado (como descarregar).

Próximos passos

Anterior: IntroduçãoPróximo: Páginas Estruturadas Razor