ASP.NET MVC - 控制器的 JSON.NET 扩展方法

Question

我刚刚将 JSON.NET 添加到我的项目中，我想创建一个名为 JsonNet 的扩展方法，它的行为方式与 Json 方法相同，但改用 JSON.NET。

我这里有一个使用 JSON.NET 扩展 JsonResult 的类：

public class JsonNetResult : JsonResult {
    public override void ExecuteResult(ControllerContext context) {
        if (context == null)
            throw new ArgumentNullException("context");

        var response = context.HttpContext.Response;

        response.ContentType = !String.IsNullOrEmpty(ContentType)
            ? ContentType
            : "application/json";

        if (ContentEncoding != null)
            response.ContentEncoding = ContentEncoding;

        var serializedObject = JsonConvert.SerializeObject(Data, Formatting.Indented);
        response.Write(serializedObject);
    }
}

在 ExecuteResult 方法下，我尝试添加这些：

public static JsonNetResult JsonNet(this Controller controller, object data) {
    var result = new JsonNetResult();
    result.Data = data;
    return result;
}

public static JsonNetResult JsonNet(this Controller controller, object data, JsonRequestBehavior behavior) {
    var result = new JsonNetResult();
    result.Data = data;
    result.JsonRequestBehavior = behavior;
    return result;
}

然后我有我的控制器：

public class SomethingController : Controller {
    public ActionResult SomeAction() {
        object data = SomeClass.GetData();
        return JsonNet(data, JsonRequestBehavior.AllowGet);
    }
}

而且编译器找不到 JsonNet 方法。即使我尝试这样做：

return ((Controller)this).JsonNet(data, JsonRequestBehavior.AllowGet);

还是不行。

如果我将 JsonNet 中的代码复制到 SomeAction 中，它工作得很好，所以我知道SomethingController 可以看到 JsonNetResult。

如果有帮助，这两个类位于不同的命名空间中。

Answer 1

这是我现在使用的一个，它还为我从中提取一些源代码的页面提供了 cmets。不过我自己做了一些调整，包括扩展方法。

如上所述，您需要将适当的 using 命名空间添加到您的控制器中。

我只是使用return this.JsonNet(data) 调用它。我只是允许自定义格式的覆盖，还有一个是因为我遇到了要求内容类型为“纯/文本”的 JS 插件。

//http://james.newtonking.com/archive/2008/10/16/asp-net-mvc-and-json-net.aspx
public class JsonNetResult : ActionResult
{
    public Encoding ContentEncoding { get; set; }
    public string ContentType { get; set; }
    public object Data { get; set; }

    public JsonSerializerSettings SerializerSettings { get; set; }
    public Formatting Formatting { get; set; }

    public JsonNetResult()
    {
        SerializerSettings = new JsonSerializerSettings
            {
                //http://odetocode.com/blogs/scott/archive/2013/03/25/asp-net-webapi-tip-3-camelcasing-json.aspx
                #if DEBUG
                Formatting = Formatting.Indented, //Makes the outputted Json for structures for easier reading by a human, only needed in debug
                #endif
                ContractResolver = new CamelCasePropertyNamesContractResolver() //Makes the default for properties outputted by Json to use camelCaps
            };
    }

    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        HttpResponseBase response = context.HttpContext.Response;

        response.ContentType = !string.IsNullOrEmpty(ContentType)
                                   ? ContentType
                                   : "application/json";

        if (ContentEncoding != null)
            response.ContentEncoding = ContentEncoding;

        if (Data != null)
        {
            JsonTextWriter writer = new JsonTextWriter(response.Output) {Formatting = Formatting};

            JsonSerializer serializer = JsonSerializer.Create(SerializerSettings);
            serializer.Serialize(writer, Data);

            writer.Flush();
        }
    }
}

public static class JsonNetExtenionMethods
{
    public static ActionResult JsonNet(this Controller controller, object data)
    {
        return new JsonNetResult() {Data = data};
    }

    public static ActionResult JsonNet(this Controller controller, object data, string contentType)
    {
        return new JsonNetResult() { Data = data, ContentType = contentType };
    }

    public static ActionResult JsonNet(this Controller controller, object data, Formatting formatting)
    {
        return new JsonNetResult() {Data = data, Formatting = formatting};
    }
}

Answer 2

编译器不会找到扩展方法，除非它们在静态类中。尝试将您的 JsonNet 方法放在他们自己的静态类中，例如JsonNetExtensions。还要确保你的扩展类与你的控制器在同一个命名空间中，或者你的控制器在顶部有一个 using 声明，带有扩展类的命名空间。