.net MVC4 web Api輸出Json格式實例

.Net基於MVC4 Web Api輸出Json格式實例

投稿：shichen2014 字體：[增加 減小] 類型：轉載 時間：2014-10-24 我要評論

這篇文章主要介紹了.Net基於MVC4 Web Api輸出Json格式的實現方法,實例講述了Global中json的操作與XML的處理等技巧,需要的朋友可以參考下

本文實例講述了.Net基於MVC4 Web Api輸出Json格式的方法，分享給大家供大家參考。具體實現方法如下：

1、Global 中增加json輸出

複製代碼代碼如下:

GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("json", "true", "application/json"));

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    //添加json 解析  使用方法 http://xxx/api/action?json=true
    GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("json", "true", "application/json"));
    WebApiConfig.Register(GlobalConfiguration.Configuration);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
}

2、Global 中刪除xml解析

複製代碼代碼如下:

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    WebApiConfig.Register(GlobalConfiguration.Configuration);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
    //刪除xml的解析 當返回值是string 時 直接返回string不是json對象
    GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 
}

3、指定返回格式

新建方法 需要程序集：

複製代碼代碼如下:

System.Web.Extensions
public static HttpResponseMessage ToJson(Object obj)
{
    String str;
    if (obj is String || obj is Char)
    {
        str = obj.ToString();
    }
    else
    {
        var serializer = new JavaScriptSerializer();
        str = serializer.Serialize(obj);
    }
    var result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") };
    return result;
}

 調用戶方法轉換爲json對象輸出

複製代碼代碼如下:

public HttpResponseMessage GetString(string name)
{
     return ToJson(name);
}

4、重寫默認實現類 所有輸出將被重新解析成 json

新建JsonContentNegotiator 類

複製代碼代碼如下:

public class JsonContentNegotiator : IContentNegotiator
{
    private readonly JsonMediaTypeFormatter _jsonFormatter;
    public JsonContentNegotiator(JsonMediaTypeFormatter formatter)
    {
        _jsonFormatter = formatter;
    }

    public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> formatters)
    {
        var result = new ContentNegotiationResult(_jsonFormatter, new MediaTypeHeaderValue("application/json"));
        return result;
    }
}

WebApiConfig中使用重寫

複製代碼代碼如下:

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

    var jsonFormatter = new JsonMediaTypeFormatter();
    config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter));

    // 取消註釋下面的代碼行可對具有 IQueryable 或 IQueryable<T> 返回類型的操作啓用查詢支持。
    // 若要避免處理意外查詢或惡意查詢，請使用 QueryableAttribute 上的驗證設置來驗證傳入查詢。
    // 有關詳細信息，請訪問 http://go.microsoft.com/fwlink/?LinkId=279712。
    //config.EnableQuerySupport();

    // 若要在應用程序中禁用跟蹤，請註釋掉或刪除以下代碼行
    // 有關詳細信息，請參閱: http://www.asp.net/web-api
    config.EnableSystemDiagnosticsTracing();
}