ASP.Net MVC的ViewBag一个坑，不要跳进去

Posted 2020-09-27 WebEnh

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了ASP.Net MVC的ViewBag一个坑，不要跳进去相关的知识，希望对你有一定的参考价值。

如鹏的学习管理系统是使用ASP.net MVC 5开发的，今天一个新版本发布后网站出现一个Bug，学生在下拉列表中选中的项再加载显示的时候发现仍然没被选中。详细一点说吧：
假如有这样一个Action：

public ActionResult Index()
{
List<SelectListItem> persons = new List<SelectListItem>(); 
persons.Add(new SelectListItem { Text = "腾讯", Value = "qq" });
persons.Add(new SelectListItem { Text = "如鹏", Value = "rupeng", Selected = true });
ViewBag.persons = persons;
return View();
}

Cshtml是这样的：

@Html.DropDownList("persons", (IEnumerable<SelectListItem>)ViewBag.persons)
生成的html是这样的：

<select id="persons" name="persons">
<option value="qq">腾讯</option>
<option value="rupeng">如鹏</option>
</select>

　竟然第二项没有处于选中状态，太诡异了吧！

只要把DropDownList第二个参数的"persons"改成和”ViewBag.persons”的persons名字不一样就可以，比如：
@Html.DropDownList("persons1", (IEnumerable<SelectListItem>)ViewBag.persons)
这样就正确生成了：

<select id="persons1" name="persons1">
<option value="qq">腾讯</option>
<option selected="selected" value="rupeng">如鹏</option>
</select>

好诡异！！！

咋办？看源码！
DropDownList是定义在SelectExtensions扩展类中，DropDownList方法最终是调用SelectInternal方法，核心代码是这一段：

if (!flag && obj == null && !string.IsNullOrEmpty(name))
{
obj = htmlHelper.ViewData.Eval(name);
}
if (obj != null)
{
selectList = SelectExtensions.GetSelectListWithDefaultValue(selectList, obj, allowMultiple);
}

这个name参数就是我们传递给DropDownList的第一个参数"persons"，上面代码主要逻辑就是：首先到ViewData中查找名字为"persons"的值，我们知道ViewData和ViewBag是一样的，所以htmlHelper.ViewData.Eval(name)取到的值就是我们在Index中定义的List<SelectListItem>()集合。GetSelectListWithDefaultValue方法的代码是：

private static IEnumerable<SelectListItem> GetSelectListWithDefaultValue(IEnumerable<SelectListItem> selectList, object defaultValue, bool allowMultiple)
{
IEnumerable enumerable= new object[]
{
defaultValue
};
IEnumerable<string> collection = 
from object value in enumerable
select Convert.ToString(value, CultureInfo.CurrentCulture);
 
HashSet<string> hashSet = new HashSet<string>(collection, StringComparer.OrdinalIgnoreCase);
List<SelectListItem> list = new List<SelectListItem>();
foreach (SelectListItem current in selectList)
{
current.Selected = ((current.Value != null) ? hashSet.Contains(current.Value) : hashSet.Contains(current.Text));
list.Add(current);
}
return list;
}

注意，我们的List<SelectListItem>()集合被当成defaultValue参数传递给GetSelectListWithDefaultValue方法了（why？），在方法内部又把defaultValue给 Convert.ToString()一下，变成了”System.Collections.Generic.List`1[System.Web.Mvc.SelectListItem]”这么一个玩意， GetSelectListWithDefaultValue的主要逻辑就是查找selectList中等于”System.Collections.Generic.List`1[System.Web.Mvc.SelectListItem]”的值，能找到才算见了鬼呢！！！
经过上面的分析我们还可以知道，不能让cshtml中DropDownList的第一个name参数和ViewBag中任何一个属性重名，否则还是会有问题，比如

public ActionResult Index()
{
List<SelectListItem> persons = new List<SelectListItem>(); 
persons.Add(new SelectListItem { Text = "腾讯", Value = "qq" });
persons.Add(new SelectListItem { Text = "如鹏", Value = "rupeng", Selected = true });
ViewBag.persons = persons;
ViewBag.persons1 = new string[] { };
return View();
}