【.net 深呼吸】聊聊WCF服务返回XML或JSON格式数据
【.net 深呼吸】聊聊WCF服务返回XML或JSON格式数据
有时候,为了让数据可以“跨国经营”,尤其是HTTP Web有关的东东,会将数据内容以 XML 或 JSON 的格式返回,这样一来,不管客户端平台是四大文明古国,还是处于蒙昧时代的原始部落,都可以使用这些数据。
在WCF中实现将数据以XML或JSON格式返回有Y多种方法,不管你用什么方法,只要得到预期结果就好,米芾说了,笔可以八面出锋,当然了,人家指的是绘画。
这里,老周就挑两种方法来演示,仅供参考,没有考古价值,建议司马子长不要把本文收入《史记》。
第一种方法是用到 WebServiceHost 类,它可以自动完成一些与HTTP通信相关的配置,不过,使用该类,要以管理身份运行,不然,会无权限监听。
首先定义一个 Book 类,稍后咱们会把一个Book实例以XML或JSON数据返回。
public sealed class Book
{
public string BookName { get; set; }
public decimal Price { get; set; }
public string BarCode { get; set; }
}
然后,很重要一步,就是声明服务协定,它是个接口,可以对客户端公开,当然客户端也可以重新定义。
[ServiceContract]
interface IService
{
[OperationContract]
[WebGet(UriTemplate = "getdata?f={format}")]
Message GetXml(string format);
}
加上ServiceContract特性表明它是服务协定,如果没有明确指定Name,则它的名字与接口的名字相同;协定接口中,希望向客户端公开的方法要加上OperationContract特性,否则不会被认为是服务操作,无法被客户端使用。
服务协定接口允许在服务器和客户端使用不同定义,只要协定的名称相同,并且方法的参数和返回值类型和数目相同即可。
WebGet特性指定URI的使用方法,地址为相对路径,假如基址是http://dog.net/,那么访问GetXml方法的路径为 http://dog.net/getdata?f=xml。
本来我只想返回XML数据的,所以叫GetXml,后来一想,单返回XML格式的内容也太小气了,索性弄一个参数,来指定格式,可以传入xml或json。
?f后面的{format}会自动把值传给方法的format参数,所以,UriTemplate的参数名字不要写错,如果写成 ?f={firmat},那就识别不了参数了。
然后要实现服务,实现协定接口的类型不必向客户端公开,因为它是在服务器上执行的。
public class MyService : IService{
public Message GetXml(string format)
{
WebOperationContext context = WebOperationContext.Current;
Book b = new Book
{
BookName = "卖女孩的小火柴",
Price = 25.2M,
BarCode = "2811365801"
};
Message msgreturn = null;
// 判断格式
if (format.ToLower() == "xml")
{
msgreturn = context.CreateXmlResponse<Book>(b);
}
else
{
msgreturn = context.CreateJsonResponse<Book>(b);
}
return msgreturn;
}
}
这里通过一个很好玩的方法来完成,所以方法返回类型为Message。静态属性WebOperationContext.Current可以得到与当前调用的操作协定关联的上下文对象,即WebOperationContext实例。
它公开了一堆方法,名字都是 CreateXXXResponse,其中XXX是啥取决于返回内容,
要返回JSON,就调用CreateJsonResponse方法,
返回XML就调用CreateXmlResponse方法。
实例化Book对象后,可以传给带泛型参数的CreateJsonResponse或CreateXmlResponse方法,
把类型参数T指定为Book,就会自动把Book对象序列化,然后返回给客户端。
最后,在配置文件中给服务设定一个基址,可以在代码中写,也可以在配置文件中写,此处老周选用配置文件
好处是可以动态修改而不必重新编译应用程序。
<system.serviceModel>
<services>
<service name="getXmlSample.MyService">
<host>
<baseAddresses>
<add baseAddress="http://localhost:1888/"/>
</baseAddresses>
</host>
</service>
</services>
</system.serviceModel>
可能有初学的朋友说WCF的配置文件很难写,其实啊,是有规律的,你不妨细心研究一下,掌握规律后你会发现配置文件并不难写。
service的 name 属性的值就是服务类的Type的名字(类型名,带命名空间名称)。
在Main中实例化WebServiceHost
static void Main(string[] args){
WebServiceHost host = new WebServiceHost(typeof(MyService));
host.Open();
Console.WriteLine("服务已打开。");
Console.Read();
host.Close();
}
注意,传给构造函数的Type是服务类的类型,与配置文件中service/name的值相同。
以管理员身份运行这个例子,然后打开浏览器,输入http://localhost:1888/getdata?f=xml,回车后,你会看到这样的内容:
把xml改为json,再看看。
怎么样,好玩吧。下面老周再演示另一种方法。
这种方法没使用WebServiceHost,而是使用普通的ServiceHost类来承载服务
可通过WebHttpBinding来得到HTTP交互的支持,不过,不要忘了给终结点配置WebHttpBehavior行为。
同样,先定义一个类,随后用来做测试。
[DataContract(Namespace = "http://sample",Name = "student")]
public sealed class Student
{
[DataMember(Name = "stu_id")]
public int StuID { get; set; }
[DataMember(Name = "stu_name")]
public string StuName { get; set; }
}
这一次,咱们通过将对象进行XML或JSON序列化的方式生成数据,并转为字符串返回。服务协定如下:
[ServiceContract]
public interface IData
{
[OperationContract]
[WebGet(UriTemplate = "getdata?f={format}")]
string GetData(string format);
}
和前面差不多,只是返回类型改为string。
下面代码实现协定接口:
public class MyService : IData
{
public string GetData(string format)
{
string res = null;
Student stu = new Student
{
StuID = 3, StuName = "小白"
};
using (MemoryStream ms=new MemoryStream())
{
XmlObjectSerializer sz = null;
if (format != null && format.ToLower() == "xml")
{
sz = new DataContractSerializer(stu.GetType());
}
else
{
sz = new DataContractJsonSerializer(stu.GetType());
}
sz.WriteObject(ms, stu);
res = Encoding.UTF8.GetString( ms.ToArray());
}
return res;
}
}
接着,在配置文件中配置一下。
<system.serviceModel>
<behaviors>
<endpointBehaviors>
<behavior name="hb">
<webHttp automaticFormatSelectionEnabled="true"/>
</behavior>
</endpointBehaviors>
</behaviors>
<services>
<service name="getXmlSample2.MyService">
<endpoint address="http://localhost:2008" binding="webHttpBinding" contract="getXmlSample2.IData" behaviorConfiguration="hb"/>
</service>
</services>
</system.serviceModel>
behaviors节点下可以配置两种行为——服务行为和终结点行为。此处我们只需配置终结点的行为,需要一个webHttp元素,它映射到 WebHttpBehavior 类。记得要为behavior节点分配名字,随后在/services/service/endpoint节点下,才能通过behaviorConfiguration属性来引用前面的behavior。
实现HTTP交互,应使用webHttpBinding。
在配置webHttp行为时,应该把automaticFormatSelectionEnabled的值设置为true,这样一来,返回给调用方的内容会自动识别格式,其实主要目的是让返回的字符串中能够去掉最外层的双引号。
回到代码,实例化ServiceHost,然后打开服务。
static void Main(string[] args)
{
using (ServiceHost host=new ServiceHost(typeof(MyService)))
{
host.Open();
Console.WriteLine("服务已打开。");
Console.Read();
}
}
运行应用程序,在浏览中输入http://localhost:2008/getdata?f=xml,得到结果如下。
然后再输入http://localhost:2008/getdata?f=json看看。
好了,就演示这两种方法吧,你愿意探索的话,方法是有很多种的。
相关文章
- 学习ASP.NET Core Razor 编程系列四——Asp.Net Core Razor列表模板页面
- WCF学习之旅—TcpTrace工具(二十五)
- WCF学习之旅—实现支持REST客户端应用(二十四)
- WCF学习之旅—HTTP双工模式(二十)
- WCF - net.pipe vs. net.tcp vs. http Bindings
- WCF中的由于目标计算机积极拒绝,无法连接
- WCF - IIS Hosting
- WCF - Hosting WCF Service 四种托管方式
- WCF - Developers Tools
- c#中@标志的作用 C#通过序列化实现深表复制 细说并发编程-TPL 大数据量下DataTable To List效率对比 【转载】C#工具类:实现文件操作File的工具类 异步多线程 Async .net 多线程 Thread ThreadPool Task .Net 反射学习
- 代码走查25条疑问 C# 跳转新的标签页 C#线程处理 .Net 特性 attribute 学习 ----自定义特性 看懂 ,学会 .NET 事件的正确姿势-简单版
- ASP.NET Core 2.2 : 十六.扒一扒新的Endpoint路由方案 try.dot.net 的正确使用姿势 .Net NPOI 根据excel模板导出excel、直接生成excel .Net NPOI 上传excel文件、提交后台获取excel里的数据
- 连表查询都用Left Join吧 以Windows服务方式运行.NET Core程序 HTTP和HTTPS的区别 ASP.NET SignalR介绍 asp.net—WebApi跨域 asp.net—自定义轻量级ORM C#之23中设计模式
- 大比速:remoting、WCF(http)、WCF(tcp)、WCF(RESTful)、asp.net core(RESTful) .net core 控制台程序使用依赖注入(Autofac)
- .NET Core实战项目之CMS 第二章 入门篇-快速入门ASP.NET Core看这篇就够了 [WPF]为旧版本的应用添加触控支持 js css等静态文件版本控制,一处配置多处更新.net版【原创】 C#图片处理,缩略图制作 SqlDataReader 结果集 转成 DataTable DataTable转成List集合 如何使用linq读取DataTable集合?
- 项目开发中的一些注意事项以及技巧总结 基于Repository模式设计项目架构—你可以参考的项目架构设计 Asp.Net Core中使用RSA加密 EF Core中的多对多映射如何实现? asp.net core下的如何给网站做安全设置 获取服务端https证书 Js异常捕获
- ASP.NET MVC Filters 4种默认过滤器的使用【附示例】 数据库常见死锁原因及处理 .NET源码中的链表 多线程下C#如何保证线程安全? .net实现支付宝在线支付 彻头彻尾理解单例模式与多线程 App.Config详解及读写操作 判断客户端是iOS还是Android,判断是不是在微信浏览器打开
- Visual Studio 2017中使用正则修改部分内容 如何使用ILAsm与ILDasm修改.Net exe(dll)文件 C#学习-图解教程(1):格式化数字字符串 小程序开发之图片转Base64(C#、.Net) jquery遍历table为每一个单元格取值及赋值 。net加密解密相关方法 .net关于坐标之间一些简单操作
- C#字符串数组排序 C#排序算法大全 C#字符串比较方法 一个.NET通用JSON解析/构建类的实现(c#) C#处理Json文件 asp.net使用Jquery+iframe传值问题
- 路由其实也可以很简单-------Asp.net WebAPI学习笔记(一) ASP.NET WebApi技术从入门到实战演练 C#面向服务WebService从入门到精通 DataTable与List<T>相互转换
- C#中的函数式编程:递归与纯函数(二) 学习ASP.NET Core Razor 编程系列四——Asp.Net Core Razor列表模板页面
- C# 插件热插拔 .NET:何时应该 “包装异常”? log4.net 自定义日志文件名称
- WCF与WPF
- .NET/ASP.NET/C#/WCF/SQL Server/My SQL/Java/JSP/JDBC/Spring/Spring MVC/PHP/Python/Ruby/Shell/Agile/CSS/HTML/HTTP/Unix/Linux大量PDF书籍/电子书籍下载, Effective Java 下载
- Silverlight+WCF 新手实例 象棋 主界面-事件区-返回退出(三十三)
- WCF .net Tcp 错误异常
- Silverlight+WCF 新手实例 象棋 棋子移动-吃子(五)
- Silverlight+WCF 新手实例 象棋 棋子定位与象棋类(四)
- WCF调试异常信息:ServiceHost 仅支持类服务类型
- Silverlight+WCF 实战-网络象棋最终篇之非线程阻塞倒计时窗口-应用篇(七)
- WCF配置后支持通过URL进行http方式调用
- WCF开发实战系列五:创建WCF客户端程序
- WCF开发实战系列五:创建WCF客户端程序
- 【.net 深呼吸】聊聊WCF服务返回XML或JSON格式数据
- C#与.NET Framework c#编程语言,和java是一样的。(c#,java) -->javaweb,asp.net