Identity – Introduction & Scaffold

主要参考:

Introduction to Identity on ASP.NET Core

Start by command

dotnet new webapp --auth Individual -uld -o WebApp1

new webapp 是做一个 razor page

--auth Individual 表示要包含 Identity Framework (简称 Identity)

-uld 是 use local database (本地数据库, 默认是用 SQLite)

-o WebApp1 是 output 项目名字

运行上面 command 后, 所有代码就写好了. 它是搭配 EF Core 的. 所以接下来通过 EF Migration 创建数据库.

dotnet ef database update

在 privacy 页面放上 [Authorize] 标签就可以跑了.

Scaffold Identity

参考: Scaffold Identity in ASP.NET Core projects

之所以几行 command 就可以跑起来, 那是因为 ASP.NET Core 对 Identity 做了一个封装, 这个封装还包括了 View (这个技术叫 Razor Class Library 简称 RCL)

我们来从一个 Web App 没有 authen 的做起.

先装好 global 工具

dotnet tool install -g dotnet-aspnet-codegenerator

// 做一个新项目, 没有 authentication 的
dotnet new webapp -o ScaffoldIdentity
 
// 进入项目 folder
cd ScaffoldIdentity
 
// 装 package
dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet add package Microsoft.EntityFrameworkCore.Design
dotnet add package Microsoft.AspNetCore.Identity.EntityFrameworkCore
dotnet add package Microsoft.AspNetCore.Identity.UI
dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Tools
 
// generate Identity code template
dotnet aspnet-codegenerator Identity --useDefaultUI
 
// 做数据库
dotnet ef migrations add CreateIdentitySchema
dotnet ef database update

跑完上面的 command 后, 在 startup 添加 UseAuthentication

然后 layout view 添加 _LoginPartial, 就可以了.

当然这个只是演示让, 让我们知道它是怎样 work 的, 真实开发还是差很多的. 之后慢慢讲.

这里有几个 point 可以记入一下.

在 IdentityHostingStartup.cs 里面封装了 service 的调用, 所以我们在 startup 看不到,

然后所有的 view 都是看不见 source code 的.

除非在我们声明时加入 --files (把指定要的 file 调出来) 或者拿掉 --useDefaultUI 那么所有的 source code 才会显示出来 (这正是我们需要的, 不然怎么魔改呢?)

Identity Overview

既然 Scaffold 帮我们搞了这么多代码, 那我们一个一个来看看 Identity 的代码是如何工作的。要魔改自然要先摸清楚它底细.

首先是 Entity

public class ScaffoldIdentityIdentityDbContext : IdentityDbContext<IdentityUser>
{
    public ScaffoldIdentityIdentityDbContext(DbContextOptions<ScaffoldIdentityIdentityDbContext> options)
        : base(options)
    {
    }
 
    protected override void OnModelCreating(ModelBuilder builder)
    {
        base.OnModelCreating(builder);
    }
}

把平常的 DbContext 继承了 IdentityDbContext

Identity 封装了许多的 Entity, 比如 IdentityUser, IdentityRole, IdentityLogin 等等, 有了这些, 数据库就搞定了.

AspNetUsers = user table

AspNetUserClaims = user 的 claims

AspNetUserLogins = user 的 external logins

AspNetRoles = role table

AspNetRoleClaims = role 的 claims

AspNetUserRoles = user 和 role 的关系

AspNetUserTokens = 暂时不清楚

Role 和 Claims 都是用来做 autho 的, 之后会讲到

接下来就是 Startup 的 service provide

services.AddDefaultIdentity<IdentityUser>(options => options.SignIn.RequireConfirmedAccount = true)
    .AddEntityFrameworkStores<ScaffoldIdentityIdentityDbContext>();

源码在这里

2 年前我超讨厌看 .NET 源码, 东一个西一个, 幸好现在全部放一起了.

这些源码最好都稍微看一下，因为大部分情况我们是需要修改的.

AddDefaultIdentity

IdentityServiceCollectionUIExtensions.cs

services.AddAuthentication 是 ASP.NET Core authen 的 service 哦

AddIdentityCookies

IdentityCookiesBuilderExtensions.cs

里面负责了 cookie schemes 的代码

AddIdentityCore

IdentityServiceCollectionExtensions.cs

负责UserManger 之类的

AddDefaultUI

IdentityBuilderUIExtensions.cs

负责 Ui 的咚咚, SignInManager 也在这里

AddDefaultTokenProviders

IdentityBuilderExtensions.cs

Email, Phone reset password 这些 token 的做法

还有一个 AddIdentity

IdentityServiceCollectionExtensions.cs

这个是以前还没有 AddDefaultIdentity 的时候的调用, 如果现在没有要 DefaultUI 也是会用回 AddIdentity + AddDefaultTokenProviders

注: AddDefaultUI 会有 Error Page 哦, 可能破坏 router, 除非你真的要, 不然建议不适用它.

整个过程就是, 你要什么就拿什么来用, 或拿来改就是了, 最重要的是全部过一遍, 知道它都搞了些什么.