.NET FrameworkのWCFとは？C#で簡単なサービスを作成する方法

WCFとはWindows Communication Foundationの略称で、統合通信フレームワークを表します。WCFが導入される前までは、通信フレームワークに互換性がなく、通信方式を簡単には変えることができませんでした。WCFの登場後は、複数の通信フレームワークが統合されており、共通のアプローチで複数の通信方式を扱うことが可能となりました。ここでは、このWCFについて掘り下げていきたいと思います。

プログラマー

WCF……統合通信フレームワークって聞いて、なんだか難しそうなイメージがあります。どうやって実装するのでしょうか？

プロジェクト
リーダー

プログラミング初学者の方にはちょっと難しいかもしれませんね。WCFを理解するためには、基本的な概念は必ず押さえておく必要があります。まずはそこから確認していきましょう。

実行環境
・Visual Studio Community 2017

.NET Framework 3系で追加されたWCFとは

WCFは.NET Framework 3.0から新たに追加された、ネットワークを介して異なるコンピュータで動作するソフトウェア間で通信することができるフレームワークです。
WCFを理解するためには、まず知っておくべき基本的な概念が存在します。それが下記で説明する「ABC」です。

• ■A: Address

どこで公開するか(Where)を定義します。URLがこれに該当します

• ■B: Binding

どうやって公開するのか(How)を定義します。HTTPやTCPなどの通信プロトコルがこれに該当します

• ■C: Contract

何を公開するのか(What)を定義します。商取引やゲームなどがこれに該当します

このABCの基本概念があるからこそ、通信方式とロジックを分離し、通信方式の切り替えをより簡単に行うことが可能になります。
WCFでは様々な種類の通信方式が利用できますが、多くの場面で見られるのがHTTPです。利用できる通信方式も確認しておきましょう。

簡単なWCFサービスを作成する方法

今回は、C#を使って簡単なWCFサービスを作成していきましょう。

1. まず、Visual Studioから新しいプロジェクトを作成します。

   

2. プロジェクトが作成されました。プログラムは大きく分けてインターフェイス（IService1.cs）とインプリメンテーション（Service1.svc.cs）に分かれます。

   以下のプログラムでは「NewProc」の箇所を新たに追加しました。それ以外は変更する必要はありません。

   IService1.cs

   C#

   using System; using System.Collections.Generic; using System.Linq; using System.Runtime.Serialization; using System.ServiceModel; using System.ServiceModel.Web; using System.Text; namespace WcfService1 { // メモ: [リファクター] メニューの [名前の変更] コマンドを使用すると、コードと config ファイルの両方で同時にインターフェイス名 "IService1" を変更できます。 [ServiceContract] public interface IService1 { [OperationContract] string GetData(int value); [OperationContract] CompositeType GetDataUsingDataContract(CompositeType composite); // TODO: ここにサービス操作を追加します。 [OperationContract] string NewProc(string name); } // サービス操作に複合型を追加するには、以下のサンプルに示すようにデータ コントラクトを使用します。 [DataContract] public class CompositeType { bool boolValue = true; string stringValue = "Hello "; [DataMember] public bool BoolValue { get { return boolValue; } set { boolValue = value; } } [DataMember] public string StringValue { get { return stringValue; } set { stringValue = value; } } } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

   using System; using System.Collections.Generic; using System.Linq; using System.Runtime.Serialization; using System.ServiceModel; using System.ServiceModel.Web; using System.Text;   namespace WcfService1 {     // メモ: [リファクター] メニューの [名前の変更] コマンドを使用すると、コードと config ファイルの両方で同時にインターフェイス名 "IService1" を変更できます。     [ServiceContract]     public interface IService1     {           [OperationContract]         string GetData(int value);           [OperationContract]         CompositeType GetDataUsingDataContract(CompositeType composite);           // TODO: ここにサービス操作を追加します。         [OperationContract]         string NewProc(string name);     }         // サービス操作に複合型を追加するには、以下のサンプルに示すようにデータ コントラクトを使用します。     [DataContract]     public class CompositeType     {         bool boolValue = true;         string stringValue = "Hello ";           [DataMember]         public bool BoolValue         {             get { return boolValue; }             set { boolValue = value; }         }           [DataMember]         public string StringValue         {             get { return stringValue; }             set { stringValue = value; }         }     } }

   Service1.svc.cs

   C#

   using System; using System.Collections.Generic; using System.Linq; using System.Runtime.Serialization; using System.ServiceModel; using System.ServiceModel.Web; using System.Text; namespace WcfService1 { // メモ: [リファクター] メニューの [名前の変更] コマンドを使用すると、コード、svc、および config ファイルで同時にクラス名 "Service1" を変更できます。 // 注意: このサービスをテストするために WCF テスト クライアントを起動するには、ソリューション エクスプローラーでService1.svcまたはService1.svc.csを選択し、デバッグを開始してください。 public class Service1 : IService1 { public string GetData(int value) { return string.Format("You entered: {0}", value); } public CompositeType GetDataUsingDataContract(CompositeType composite) { if (composite == null) { throw new ArgumentNullException("composite"); } if (composite.BoolValue) { composite.StringValue += "Suffix"; } return composite; } public string NewProc(string name) { return "はじめまして" + name + "様"; } } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

   using System; using System.Collections.Generic; using System.Linq; using System.Runtime.Serialization; using System.ServiceModel; using System.ServiceModel.Web; using System.Text;   namespace WcfService1 {     // メモ: [リファクター] メニューの [名前の変更] コマンドを使用すると、コード、svc、および config ファイルで同時にクラス名 "Service1" を変更できます。     // 注意: このサービスをテストするために WCF テスト クライアントを起動するには、ソリューション エクスプローラーでService1.svcまたはService1.svc.csを選択し、デバッグを開始してください。     public class Service1 : IService1     {         public string GetData(int value)         {             return string.Format("You entered: {0}", value);         }           public CompositeType GetDataUsingDataContract(CompositeType composite)         {             if (composite == null)             {                 throw new ArgumentNullException("composite");             }             if (composite.BoolValue)             {                 composite.StringValue += "Suffix";             }             return composite;         }         public string NewProc(string name)         {             return "はじめまして" + name + "様";         }     } }

3. それでは動作確認をしてみましょう。Service1.svc.csを開いてからデバッグを実行しましょう。以下の画面が表示されます。

   

4. クライアントのデモ環境です。今回追加した「NewProc」をダブルクリックします。

   

5. 要求のnameの値に“テストクライアント”を設定します。起動ボタンを押下します。

   

6. OKを押下します。

   

7. 応答の値に正しく値が設定されていることを確認できました。

   

8. 次に、IService1.csを開いてデバッグを実行します。以下の画面が表示されますので、Service1.svcのリンクをクリックします。

   

9. http://localhost:54047/Service1.svc?wsdlの箇所はメモ帳などに保存しておきましょう。次項のサービスへのアクセス方法で使用します。

   

作成したサービスへのアクセス

1. クライアントとなる新しいプロジェクトを作成します。

   

2. プロジェクトが作成できたら、ソリューションエクスプローラーに表示されている参照を右クリックで、サービス参照の追加を行います。

   追加するURLは保存しておいたhttp://localhost:54047/Service1.svc?wsdlです。

   

3. 次に簡単なWindows Formsアプリを作成します。

   テキストボックスに値を設定し、ボタンを押下するとラベルに応答値が出力される仕組みです。今回は”テストクライアント”を入力値とします。

   ボタン押下の処理

   C#

   using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Windows.Forms; namespace WindowsFormsApp27 { public partial class Form1 : Form { public Form1() { InitializeComponent(); } private void button1_Click(object sender, EventArgs e) { ServiceReference1.Service1Client client = new ServiceReference1.Service1Client(); string returnString; returnString = client.NewProc(textBox1.Text); label1.Text = returnString; } } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

   using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Windows.Forms;   namespace WindowsFormsApp27 {     public partial class Form1 : Form     {         public Form1()         {             InitializeComponent();         }           private void button1_Click(object sender, EventArgs e)         {             ServiceReference1.Service1Client client = new ServiceReference1.Service1Client();             string returnString;               returnString = client.NewProc(textBox1.Text);             label1.Text = returnString;         }     } }

   

4. ラベルに値が出力されることを確認できました。

   

プログラマー

簡単にWCFの利用ができるのですね！まずは試しに自分でもコーディングしてみます。

プロジェクト
リーダー

そうですね。基本的な概念を理解することはとても大切なことです。それと同時にWCFを理解する一番の近道は、自分でコーディングしてみることです。

アプリケーションの通信に利用できるWCF

統合通信フレームワークと聞いて、難しい印象を持たれた方も多いかと思います。Windows Formsでクライアント画面を実装して、通信にはHTTPプロトコルを利用するアプリケーションを開発することは、多くの場面で求められるスキルではないでしょうか。勉強の際まずは、ここで解説したような簡単なWCFの作成方法を理解することから始めることをおすすめします。

>>>.NET Frameworkの案件を探すならFEnet .NET Navi