webapi输出炜json_ASP.NET WebApi返回JSON格式

ASP.NET WebApi返回的内容格式会经过内容协商，决定返回是XML格式或JSON格式。如果我们直接在浏览器上打开，一般返回的是XML格式的，这是因为，浏览器在发送请求时，Accept请求的是：

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

如果我们希望它返回JSON格式，发送请求的时候，可以这样：

Accept: application/json

这样返回的数据就是JSON格式了。但是这样返回的内容格式取决于客户端的请求，如果希望让WebApi一直返回JSON格式，可以这样：

一、Global配置(此方法杀伤力太大，所有的返回的xml格式都会被毙掉)

public class WebApiApplication : System.Web.HttpApplication

{

protected void Application_Start()

{

AreaRegistration.RegisterAllAreas();

GlobalConfiguration.Configure(WebApiConfig.Register);

FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);

RouteConfig.RegisterRoutes(RouteTable.Routes);

BundleConfig.RegisterBundles(BundleTable.Bundles);

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

}

}

有个不好的地方，如果返回的结果是String类型，如aaa，返回的json就会变成"aaa"。

注：这个其实是字符串的JSON格式。

二、WebApiConfig配置

namespace WebApiTest

{

public static class WebApiConfig

{

public static void Register(HttpConfiguration config)

{

// Web API 配置和服务

#region [=>1、WebApi 返回JSON，不推荐做法性能不高]

/*

config.Formatters.Clear();

config.Formatters.Remove(config.Formatters.XmlFormatter);

config.Formatters.Add(new JsonMediaTypeFormatter());

config.Formatters.JsonFormatter.SerializerSettings = new JsonSerializerSettings

{

ContractResolver = new UnderlineSplitContractResolver(), //小写命名法。

DateFormatString = "yyyy-MM-dd HH:mm:ss",//解决json时间带T的问题

Formatting = Newtonsoft.Json.Formatting.Indented,//解决json格式化缩进问题

ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore//解决json序列化时的循环引用问题

};

*/

#endregion

#region [=>2、WebApi 返回JSON，推荐做法性能最高]

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

#endregion

// Web API 路由

config.MapHttpAttributeRoutes();

config.Routes.MapHttpRoute(

name: "DefaultApi",

routeTemplate: "api/{controller}/{id}",

defaults: new { id = RouteParameter.Optional }

);

}

}

///

/// 在全局设置中，使用自定义的只返回Json Result。只让api接口中替换xml，返回json。这种方法的性能是最高的！

///

public class JsonContentNegotiator : IContentNegotiator

{

private readonly JsonMediaTypeFormatter _jsonFormatter;

public JsonContentNegotiator(JsonMediaTypeFormatter formatter)

{

_jsonFormatter = formatter;

}

public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable formatters)

{

// 对 JSON 数据使用混合大小写。驼峰式,但是是javascript 首字母小写形式.小驼峰命名法。

//config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

// 对 JSON 数据使用混合大小写。跟属性名同样的大小.输出

_jsonFormatter.SerializerSettings.ContractResolver = new UnderlineSplitContractResolver(); //小写命名法。

_jsonFormatter.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";//解决json时间带T的问题

_jsonFormatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;//解决json格式化缩进问题

_jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;//解决json序列化时的循环引用问题

var result = new ContentNegotiationResult(_jsonFormatter, new MediaTypeHeaderValue("application/json"));

return result;

}

}

///

/// Json.NET 利用ContractResolver解决命名不一致问题

/// 解决问题：通过无论是序列化还是反序列化都达到了效果，即：ProjectName -> project_name 和 project_name -> ProjectName

///

public class UnderlineSplitContractResolver : DefaultContractResolver

{

protected override string ResolvePropertyName(string propertyName)

{

return CamelCaseToUnderlineSplit(propertyName);//下划线分割命名法

//return propertyName.ToLower();//小写命名法

}

private string CamelCaseToUnderlineSplit(string name)

{

StringBuilder builder = new StringBuilder();

for (int i = 0; i < name.Length; i++)

{

var ch = name[i];

if (char.IsUpper(ch) && i > 0)

{

var prev = name[i - 1];

if (prev != '_')

{

if (char.IsUpper(prev))

{

if (i < name.Length - 1)

{

var next = name[i + 1];

if (char.IsLower(next))

{

builder.Append('_');

}

}

}

else

{

builder.Append('_');

}

}

}

builder.Append(char.ToLower(ch));

}

return builder.ToString();

}

}

}

相关链接