.NET6 ASP.NET Core中Controller无法通过ViewBag传值至View问题

核心原因 #

ASP.NET Core MVC与.NET Framework MVC的控制器生命周期存在本质差异：

• 在.NET Framework MVC中，控制器构造函数执行时，ViewData/ViewBag依赖的ViewDataDictionary已完成初始化，此时赋值的内容会被正常传递到视图。
• 而在ASP.NET Core MVC中，控制器构造函数执行阶段，ViewDataDictionary尚未初始化，此时给ViewBag/ViewData赋值的内容不会被后续视图渲染流程读取，因此布局页中获取到的是null。

可行解决方案 #

方案1：重写控制器生命周期方法OnActionExecuting #

利用控制器的OnActionExecuting方法（Action执行前触发）设置ViewBag，此时ViewData已可用：

public class HomeController : Controller
{
    private readonly ILoggerFactory _logger;
    public AppUser CurrentUser { get; set; }

    public HomeController(ILoggerFactory logger)
    {
        _logger = logger;
    }

    protected override void OnActionExecuting(ActionExecutingContext context)
    {
        base.OnActionExecuting(context);
        CurrentUser = GetCurrentUser();
        ViewBag.CurrentUser = CurrentUser;
    }

    private AppUser GetCurrentUser()
    {
        // 实现你的获取当前用户逻辑，比如从HttpContext解析
        // 示例：
        // var userId = User.FindFirstValue(ClaimTypes.NameIdentifier);
        // return _userService.GetById(userId);
        return new AppUser();
    }
}

方案2：注册全局Action过滤器 #

如果所有控制器都需要设置当前用户信息，用全局过滤器可避免重复代码：

1. 创建过滤器类：

public class CurrentUserFilter : IAsyncActionFilter
{
    // 可注入所需服务，如用户服务
    // private readonly IUserService _userService;
    // public CurrentUserFilter(IUserService userService)
    // {
    //     _userService = userService;
    // }

    public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
    {
        var currentUser = GetCurrentUser(context.HttpContext);
        context.Controller.ViewBag.CurrentUser = currentUser;
        
        // 继续执行后续Action流程
        await next();
    }

    private AppUser GetCurrentUser(HttpContext httpContext)
    {
        // 从HttpContext中获取用户信息的逻辑
        return new AppUser();
    }
}

2. 在Program.cs中注册全局过滤器：

builder.Services.AddControllersWithViews(options =>
{
    options.Filters.Add<CurrentUserFilter>();
});

方案3：使用ViewComponent（推荐全局布局场景） #

ASP.NET Core的ViewComponent更适合处理布局页中的独立组件逻辑，比如用户信息展示：

1. 创建ViewComponent类：

public class CurrentUserViewComponent : ViewComponent
{
    // 注入必要服务
    // private readonly IUserService _userService;
    // public CurrentUserViewComponent(IUserService userService)
    // {
    //     _userService = userService;
    // }

    public IViewComponentResult Invoke()
    {
        var currentUser = GetCurrentUser();
        return View(currentUser);
    }

    private AppUser GetCurrentUser()
    {
        // 实现获取用户逻辑
        return new AppUser();
    }
}

2. 创建视图文件Views/Shared/Components/CurrentUser/Default.cshtml：

@model AppUser
<!-- 根据实际需求渲染用户信息 -->
<div class="user-info">
    欢迎，@Model.UserName
</div>

3. 在_Layout.cshtml中调用：

</head>
<body>
    @await Component.InvokeAsync("CurrentUser")
    <!-- 页面其他内容 -->
</body>

内容的提问来源于stack exchange，提问作者FLICKER