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

智能推荐

分布式光纤传感器的全球与中国市场2022-2028年:技术、参与者、趋势、市场规模及占有率研究报告_预计2026年中国分布式传感器市场规模有多大-程序员宅基地

文章浏览阅读3.2k次。本文研究全球与中国市场分布式光纤传感器的发展现状及未来发展趋势,分别从生产和消费的角度分析分布式光纤传感器的主要生产地区、主要消费地区以及主要的生产商。重点分析全球与中国市场的主要厂商产品特点、产品规格、不同规格产品的价格、产量、产值及全球和中国市场主要生产商的市场份额。主要生产商包括:FISO TechnologiesBrugg KabelSensor HighwayOmnisensAFL GlobalQinetiQ GroupLockheed MartinOSENSA Innovati_预计2026年中国分布式传感器市场规模有多大

07_08 常用组合逻辑电路结构——为IC设计的延时估计铺垫_基4布斯算法代码-程序员宅基地

文章浏览阅读1.1k次,点赞2次,收藏12次。常用组合逻辑电路结构——为IC设计的延时估计铺垫学习目的:估计模块间的delay,确保写的代码的timing 综合能给到多少HZ,以满足需求!_基4布斯算法代码

OpenAI Manager助手(基于SpringBoot和Vue)_chatgpt网页版-程序员宅基地

文章浏览阅读3.3k次,点赞3次,收藏5次。OpenAI Manager助手(基于SpringBoot和Vue)_chatgpt网页版

关于美国计算机奥赛USACO,你想知道的都在这_usaco可以多次提交吗-程序员宅基地

文章浏览阅读2.2k次。USACO自1992年举办,到目前为止已经举办了27届,目的是为了帮助美国信息学国家队选拔IOI的队员,目前逐渐发展为全球热门的线上赛事,成为美国大学申请条件下,含金量相当高的官方竞赛。USACO的比赛成绩可以助力计算机专业留学,越来越多的学生进入了康奈尔,麻省理工,普林斯顿,哈佛和耶鲁等大学,这些同学的共同点是他们都参加了美国计算机科学竞赛(USACO),并且取得过非常好的成绩。适合参赛人群USACO适合国内在读学生有意向申请美国大学的或者想锻炼自己编程能力的同学,高三学生也可以参加12月的第_usaco可以多次提交吗

MySQL存储过程和自定义函数_mysql自定义函数和存储过程-程序员宅基地

文章浏览阅读394次。1.1 存储程序1.2 创建存储过程1.3 创建自定义函数1.3.1 示例1.4 自定义函数和存储过程的区别1.5 变量的使用1.6 定义条件和处理程序1.6.1 定义条件1.6.1.1 示例1.6.2 定义处理程序1.6.2.1 示例1.7 光标的使用1.7.1 声明光标1.7.2 打开光标1.7.3 使用光标1.7.4 关闭光标1.8 流程控制的使用1.8.1 IF语句1.8.2 CASE语句1.8.3 LOOP语句1.8.4 LEAVE语句1.8.5 ITERATE语句1.8.6 REPEAT语句。_mysql自定义函数和存储过程

半导体基础知识与PN结_本征半导体电流为0-程序员宅基地

文章浏览阅读188次。半导体二极管——集成电路最小组成单元。_本征半导体电流为0

随便推点

【Unity3d Shader】水面和岩浆效果_unity 岩浆shader-程序员宅基地

文章浏览阅读2.8k次,点赞3次,收藏18次。游戏水面特效实现方式太多。咱们这边介绍的是一最简单的UV动画(无顶点位移),整个mesh由4个顶点构成。实现了水面效果(左图),不动代码稍微修改下参数和贴图可以实现岩浆效果(右图)。有要思路是1,uv按时间去做正弦波移动2,在1的基础上加个凹凸图混合uv3,在1、2的基础上加个水流方向4,加上对雾效的支持,如没必要请自行删除雾效代码(把包含fog的几行代码删除)S..._unity 岩浆shader

广义线性模型——Logistic回归模型(1)_广义线性回归模型-程序员宅基地

文章浏览阅读5k次。广义线性模型是线性模型的扩展,它通过连接函数建立响应变量的数学期望值与线性组合的预测变量之间的关系。广义线性模型拟合的形式为:其中g(μY)是条件均值的函数(称为连接函数)。另外,你可放松Y为正态分布的假设,改为Y 服从指数分布族中的一种分布即可。设定好连接函数和概率分布后,便可以通过最大似然估计的多次迭代推导出各参数值。在大部分情况下,线性模型就可以通过一系列连续型或类别型预测变量来预测正态分布的响应变量的工作。但是,有时候我们要进行非正态因变量的分析,例如:(1)类别型.._广义线性回归模型

HTML+CSS大作业 环境网页设计与实现(垃圾分类) web前端开发技术 web课程设计 网页规划与设计_垃圾分类网页设计目标怎么写-程序员宅基地

文章浏览阅读69次。环境保护、 保护地球、 校园环保、垃圾分类、绿色家园、等网站的设计与制作。 总结了一些学生网页制作的经验:一般的网页需要融入以下知识点:div+css布局、浮动、定位、高级css、表格、表单及验证、js轮播图、音频 视频 Flash的应用、ul li、下拉导航栏、鼠标划过效果等知识点,网页的风格主题也很全面:如爱好、风景、校园、美食、动漫、游戏、咖啡、音乐、家乡、电影、名人、商城以及个人主页等主题,学生、新手可参考下方页面的布局和设计和HTML源码(有用点赞△) 一套A+的网_垃圾分类网页设计目标怎么写

C# .Net 发布后,把dll全部放在一个文件夹中,让软件目录更整洁_.net dll 全局目录-程序员宅基地

文章浏览阅读614次,点赞7次,收藏11次。之前找到一个修改 exe 中 DLL地址 的方法, 不太好使,虽然能正确启动, 但无法改变 exe 的工作目录,这就影响了.Net 中很多获取 exe 执行目录来拼接的地址 ( 相对路径 ),比如 wwwroot 和 代码中相对目录还有一些复制到目录的普通文件 等等,它们的地址都会指向原来 exe 的目录, 而不是自定义的 “lib” 目录,根本原因就是没有修改 exe 的工作目录这次来搞一个启动程序,把 .net 的所有东西都放在一个文件夹,在文件夹同级的目录制作一个 exe._.net dll 全局目录

BRIEF特征点描述算法_breif description calculation 特征点-程序员宅基地

文章浏览阅读1.5k次。本文为转载,原博客地址:http://blog.csdn.net/hujingshuang/article/details/46910259简介 BRIEF是2010年的一篇名为《BRIEF:Binary Robust Independent Elementary Features》的文章中提出,BRIEF是对已检测到的特征点进行描述,它是一种二进制编码的描述子,摈弃了利用区域灰度..._breif description calculation 特征点

房屋租赁管理系统的设计和实现,SpringBoot计算机毕业设计论文_基于spring boot的房屋租赁系统论文-程序员宅基地

文章浏览阅读4.1k次,点赞21次,收藏79次。本文是《基于SpringBoot的房屋租赁管理系统》的配套原创说明文档,可以给应届毕业生提供格式撰写参考,也可以给开发类似系统的朋友们提供功能业务设计思路。_基于spring boot的房屋租赁系统论文