C# web api返回類型設置為json的兩種方法

2019-11-02 15:54:19

字體：大中小

來源：轉載

供稿：網友

天天愛去電影網[www.aikan.tv/special/tiantianaiqudianyingwang/]

bsp;web api寫api接口時默認返回的是把你的對象序列化后以XML形式返回，那么怎樣才能讓其返回為json呢，下面為大家介紹幾種不錯的方法

web api寫api接口時默認返回的是把你的對象序列化后以XML形式返回，那么怎樣才能讓其返回為json呢，下面就介紹兩種方法：方法一：(改配置法) 找到Global.asax文件，在Application_Start()方法中添加一句：代碼如下:GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 修改后：代碼如下:protected void Application_Start() { AreaRegistration.RegisterAllAreas(); WebApiConfig.Register(GlobalConfiguration.Configuration); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); // 使api返回為json GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); } 這樣返回的結果就都是json類型了，但有個不好的地方，如果返回的結果是String類型，如123，返回的json就會變成"123"; 解決的方法是自定義返回類型(返回類型為HttpResponseMessage) 代碼如下:public HttpResponseMessage PostUserName(User user) { String userName = user.userName; HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(userName,Encoding.GetEncoding("UTF-8"), "application/json") }; return result; } 方法二：(萬金油法) 方法一中又要改配置，又要處理返回值為String類型的json，甚是麻煩，不如就不用web api中的的自動序列化對象，自己序列化后再返回代碼如下:public HttpResponseMessage PostUser(User user) { JavaScriptSerializer serializer = new JavaScriptSerializer(); string str = serializer.Serialize(user); HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") }; return result; } 方法二是我比較推薦的方法，為了不在每個接口中都反復寫那幾句代碼，所以就封裝為一個方法這樣使用就方便多了。代碼如下:public static HttpResponseMessage toJson(Object obj) { String str; if (obj is String ||obj is Char) { str = obj.ToString(); } else { JavaScriptSerializer serializer = new JavaScriptSerializer(); str = serializer.Serialize(obj); } HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") }; return result; } 方法三：(最麻煩的方法) 方法一最簡單，但殺傷力太大，所有的返回的xml格式都會被斃掉，那么方法三就可以只讓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<MediaTypeFormatter> formatters) { var result = new ContentNegotiationResult(_jsonFormatter, new MediaTypeHeaderValue("application/json")); return result; } } 找到App_Start中的WebApiConfig.cs文件，打開找到Register(HttpConfiguration config)方法添加以下代碼：代碼如下:var jsonFormatter = new JsonMediaTypeFormatter(); config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter)); 添加后代碼如下：代碼如下:public static void Register(HttpConfiguration config) { config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{action}/{id}", defaults: new { id = RouteParameter.Optional } ); var jsonFormatter = new JsonMediaTypeFormatter(); config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter)); } 方法三如果返回的結果是String類型，如123，返回的json就會變成"123"，解決方法同方法一。其實web api會自動把返回的對象轉為xml和json兩種格式并存的形式，方法一與方法三是斃掉了xml的返回，而方法二是自定義返回。

上一篇：淺談setTimeout 與 setInterval

下一篇：asp.net獲取網站目錄物理路徑示例