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

智能推荐

使用nginx解决浏览器跨域问题_nginx不停的xhr-程序员宅基地

文章浏览阅读1k次。通过使用ajax方法跨域请求是浏览器所不允许的,浏览器出于安全考虑是禁止的。警告信息如下:不过jQuery对跨域问题也有解决方案,使用jsonp的方式解决,方法如下:$.ajax({ async:false, url: 'http://www.mysite.com/demo.do', // 跨域URL ty..._nginx不停的xhr

在 Oracle 中配置 extproc 以访问 ST_Geometry-程序员宅基地

文章浏览阅读2k次。关于在 Oracle 中配置 extproc 以访问 ST_Geometry,也就是我们所说的 使用空间SQL 的方法,官方文档链接如下。http://desktop.arcgis.com/zh-cn/arcmap/latest/manage-data/gdbs-in-oracle/configure-oracle-extproc.htm其实简单总结一下,主要就分为以下几个步骤。..._extproc

Linux C++ gbk转为utf-8_linux c++ gbk->utf8-程序员宅基地

文章浏览阅读1.5w次。linux下没有上面的两个函数,需要使用函数 mbstowcs和wcstombsmbstowcs将多字节编码转换为宽字节编码wcstombs将宽字节编码转换为多字节编码这两个函数,转换过程中受到系统编码类型的影响,需要通过设置来设定转换前和转换后的编码类型。通过函数setlocale进行系统编码的设置。linux下输入命名locale -a查看系统支持的编码_linux c++ gbk->utf8

IMP-00009: 导出文件异常结束-程序员宅基地

文章浏览阅读750次。今天准备从生产库向测试库进行数据导入,结果在imp导入的时候遇到“ IMP-00009:导出文件异常结束” 错误,google一下,发现可能有如下原因导致imp的数据太大,没有写buffer和commit两个数据库字符集不同从低版本exp的dmp文件,向高版本imp导出的dmp文件出错传输dmp文件时,文件损坏解决办法:imp时指定..._imp-00009导出文件异常结束

python程序员需要深入掌握的技能_Python用数据说明程序员需要掌握的技能-程序员宅基地

文章浏览阅读143次。当下是一个大数据的时代,各个行业都离不开数据的支持。因此,网络爬虫就应运而生。网络爬虫当下最为火热的是Python,Python开发爬虫相对简单,而且功能库相当完善,力压众多开发语言。本次教程我们爬取前程无忧的招聘信息来分析Python程序员需要掌握那些编程技术。首先在谷歌浏览器打开前程无忧的首页,按F12打开浏览器的开发者工具。浏览器开发者工具是用于捕捉网站的请求信息,通过分析请求信息可以了解请..._初级python程序员能力要求

Spring @Service生成bean名称的规则(当类的名字是以两个或以上的大写字母开头的话,bean的名字会与类名保持一致)_@service beanname-程序员宅基地

文章浏览阅读7.6k次,点赞2次,收藏6次。@Service标注的bean,类名:ABDemoService查看源码后发现,原来是经过一个特殊处理:当类的名字是以两个或以上的大写字母开头的话,bean的名字会与类名保持一致public class AnnotationBeanNameGenerator implements BeanNameGenerator { private static final String C..._@service beanname

随便推点

二叉树的各种创建方法_二叉树的建立-程序员宅基地

文章浏览阅读6.9w次,点赞73次,收藏463次。1.前序创建#include&lt;stdio.h&gt;#include&lt;string.h&gt;#include&lt;stdlib.h&gt;#include&lt;malloc.h&gt;#include&lt;iostream&gt;#include&lt;stack&gt;#include&lt;queue&gt;using namespace std;typed_二叉树的建立

解决asp.net导出excel时中文文件名乱码_asp.net utf8 导出中文字符乱码-程序员宅基地

文章浏览阅读7.1k次。在Asp.net上使用Excel导出功能,如果文件名出现中文,便会以乱码视之。 解决方法: fileName = HttpUtility.UrlEncode(fileName, System.Text.Encoding.UTF8);_asp.net utf8 导出中文字符乱码

笔记-编译原理-实验一-词法分析器设计_对pl/0作以下修改扩充。增加单词-程序员宅基地

文章浏览阅读2.1k次,点赞4次,收藏23次。第一次实验 词法分析实验报告设计思想词法分析的主要任务是根据文法的词汇表以及对应约定的编码进行一定的识别,找出文件中所有的合法的单词,并给出一定的信息作为最后的结果,用于后续语法分析程序的使用;本实验针对 PL/0 语言 的文法、词汇表编写一个词法分析程序,对于每个单词根据词汇表输出: (单词种类, 单词的值) 二元对。词汇表:种别编码单词符号助记符0beginb..._对pl/0作以下修改扩充。增加单词

android adb shell 权限,android adb shell权限被拒绝-程序员宅基地

文章浏览阅读773次。我在使用adb.exe时遇到了麻烦.我想使用与bash相同的adb.exe shell提示符,所以我决定更改默认的bash二进制文件(当然二进制文件是交叉编译的,一切都很完美)更改bash二进制文件遵循以下顺序> adb remount> adb push bash / system / bin /> adb shell> cd / system / bin> chm..._adb shell mv 权限

投影仪-相机标定_相机-投影仪标定-程序员宅基地

文章浏览阅读6.8k次,点赞12次,收藏125次。1. 单目相机标定引言相机标定已经研究多年,标定的算法可以分为基于摄影测量的标定和自标定。其中,应用最为广泛的还是张正友标定法。这是一种简单灵活、高鲁棒性、低成本的相机标定算法。仅需要一台相机和一块平面标定板构建相机标定系统,在标定过程中,相机拍摄多个角度下(至少两个角度,推荐10~20个角度)的标定板图像(相机和标定板都可以移动),即可对相机的内外参数进行标定。下面介绍张氏标定法(以下也这么称呼)的原理。原理相机模型和单应矩阵相机标定,就是对相机的内外参数进行计算的过程,从而得到物体到图像的投影_相机-投影仪标定

Wayland架构、渲染、硬件支持-程序员宅基地

文章浏览阅读2.2k次。文章目录Wayland 架构Wayland 渲染Wayland的 硬件支持简 述: 翻译一篇关于和 wayland 有关的技术文章, 其英文标题为Wayland Architecture .Wayland 架构若是想要更好的理解 Wayland 架构及其与 X (X11 or X Window System) 结构;一种很好的方法是将事件从输入设备就开始跟踪, 查看期间所有的屏幕上出现的变化。这就是我们现在对 X 的理解。 内核是从一个输入设备中获取一个事件,并通过 evdev 输入_wayland

推荐文章

热门文章

相关标签