一、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(); //<------- 斃掉XML使api返回為json } }
但有個不好的地方,如果返回的結果是String類型,如aaa,返回的json就會變成"aaa"
二、WebApiConfig配置
namespace TestWebApi { 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}/{action}/{id}", defaults: new { id = RouteParameter.Optional } ); } } /// <summary> /// 在全局設置中,使用自定義的只返回Json Result。只讓api接口中替換xml,返回json。這種方法的性能是最高的! /// </summary> public class JsonContentNegotiator : IContentNegotiator { private readonly JsonMediaTypeFormatter _jsonFormatter; public JsonContentNegotiator(JsonMediaTypeFormatter formatter) { _jsonFormatter = formatter; } public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> 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; } } /// <summary> /// Json.NET 利用ContractResolver解決命名不一致問題 /// 解決問題:通過無論是序列化還是反序列化都達到了效果,即:ProjectName -> project_name 和 project_name -> ProjectName /// </summary> 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(); } } }