C# web api返回类型设置为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的返回，而方法二是自定义返回。
ps：关于json操作，这里再为大家推荐几款比较实用的json在线工具供大家参考使用：
在线json代码检验、检验、美化、格式化工具：
json在线格式化工具：
在线xml/json互相转换工具：
json代码在线格式化/美化/压缩/编辑/转换工具：
在线json压缩/转义工具：
c语言风格/html/css/json代码格式化美化工具：
如对本文有疑问，请在下面进行留言讨论，广大热心网友会与你互动！！
点击进行留言回复
我要评论
网友评论