ASP.NET Core 标识（Identity）框架系列（一）：怎样使用 ASP.NET Core 标 ...

媒介

ASP.NET Core 内置的标识（identity）框架，采用的是 RBAC（role-based access control，基于角色的访问控制）计谋，是一个用于管理用户身份验证、授权和安全性的框架。
它提供了一套工具和库，用于管理用户、角色、登录、暗码重置、电子邮件确认等功能。
通过它，你可以：

• 用户管理：创建、管理和验证用户，这样你可以轻松操作注册用户、登录、注销、暗码重置等功能。
  
• 角色管理：定义不同的用户角色，并将用户分配到这些角色中，这样你可以更好地控制用户的权限和访问级别。
  
• 暗码计谋：框架提供了暗码计谋功能，允许你定义暗码的复杂度要求，例如暗码长度、大小写字母、数字等要求。
  
• 外部登录：框架还支持你使用外部身份验证提供者（如 QQ、微信、微博等）进行身份验证。
  
• 电子邮件确认：通过电子邮件确认用户注册和暗码重置操作，这样注册和修改暗码操作更加安全可靠。
  

今天，我们主要聊聊怎样使用 ASP.NET Core 标识（Identity）框架来管理用户和角色，也有涉及到暗码计谋、电子邮件确认等方面。
Step By Step 步调

• 创建一个 ASP.NET Core webapi 项目，定名为 IdentitySample
  
• 引用以下 Nuget 包：
  

  Microsoft.AspNetCore.Identity.EntityFrameworkCore
  Microsoft.EntityFrameworkCore.Relational
  Microsoft.EntityFrameworkCore.SqlServer
  Microsoft.EntityFrameworkCore.Tools
  

  
  
• 修改 appsettings.json，添加数据库毗连字符串
  1. {
  2.   "Logging": {
  3.         "LogLevel": {
  4.           "Default": "Information",
  5.           "Microsoft.AspNetCore": "Warning"
  6.         }
  7.   },
  8.   "AllowedHosts": "*",
  9.   "ConnectionStrings": {
  10.         "Default": "Server=(localdb)\\mssqllocaldb;Database=IdentityTestDB;Trusted_Connection=True;MultipleActiveResultSets=true"
  11.   }
  12. }       

  复制代码
• 创建用户实体类 User（重点看注释）
  1. using Microsoft.AspNetCore.Identity;
  3. // IdentityUser<long> 表示 long 类型主键的用户实体类
  4. // IdentityUser 中定义了 UserName（用户名）、Email（邮箱）、PhoneNumber（手机号）、PasswordHash（密码的哈希值）等属性，
  5. // 这里又添加了 CreationTime（创建时间）、NickName（昵称）两个属性。
  6. public class User: IdentityUser<long>
  7. {
  8.         public DateTime CreationTime { get; set; }
  9.         public string? NickName { get; set; }
  10. }

  复制代码
• 创建角色实体类 Role
  1. using Microsoft.AspNetCore.Identity;
  3. public class Role: IdentityRole<long>
  4. {
  6. }

  复制代码
• 创建继承自 IdentityDbContext 的上下文类（重点看注释）
  1. using Microsoft.EntityFrameworkCore;
  2. using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
  4. // 使用 Identity 框架要继承 IdentityDbContext
  5. // IdentityDbContext 是一个泛型类，有3个泛型参数，分别代表用户类型、角色类型和主键类型
  6. public class IdDbContext: IdentityDbContext<User, Role, long>
  7. {
  8.         public IdDbContext(DbContextOptions<IdDbContext> options) : base(options)
  9.         {
  11.         }
  13.         protected override void OnModelCreating(ModelBuilder modelBuilder)
  14.         {
  15.                 base.OnModelCreating(modelBuilder);
  16.                 modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
  17.         }
  18. }       

  复制代码
• 打开 Program.cs 文件，向依赖注入容器中注册与标识框架相关的服务，而且对相关的选项进行设置（重点看注释）
  1. using Microsoft.AspNetCore.Identity;
  2. using Microsoft.EntityFrameworkCore;
  4. var builder = WebApplication.CreateBuilder(args);
  6. // Add services to the container.
  8. builder.Services.AddControllers();
  9. // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
  10. builder.Services.AddEndpointsApiExplorer();
  11. builder.Services.AddSwaggerGen();
  13. // 向依赖注入容器中注册与标识框架相关的服务，并对相关的选项进行配置
  14. // ----1. 数据库注入
  15. IServiceCollection services = builder.Services;
  16. services.AddDbContext<IdDbContext>(opt =>
  17. {
  18.         string connStr = builder.Configuration.GetConnectionString("Default")!;
  19.         opt.UseSqlServer(connStr);
  20. });
  21. // ----2. 数据保护服务注入
  22. // ----数据保护提供了一个简单、基于非对称加密改进的加密API用于确保Web应用敏感数据的安全存储
  23. // ----不需要开发人员自行生成密钥，它会根据当前应用的运行环境，生成该应用独有的一个私钥
  24. services.AddDataProtection();
  25. // ----3. 添加标识框架的一些重要的基础服务
  26. services.AddIdentityCore<User>(options => {
  27.         options.Password.RequireDigit = false;
  28.         options.Password.RequireLowercase = false;
  29.         options.Password.RequireNonAlphanumeric = false;
  30.         options.Password.RequireUppercase = false;
  31.         options.Password.RequiredLength = 6;
  32.         options.Tokens.PasswordResetTokenProvider = TokenOptions.DefaultEmailProvider;
  33.         options.Tokens.EmailConfirmationTokenProvider = TokenOptions.DefaultEmailProvider;
  34. });
  35. // ----4. 注入 UserManager、RoleManager等服务
  36. var idBuilder = new IdentityBuilder(typeof(User), typeof(Role), services);
  37. idBuilder.AddEntityFrameworkStores<IdDbContext>()
  38.         .AddDefaultTokenProviders()
  39.         .AddRoleManager<RoleManager<Role>>()
  40.         .AddUserManager<UserManager<User>>();
  42. var app = builder.Build();
  44. // Configure the HTTP request pipeline.
  45. if (app.Environment.IsDevelopment())
  46. {
  47.         app.UseSwagger();
  48.         app.UseSwaggerUI();
  49. }
  51. app.UseHttpsRedirection();
  53. app.UseAuthorization();
  55. app.MapControllers();
  57. app.Run();

  复制代码
• 执行以下命令进行数据迁徙，执行后将在数据库中生成多张与 Identity 相关的表
  1. Add-Migration InitIdentity
  2. Update-database

  复制代码
• 创建相应的实体类
  1. public record LoginRequest(string UserName, string Password);
  3. public record SendResetPasswordTokenRequest(string Email);
  5. public record ResetPasswordResponse(string Email, string Token, string NewPassword);

  复制代码
• 在控制器中编写代码，操作角色、用户数据（重点看注释）
  1. using Microsoft.AspNetCore.Mvc;
  2. using Microsoft.AspNetCore.Identity;
  4. namespace IdentitySample.Controllers
  5. {
  6.         [ApiController]
  7.         [Route("[controller]/[action]")]
  8.         public class Test1Controller : ControllerBase
  9.         {
  10.                 private readonly ILogger<Test1Controller> logger;
  11.                 private readonly RoleManager<Role> roleManager;
  12.                 private readonly UserManager<User> userManager;
  14.                 // 注入 RoleManager，UserManager，ILogger
  15.                 public Test1Controller(
  16.                         ILogger<Test1Controller> logger,
  17.                         RoleManager<Role> roleManager,
  18.                         UserManager<User> userManager)
  19.                 {
  20.                         this.logger = logger;
  21.                         this.roleManager = roleManager;
  22.                         this.userManager = userManager;
  23.                 }
  25.                 // 创建角色和用户
  26.                 [HttpPost]
  27.                 public async Task<ActionResult> CreateUserRole()
  28.                 {
  29.                         // 1. 判断管理员角色是否存在，不存在则创建
  30.                         bool roleExists = await roleManager.RoleExistsAsync("admin");
  31.                         if (!roleExists)
  32.                         {
  33.                                 Role role = new Role() { Name = "Admin" };
  34.                                 var r = await roleManager.CreateAsync(role);
  35.                                 if (!r.Succeeded)
  36.                                 {
  37.                                         return BadRequest(r.Errors);
  38.                                 }
  39.                         }
  41.                         // 2. 创建账户
  42.                         User user = await userManager.FindByNameAsync("yzk");
  43.                         if (user == null)
  44.                         {
  45.                                 user = new User
  46.                                 {
  47.                                         UserName = "yzk",
  48.                                         Email = "51398898@qq.com",
  49.                                         EmailConfirmed = true,
  50.                                 };
  52.                                 var r = await userManager.CreateAsync(user, "123456");
  53.                                 if (!r.Succeeded)
  54.                                 {
  55.                                         return BadRequest(r.Errors);
  56.                                 }
  57.                                 r = await userManager.AddToRoleAsync(user, "Admin");
  58.                                 if (!r.Succeeded)
  59.                                 {
  60.                                         return BadRequest(r.Errors);
  61.                                 }
  62.                         }
  63.                         return Ok();
  64.                 }
  66.                 // 登录
  67.                 [HttpPost]
  68.                 public async Task<ActionResult> Login(LoginRequest req)
  69.                 {
  70.                         string userName = req.UserName;
  71.                         string password = req.Password;
  72.                         var user = await userManager.FindByNameAsync(userName);
  73.                         if (user == null)
  74.                         {
  75.                                 return NotFound($"用户名不存在{userName}");
  76.                         }
  77.                         if (await userManager.IsLockedOutAsync(user))
  78.                         {
  79.                                 return BadRequest("LockedOut");
  80.                         }
  81.                         var success = await userManager.CheckPasswordAsync(user, password);
  82.                         if (success)
  83.                         {
  84.                                 return Ok("Success");
  85.                         }
  86.                         else
  87.                         {
  88.                                 // 调用userManager的AccessFailedAsync方法来记录一次“登录失败”，
  89.                                 // 当连续多次登录失败之后，账户就会被锁定一段时间，以避免账户被暴力破解
  90.                                 var r = await userManager.AccessFailedAsync(user);
  91.                                 if (!r.Succeeded)
  92.                                 {
  93.                                         return BadRequest("AccessFailed failed");
  94.                                 }
  95.                                 return BadRequest("Failed");
  96.                         }
  97.                 }
  99.                 // 发送重置密码 Token
  100.                 [HttpPost]
  101.                 public async Task<IActionResult> SendResetPasswordToken(
  102.                         SendResetPasswordTokenRequest req)
  103.                 {
  104.                         string email = req.Email;
  105.                         var user = await userManager.FindByEmailAsync(email);
  106.                         if (user == null)
  107.                         {
  108.                                 return NotFound($"邮箱不存在：[{email}]");
  109.                         }
  110.                         // 调用GeneratePasswordResetTokenAsync方法来生成一个密码重置令牌，这个令牌会被保存到数据库中
  111.                         // 然后把这个令牌发送到用户邮箱
  112.                         string token = await userManager.GenerateEmailConfirmationTokenAsync(user);
  113.                         logger.LogInformation($"向邮箱{user.Email}发送Token={token}");
  114.                         return Ok(token);
  115.                 }
  117.                 // 重置密码
  118.                 [HttpPost]
  119.                 public async Task<IActionResult> VerifyResetPasswordToken(
  120.                         ResetPasswordRequest req)
  121.                 {
  122.                         string email = req.Email;
  123.                         var user = await userManager.FindByEmailAsync(email);
  124.                         string token = req.Token;
  125.                         string password = req.NewPassword;
  126.                         var r = await userManager.ResetPasswordAsync(user, token, password);
  127.                         return Ok();
  128.                 }
  129.         }
  130. }       

  复制代码
• 启动项目，通过 Postman 或 Swagger 运行 API 进行测试
  

最后

ASP.NET Core 内置的标识（identity）框架使用 EF Core 对数据库进行操作
往期精彩

• C# 静态类，高手不想让你知道的 15 个真相
  
• 封装一个 C# 范围判断函数，今后告别重复编写范围判断代码的烦恼
  
• 用 C# Stopwatch 计时，让代码性能飞起来！
  
• 轻装上阵，Visual Studio LocalDB：.NET 程序员的当地数据库神器
  
• 封装一个C#全能基础数据范例转换器，一招解决所有基础范例转换烦恼
  
• 闲话 .NET（7）：.NET Core 能淘汰 .NET FrameWork 吗？
  
• 常用的 4 种 ORM 框架（EF Core，SqlSugar，FreeSql，Dapper）对比总结
  
• C# AutoMapper 10个常用方法总结
  
• C# 7个方法比较两个对象是否相称
  
• C# 去掉字符串最后一个字符的 4 种方法
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。