Deel 2: een model toevoegen aan een Razor Pagina-app in ASP.NET Core

In deze handleiding worden klassen toegevoegd om films in een database te beheren. De modelklassen van de app gebruiken Entity Framework Core (EF Core) om met de database te werken. EF Core is een object-relationele mapper (O/RM) die de toegang tot gegevens vereenvoudigt. U schrijft eerst de modelklassen en EF Core maakt de database.

De modelklassen worden POCO-klassen genoemd (van "Plain-Old CLR Objects") omdat ze geen afhankelijkheid hebben van EF Core. Ze definiëren de eigenschappen van de gegevens die zijn opgeslagen in de database.

Een gegevensmodel toevoegen

Visual Studio

1. Klik in Solution Explorer met de rechtermuisknop op het RazorPagesMovie-project>Nieuwe map>. Geef de map een naam Models.

2. Klik met de rechtermuisknop op de map Models. Selecteer >Klassetoevoegen. Noem de klasse Movie.

3. Voeg de volgende eigenschappen toe aan de Movie klasse:

   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; }
   }
   

De klasse Movie bevat:

• Het ID veld is vereist voor de database voor de primaire sleutel.

• Een kenmerk [DataType] dat het type gegevens in de ReleaseDate eigenschap aangeeft. Met dit kenmerk:

  • De gebruiker hoeft geen tijdgegevens in te voeren in het datumveld.
  • Alleen de datum wordt weergegeven, geen tijdinformatie.

• Het vraagteken na string geeft aan dat de eigenschap nullable is. Voor meer informatie, zie Nullbare referentietypen.

DataAnnotations worden behandeld in een volgende handleiding.

Bouw het project om te controleren of er geen compilatiefouten zijn.

Visual Studio Code

1. Voeg een map toe met de naam Models.
2. Voeg een klasse toe aan de map met de Models naam Movie.cs.

Voeg de volgende eigenschappen toe aan de Movie klasse:

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; }
}

De klasse Movie bevat:

• Een ID veld voor het opgeven van een primaire sleutel voor de database.

• Een kenmerk [DataType] om het type gegevens in het ReleaseDate veld op te geven. Met dit kenmerk:

  • De gebruiker hoeft geen tijdgegevens in te voeren in het datumveld.
  • Alleen de datum wordt weergegeven, geen tijdinformatie.

• Het vraagteken na string geeft aan dat de eigenschap nullable is. Voor meer informatie, zie Nullbare referentietypen.

DataAnnotations worden behandeld in een volgende handleiding.

NuGet-pakketten en EF-hulpprogramma's toevoegen

Voer de volgende .NET CLI-opdrachten uit:

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

Met de voorgaande commando's voegt u het volgende toe:

• De CLI-hulpprogramma's voor EF Core
• Het scaffolding-hulpprogramma aspnet-codegenerator.
• Ontwerptijdhulpmiddelen voor EF Core
• De EF Core SQLite-provider, waarmee het EF Core-pakket als een afhankelijkheid wordt geïnstalleerd.
• Pakketten die nodig zijn voor steigerbouw: Microsoft.VisualStudio.Web.CodeGeneration.Design en Microsoft.EntityFrameworkCore.SqlServer.

Zie ASP.NET Core runtime-omgevingen voor hulp bij de configuratie van meerdere omgevingen waarmee een app databasecontexten per omgeving kan configureren.

Note

De architectuur van de binaire .NET-bestanden die moeten worden geïnstalleerd, vertegenwoordigt standaard de huidige besturingssysteemarchitectuur. Als u een andere besturingssysteemarchitectuur wilt opgeven, raadpleegt u de optie dotnet tool install, --arch. Zie GitHub issue dotnet/AspNetCore.Docs #29262 voor meer informatie.

Druk in Visual Studio Code op Ctrl+F5 om de app uit te voeren zonder foutopsporing.

Selecteer in het deelvenster onder de editorregio het tabblad PROBLEMEN of selecteer in het menu WeergavePROBLEMEN als het momenteel niet in beeld is. Controleer of er geen compilatiefouten zijn.

Zet het filmmodel op

In deze sectie wordt het filmmodel opgebouwd. Met andere woorden, het hulpprogramma produceert pagina's voor het maken, lezen, bijwerken en verwijderen (CRUD) van het filmmodel.

Visual Studio

1. Maak de map Pagina's/films :

   1. Klik met de rechtermuisknop op de map >Nieuwe map>.
   2. Geef de map Films een naam.

2. Klik met de rechtermuisknop op de map Pages/Movies, voeg >Nieuw gestructureerd item toe.

   

3. In het dialoogvenster Nieuwe scaffold toevoegen, selecteer Razor Pagina's met behulp van Entity Framework (CRUD)>Toevoegen.

   Scaffold toevoegen

4. Voltooi het dialoogvenster Pagina's toevoegen Razor met behulp van Entity Framework (CRUD):

   1. Selecteer Film (RazorPagesMovie.Models) in de vervolgkeuzelijst Modelklasse.
   2. Selecteer in de rij Gegevenscontextklasse het + (plusteken).
      1. In het dialoogvenster Gegevenscontext toevoegen wordt de klassenaam RazorPagesMovie.Data.RazorPagesMovieContext gegenereerd.
      2. Selecteer in de vervolgkeuzelijst Database providerSQL Server.
   3. Selecteer Toevoegen.

   

Het appsettings.json-bestand wordt bijgewerkt met de verbindingsreeks die wordt gebruikt om verbinding te maken met een lokale database.

Visual Studio Code

• Open een opdrachtshell naar de projectmap, die de Program.cs en .csproj bestanden bevat. Voer de volgende opdracht uit:

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

In de volgende tabel worden de opties voor de ASP.NET Core-codegenerator beschreven.

Option	Description
-m	De naam van het model.
-dc	De DbContext klasse die moet worden gebruikt, inclusief naamruimte.
-udl	Gebruik de standaardindeling.
-outDir	Het relatieve pad van de uitvoermap voor het aanmaken van de weergaven.
--referenceScriptLibraries	Voegt _ValidationScriptsPartial toe aan de pagina's "Bewerken" en "Maken"

Gebruik de -h optie om hulp te krijgen bij de dotnet aspnet-codegenerator razorpage opdracht:

dotnet aspnet-codegenerator razorpage -h

Zie dotnet aspnet-codegenerator voor meer informatie.

SQLite gebruiken voor ontwikkeling, SQL Server voor productie

Wanneer SQLite is geselecteerd, is de door de sjabloon gegenereerde code gereed voor ontwikkeling. De volgende code laat zien hoe u de SQLite-verbindingsreeks selecteert in de ontwikkelomgeving en de SQL Server in de productie.

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

De voorgaande code roept UseDeveloperExceptionPage niet aan in de ontwikkelingsmodus omdat WebApplicationUseDeveloperExceptionPage in de ontwikkelingsmodus aanroept.

Warning

In dit artikel wordt een lokale database gebruikt waarvoor de gebruiker niet hoeft te worden geverifieerd. Productie-apps moeten gebruikmaken van de veiligste verificatiestroom die beschikbaar is. Zie Beveiligde verificatiestromenvoor meer informatie over verificatie voor geïmplementeerde test- en productie-apps.

Bestanden die zijn gemaakt en bijgewerkt

Het scaffold-proces maakt de volgende bestanden:

• Pagina's/films: maken, verwijderen, details, bewerken en indexeren.
• Data/RazorPagesMovieContext.cs

De gemaakte bestanden komen aan bod in de volgende handleiding.

Het scaffold-proces voegt de volgende gemarkeerde code toe aan het Program.cs bestand:

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

app.UseAuthorization();

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

app.Run();

Visual Studio Code

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

De Program.cs wijzigingen worden verderop in deze zelfstudie uitgelegd.

Het eerste databaseschema maken met behulp van de migratiefunctie van EF

De migratiefunctie in Entity Framework Core biedt een manier om:

• Maak het oorspronkelijke databaseschema.
• Werk het databaseschema incrementeel bij om het gesynchroniseerd te houden met het gegevensmodel van de app. Bestaande gegevens in de database blijven behouden.

Visual Studio

In deze sectie wordt het venster Package Manager Console (PMC) gebruikt voor het volgende:

• Voeg een initiële migratie toe.

• Werk de database bij met de eerste migratie.

• Selecteer van het Tools menu de NuGet Package Manager>Package Manager Console.

  

• Voer in de PMC de volgende opdracht in:

  Add-Migration InitialCreate
  

• Met de opdracht Add-Migration genereert u code om het oorspronkelijke databaseschema te maken. Het schema is gebaseerd op het model dat is opgegeven in DbContext. Het argument InitialCreate wordt gebruikt om de migratie een naam te geven. Elke naam kan worden gebruikt, maar volgens de conventie wordt een naam geselecteerd die de migratie beschrijft.

De volgende waarschuwing wordt weergegeven, die in een latere stap wordt behandeld:

Er is geen type opgegeven voor de decimale kolom 'Prijs' op entiteitstype 'Film'. Hierdoor worden waarden stilzwijgend afgekapt als ze niet in de standaardprecisie en schaal passen. Geef expliciet het kolomtype SQL-server op dat geschikt is voor alle waarden met behulp van HasColumnType().

• Voer in de PMC de volgende opdracht in:

  Update-Database
  

  Met Update-Database de opdracht wordt de Up methode uitgevoerd in migraties die niet zijn toegepast. In dit geval voert de opdracht de Up methode uit in het Migrations/<time-stamp>_InitialCreate.cs bestand, waarmee de database wordt gemaakt.

Visual Studio Code

• Klik met de rechtermuisknop op het Project RazorPagesMovie.csproj en selecteer Openen in Geïntegreerde terminal.

  Het terminalvenster wordt geopend met de opdrachtprompt in de projectmap, die de Program.cs- en .csproj-bestanden bevat.

• Voer de volgende .NET CLI-opdracht uit:

  dotnet ef migrations add InitialCreate
  

  Met de opdracht migrations genereert u code om het oorspronkelijke databaseschema te maken. Het schema is gebaseerd op het model dat is opgegeven in DbContext. Het InitialCreate argument wordt gebruikt om de migraties een naam te geven. Elke naam kan worden gebruikt, maar volgens de conventie wordt een naam geselecteerd die de migratie beschrijft.

• Voer de volgende .NET CLI-opdracht uit:

  dotnet ef database update
  

  Met update de opdracht wordt de Up methode uitgevoerd in migraties die niet zijn toegepast. In dit geval voert update de Up methode uit in het Migrations/<time-stamp>_InitialCreate.cs bestand, en maakt de database.

Note

Voor SQLite is het kolomtype voor het Price veld ingesteld op TEXT. Dit wordt in een latere stap opgelost.

De gegevenscontext RazorPagesMovieContext:

• Is afgeleid van Microsoft.EntityFrameworkCore.DbContext.
• Hiermee geeft u op welke entiteiten zijn opgenomen in het gegevensmodel.
• Coördineert de functionaliteit EF Core, zoals het maken, lezen, bijwerken en verwijderen, voor het Movie model.

De RazorPagesMovieContext klasse in het gegenereerde bestand 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!;
    }
}

Met de voorgaande code maakt u voor de entiteitsset een eigenschap DbSet<Movie> aan. In Entity Framework-terminologie komt een entiteitsset meestal overeen met een databasetabel. Een entiteit komt overeen met een rij in de tabel.

De naam van de verbindingsreeks wordt doorgegeven aan de context door een methode aan te roepen voor een DbContextOptions-object . Voor lokale ontwikkeling leest het configuratiesysteem de verbindingsreeks uit het appsettings.json bestand.

De app testen

1. Voer de app uit en voeg /Movies toe aan de URL in de browser (http://localhost:port/movies).

   Als u de volgende fout krijgt:

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

   U hebt de migratiestap gemist.

2. Test de link Nieuw maken.

   

   Note

   Mogelijk kunt u geen decimale komma's invoeren in het veld Price. Ter ondersteuning van jQuery-validatie voor niet-Engelse landinstellingen die een komma (",") gebruiken voor een decimaalteken en voor niet-US-English datumnotaties, moet de app worden geglobaliseerd. Zie dit GitHub-probleemvoor instructies voor globalisatie.

3. Test de links Bewerken, Details en Verwijderen.

In de volgende zelfstudie worden de bestanden uitgelegd die zijn gemaakt door scaffolding.

De context onderzoeken die is geregistreerd met afhankelijkheidsinjectie

ASP.NET Core is gebouwd met afhankelijkheidsinjectie. Services, zoals de EF Core databasecontext, worden via afhankelijkheidsinjectie geregistreerd tijdens de applicatie-start. Onderdelen waarvoor deze services (zoals Razor Pagina's) zijn vereist, worden aangeboden via parameters van de constructor. De constructorcode die een databasecontextinstantie ophaalt, wordt verderop in de zelfstudie weergegeven.

Het steigerprogramma heeft automatisch een databasecontext gemaakt en deze geregistreerd bij de afhankelijkheidsinjectiecontainer. De volgende gemarkeerde code wordt door de scaffolder aan het Program.cs bestand toegevoegd:

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

app.UseAuthorization();

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

app.Run();

Visual Studio Code

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

Problemen oplossen met het voltooide voorbeeld

Als u een probleem ondervindt dat u niet kunt oplossen, vergelijkt u de code met het voltooide project. Voltooid project weergeven of downloaden (hoe te downloaden).

Volgende stappen

Vorige: Aan de slagVolgende: Scaffold-pagina's Razor