C# 开发WCF基本步骤（以控制台为宿主）

最新推荐文章于 2024-06-26 11:27:18 发布
最新推荐文章于 2024-06-26 11:27:18 发布
阅读量1.7k 收藏 5
点赞数
分类专栏： C# 文章标签： WCF
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/cyoubo/article/details/101313695
版权

文章目录

基本步骤

  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);
		}
	});       
}
地图工程师
关注
专栏目录
c# 开发WCF服务
zhangzhechun的专栏
03-31 1494
要自定义WCF服务中处理客户端POST请求数据的行为，您可以创建一个自定义的消息编码器（Message Encoder），并将其添加到服务终结点（Service Endpoint）的绑定（Binding）中。编译和部署WCF服务。总之，要自定义WCF服务中处理客户端POST请求数据的行为，您需要创建一个自定义消息编码器，并将其添加到服务终结点的绑定中。要将自定义消息编码器添加到服务终结点的绑定中，您可以在配置文件中指定一个自定义绑定（Custom Binding），并将自定义消息编码器添加到绑定中。
c# WCF开发实例（特别详细）适合初学者理解
us2019的博客
11-14 4876
由于之前开发没有用过wcf的开发模式，但是新的公司用到了，所以有幸学习了一下，自己先做个实例很有必要 特别适合没有接触过WCF开发模式的新人，手把手操作，十几分钟搞定，可以跟着试一下，特别详细 创建一个新的项目 创建后会默认生成 Service1.svc文件与Service.cs文件。可将其删除，项目右键，添加 有个默认DoWork方法，为了测试返回一个字符串 ...
使用C#创建WCF服务控制台应用程序
weixin_30619101的博客
07-12 390
本文属于原创，转载请注明出处，谢谢！ 一、开发环境 操作系统：Windows 10 开发环境：VS2015 编程语言：C# IIS版本：10.0.0.0 二、添加WCF服务、Internet Information Services(IIS) 1、进入“控制面板”，打开“程序和功能”，点击左上角的“启用或关闭Windows功能”后，在“.NET Framework 4.6 高...
C# WCF开发实例代码
04-23
一个C#实现的异常记录捕获工程,包含服务端所有源码
【Web服务与Web应用开发】【C#】创建第一个简单的WCF服务应用程序 WCF Service Application；搭建RESTful Web 服务（图文详情）
最新发布
Wynne的博客
06-26 1130
Visual Studio 2019创建第一个简单的WCF服务应用程序 WCF Service Application
无废话WCF入门教程一[什么是WCF]
weixin_33901641的博客
09-25 1277
一、概述 　　Windows Communication Foundation(WCF)是由微软发展的一组数据通信的应用程序开发接口，可以翻译为Windows通讯接口，它是.NET框架的一部分。由 .NET Framework 3.0 开始引入。 　　WCF的最终目标是通过进程或不同的系统、通过本地网络或是通过Internet收发客户和服务之间的消息。 　　WCF合并了Web服务、.ne...
C#WCF和WEB项目接口开发实际案例
02-19
自己项目中开发的服务器接口案例。增删改查基础案例。
JS跨域调用WCF服务实例(WCF服务宿主到控制台)
09-24
通过以上步骤，你就可以在控制台应用中成功宿主一个支持跨域调用的WCF服务，并且可以在JS中无障碍地调用它。记住，为了在实际生产环境中部署，你需要确保服务安全性和性能的优化，例如添加身份验证、使用HTTPS等。
net Wcf应用实例-含控制台和windows服务宿主
11-13
本教程将深入探讨如何在C#环境中实现WCF应用，包括在控制台应用和Windows服务中作为宿主的两种方式。 **一、WCF基础概念** 1. **服务契约（Service Contract）**：定义了服务提供的操作及其参数和返回类型。使用`...
WCF-控制台-宿主-服务端配置方法
MrLsss的博客
03-18 449
创建WCF服务库：WcfServiceLibrary，根据自动创建的代码修改自己的WCF 服务协议、操作协议、数据协议。本次先实现简单的WCF最基本的通信方式：请求-》应答模式。
WCF服务以控制台程序为宿主时的跨域访问问题(附源码)
boyhxy的专栏
01-22 8938
            前几天研究SilverLight时碰到了这个问题，本以为很轻松的试验结果很不顺利，查了很多资料才解决了这个问题，在此把解决问题的方法写出来，也方便其它朋友借鉴。       问题是这样产生了，我在测试SilverLight时为了测试与WCF的通讯，创建了一个控制台的应用程序做为WCF服务的宿主程序。      同时创建了一个SilverLight应用程序
C# WCF项目示例
02-23
WCF示例项目，c#...................................................................................................................................
C#创建WCF服务控制台应用程序详解
08-30
主要为大家详细介绍了C#创建WCF服务控制台应用程序，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
C# WCF架构创建过程 (C/S)
10-31
C# WCF架构创建过程 (C/S)，c# winform .Net 架构 编程
WCF完整实例(Windows服务宿主)
10-26
通过这个完整的实例，开发者不仅可以了解WCF的基本原理，还能掌握如何在实际环境中部署和运行WCF服务，特别是使用Windows服务宿主的方式，这对于构建长期运行的后台服务尤其有用。同时，实践是学习的最佳途径，因此...
（C#）一个WCF简单实例
zexin1的专栏
01-07 709
以订票为例简单应用wcf新建一个wcf服务应用程序在IService1.cs定义服务契约namespace WcfDemo{    // 注意: 如果更改此处的接口名称 "IService1"，也必须更新 Web.config 中对 "IService1" 的引用。     [ServiceContract]  // 服务合同即提供服务的接口或类    publicinterface IService1     {         [OperationContract]        /* 增加车票的方法*
C#学习之简单的WCF例子
weixin_34054931的博客
02-28 185
  学silverlight学到WCF，嗯，WCF的确有点难，不过没所谓，一点一点来，下面就尝试着实现一个最基本最简单的WCF例子，里面不涉及到EndPoint、Binding、Element、异步调用、序列化等等这些或者其他更难理解的概念，只是简单地按照默认设置用最简单的代码把WCF最基本的应用体现出来。 第一步：创建一个空的解决方案，新建一个WCF服务应用程序项目（使用默认名字） 来模拟服...
C# WCF入门
Wu7z_的博客
12-15 3661
目录标题一、什么是WCF二、第一个WCF程序三、WCF服务的使用 一、什么是WCF WCF是使用托管代码建立和运行面向服务(Service Oriented)应用程序的统一框架。它使得开发者能够建立一个跨平台的、安全、可信赖、事务性的解决方案，且能与已有系统兼容协作。WCF是微软分布 式应用程序开发的集大成者，它整合了.Net平台下所有的和分布式系统有关的技术，例如.Net Remoting、ASMX、WSE和MSMQ（消息队列）。以通信(Communiation)范围而论，它可以跨进程、跨机器、跨子网、企
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值