设置/更改Controller / ViewComponent中属性的Display(Name =“”)属性

时间:2019-03-14 12:41:11

标签: c# asp.net-core data-annotations displayname-attribute

根据2010年的this答案,关于mvc-2,这是不可能的。那么,在asp.net-core 2.2中呢?

我的用例:

我有一个BaseViewModel正在被2个视图使用:TableView(对于用户)和TableManagentView(对于管理员)。 BaseViewModelViewComponent调用。以下是一些示例:

BaseViewModel:

public class BaseViewModel {
    [Display(Name = "Comment")
    public string UserComment { get; set; }
}

TableView:

@await Component.InvokeAsync(nameof(Base), new { myObject = myObject, stringName = "User"})

TableManagementView:

@await Component.InvokeAsync(nameof(Base), new { myObject = myObject, stringName = "Admin"})

基础:

public class Base : ViewComponent
{
    public IViewComponentResult Invoke(BaseViewModel myObjet, string invokingView)
    {
        // here i want to do something like that
        if (invokingView == "User") {
            myObject.UserComment.SetDisplayName("My Comment");
        } 
        if (invokingView == "Admin") {
            myObject.UserComment.SetDisplayName("User's Comment");
        }


        return View("BaseViewComponent", myObject);
    }
}

BaseViewComponent:

@Html.DisplayNameFor(model => model.UserComment)

BaseViewModel被简化,但是有更多的属性。我要这样做的原因是为了避免两个表中的代码重复。唯一应该更改的是标签名称。

我尝试过reflection,但没有成功:

public IViewComponentResult Invoke(BaseViewModel myObject, string invokingView)
    {
        MemberInfo property = typeof(BaseViewModel).GetProperty("UserComment");
        property.GetCustomAttributes(typeof(DisplayAttribute)).Cast<DisplayAttribute>().Single().Name = "test";

        return View("BaseViewComponent", myObject);
    }

Name不变,并且从初始设置开始保持"Comment"

如果无法以编程方式设置属性名称,那么我还有什么其他解决方案?我正在考虑ViewBag/ViewDataTempData,但是这种解决方案对我而言并不有吸引力。优点和缺点是什么?

1 个答案:

答案 0 :(得分:1)

在我留下的评论中,一种解决问题的方法是让BaseViewModel是一个抽象类,并从中派生出具体的类。所以UserViewModelAdminViewModel。然后,这两个具体的类将成为TableViewTableManagentView的模型,并负责告诉“外部世界”如何标记字段。

基类有两个主要方面(除了您的普通字段):抽象Dictionary<string, string>,它将包含标签;以及一种从列表中获取标签的方法:string GetLabel(string propName)。像这样:

public abstract class BaseViewModel
{
    protected abstract Dictionary<string, string> Labels { get; }

    public string UserComment { get; set; }

    public string GetLabel(string propName)
    {
        if (!Labels.TryGetValue(propName, out var label))
            throw new KeyNotFoundException($"Label not found for property name: {propName}");

        return label;
    }
}

然后您创建两个派生类UserAdmin

public sealed class UserViewModel : BaseViewModel
{
    protected override Dictionary<string, string> Labels => new Dictionary<string, string>
    {
        { nameof(UserComment), "User label" }
    };
}

public sealed class AdminViewModel : BaseViewModel
{
    protected override Dictionary<string, string> Labels => new Dictionary<string, string>
    {
        { nameof(UserComment), "Admin label" }
    };
}

它们仅实现Dictionary<string, string>并为基类上的每个字段设置适当的文本。

接下来,将您的BaseViewComponent更改为此:

查看

@model DisplayNameTest.Models.BaseViewModel

<h3>Hello from my View Component</h3>

<!-- Gets the label via the method on the base class -->
<p>@Model.GetLabel(nameof(BaseViewModel.UserComment))</p>

<p>@Model.UserComment)</p>

ComponentView类(现在更简单)

public IViewComponentResult Invoke(BaseViewModel viewModel)
{
    return View(viewModel);
}

最后,将您的视图TableViewTableManagentView更改为此:

@model WebApp.Models.AdminViewModel

@{
    Layout = null;
}

<h1>Admin View</h1>
<div>
    @await Component.InvokeAsync("Base", Model)
</div>

和控制器:

public IActionResult Index()
{
    var adminViewModel = new AdminViewModel { UserComment = "some comment from admin" };
    return View(adminViewModel);
}

现在,当您导航到TableView时,会将UserViewModel传递给BaseViewComponent,它将找出正确的标签。刚刚引入新字段将需要您更改视图模型,向Dictionary添加新条目。

这并不完美,但是我认为这是解决问题的一种好方法。我到目前为止还不是MVC专家,所以也许其他人也可以提出一种更自然的方法。我还准备了一个工作示例应用程序,并推送到GitHub。您可以在这里进行检查:aspnet-view-component-demo。希望它能有所帮助。