将身份验证和 Identity 迁移到 ASP.NET Core

作者:Steve Smith

在上一篇文章中,我们已将配置从 ASP.NET MVC 项目迁移到 ASP.NET Core MVC。 在本文中,我们将迁移注册、登录和用户管理功能。

配置 Identity 和成员身份

在 ASP.NET MVC 中,身份验证和标识功能是在 Startup.Auth.csIdentityConfig.cs 中(位于 App_Start 文件夹中)使用 ASP.NET Identity 配置的。 在 ASP.NET Core MVC 中,这些功能在 Startup.cs 中配置。

安装以下 NuGet 包:

  • Microsoft.AspNetCore.Identity.EntityFrameworkCore
  • Microsoft.AspNetCore.Authentication.Cookies
  • Microsoft.EntityFrameworkCore.SqlServer

警告

本文介绍连接字符串的使用。 使用本地数据库时,用户无需进行身份验证,但在生产环境中,连接字符串有时包括进行身份验证的密码。 资源所有者密码凭据(ROPC)是在生产数据库中应避免的安全风险。 生产应用应使用可用的最安全的身份验证流。 有关部署到测试或生产环境的应用的身份验证的详细信息,请参阅 安全身份验证流

Startup.cs 中,更新 Startup.ConfigureServices 方法以使用实体框架和 Identity 服务:

public void ConfigureServices(IServiceCollection services)
{
    // Add EF services to the services container.
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

    services.AddIdentity<ApplicationUser, IdentityRole>()
        .AddEntityFrameworkStores<ApplicationDbContext>()
        .AddDefaultTokenProviders();

     services.AddMvc();
}

此时,上述代码中引用了两种尚未从 ASP.NET MVC 项目迁移的类型:ApplicationDbContextApplicationUser。 在 ASP.NET Core 项目中创建一个新的 Models 文件夹,并向其中添加与这些类型相对应的两个类。 你可以在 /Models/IdentityModels.cs 中找到这些类的 ASP.NET MVC 版本,但我们将在迁移的项目中为每个类使用一个文件,因为这样更清楚。

ApplicationUser.cs:

using Microsoft.AspNetCore.Identity.EntityFrameworkCore;

namespace NewMvcProject.Models
{
    public class ApplicationUser : IdentityUser
    {
    }
}

ApplicationDbContext.cs:

using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
using Microsoft.Data.Entity;

namespace NewMvcProject.Models
{
    public class ApplicationDbContext : IdentityDbContext<ApplicationUser>
    {
        public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options)
            : base(options)
        {
        }

        protected override void OnModelCreating(ModelBuilder builder)
        {
            base.OnModelCreating(builder);
            // Customize the ASP.NET Core Identity model and override the defaults if needed.
            // For example, you can rename the ASP.NET Core Identity table names and more.
            // Add your customizations after calling base.OnModelCreating(builder);
        }
    }
}

ASP.NET Core MVC 入门版 Web 项目包含的用户或 ApplicationDbContext 自定义项不多。 迁移实际应用时,还需要迁移应用的用户和 DbContext 类的所有自定义属性和方法,以及应用使用的任何其他 Model 类。 例如,如果 DbContext 有一个 DbSet<Album>,则需要迁移 Album 类。

有了这些文件,就可以通过更新 using 语句来编译 Startup.cs 文件:

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Hosting;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

我们的应用现在可以支持身份验证和 Identity 服务。 它只需向用户公开这些功能。

迁移注册和登录逻辑

为使用 Entity Framework 和 SQL Server 配置的应用和数据访问配置 Identity 服务后,就可以添加对应用注册和登录的支持。 回想一下,在迁移过程的早期,我们在 _Layout.cshtml 中注释禁止对 _LoginPartial 的引用。 现在,可以返回该代码,取消注释,并添加必要的控制器和视图来支持登录功能。

取消注释 _Layout.cshtml 中的 @Html.Partial 行:

      <li>@Html.ActionLink("Contact", "Contact", "Home")</li>
    </ul>
    @*@Html.Partial("_LoginPartial")*@
  </div>
</div>

现在,将名为 _LoginPartial 的新 Razor 视图添加到 Views/Shared 文件夹:

使用以下代码更新 _LoginPartial.cshtml(替换其所有内容):

@inject SignInManager<ApplicationUser> SignInManager
@inject UserManager<ApplicationUser> UserManager

@if (SignInManager.IsSignedIn(User))
{
    <form asp-area="" asp-controller="Account" asp-action="Logout" method="post" id="logoutForm" class="navbar-right">
        <ul class="nav navbar-nav navbar-right">
            <li>
                <a asp-area="" asp-controller="Manage" asp-action="Index" title="Manage">Hello @UserManager.GetUserName(User)!</a>
            </li>
            <li>
                <button type="submit" class="btn btn-link navbar-btn navbar-link">Log out</button>
            </li>
        </ul>
    </form>
}
else
{
    <ul class="nav navbar-nav navbar-right">
        <li><a asp-area="" asp-controller="Account" asp-action="Register">Register</a></li>
        <li><a asp-area="" asp-controller="Account" asp-action="Login">Log in</a></li>
    </ul>
}

此时,你应该能够在浏览器中刷新站点。

摘要

ASP.NET Core 引入了对 ASP.NET Identity 功能的更改。 在本文中,你已了解如何将 ASP.NET Identity 的身份验证和用户管理功能迁移到 ASP.NET Core。