WCF开发之服务契约

2024-05-02 00:48
文章标签 服务 开发 wcf 契约

本文主要是介绍WCF开发之服务契约,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

契约服务说白了就是对WCF服务的对外接口作定义和声明。下面是一些关键字,只有加了关键字的方法才能被服务调用者访问。

[ServiceContract]:定义服务操作,对于某个Interface加上这个属性标签就会就定义了一个服务,客户端才可以看到这个服务。这个属性标签可以应用于接口或者类,建议应用于接口,第一,可以消除服务实现的耦合性,因为接口中不存在任何的业务逻辑相关的东西,第二,服务可能会实现多于一个契约,也就是说一个类同时实现多个服务,如果把标签定义在类上,就无法同时实现多个服务了。

两个属性:

Name:指定暴露给客户端的服务名称。

Namespace:提供有意义的命名空间。

[OperationContract]:使得方法作为公共服务契约的一部分暴露出来,也就说说客户端可以看到服务中暴露出来的方法。服务契约中的所有方法都应该拥有这个属性标签。

一些属性:

Namespace:提供有意义的命名空间。

Name:指定暴露给客户端的方法名称。

Action:Web调用地址,获取或设置请求消息的 WS-Addressing 操作,定义具体的动作,他表示的是一个层次上的关系,下面的代码中可以看出,Action=namespace+servername+methodname。当客户端导入一个服务终结点的元数据时,如果该终结点的契约属于接口层级的一部分,则生成的客户端契约将不再维持原来的层级关系。相反,它会取消层级,组成一个单独的契约,名称为终结点的契约名。这个单独的契约包含了层级中从上至下所有接口定义的操作。然而,如果使用OperationContract特性中的Action与ResponseAction属性,那么导入的接口定义仍然可以保留原来定义每个操作的契约名,比如:服务接口之间如果有继承关系的存在,那么他就可以派上用场了。

ReplyAction:调用后回传的地址,获取或设置用于该操作答复消息的 SOAP 操作的值,定义具体的相应动作。它主要完成的是SOAP数据到具体代码的映射关系。

对于这后两个属性是不是不太理解,没关系后面的sample会给你答案, 继续读完吧,坚持就是胜利!!!

[MessageParameter]:用来控制参数或者返回名称,下面的一段代码可以很好的帮我们理解他的作用,很简单,其实就是映射作用。具体如下:有一个Java的客户端,发送一个SOAP给WCF服务,WCF会检查SOAP中有没有的对应定义的MessageParameter Name,如果有就会对应到WCF函数中的相应位置,通过这种映射关系,然后通过反序列化把数据传到WCF的对应方法中,实现对象的传递。说简单点他就是用来控制在soap中参数节点的名称的。

概念SOAP:Simple Object Access Protocol,简单对象访问协议(SOAP)是一种轻量的、简单的、基于 XML 的协议,它被设计成在 WEB 上交换结构化的和固化的信息。 SOAP 可以和现存的许多因特网协议和格式结合使用,包括超文本传输协议( HTTP),简单邮件传输协议(SMTP),多用途网际邮件扩充协议(MIME)。它还支持从消息系统到远程过程调用(RPC)等大量的应用程序。

WCF服务和Client之间其实就是用的SOAP这种协议。下面的代码展示了这些关键字的使用方法。

复制代码
Demo 代码
using  System;
using  System.Collections.Generic;
using  System.Linq;
using  System.Text;
using  System.ServiceModel;

namespace  WCF.Demo
{
    
public   class  HelloWorldService : IService
    {
        
public   string  HelloWorld( string  message)
        {
            
return   string .Format( " At {0}, I will say {1} " , DateTime.Now, message);
        }

        
public   void  SaveLink( string  item)
        {

        }

        
public   string  GetLink( string  id)
        {
            
return   " Thanks! " ;
        }
    }

    [ServiceContract(Name 
=   " ContentManagerContract " , Namespace  =   " http://www.cnblogs.com/CharlesLiu " )]
    
public   interface  IService
    {
        [OperationContract(Name 
=   " SaveLinkString " , Action  =   " http://www.cnblogs.com/CharlesLiu/ContentManagerContract/SaveLink " ,ReplyAction = " http://www.cnblogs.com/CharlesLiu/ContentManagerContract/ResponseSaveLink " )]
        
void  SaveLink([MessageParameter(Name  =   " StringItem " )] string  item);

        [OperationContract]
        [
return : MessageParameter(Name  =   " StringItem " )]
        
string  GetLink( string  id);

        [OperationContract]
        
string  HelloWorld( string  message);
    }
}
复制代码

 

下面的例子主要介绍Action属性,创建WCF程序项目,更加方便,不用编写host部分了,F5会自动把Service给host起来,如下图:

 

复制代码
Demo1.IService代码
using  System;
using  System.Collections.Generic;
using  System.Linq;
using  System.Runtime.Serialization;
using  System.ServiceModel;
using  System.Text;

namespace  WcfServiceLibraryDemo
{
    
//  NOTE: If you change the interface name "IService1" here, you must also update the reference to "IService1" in App.config.
    [ServiceContract(Name  =   " ServiceAContract " , Namespace  =   " http://www.cnblogs.com/Charlesliu " )]
    
public   interface  IServiceA
    {
        [OperationContract(Name 
=   " Name_Operation1 " , Action  =   " http://www.cnblogs.com/Charlesliu/ServiceAContract/Operation1 " , ReplyAction  =   " http://www.cnblogs.com/Charlesliu/ServiceAContract/Operation1Response " )]
        
string  Operation1();

        [OperationContract(Name 
=   " Name_Operation2 " , Action  =   " http://www.cnblogs.com/Charlesliu/ServiceAContract/Operation2 " , ReplyAction  =   " http://www.cnblogs.com/Charlesliu/ServiceAContract/Operation2Response " )]
        
string  Operation2();
    }
}
复制代码

 

复制代码
Demo1.Service.Class代码
using  System;
using  System.Collections.Generic;
using  System.Linq;
using  System.Runtime.Serialization;
using  System.ServiceModel;
using  System.Text;

namespace  WcfServiceLibraryDemo
{
    
public   class  ServiceA : IServiceA
    {

        
public   string  Operation1()
        {
            
return   " IServiceA.Operation1() invoked. " ;
        }

        
public   string  Operation2()
        {
            
return   " IServiceA.Operation2() invoked. " ;
        }

    }
}
复制代码

 

复制代码
Demo1.WinClient代码
using  System;
using  System.Collections.Generic;
using  System.ComponentModel;
using  System.Data;
using  System.Drawing;
using  System.Linq;
using  System.Text;
using  System.Windows.Forms;

namespace  WinTest
{
    
public   partial   class  Form1 : Form
    {
        
public  Form1()
        {
            InitializeComponent();
        }

        
private   void  button1_Click( object  sender, EventArgs e)
        {
            MyServiceReference.ServiceAContractClient so1 
=   new  WinTest.MyServiceReference.ServiceAContractClient();
            MessageBox.Show(so1.Name_Operation1());
        }

        
private   void  button2_Click( object  sender, EventArgs e)
        {
            MyServiceReference.ServiceAContractClient so1 
=   new  WinTest.MyServiceReference.ServiceAContractClient();
            MessageBox.Show(so1.Name_Operation2());
        }
    }
}
复制代码

Action说简单点就是用来定义某个web方法在SOAP中的调用地址的。ReplyAction也就是用来定义某个web方法返回值在SOAP中的输出地址的。当在一个大的服务中出现同名的方法时,不论是有继承关系或是简单的同名,这个地址就可以很好的在SOAP中区分开该方法。

只有有了这些地址WCF才能进行输入和输出的操作,他们会用默认值自动设置上去。

 当然这部分还有很多的知识,在以后的开发工作中会逐步积累和总结。

这篇关于WCF开发之服务契约的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/953063

相关文章

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战:从入门到进阶优化1. MyBatis

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark

Linux上设置Ollama服务配置(常用环境变量)

《Linux上设置Ollama服务配置(常用环境变量)》本文主要介绍了Linux上设置Ollama服务配置(常用环境变量),Ollama提供了多种环境变量供配置,如调试模式、模型目录等,下面就来介绍一... 目录在 linux 上设置环境变量配置 OllamPOgxSRJfa手动安装安装特定版本查看日志在

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具?核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件

SpringCloud之LoadBalancer负载均衡服务调用过程

《SpringCloud之LoadBalancer负载均衡服务调用过程》:本文主要介绍SpringCloud之LoadBalancer负载均衡服务调用过程,具有很好的参考价值,希望对大家有所帮助,... 目录前言一、LoadBalancer是什么?二、使用步骤1、启动consul2、客户端加入依赖3、以服务

基于Python开发批量提取Excel图片的小工具

《基于Python开发批量提取Excel图片的小工具》这篇文章主要为大家详细介绍了如何使用Python中的openpyxl库开发一个小工具,可以实现批量提取Excel图片,有需要的小伙伴可以参考一下... 目前有一个需求,就是批量读取当前目录下所有文件夹里的Excel文件,去获取出Excel文件中的图片,并

基于Python开发PDF转PNG的可视化工具

《基于Python开发PDF转PNG的可视化工具》在数字文档处理领域,PDF到图像格式的转换是常见需求,本文介绍如何利用Python的PyMuPDF库和Tkinter框架开发一个带图形界面的PDF转P... 目录一、引言二、功能特性三、技术架构1. 技术栈组成2. 系统架构javascript设计3.效果图

基于Python开发PDF转Doc格式小程序

《基于Python开发PDF转Doc格式小程序》这篇文章主要为大家详细介绍了如何基于Python开发PDF转Doc格式小程序,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 用python实现PDF转Doc格式小程序以下是一个使用Python实现PDF转DOC格式的GUI程序,采用T

使用Python开发一个图像标注与OCR识别工具

《使用Python开发一个图像标注与OCR识别工具》:本文主要介绍一个使用Python开发的工具,允许用户在图像上进行矩形标注,使用OCR对标注区域进行文本识别,并将结果保存为Excel文件,感兴... 目录项目简介1. 图像加载与显示2. 矩形标注3. OCR识别4. 标注的保存与加载5. 裁剪与重置图像