【WCF】错误协定声明

在上一篇烂文中,老周给大伙伴们介绍了 IErrorHandler 接口的使用,今天,老周补充一个错误处理的知识点——错误协定。

错误协定与IErrorHandler接口不同,大伙伴们应该记得,上回我们是把自己实现IErrorHandler接口的类型添加到ChannelDispatcher中的,也就是说,IErrorHandler处理的是通道层的错误,它可以捕捉到多个服务操作上发生的错误。而错误协定是面向协定层的,它是通过 FaultContractAttribute 来声明的,这个特性在上一篇文章中我们用过,它应用的目标是方法。故而这个特性是针对某个服务操作而定义的,主要指明在某个服务操作可能会引发的  FaultException<TDetail> 异常,其中的TDetail泛型参数的类型是在FaultContract特性中指定。

在上一篇烂文中提到过,如果是像string、int这些基本类型,是可以直接用的,如果是自定义的类型,则应该将其声明为数据协定,然后在FaultContract特性中作声明。

咱们来实战一下。首先,咱们定一个服务协定。

    [ServiceContract(Namespace = "zhou-demo", Name = "runner")]
    public interface IDemo
    {
        [OperationContract(Action = "getNum", ReplyAction = "getNumRes")]
        [FaultContract(typeof(ErrorData), Namespace = "zhou-demo/faults", Name = "fault-ct", Action = "fault-back")]
        int GetNumber();
    }

这个协定没什么重要的事情干,无非就是返回一个整数,待会儿咱们让它返回随机整数。

不过大家注意,我在方法上应用了FaultContract特性,它的构造函数是个Type,这个Type用来指定存放错误详细信息的类型,这个类型就是FaultException<TDetail>中的TDetail的类型。其他属性如Action,Namespace、Name这些,不用我多说了吧,都知道干吗用的,你也可以不设置的,它会自动生成一个默认值。

ErrorData是我自己定义的一个数据协定,请看下面代码。

    [DataContract(Namespace = "zhou-demo/fault-data")]
    public class ErrorData
    {
        [DataMember]
        public int ErrorNumber { get; set; }
        [DataMember]
        public string ErrorSource { get; set; }
        [DataMember]
        public string ErrorMessage { get; set; }
        [DataMember]
        public string ErrorType { get; set; }
    }

这个好懂吧,不必介绍了吧。

当服务操作中发生异常时,可以用ErrorData类来封装自定义的错误信息,WCF会把它序列化,然后塞进SOAP消息中发回给客户端,客户端就可以catch到这些错误数据了。

接下来,实现服务类。

    class DemoService : IDemo
    {
        public int GetNumber()
        {
            Random rand = new Random();
            int n = rand.Next(2000);
            if(n % 3 == 0)
            {
                ErrorData erdata = new ErrorData
                {
                    ErrorNumber = n,
                    ErrorSource="人品",
                    ErrorType="生物机能错误",
                    ErrorMessage ="运气指数不佳,引发不可修复错误。"
                };
                throw new FaultException<ErrorData>(erdata);
            }
            return n;
        }
    }

这代码没什么技术含量,你如果看不懂,应该写一份30万字的检讨书。随机生成一个整数,如果这个整数可以被3整除,那就抛出异常,否则正常返回这个数值。

服务完成,下面该轮到实例化ServiceHost了,有了Host我们才能调用服务。Host的处理很TMD简单,直接指定:基址 + 服务类型 = 完事。

            Uri baseAddress = new Uri("http://localhost:9973");
            ServiceHost host = new ServiceHost(typeof(DemoService), baseAddress);
            host.Open();
            Console.WriteLine("服务已启动。");
             ……
            host.Close();

还记得老周以前说过吧,如果仅仅指定基址,而不定义任何EndPoint的话,Host会自动根据协定个数和基址个数,自动生成默认的终结点。在这个高大上例子中,基址是http方案的,所以生成的终结点默认使用BasicHttpBinding,由于服务类只实现了一个服务协定接口,所以该Host中也就只有一个终结点了。

好了,万事具备,只欠东风了,东风就是客户端调用代码。

            Console.WriteLine("请按 Esc 键退出,按任意键调用服务。");
            ConsoleKeyInfo keyinfo;
            while((keyinfo = Console.ReadKey(true)).Key != ConsoleKey.Escape)
            {
                EndpointAddress epaddr = new EndpointAddress(baseAddress);
                BasicHttpBinding binding = new BasicHttpBinding();
                IDemo channel = ChannelFactory<IDemo>.CreateChannel(binding, epaddr);
                try
                {
                    int x = channel.GetNumber();
                    Console.WriteLine($"\n调用结果:{x}。");
                }
                catch(FaultException<ErrorData> ftex)
                {
                    ErrorData detail = ftex.Detail;
                    string msg = $"\n错误数字:{detail.ErrorNumber}\n" +
                        $"错误源:{detail.ErrorSource}\n" +
                        $"错误类型:{detail.ErrorType}\n" +
                        $"错误详情:{detail.ErrorMessage}";
                    Console.WriteLine(msg);
                }
                catch(FaultException fex)
                {
                    Console.WriteLine(fex.Message);
                }
                catch(Exception ex)
                {
                    Console.WriteLine(ex.Message);
                }
                finally
                {
                    IClientChannel client = (IClientChannel)channel;
                    client.Close();
                }

为了能够在控制台应用程序中多次调用服务(整数是随机生成,不能保证每次都抛异常),老周做了些处理,按任意键来调用服务,当然不能弄成死循环,为了使循环不死,我留了个出口——按Esc键。

如果在服务器上果真引发了FaultException<TDetail>,那么,在客户端就可以捕捉到该异常。服务器引发异常后会数据对象序列化,传到客户端后,会进行反序列化。

示例运行结果如下图所示。

好了,知识点补完了,老周得准备吃lunch了,今天是国庆长假第二天,下午老周要去朋友H家里看现场水墨绘画,据说有不少妹子在那里。

示例代码下载

===================================================

很久没讲故事了,这回就讲一讲老周为什么会进入IT界吧。

其实原因也极其简单,也不是什么远大志向,老周之所以会进入IT领域,就是因为喜欢编程,纯粹就是爱编程,不等于爱做项目,老周很讨厌做项目。

还是孔爷爷说得好,“知之者不如好之者,好之者不如乐之者”,对老周而言,除了卖保险之外,什么行业都可以进,要不是热爱编程,老周是不会选择走IT道路。而编程里面,犹爱.NET。

所以,以后你要是想跟老周讨论编程问题,那就只讨论编程上的事,不要跟我讨论怎么找到好工作,找工作那是你的事,跟我没关系,也不要讨论.net有什么前景之类的话题,那是匹夫才讨论的问题。不过,最近些天,好像又有些不学无术的人,又在搞.NET与Java之争,那些东西在老周眼里,等同于看一场相声表演而已。

反正老周只告诉你一句话:我就是热爱.NET。

如果你喜欢.NET,欢迎你看看老周写的烂文章;如果你不喜欢.NET,那无所谓,你可以无视老周的博客。但是,老周不允许有人在博客评论里面说不文明的言论。心诚则与君交,心不诚则与君绝。

时间: 2024-08-07 04:31:43

【WCF】错误协定声明的相关文章

WCF初探-20:WCF错误协定

WCF错误协定概述 在所有托管应用程序中,处理错误由 Exception 对象表示. 在基于 SOAP 的应用程序(如 WCF 应用程序)中,服务方法使用 SOAP 错误消息来传递处理错误信息. SOAP 错误是包括在服务操作元数据中的消息类型,因此会创建一个错误协定,客户端可使用该协定来使操作更加可靠或更具交互性. 此外,由于 SOAP 错误在客户端以 XML 格式表示,这是一种任何 SOAP 平台上的客户端都可以使用的具有极好的互操作性的类型系统,可增加 WCF 应用程序的适用范围. 由于

WCF初探-15:WCF操作协定

前言: 在前面的文章中,我们定义服务协定时,在它的操作方法上都会加上OperationContract特性,此特性属于OperationContractAttribute 类,将OperationContract应用于方法,以指示该方法实现作为服务协定(由 ServiceContractAttribute 属性指定)一部分的服务操作.OperationContractAttribute 属性声明方法是服务协定中的操作. 只有具有 OperationContractAttribute 属性的方法可

WCF初探-14:WCF服务协定

前言: 在前面的文章中,我们定义的服务协定上都会有一个ServiceContract的特性来修饰,这是因为服务契约的实现要靠ServiceContractAttribute 属性定义,然后使用一个或多个类(或接口)方法中的 OperationContractAttribute 属性定义协定的服务操作. 实现服务协定后并将其与WCF 绑定和 EndpointAddress 对象一起使用时,此服务协定将公开以供客户端使用. 公开的信息由 ServiceContractAttribute 表示,其接口

WCF错误:413 Request Entity Too Large

在我们用WCF传输数据的时候,如果启用默认配置,传输的数据量过大,经常会出这个错误. WCF包含服务端与客户端,所以这个错误可能出现在服务端返回数据给客户端,或客户端传数据给服务端时. 1. 服务端返回数据给客户端报错 在客户端配置文件中,主要是配置maxReceivedMessageSize <system.serviceModel> <bindings> <basicHttpBinding> <binding name="ServiceProxyBi

WCF初探-16:WCF数据协定之基础知识

数据协定概念 “数据协定”是在服务与客户端之间达成的正式协议,用于以抽象方式描述要交换的数据. 也就是说,为了进行通信,客户端和服务不必共享相同的类型,而只需共享相同的数据协定. 数据协定为每一个做数据交换时需要被序列化的参数或者返回值做了精确定义. 数据协定特点 默认情况下, WCF使用称为数据协定序列化程序的序列化引擎对数据进行序列化和反序列化(与 XML 进行相互转换). 所有 .NET Framework 基元类型(如整型和字符串型)以及某些被视为基元的类型(如 DateTime 和 X

WCF初探-18:WCF数据协定之KnownType

KnownTypeAttribute 类概述 在数据到达接收终结点时,WCF 运行库尝试将数据反序列化为公共语言运行库 (CLR) 类型的实例.通过首先检查传入消息选择为反序列化而实例化的类型,以确定消息内容遵循的数据协定.然后反序列化引擎尝试查找实现与消息内容兼容的数据协定的 CLR 类型.反序列化引擎在此过程中允许的侯选类型集称为反序列化程序的“已知类型”集. 让反序列化引擎了解某个类型的一种方法是使用 KnownTypeAttribute.不能将属性应用于单个数据成员,只能将它应用于整个数

WCF初探-17:WCF数据协定之等效性

数据协定等效性特点概述 对于客户端要将某种类型的数据成功发送到服务,或者服务要将数据成功发送到客户端的情况,接收端上并不一定必须存在此发送数据类型. 唯一的要求是两种类型的数据协定应该等效. 要使数据协定等效,其命名空间和名称必须相同. 此外,某一端上的每个数据成员还必须在另一端上具有等效的数据成员.注意,数据协定名称和命名空间以及数据成员名称均区分大小写. 要使数据成员等效,其名称必须相同. 此外,它们还必须表示同一类型的数据,也就是说,其数据协定必须等效. 如果同一端(发送方或接收方)存在两

调用WCF错误-There was no endpoint listening

问题描述: 今天在调用WCF服务时候出现了下面的错误. 原因: 调用服务的客户端ip设置成了固定ip.(至于固定ip为什么会导致这个错误,没能去研究) 解决方法: 将客户端ip设置成自动获取.

WCF错误一例

很久没有做WCF了,这两天弄了个工程,结果发现类作为参数传递时无法传送到服务器端,也不报错.结果试了不少次,还百度了一下,有人说是命名空间的事情,其实命名空间是一样的还是有问题,后来干脆把这些服务器和客户端都要用的类抽出来全部到一个类库,前后台都使用同一个类库.问题得以解决. 使用微软的服务契约应该可以解决,不过这种方式比较麻烦,还是这种两用方式直接一点. 版权声明:本文为博主原创文章,未经博主允许不得转载.