如何排除某些公共屬性被序列化爲JsonResult？

Question

我有一個使用JsonResult序列化的自定義viewmodel。 ViewModel有一些必須公開的屬性，但同時這些屬性在結果Json輸出中不可見。

我已經嘗試過使用[NonSerialized]屬性，但這似乎沒有任何效果。

有沒有簡單的方法來做到這一點？或者我必須編寫自己的結果類型（在這種情況下，我可能不會打擾）？

Answer 1

您可以將[ScriptIgnore]屬性放在不應序列化的成員上。以ScriptIgnoreAttribute Class in MSDN爲例。

Answer 2

不正是你要找的，但你可以用下面的代碼和匿名類作弊Json()答案：

MyModel model = ...; 
return Json(new MyModel {model.Prop1, model.Prop2}); 

Answer 3

您可以創建一個公開只是你在想這些屬性的包裝類JsonResult。在下面的例子中，Cow有兩個屬性 - 「腿」和「Moo」。假設您只想將「Leg」作爲屬性公開。然後

昏暗CW作爲CowWrapper =新CowWrapper（C）

會返回一個包裝類，只公開 「腿」。如果你只想顯示一些屬性的子集，這對DataGridView等也很有用。

公共類牛

公共ReadOnly屬性腿（）作爲字符串

get 

     return "leg" 

    end get 

端屬性

公共ReadOnly屬性武（）作爲字符串

get 

     return "moo" 

    end get 

端屬性

端類

公共類CowWrapper

Private m_cow as Cow = Nothing 

Public Sub New(ByVal cow as Cow) 

    m_cow = cow 

end Sub 


    m_cow = cow 

公共ReadOnly屬性腿（）作爲字符串

get 

     return m_cow.Leg() 

    end get 

端屬性

端類

Answer 4

擴展JavaScriptConverter類不包括prope與NonSerializedAttribute。然後，您可以創建一個自定義ActionResult，使用您的JavaScriptConverter序列化對象。

這創建了一個堅實且可測試的類，而不必（重新）生成包裝類或使用匿名對象。

Answer 5

看看James Newton-King的JSON.NET。它會做你想要的。

Answer 6

只需創建一個接口，而不是返回一個類。

public interface IMyViewModel { 
    string MyPublicProperty { get; set; } 
} 

然後創建一個繼承接口

public class MyViewModel : IMyViewModel { 
    public string MyPublicProperty { get; set; } 
    public string MyNotSoPublicProperty { get; set; } 
} 

類和返回的接口，而不是類，在控制器動作

public JsonResult MyJson(){ 
    IMyViewModel model = new MyViewModel(); 
    return Json(model); 
} 

，所得JSON將

{ 
    'MyPublicProperty': '' 
} 

客戶端腳本的一個挑戰是，如果你改變你的類，你不知道你是否在破壞客戶端的實現。如果你在JSON中使用接口類型，你就會明白，如果你改變接口，你正在做一些可能會殺死客戶端實現的東西。而且，如果你正在改變不在界面中的東西（因此不會被序列化），它也可以避免雙重檢查客戶端。

而且，很多時候，你的ViewModels可能有大的集合或複雜類型的人身上，你不一定要輸出到客戶端。這些可能需要很長時間才能序列化或暴露不屬於客戶端代碼的信息。使用接口將使它更加透明地知道輸出中的內容。

另外，對屬性使用諸如[ScriptIgnore]之類的屬性僅適用於特定場景（JavaScript序列化），如果您稍後序列化爲XML，則迫使您面對完全相同的問題。這會不必要地浪費你的視圖模型有很多屬性。那裏有多少人真的想要？使用intefaces適用於任何地方，並且viewmodel不需要額外的屬性。