ASP.NET Core 2.0 MVC - 获取当前登录用户信息

前言

       上篇实战完成后，没想到会有那么多的圈友给了那么多的支持，甚至连只是作为代码仓储的git上也给了一些小星星，真的感觉很惶恐啊，哈哈哈，毕竟代码写的很烂啊。由于上一篇只是大概说了下项目，所以准备写下这篇详细说下自己对于获取当前登录用户的设计与实现，原本准备上周末就完成的这篇，结果周六一起来，发现自己起水痘了，嗯，很悲催。。。请了一个星期的假，今天好歹头不痛，不发烧能看电脑了，就努力努力赶出来吧。
       获取当前登录用户的整体思路，我们可以通过创建一个静态的用户类，存储当前登录的用户。通过将属性值存储在session中，从而存储到服务器的内存中，做到可以在系统全局中获取当前登录用户的数据信息。
       .NET Framework平台下面的MVC与.NET Core平台下面的MVC，对于Session的使用上存在着一些的差异，主要在于如何获取到Session对象。在传统的MVC项目中我们可以直接使用HttpContext.Current.Session获取到session，从而做到对于数据的取值、赋值；而在ASP.NET Core MVC中，并没有HttpContext.Current.Session这个静态类，通过查阅微软的文档可知，我们可以通过注入IHttpContextAccessor对象的方式从而获取到session对象，解决方案如下所示。

使用Session存储当前登录的用户信息

首先，在ASP.NET Core 中使用Session，我们需要将Session注入到ASP.NET Core的管道(pipeline)中，和我们使用MVC的方式相同，在ConfigureServices(IServiceCollection services)中，添加

1	services.AddSession();

在Configure(IApplicationBuilder app, IHostingEnvironment env)中添加

1	app.UseSession();

这样，我们就可以在MVC中使用到Session了。当然现在也只是能在Controller中获取到Session对象，如果想在别的类文件中使用到Session对象，我们需要注入IHttpContextAccessor对象。这里，我们可以使用nuget添加Microsoft.AspNetCore.Http.Extensions这个程序集，方便我们对于Session进行操作。
因为我们采用静态类作为当前登录用户的载体，而静态类不能拥有实例构造函数，所以我采用创建一个配置方法来进行注入，CurrentUser类如下所示。

public static class CurrentUser
{
    #region Initialize

    private static IHttpContextAccessor _httpContextAccessor;

    private static ISession _session => _httpContextAccessor.HttpContext.Session;

    public static void Configure(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    #endregion

    #region Attribute

    /// <summary>
    /// 用户主键
    /// </summary>
    public static string UserOID
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserOID");
        set => _session.SetString("CurrentUser_UserOID", !string.IsNullOrEmpty(value) ? value : "");
    }

    /// <summary>
    ///用户编号 
    /// </summary>
    public static long UserId
    {
        get => _session == null ? 0 : Convert.ToInt64(_session.GetString("CurrentUser_UserId"));
        set => _session.SetString("CurrentUser_UserId", value != 0 ? value.ToString() : "0");
    }

    /// <summary>
    /// 用户姓名
    /// </summary>
    public static string UserName
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserName");
        set => _session.SetString("CurrentUser_UserName", !string.IsNullOrEmpty(value) ? value : "");
    }

    /// <summary>
    /// 用户登录账户
    /// </summary>
    public static string UserAccount
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserAccount");
        set => _session.SetString("CurrentUser_UserAccount", !string.IsNullOrEmpty(value) ? value : "");
    }

    /// <summary>
    /// 用户头像地址
    /// </summary>
    public static string UserImage
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserImage");
        set => _session.SetString("CurrentUser_UserImage", !string.IsNullOrEmpty(value) ? value : "");
    }

    /// <summary>
    /// 用户角色
    /// </summary>
    public static string UserRole
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserRole");
        set => _session.SetString("CurrentUser_UserRole", !string.IsNullOrEmpty(value) ? value : "");
    }

    /// <summary>
    /// 主页地址
    /// </summary>
    public static string UserPage
    {
        get => _session == null ? "" : _session.GetString("CurrentUser_UserPage");
        set => _session.SetString("CurrentUser_UserPage", !string.IsNullOrEmpty(value) ? value : "");
    }

    #endregion
}

当我们创建好了这样一个静态类后，我们就可以在登录成功后，将当前登录的用户信息赋值给这个静态类，这样我们就可以在需要使用到的地方直接使用CurrentUser这个静态类即可。在当时实际使用后发现，想要获取到登录后存储的用户信息，则必须在Controller的构造方法中调用CurrentUser的Configure方法，无形中还是增加了许多的工作量。
Controller的构造函数示例代码如下：

[Area("Administrator")]
[Authorize(Policy = "Administrator")]
public class HomeController : DanvicController
{
    #region Initialize

    private readonly ApplicationDbContext _context;
    private readonly ILogger _logger;
    private readonly IHomeService _service;
    private readonly IHttpContextAccessor _httpContextAccessor;
    public HomeController(IHomeService service, ILogger<HomeController> logger, IHttpContextAccessor httpContextAccessor, ApplicationDbContext context)
    {
        _service = service;
        _logger = logger;
        _httpContextAccessor = httpContextAccessor;
        _context = context;
        CurrentUser.Configure(_httpContextAccessor);
    }

    #endregion

    #region View

    #endregion
}

登录成功后给CurrentUser赋值的相关代码如下所示：

/// <summary>
/// 设置当前登录用户
/// </summary>
public async Task SetCurrentUser(string oid, IHttpContextAccessor httpContextAccessor, ApplicationDbContext context)
{
    CurrentUser.Configure(httpContextAccessor);

    var user = await PSURepository.GetUserByOIDAsync(oid, context);

    if (user != null)
    {
        string role = string.Empty;
        switch (user.AccountType)
        {
            case 0:
                role = "Administrator";
                break;
            case 1:
                role = "Instructor";
                break;
            case 2:
                role = "Student";
                break;
        }

        CurrentUser.UserAccount = user.Account;
        CurrentUser.UserId = user.Id;
        CurrentUser.UserImage = user.ImageSrc;
        CurrentUser.UserName = user.Name;
        CurrentUser.UserOID = user.IdentityUserOID;
        CurrentUser.UserRole = role;
        CurrentUser.UserPage = user.HomePage;
    }
}