Hinzufügen, Herunterladen und Löschen von benutzerdefinierten Benutzerdaten zu Identity in einem ASP.NET Core Projekt

In diesem Artikel wird gezeigt, wie:

  • Fügen Sie einer ASP.NET Core Web-App benutzerdefinierte Benutzerdaten hinzu.
  • Markieren Sie das benutzerdefinierte Benutzerdatenmodell mit dem PersonalDataAttribute Attribut, damit es automatisch zum Herunterladen und Löschen verfügbar ist. Die Daten, die heruntergeladen und gelöscht werden können, tragen dazu bei, die DSGVO-Anforderungen zu erfüllen.

Das Projektbeispiel wird aus einer Razor Pages-Web-App erstellt, die Anweisungen für eine ASP.NET Core MVC-Web-App sind jedoch ähnlich.

Anzeigen oder Herunterladen von Beispielcode (Vorgehensweise zum Herunterladen)

Prerequisites

.NET 10.0 SDK

Schnellstart: Hinzufügen von zwei benutzerdefinierten Eigenschaften

Für den gängigen Fall beim Hinzufügen von zwei benutzerdefinierten Eigenschaften wie FirstName z. B. und LastName:

  1. Erstellen eines neuen ASP.NET Core Projekts mit der Authentifizierung einzelner Konten
  2. Gerüst Identity zum Überschreiben der Seiten „Registrieren“ und „Verwalten/Index“
  3. Fügen Sie benutzerdefinierte Eigenschaften wie FirstName und LastName zur Benutzerklasse mit dem [PersonalData] Attribut hinzu.
  4. Aktualisieren Sie die Seiten "Register" und "Manage/Index", um Eingabefelder für Ihre Eigenschaften einzuschließen.
  5. Erstellen und Anwenden einer Migration
  6. Testen Sie die Registrierung und Profilverwaltung.

In den folgenden Abschnitten finden Sie detaillierte schrittweise Anleitungen für diesen Prozess.

Erstellen einer Web-App

Sie können entweder eine Razor Seiten- oder MVC-Web-App erstellen. Beide verwenden die gleiche IdentityRazor Benutzeroberfläche für Seiten.

Razor Seiten

  • Wählen Sie im Visual Studio-Menü DateiNeu>Projekt/Lösung... aus.
  • Auswählen ASP.NET Core Web App (Razor Seiten)>Weiter
  • Benennen Sie das Projekt WebApp1 , wenn es mit dem Namespace des Downloadbeispielcodes übereinstimmen soll. Wählen Sie Weiteraus.
  • Auswählen des Authentifizierungstyps>"Einzelne Konten>erstellen"
  • Erstellen Sie das Projekt, und führen Sie es aus.

MVC

  • Wählen Sie im Visual Studio-Menü DateiNeu>Projekt/Lösung... aus.
  • Wählen Sie ASP.NET Core Web App (Modell-View-Controller)>Weiter
  • Benennen Sie das Projekt WebApp1 , wenn es mit dem Namespace des Downloadbeispielcodes übereinstimmen soll. Wählen Sie Weiteraus.
  • Auswählen des Authentifizierungstyps>"Einzelne Konten>erstellen"
  • Erstellen Sie das Projekt, und führen Sie es aus.

Note

Identity Die Benutzeroberfläche wird als Razor Klassenbibliothek implementiert. Wenn Sie ein MVC-Projekt mit Authentifizierung erstellen, werden die Identity-Seiten aus der Razor-Klassenbibliothek bereitgestellt. Das bedeutet, dass Ihr MVC-Projekt Razor-Seiten für Identity verwendet, obwohl im restlichen Projekt MVC-Controller und -Ansichten verwendet werden.

Führen Sie den Identity-Gerüstbau aus.

  • Klicken Sie in Projektmappen-Explorer mit der rechten Maustaste auf das Projekt >Add>Neues Gerüstelement.
  • Wählen Sie im linken Bereich des Dialogfelds " Gerüst hinzufügen " die Option Identity>"Hinzufügen" aus.
  • Wählen Sie im Dialogfeld Identity hinzufügen die folgenden Optionen aus:
    • Auswählen der vorhandenen Layoutdatei ~/Pages/Shared/_Layout.cshtml für Razor Seiten oder ~/Views/Shared/_Layout.cshtml für MVC
    • Wählen Sie die folgenden Dateien zum Überschreiben aus:
      • Konto/Registrierung
      • Konto/Verwalten/Index
    • Wählen Sie die + Schaltfläche aus, um eine neue Datenkontextklasse zu erstellen. Übernehmen Sie den Typ (WebApp1.Models.WebApp1Context , wenn das Projekt "WebApp1" heißt).
    • Wählen Sie die + Schaltfläche aus, um eine neue Benutzerklasse zu erstellen. Akzeptieren Sie den Typ (WebApp1User, wenn das Projekt WebApp1 heißt) und klicken Sie auf >.
  • Wählen Sie Hinzufügen aus.

Befolgen Sie die Anweisungen in Migrationen, UseAuthentication und Layout, um die folgenden Schritte auszuführen:

  • Erstellen Sie eine Migration, und aktualisieren Sie die Datenbank.
  • Fügen Sie UseAuthentication zu Program.cs hinzu
  • Fügen Sie <partial name="_LoginPartial" /> in die Layoutdatei ein.
  • Testen Sie die App:
    • Registrieren eines Benutzers
    • Wählen Sie den neuen Benutzernamen aus (neben dem Link " Abmelden "). Möglicherweise müssen Sie das Fenster erweitern oder das Navigationsleistensymbol auswählen, um den Benutzernamen und andere Links anzuzeigen.
    • Wählen Sie die Registerkarte " Persönliche Daten " aus.
    • Wählen Sie die Schaltfläche "Herunterladen " aus, und überprüfen Sie die PersonalData.json Datei.
    • Testen Sie die Schaltfläche "Löschen ", die den angemeldeten Benutzer löscht.

Hinzufügen von benutzerdefinierten Benutzerdaten zur Identity DB

Aktualisieren Sie die IdentityUser abgeleitete Klasse mit benutzerdefinierten Eigenschaften. Wenn Sie das Projekt WebApp1 benannt haben, wird die Datei benannt Areas/Identity/Data/WebApp1User.cs. Aktualisieren Sie die Datei mit dem folgenden Code:

using Microsoft.AspNetCore.Identity;

namespace WebApp1.Areas.Identity.Data;

public class WebApp1User : IdentityUser
{
    [PersonalData]
    public string? Name { get; set; }
    [PersonalData]
    public DateTime DOB { get; set; }
}

Eigenschaften mit dem PersonalData-Attribut sind:

  • Gelöscht, wenn die Seite Areas/Identity/Pages/Account/Manage/DeletePersonalData.cshtmlRazorUserManager.Delete aufruft.
  • Sie werden durch die Areas/Identity/Pages/Account/Manage/DownloadPersonalData.cshtmlRazor-Seite in die heruntergeladenen Daten einbezogen.

Aktualisieren der Account/Manage/Index.cshtml Seite

Aktualisieren Sie das InputModel in Areas/Identity/Pages/Account/Manage/Index.cshtml.cs mit dem folgenden hervorgehobenen Code:

public class IndexModel : PageModel
{
    private readonly UserManager<WebApp1User> _userManager;
    private readonly SignInManager<WebApp1User> _signInManager;

    public IndexModel(
        UserManager<WebApp1User> userManager,
        SignInManager<WebApp1User> signInManager)
    {
        _userManager = userManager;
        _signInManager = signInManager;
    }

    /// <summary>
    ///     This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
    ///     directly from your code. This API may change or be removed in future releases.
    /// </summary>
    public string Username { get; set; }

    // Remaining API warnings omited.

    [TempData]
    public string StatusMessage { get; set; }

    [BindProperty]
    public InputModel Input { get; set; }

    public class InputModel
    {
        [Required]
        [DataType(DataType.Text)]
        [Display(Name = "Full name")]
        public string Name { get; set; }

        [Required]
        [Display(Name = "Birth Date")]
        [DataType(DataType.Date)]
        public DateTime DOB { get; set; }

        [Phone]
        [Display(Name = "Phone number")]
        public string PhoneNumber { get; set; }
    }

    private async Task LoadAsync(WebApp1User user)
    {
        var userName = await _userManager.GetUserNameAsync(user);
        var phoneNumber = await _userManager.GetPhoneNumberAsync(user);

        Username = userName;

        Input = new InputModel
        {
            Name = user.Name,
            DOB = user.DOB,
            PhoneNumber = phoneNumber
        };
    }

    public async Task<IActionResult> OnGetAsync()
    {
        var user = await _userManager.GetUserAsync(User);
        if (user == null)
        {
            return NotFound($"Unable to load user with ID '{_userManager.GetUserId(User)}'.");
        }

        await LoadAsync(user);
        return Page();
    }

    public async Task<IActionResult> OnPostAsync()
    {
        var user = await _userManager.GetUserAsync(User);
        if (user == null)
        {
            return NotFound($"Unable to load user with ID '{_userManager.GetUserId(User)}'.");
        }

        if (!ModelState.IsValid)
        {
            await LoadAsync(user);
            return Page();
        }

        var phoneNumber = await _userManager.GetPhoneNumberAsync(user);
        if (Input.PhoneNumber != phoneNumber)
        {
            var setPhoneResult = await _userManager.SetPhoneNumberAsync(user, Input.PhoneNumber);
            if (!setPhoneResult.Succeeded)
            {
                StatusMessage = "Unexpected error when trying to set phone number.";
                return RedirectToPage();
            }
        }

        if (Input.Name != user.Name)
        {
            user.Name = Input.Name;
        }

        if (Input.DOB != user.DOB)
        {
            user.DOB = Input.DOB;
        }

        await _userManager.UpdateAsync(user);
        await _signInManager.RefreshSignInAsync(user);
        StatusMessage = "Your profile has been updated";
        return RedirectToPage();
    }
}

Aktualisieren Sie das Areas/Identity/Pages/Account/Manage/Index.cshtml mit dem unten aufgeführten hervorgehobenen Markup.

@page
@model IndexModel
@{
    ViewData["Title"] = "Profile";
    ViewData["ActivePage"] = ManageNavPages.Index;
}

<h3>@ViewData["Title"]</h3>
<partial name="_StatusMessage" for="StatusMessage" />
<div class="row">
    <div class="col-md-6">
        <form id="profile-form" method="post">
            <div asp-validation-summary="ModelOnly" class="text-danger"></div>
            <div class="form-floating">
                <input asp-for="Username" class="form-control" disabled />
                <label asp-for="Username" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.Name" class="form-control" />
                <label asp-for="Input.Name" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.DOB" class="form-control" />
                <label asp-for="Input.DOB" class="form-label"></label>
            </div>
            <div class="form-floating">
                <input asp-for="Input.PhoneNumber" class="form-control" />
                <label asp-for="Input.PhoneNumber" class="form-label"></label>
                <span asp-validation-for="Input.PhoneNumber" class="text-danger"></span>
            </div>
            <button id="update-profile-button" type="submit" class="w-100 btn btn-lg btn-primary">Save</button>
        </form>
    </div>
</div>

@section Scripts {
    <partial name="_ValidationScriptsPartial" />
}

Aktualisieren der Account/Register.cshtml Seite

Aktualisieren Sie das InputModel in Areas/Identity/Pages/Account/Register.cshtml.cs mit dem folgenden hervorgehobenen Code:

    public class RegisterModel : PageModel
    {
        private readonly SignInManager<WebApp1User> _signInManager;
        private readonly UserManager<WebApp1User> _userManager;
        private readonly IUserStore<WebApp1User> _userStore;
        private readonly IUserEmailStore<WebApp1User> _emailStore;
        private readonly ILogger<RegisterModel> _logger;
        private readonly IEmailSender _emailSender;

        public RegisterModel(
            UserManager<WebApp1User> userManager,
            IUserStore<WebApp1User> userStore,
            SignInManager<WebApp1User> signInManager,
            ILogger<RegisterModel> logger,
            IEmailSender emailSender)
        {
            _userManager = userManager;
            _userStore = userStore;
            _emailStore = GetEmailStore();
            _signInManager = signInManager;
            _logger = logger;
            _emailSender = emailSender;
        }

        /// <summary>
        ///     This API supports the ASP.NET Core Identity default UI infrastructure and is not intended to be used
        ///     directly from your code. This API may change or be removed in future releases.
        /// </summary>
        [BindProperty]
        public InputModel Input { get; set; }

        // Remaining API warnings omited.
        public string ReturnUrl { get; set; }

        public IList<AuthenticationScheme> ExternalLogins { get; set; }

        public class InputModel
        {
            [Required]
            [DataType(DataType.Text)]
            [Display(Name = "Full name")]
            public string Name { get; set; }

            [Required]
            [Display(Name = "Birth Date")]
            [DataType(DataType.Date)]
            public DateTime DOB { get; set; }

            [Required]
            [EmailAddress]
            [Display(Name = "Email")]
            public string Email { get; set; }

            [Required]
            [StringLength(100, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
            [DataType(DataType.Password)]
            [Display(Name = "Password")]
            public string Password { get; set; }

            [DataType(DataType.Password)]
            [Display(Name = "Confirm password")]
            [Compare("Password", ErrorMessage = "The password and confirmation password do not match.")]
            public string ConfirmPassword { get; set; }
        }


        public async Task OnGetAsync(string returnUrl = null)
        {
            ReturnUrl = returnUrl;
            ExternalLogins = (await _signInManager.GetExternalAuthenticationSchemesAsync()).ToList();
        }

        public async Task<IActionResult> OnPostAsync(string returnUrl = null)
        {
            returnUrl ??= Url.Content("~/");
            ExternalLogins = (await _signInManager.GetExternalAuthenticationSchemesAsync()).ToList();
            if (ModelState.IsValid)
            {
                var user = CreateUser();

                user.Name = Input.Name;
                user.DOB = Input.DOB;

                await _userStore.SetUserNameAsync(user, Input.Email, CancellationToken.None);
                await _emailStore.SetEmailAsync(user, Input.Email, CancellationToken.None);
                var result = await _userManager.CreateAsync(user, Input.Password);

                if (result.Succeeded)
                {
                    _logger.LogInformation("User created a new account with password.");

                    var userId = await _userManager.GetUserIdAsync(user);
                    var code = await _userManager.GenerateEmailConfirmationTokenAsync(user);
                    code = WebEncoders.Base64UrlEncode(Encoding.UTF8.GetBytes(code));
                    var callbackUrl = Url.Page(
                        "/Account/ConfirmEmail",
                        pageHandler: null,
                        values: new { area = "Identity", userId = userId, code = code, returnUrl = returnUrl },
                        protocol: Request.Scheme);

                    await _emailSender.SendEmailAsync(Input.Email, "Confirm your email",
                        $"Please confirm your account by <a href='{HtmlEncoder.Default.Encode(callbackUrl)}'>clicking here</a>.");

                    if (_userManager.Options.SignIn.RequireConfirmedAccount)
                    {
                        return RedirectToPage("RegisterConfirmation", new { email = Input.Email, returnUrl = returnUrl });
                    }
                    else
                    {
                        await _signInManager.SignInAsync(user, isPersistent: false);
                        return LocalRedirect(returnUrl);
                    }
                }
                foreach (var error in result.Errors)
                {
                    ModelState.AddModelError(string.Empty, error.Description);
                }
            }

            // If we got this far, something failed, redisplay form
            return Page();
        }

        private WebApp1User CreateUser()
        {
            try
            {
                return Activator.CreateInstance<WebApp1User>();
            }
            catch
            {
                throw new InvalidOperationException($"Can't create an instance of '{nameof(WebApp1User)}'. " +
                    $"Ensure that '{nameof(WebApp1User)}' is not an abstract class and has a parameterless constructor, or alternatively " +
                    $"override the register page in /Areas/Identity/Pages/Account/Register.cshtml");
            }
        }

        private IUserEmailStore<WebApp1User> GetEmailStore()
        {
            if (!_userManager.SupportsUserEmail)
            {
                throw new NotSupportedException("The default UI requires a user store with email support.");
            }
            return (IUserEmailStore<WebApp1User>)_userStore;
        }
    }
}

Aktualisieren Sie das Areas/Identity/Pages/Account/Register.cshtml mit dem unten aufgeführten hervorgehobenen Markup.

@page
@model RegisterModel
@{
    ViewData["Title"] = "Register";
}

<h1>@ViewData["Title"]</h1>

<div class="row">
    <div class="col-md-4">
        <form id="registerForm" asp-route-returnUrl="@Model.ReturnUrl" method="post">
            <h2>Create a new account.</h2>
            <hr />
            <div asp-validation-summary="ModelOnly" class="text-danger"></div>

            <div class="form-floating">
                <input asp-for="Input.Name" class="form-control" />
                <label asp-for="Input.Name"></label>
                <span asp-validation-for="Input.Name" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.DOB" class="form-control" />
                <label asp-for="Input.DOB"></label>
                <span asp-validation-for="Input.DOB" class="text-danger"></span>
            </div>

            <div class="form-floating">
                <input asp-for="Input.Email" class="form-control" autocomplete="username" aria-required="true" />
                <label asp-for="Input.Email"></label>
                <span asp-validation-for="Input.Email" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.Password" class="form-control" autocomplete="new-password" aria-required="true" />
                <label asp-for="Input.Password"></label>
                <span asp-validation-for="Input.Password" class="text-danger"></span>
            </div>
            <div class="form-floating">
                <input asp-for="Input.ConfirmPassword" class="form-control" autocomplete="new-password" aria-required="true" />
                <label asp-for="Input.ConfirmPassword"></label>
                <span asp-validation-for="Input.ConfirmPassword" class="text-danger"></span>
            </div>
            <button id="registerSubmit" type="submit" class="w-100 btn btn-lg btn-primary">Register</button>
        </form>
    </div>
    <div class="col-md-6 col-md-offset-2">
        <section>
            <h3>Use another service to register.</h3>
            <hr />
            @{
                if ((Model.ExternalLogins?.Count ?? 0) == 0)
                {
                    <div>
                        <p>
                            There are no external authentication services configured. See this <a href="https://go.microsoft.com/fwlink/?LinkID=532715">article
                            about setting up this ASP.NET application to support logging in via external services</a>.
                        </p>
                    </div>
                }
                else
                {
                    <form id="external-account" asp-page="./ExternalLogin" asp-route-returnUrl="@Model.ReturnUrl" method="post" class="form-horizontal">
                        <div>
                            <p>
                                @foreach (var provider in Model.ExternalLogins!)
                                {
                                    <button type="submit" class="btn btn-primary" name="provider" value="@provider.Name" title="Log in using your @provider.DisplayName account">@provider.DisplayName</button>
                                }
                            </p>
                        </div>
                    </form>
                }
            }
        </section>
    </div>
</div>

@section Scripts {
    <partial name="_ValidationScriptsPartial" />
}

Projekt erstellen.

Aktualisieren des Layouts

Anweisungen zum Hinzufügen von Anmelde- und Abmeldelinks zu jeder Seite finden Sie unter Layoutänderungen .

Hinzufügen einer Migration für die benutzerdefinierten Benutzerdaten

In der Visual Studio Paket-Manager Console:

Add-Migration CustomUserData
Update-Database

Benutzerdefinierte Daten erstellen, anzeigen, herunterladen und löschen testen

Testen der App:

  • Registrieren sie einen neuen Benutzer.
  • Zeigen Sie die benutzerdefinierten Benutzerdaten auf der /Identity/Account/Manage Seite an.
  • Laden Sie die persönlichen Daten der Benutzer von der /Identity/Account/Manage/PersonalData Seite herunter, und zeigen Sie sie an.

Troubleshooting

Wenn Probleme auftreten:

Symptom Wahrscheinliche Ursache Lösung
Benutzerdefinierte Felder werden nicht im Registrierungsformular angezeigt Vergessen, Register.cshtml zu aktualisieren Stellen Sie sicher, dass Sie ein Gerüst Areas/Identity/Pages/Account/Register.cshtml erstellt und geändert haben
Benutzerdefinierte Daten werden nicht gespeichert. Vergessen, eine Migrations- oder Aktualisierungsdatenbank hinzuzufügen Führen Sie dotnet ef migrations add CustomUserData aus und dann dotnet ef database update
Benutzerdefinierte Felder, die nicht in heruntergeladenen Daten enthalten sind Fehlendes [PersonalData] Attribut Hinzufügen eines [PersonalData] Attributs zu Eigenschaften in Ihrer Benutzerklasse
Build-Fehler nach der Gerüsterstellung Paketversionskonflikt Stellen Sie sicher, dass alle Identity Pakete ihrer Zielframeworkversion entsprechen