MVC3不能正確識別JSON中的Enum枚舉值
一、背景
在MVC3項目里，如果Action的參數(shù)中有Enum枚舉作為對象屬性的話，使用POST方法提交過來的JSON數(shù)據(jù)中的枚舉值卻無法正確被識別對應的枚舉值。
二、Demo演示
為了說明問題，我使用MVC3項目創(chuàng)建Controller，并且創(chuàng)建如下代碼演示：
- //交通方式枚舉
- public enum TrafficEnum
- {
- Bus = 0,
- Boat = 1,
- Bike = 2,
- }
- public class Person
- {
- public int ID { get; set; }
- public TrafficEnum Traffic { get; set; }
- }
- public class DemoController : Controller
- {
- public ActionResult Index(Person p)
- {
- return View();
- }
- }
網(wǎng)站生成成功之后，就可以使用Fiddler來發(fā)送HTTP POST請求了，注意需要的是，要在Request Headers加上請求頭content-type:application/json，這樣才能通知服務器端Request Body里的內容為JSON格式。
點擊右上角的Execute執(zhí)行HTTP請求，在程序斷點情況下，查看參數(shù)p，屬性ID已經(jīng)正確的被識別到了值為9999，而枚舉值屬性Traffic卻被錯認為枚舉中的首個值Bus，這儼然是錯誤的，縱使你將Traffic修改成Bike，也就是值等于2，結果也是一樣。
三、解決方法
方法一：
升級MVC4，親測在MVC4項目下，這個問題已經(jīng)被修復了；
方法二：
假若因為各種原因，項目不想或者不能升級為MVC4，可以在MVC3項目上做些改動，亦可修復這個問題，
1、在項目中，新建一個類，加入以下代碼，需要引用一下 using System.ComponentModel; using System.Web.Mvc; 命名空間；
- /// <summary>
- /// 處理在MVC3下，提交的JSON枚舉值在Controller不能識別的問題
- /// </summary>
- public class EnumConverterModelBinder : DefaultModelBinder
- {
- protected override object GetPropertyValue(ControllerContext controllerContext, ModelBindingContext bindingContext, PropertyDescriptor propertyDescriptor, IModelBinder propertyBinder)
- {
- var propertyType = propertyDescriptor.PropertyType;
- if (propertyType.IsEnum)
- {
- var providerValue = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
- if (null != providerValue)
- {
- var value = providerValue.RawValue;
- if (null != value)
- {
- var valueType = value.GetType();
- if (!valueType.IsEnum)
- {
- return Enum.ToObject(propertyType, value);
- }
- }
- }
- }
- return base.GetPropertyValue(controllerContext, bindingContext, propertyDescriptor, propertyBinder);
- }
- }
2、在Global.asax的Application_Start方法中，進行EnumConverterModelBinder類的實例化操作：
- protected void Application_Start()
- {
- //處理在MVC3下，提交的JSON枚舉值在Controller不能識別的問題
- ModelBinders.Binders.DefaultBinder = new EnumConverterModelBinder();
- }
進行配置改造之后，我再次生成網(wǎng)站，重新發(fā)送HTTP請求看，MVC Action中的參數(shù)里的枚舉就能被正確的識別到了。
#p#
四、研究
我覺得這應該是mvc3里面一個小小的缺陷吧，隨著mvc的升級，這已經(jīng)在新版本里被完善修復了，可還用著mvc3的人如果在項目中遇到這個問題，可以研究一下。
遇到一個問題，去百度谷歌找解決方案是可以，但是復制粘貼完代碼之后，最好問下自己，為什么這樣可以解決問題。
從現(xiàn)象和解決代碼中猜想，應該是在MVC生命周期中的Model Binders 這一環(huán)節(jié)出了問題。
因為MVC已經(jīng)開源了，所以我嘗試著調試源碼，首先下載MVC3的源碼，其他項目可以移除，只保留紅色框中的項目即可，然后新建一個MVC3測試項目，并且將此測試項目的system.web.mvc引用移除，轉而引用本解決方案中的system.web.mvc 項目，這樣子，我們才可以對MVC源碼進行調試操作。
搜回來的代碼中可知，我們自定義的類繼承DefaultModelBinder父類，并且重寫了GetPropertyValue方法，那我們就從這點開始，在MVC3源碼中的System.Web.MVC項目中找到該類，在此方法上插入斷點。
F5調試程序，發(fā)送一個POST請求。
其實BindProperty方法是會被多次執(zhí)行的，BindProperties方法會對請求的實體類的屬性進行遍歷，每一個屬性都要經(jīng)過BindProperty方法的處理；
現(xiàn)在已經(jīng)截獲到第一個屬性ID了。
緊接著，程序進入propertyBinder.BindModel 方法。
只貼部分關鍵代碼了，通過bindingContext的ValueProvider 獲得屬性的相關信息，如果不等于null的話，轉到執(zhí)行BindSimpleModel 方法。
#p#
在BindSimpleModel方法里，首先通過Type.IsInstanceOfType方法判斷確定指定的對象是否是當前 Type 的實例，如果是，則直接返回rawValue，這里的屬性類型是Int32類型，返回True符合條件，所以直接把rawValue給返回去了。
第一個Int32類型屬性的部分關鍵代碼執(zhí)行到這里就已經(jīng)確認到值了，接下來，我們看出了問題的Enum枚舉類型屬性。
循環(huán)來到了第二個屬性了，這時我留意到有個Model屬性，對比Int32類型執(zhí)行的時候，這個屬性當時為0，而此時則為Bus，可見這是一個默認值，指定枚舉中值為0的那個類型（即使你不為枚舉顯式指定值），同樣的，經(jīng)過BindModel方法來到了BindSimpleModel方法。
此時，對比Int32類型的屬性ID，這次ModelType.IsInstanceOfType(valueProvideResult.RawValue)為False，并且接下來不是string類型就執(zhí)行以下的判斷，也不是數(shù)組類型，所以，來到了最后一個，根據(jù)綠色的注釋可以看出，這應該是一個判斷是否collection集合類型的方法，Enum都不是，所以，返回了Null。
這時，Type collectionType變量為Null，執(zhí)行最后一個case 3
在ConvertProviderResult方法里，也進行了一系列的類型判斷轉換，目的就是將JSON中的數(shù)字類型轉換成枚舉值，但是執(zhí)行過程中拋出異常了，原因是
“No type converter can convert between these types ” 也就是說，在MVC3的機制中，并沒有相應的type converter來處理數(shù)值與枚舉的對應。
經(jīng)過以上這些處理方法，都沒完成把對應的值確認下來，怎么給原來的BindProperty 老大方法交差呢，所以，小的只好將Value=Null 和 modelState.Errors 模型錯誤狀態(tài)信息如實帶回去了，讓老大決定怎么做，老大后面處理這里有點繞，但是我看源碼估計也是拿默認值來充當Value了，所以就造成了JSON傳過來的值與對應枚舉的值不對應的情況，無論傳什么值，結果都是第一個枚舉的值。
五、總結
這篇文章只是我在工作上遇到的一個小問題，然后有點小興趣就從源碼的角度上來研究和分析，缺乏理論的依據(jù)，因為之前沒有很深入的去研究MVC的底層運行機制與生命周期，所以這方面還需要得加強學習一下，如果你也有興趣，可以下載我修改好的源碼來分析一下，甚至可以下載MVC4的源碼來進行對比。
