自定义调用 Action 的 ASP Web API Json 序列化答案

【问题标题】：Customizing ASP Web API Json serialization by which Action is invoked自定义调用 Action 的 ASP Web API Json 序列化
【发布时间】：2012-08-01 11:22:41
【问题描述】：

我正在考虑将现有的 JSON api 从 hacky MVC3 实现转换为最新的 MVC4 Web Api。 MVC3 实现使用 JSON.NET 来完成所有的序列化，这将使升级变得顺利和顺利。

我一直坚持自定义某些操作的结果如何序列化。例如，我希望某些操作仅返回输出对象的几个属性，而其他操作可能会进行相当深度的序列化。在我当前的实现中，一个操作可以通过在HttpContext 中设置适当的设置来添加一堆序列化覆盖。这些稍后会通过派生自JsonResult 的类进行自定义序列化。添加自定义JsonConverters 的主要用途是控制和减少被序列化的键/值的数量，并根据操作改变要序列化的参数（某些操作应该比其他操作返回更多的对象参数）。

在我当前的 MVC3 实现中，控制器和控制 json 序列化的类的简明示例：

public class TestController : JsonController {
    public JsonResult Persons() {
        ControllerContext.HttpContext.Items[typeof(IEnumerable<JsonConverter>)] = new JsonConverter[] {
            new InterfaceExtractorJsonConverter<IPersonForList>(),
            new StringEnumConverter()
        };

        ControllerContext.HttpContext.Items[typeof(IContractResolver)] = new SpecialCamelCasePropertyNamesContractResolver();
     }
}

public class JsonNetResult : JsonResult {
    public override void ExecuteResult(ControllerContext context) {
        var response = context.HttpContext.Response;

        var additionalConverters = context.HttpContext.Items[typeof(IEnumerable<JsonConverter>)] as IEnumerable<JsonConverter> ?? Enumerable.Empty<JsonConverter>();

        var contractResolver = context.HttpContext.Items[typeof(IContractResolver)] as IContractResolver ?? new JsonContractResolver();

        var typeNameHandling = TypeNameHandling.None;
        if (context.HttpContext.Items.Contains(typeof(TypeNameHandling)))
            typeNameHandling = (TypeNameHandling)context.HttpContext.Items[typeof(TypeNameHandling)];

        response.Write(JsonConvert.SerializeObject(Data, Formatting.Indented, new JsonSerializerSettings {
            ContractResolver = contractResolver,
            ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
            Converters = additionalConverters,
            TypeNameHandling = typeNameHandling
        }));
    }
}

在 Web Api 中，我看到我可以从配置中获取 Json 格式化程序并全局更改序列化。

var config = new HttpSelfHostConfiguration("http://localhost:8080");

var jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().Single();

jsonFormatter.SerializerSettings.ContractResolver = new SpecialCamelCasePropertyNamesContractResolver();
jsonFormatter.SerializerSettings.Converters = new[] { new InterfaceExtractorJsonConverter<ITesting>() };

但是，我计划通过添加一些属性来指定要使用的JsonConverter's，以单独（或每个控制器）控制操作的序列化。因此，我希望 Json 序列化程序找到赋予被调用动作/控制器的相关属性并相应地更改序列化。我不确定在哪里以及如何做到这一点。我应该从JsonMediaTypeFormatter 继承并以某种方式在那里工作吗？我还有哪些其他选择？

【问题讨论】：

你解决了吗？

标签： c# asp.net-mvc-3 json.net asp.net-web-api

【解决方案1】：

我从未见过有人想以这种方式控制序列化。但是为了以最少的返工实现您的目标，我会直接从您的方法中返回所有这些信息：

class JsonNetResponse {
    public IContractResolver ContractResolver { get;set; }
    // Other Json.Net bits
    public object Value { get; set; }
}

然后我会创建一个自定义的 Formatter 来处理这些对象：

class JsonNetFormatter : MediaTypeFormatter {
    public override bool CanWriteType(Type t) {
        return typeof(JsonNetResponse).IsAssignableFrom(t);
    }
    // TODO WriteToStreamAsync which is basically a copy of your original JsonNetResult
}

【讨论】：