Dodawanie, pobieranie i usuwanie niestandardowych danych użytkownika w Identity projekcie ASP.NET Core

Autor: Rick Anderson

W tym artykule pokazano, jak:

• Dodawanie niestandardowych danych użytkownika do aplikacji internetowej platformy ASP.NET Core.
• Oznacz niestandardowy model danych użytkownika za pomocą atrybutu PersonalDataAttribute , aby był on automatycznie dostępny do pobrania i usunięcia. Udostępnianie danych do pobrania i usunięcia pomaga spełnić wymagania RODO .

Przykładowy projekt jest tworzony na podstawie Razor aplikacji internetowej Pages, ale instrukcje są podobne dla aplikacji internetowej ASP.NET Core MVC.

Wyświetl lub pobierz przykładowy kod (jak pobrać)

Wymagania wstępne

Zestaw SDK dla platformy .NET 6.0

Tworzenie Razor aplikacji internetowej

Program Visual Studio

• W menu Plik programu Visual Studio wybierz pozycję Nowy>projekt. Nadaj projektowi nazwę WebApp1, jeśli chcesz go dopasować do przestrzeni nazw przykładowego kodu pobierania.
• Wybierz pozycję ASP.NET Core Web Application>OK
• Wybierz pozycję Aplikacja>internetowa OK
• Skompiluj i uruchom projekt.

Interfejs wiersza polecenia platformy .NET

dotnet new webapp -o WebApp1

Uruchamianie szkieletu Identity

Program Visual Studio

• W Eksplorator rozwiązań kliknij prawym przyciskiem myszy projekt >Dodaj>nowy element szkieletowy.
• W okienku po lewej stronie okna dialogowego Dodawanie szkieletu wybierz pozycjęIdentity> Dodaj.
• W oknie dialogowym Dodawanie Identity następujące opcje:
  • Wybierz istniejący plik układu ~/Pages/Shared/_Layout.cshtml
  • Wybierz następujące pliki do zastąpienia:
    • Konto/Rejestracja
    • Konto/Zarządzanie/Indeks
  • Wybierz przycisk , + aby utworzyć nową klasę kontekstu danych. Zaakceptuj typ (WebApp1.Models.WebApp1Context , jeśli projekt ma nazwę WebApp1).
  • Wybierz przycisk , + aby utworzyć nową klasę Użytkownik. Zaakceptuj typ (WebApp1User , jeśli projekt ma nazwę WebApp1) >Dodaj.
• Wybierz Dodaj.

Interfejs wiersza polecenia platformy .NET

Jeśli wcześniej nie zainstalowano szkieletu ASP.NET Core, zainstaluj go teraz:

dotnet tool install -g dotnet-aspnet-codegenerator

Uwaga

Domyślnie architektura plików binarnych platformy .NET do zainstalowania reprezentuje obecnie uruchomioną architekturę systemu operacyjnego. Aby określić inną architekturę systemu operacyjnego, zobacz dotnet tool install, --arch option(Instalacja narzędzia dotnet). Aby uzyskać więcej informacji, zobacz problem z usługą GitHub dotnet/AspNetCore.Docs #29262.

Dodaj odwołanie do pakietu, aby Microsoft.VisualStudio.Web.CodeGeneration.Design do pliku projektu (csproj). Uruchom następujące polecenie w katalogu projektu:

dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet restore

Uruchom następujące polecenie, aby wyświetlić listę opcji szkieletu Identity :

dotnet aspnet-codegenerator identity -h

W folderze projektu uruchom Identity szkielet:

dotnet aspnet-codegenerator identity -u WebApp1User -fi Account.Register;Account.Manage.Index

Program PowerShell używa średnika jako separatora poleceń. W przypadku korzystania z programu PowerShell należy użyć średników na liście plików lub umieścić listę plików w podwójnych cudzysłowach.

Postępuj zgodnie z instrukcjami w temacie Migrations( Migracje), UseAuthentication (Używanie uwierzytelniania) i layout (Układ ), aby wykonać następujące kroki:

• Utwórz migrację i zaktualizuj bazę danych.
• Dodanie argumentu UseAuthentication do polecenia Program.cs
• Dodaj <partial name="_LoginPartial" /> do pliku układu.
• Przetestuj aplikację:
  • Rejestrowanie użytkownika
  • Wybierz nową nazwę użytkownika (obok linku Wyloguj). Może być konieczne rozwinięcie okna lub wybranie ikony paska nawigacyjnego, aby wyświetlić nazwę użytkownika i inne linki.
  • Wybierz kartę Dane osobowe.
  • Wybierz przycisk Pobierz i zbadaj PersonalData.json plik.
  • Przetestuj przycisk Usuń , który usuwa zalogowanego użytkownika.

Dodawanie niestandardowych danych użytkownika do Identity bazy danych

Zaktualizuj klasę pochodną IdentityUser za pomocą właściwości niestandardowych. Jeśli nazwano projekt WebApp1, plik ma nazwę Areas/Identity/Data/WebApp1User.cs. Zaktualizuj plik przy użyciu następującego kodu:

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

Właściwości atrybutu PersonalData to:

• Usunięto, gdy strona wywołuje metodę Areas/Identity/Pages/Account/Manage/DeletePersonalData.cshtmlRazor UserManager.Delete.
• Uwzględnione w pobranych danych przez Areas/Identity/Pages/Account/Manage/DownloadPersonalData.cshtmlRazor stronę.

Account/Manage/Index.cshtml Aktualizowanie strony

Zaktualizuj element InputModel za Areas/Identity/Pages/Account/Manage/Index.cshtml.cs pomocą następującego wyróżnionego kodu:

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 ommited.

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

Zaktualizuj element Areas/Identity/Pages/Account/Manage/Index.cshtml za pomocą następującego wyróżnionego znacznika:

@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" />
}

Account/Register.cshtml Aktualizowanie strony

Zaktualizuj element InputModel za Areas/Identity/Pages/Account/Register.cshtml.cs pomocą następującego wyróżnionego kodu:

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

Zaktualizuj element Areas/Identity/Pages/Account/Register.cshtml za pomocą następującego wyróżnionego znacznika:

@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" />
}

Skompiluj projekt.

Aktualizowanie układu

Zobacz Zmiany układu, aby uzyskać instrukcje dotyczące dodawania linków logowania i wylogowyń do każdej strony.

Dodawanie migracji dla niestandardowych danych użytkownika

Program Visual Studio

W konsoli programu Visual Studio Menedżer pakietów:

Add-Migration CustomUserData
Update-Database

Interfejs wiersza polecenia platformy .NET

dotnet ef migrations add CustomUserData
dotnet ef database update

Testowanie tworzenia, wyświetlania, pobierania, usuwania niestandardowych danych użytkownika

Przetestuj aplikację:

• Zarejestruj nowego użytkownika.
• Wyświetl niestandardowe dane użytkownika na /Identity/Account/Manage stronie.
• Pobierz i wyświetl dane osobowe użytkowników ze /Identity/Account/Manage/PersonalData strony.