C# 开发WCF基本步骤(以控制台为宿主)_c# wcf 控制台-程序员宅基地

技术标签: C#  WCF  

基本步骤

  1. 定义传输数据类型
  2. 定义请求契约
    1. 网络访问的接口URL
    2. Controller的方法接口
  3. 实现网络请求接口
  4. 定义配置文件
    1. 申明服务(ABC三要素)
    2. 申明行为约束
    3. 申明服务器端参数(支持Jsonp方式访问异步数据)
  5. 将契约接口注册到控制台中

定义传输数据类型

基本说明

  1. 传输数据类型,实质是一个受到特性限制的pojo/Vo/DAO类
  2. 传输数据类型,会依据不同的配置参数,在传递过程中序列化为Json或者xml两种交换格式
  3. 传输数据类型,其正反序列化都是由.NET框架自动进行

实例代码

namespace WCF_DataReaderService
{
    
    [DataContract]
    public class ResultEntry
    {
    
        private bool state;
        private string message;
        private string value;

        [DataMember]
        public bool State
        {
    
            get {
     return state; }
            set {
     state = value; }
        }

        [DataMember]
        public string Message
        {
    
            get {
     return message; }
            set {
     message = value; }
        }

        [DataMember]
        public string Value
        {
    
            get {
     return value; }
            set {
     this.value = value; }
        }
        
        //其他辅助方法省略...
    }
}

代码代码说明

  1. 特性 DataContract 限定当前实体类为传输数据类型
  2. 特性 DataMember 限定当前属性需要被执行正反序列化

定义请求契约

基本说明

  1. 请求契约在物理上就是一个受到特性限制的Interface
  2. 请求契约对外确定了当前网络请求的具体URL,请求方式和返回结果类型
  3. 请求契约对内确定了要相应请求的功能类的方法名称和参数类型

实例代码

namespace WCF_DataReaderService
{
    
    
    [ServiceContract]
    public interface IDataReaderService
    {
    

        [OperationContract]
        [WebInvoke(
            Method = "GET",
            RequestFormat = WebMessageFormat.Json,
            ResponseFormat = WebMessageFormat.Json,
            UriTemplate = "ReadFile/FileName={value}"
            )]
        ResultEntry ReadFile(string value);

        [OperationContract]
        [WebInvoke(
            Method = "GET",
            ResponseFormat = WebMessageFormat.Json,
            UriTemplate = "ConnectTest"
            )]
        ResultEntry ConnectTest();
    }
}

代码说明

  1. 特性 ServiceContract 限定当前接口为请求契约
  2. 特性 OperationContract 限定当前方法为契约执行方法接口
  3. 特性 WebInvoke 限定当前方法的对外的网络请求参数,包括URL,支持请求方式以及响应结果类型
  4. 返回类型 ResultEntry 为自定义参数类型,在当前配置模式下,返回的结果Entry实体会自动被序列化成为json字符串

实现业务逻辑

基本说明

  1. 该过程实际就是实现契约接口
  2. 请求契约中各个方法相互独立,不能在契约方法A中调用契约方法B
  3. 依据MVC架构,契约实体类中不包含任具体业务逻辑,只是将调用Service层中的方法

实例代码

namespace WCF_DataReaderService
{
    
    public class DataReaderService : IDataReaderService
    {
    

        public ResultEntry ReadFile(string value)
        {
    

            ResultEntry result = ResultEntry.CreateSuccessEntry("");
            //调用service层的功能方法
            JsonDataFileController controller = new JsonDataFileController();
            if (controller.IsFileExist(value) == false)
                return result.UpdateState(false, controller.DisplayError_FileNotExsit(value));
            if (controller.ReadFileValue(value) == false)
                return result.UpdateState(false, controller.DisplayError_FileReadError(value));
            result.UpdateResult(controller.Result);
            controller.Release();
            return result;
        }

        public ResultEntry ConnectTest()
        {
    
            ResultEntry result = ResultEntry.CreateSuccessEntry("this is test");
            return result;
        }
    }
}

代码说明

  1. ReadFile 方法用于读取指定目录下,由参数指定的文件名内容,并将读取内容写到ResultEntry的Value属性中
  2. ConnectTest 方法用于测试网络连接是畅通,无任何有意义的业务逻辑
  3. JsonDataFileController 封装了具体的文件内容读取实现过程,具体代码如下所示
namespace WCF_DataReaderService.Controller
{
    
    public class JsonDataFileController
    {
    
        public bool IsFileExist(string value)
        {
    
            //该类用于读取指定配置文件中写入的“共享路径”
            DataFileFoldConfig config = DataFileFoldConfig.Load();
            return (File.Exists(config.BaseFold + "/" + value));
        }

        public bool ReadFileValue(string value)
        {
    
            bool result = false;
            try
            {
    
                DataFileFoldConfig config = DataFileFoldConfig.Load();
                string FileName = config.BaseFold + "/" + value;
                using (FileStream fs = new FileStream(FileName, FileMode.Open, FileAccess.ReadWrite, FileShare.Read))
                {
    
                    using (StreamReader sw = new StreamReader(fs, Encoding.UTF8))
                    {
    
                        Result = sw.ReadToEnd();
                    }
                }
                result = true;
            }
            catch (Exception ex)
            {
    
                Console.WriteLine("ReadFileValue {0} ", ex.Message);
            }
            return result;
        }

        public string DisplayError_FileNotExsit(string value)
        {
    
            DataFileFoldConfig config = DataFileFoldConfig.Load();
            string FileName = config.BaseFold + "/" + value;
            return string.Format("文件{0}不存在", FileName);
        }

        public string DisplayError_FileReadError(string value)
        {
    
            DataFileFoldConfig config = DataFileFoldConfig.Load();
            string FileName = config.BaseFold + "/" + value;
            return string.Format("文件{0} 读取错误", FileName);
        }

        public string Result {
     get; set; }

        public void Release()
        {
    
            Result = "";
        }
    }
}

定义配置文件

  1. 配置文件实际就是宿主项目的App.config文件

实例代码

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <!-- 基本配置信息 -->
  <appSettings>
    <add key="aspnet:UseTaskFriendlySynchronizationContext" value="true" />
  </appSettings>
  
  <system.web>
    <compilation debug="true" targetFramework="4.5" />
    <httpRuntime targetFramework="4.5"/>
  </system.web>
  
  <!-- wcf模块信息 -->
  
  <system.serviceModel>
    <!-- 允许跨域 -->
    <standardEndpoints>
      <webHttpEndpoint>
          <standardEndpoint crossDomainScriptAccessEnabled="true"/>
      </webHttpEndpoint>
    </standardEndpoints>
    <!-- 申明契约 -->
    <services>
      <service behaviorConfiguration="WCF_DataReaderService.Behavior(服务行为名)" name="WCF_DataReaderService.DataReaderService(契约实现类全称)">
        <endpoint address="http://127.0.0.1:3721/CSQData(网络请求基础路径)" kind="webHttpEndpoint" contract="WCF_DataReaderService.IDataReaderService(请求契约接口类全称)" behaviorConfiguration="WCF_DataReaderService.RestfulBehavior(端口行为配置名)"></endpoint>
      </service>
    </services>
    
    <!-- 申明行为 -->
    <behaviors>
      <endpointBehaviors>
        <behavior name="WCF_DataReaderService.RestfulBehavior(端口行为配置名)">
          <webHttp/>
        </behavior>
      </endpointBehaviors>
      <serviceBehaviors>
        <behavior name="WCF_DataReaderService.Behavior(服务行为名)">
          <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true"/>
          <serviceDebug includeExceptionDetailInFaults="true"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>
    
    <!-- 申明参数 -->
    <bindings>
      <webHttpBinding>
        <binding crossDomainScriptAccessEnabled="true" />
      </webHttpBinding>
    </bindings>
  </system.serviceModel>
  
  <!-- 支持jsonp -->
  <system.webServer>
    <modules runAllManagedModulesForAllRequests="true"/>
    <directoryBrowse enabled="true"/>
    <httpProtocol>
      <customHeaders>
        <add name="Access-Control-Allow-Methods" value="OPTIONS,POST,GET" />
        <add name="Access-Control-Allow-Headers" value="x-requested-with,content-type" />
        <add name="Access-Control-Allow-Origin" value="*" />
      </customHeaders>
    </httpProtocol>
  </system.webServer>
  
</configuration>

代码说明

  1. 一般情况下 services节点和behaviors节点,需要依据实际的请求契约接口名进行修改并确保相互配套
  2. 一般情况下 其他节点内容,可以不修改直接使用

将契约接口注册到控制台中

基本说明

  1. 实际就是启动一个无限循环的控制台,实现网络请求的持续监听,充当服务器
  2. 该控制台程序所在项目需要特别引入如下dll支持
    1. System.ServiceModel
    2. System.ServiceModel.Web
    3. System.Web.Services
    4. System.Web

实例代码

namespace WCF_Host
{
    
    class Program
    {
    
        static void Main(string[] args)
        {
    
            using (WebServiceHost host = new WebServiceHost(typeof(DataReaderService)))
            {
    
                try
                {
    
                    host.Open();
                    Console.WriteLine("服务已经启动,输入exit退出...");
                    while (true)
                    {
    
                        string temp = Console.ReadLine();
                        if (temp.Equals("exit", StringComparison.CurrentCultureIgnoreCase))
                        {
    
                            break;
                        }
                    }
                    host.Close();
                }
                catch (Exception ex)
                {
    
                    Console.WriteLine("服务启动异常{0},输入exit退出...", ex.Message);
                }
            }
        }
    }
}

代码说明

  1. 请求契约实现类,实际通过WebServiceHost对象,注入到控制台容器中
  2. 控制台通过监听输入值是否为“exit”,判断是否需要执行退出

网页请求Js代码

  1. 该请求过程采用JQuery的jsonp技术
//连接测试函数
function JQuery_ConnectTest()
{
    
	//异步方式获取数据
	$.ajax
	({
    
		async: false,
		crossDomain: true,
	    type: "get",
	    url: "http://127.0.0.1:3721/CSQData/ConnectTest",
	    dataType: 'jsonp',
	    success: function(data) 
		{
    
			console.log(0,data);
			$("p").text(JSON.stringify(data));
	    },
		error: function(xhr, type) 
		{
    
			console.log(0,xhr);
		}
	});
}

//读取文件函数
function JQuery_ReadFile(filePath)
{
    
	//异步方式获取数据
	$.ajax
	({
    
		async: false,
		crossDomain: true,
	    type: "get",
	    url: "http://127.0.0.1:3721/CSQData/ReadFile/FileName=" + filePath,
	    dataType: 'jsonp', //防止跨域的问题
	    success: function(data) 
		{
    
			//异步方式获取数据后的处理函数
			result = JSON.stringify(data);
			//这里只是展示结果
			$("p").text(result);
			//也可以用传入其他函数,但就是不能执行return语句
			JQuery_ReadFile_Post(result);
	    },
		error: function(xhr, type) 
		{
    
			console.log(0,xhr);
		}
	});       
}
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/cyoubo/article/details/101313695

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk

随便推点

matlab(4):特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析 时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;amp;gt;Jni-&amp;amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法