Moonmile Solutions Blog

[win8] MetroアプリからDesktopアプリへWCFで接続する | Moonmile Solutions Blog
http://www.moonmile.net/blog/archives/3387
[win8] metro アプリケーションからデスクトップアプリにプロセス間通信する | Moonmile Solutions Blog
http://www.moonmile.net/blog/archives/3379

# 追記 2012/05/12
# 再度確認したところ、localhost によるループバック接続はパッケージを作った時は駄目で、Visual Studio からデバッグ実行しただけ接続できます。このあたり、hosts 書き換え、ip 指定でも駄目なので、別の方式を考えないと。以下は、参考のため残しておきます。
# 業務的には、別マシンに proxy を立てて localhost->proxy->localohst にすれば ok なんですが、もうちょっとうまい方法を考えますか。ネットワーク負荷がかかるし。

なところで、WCF を使ってプロセス間通信できることは確認できたのですが、WCF だと metro アプリのほうで web の参照設定をしないといけません。まぁ、製品的にサーバーが先に固定化されている場合はいいのですが、流動的に作っている場合は先にインターフェースを決めないといけないというのはちょっと酷です。

な訳で、Web API 風に GET コマンドのアドレスを使って metro アプリ（クライアント）から desktop アプリ（サーバー）へ送信できるようにします。

■クライアントの metro アプリ側

private async void Button_Click_1(object sender, RoutedEventArgs e)
{
    string text = textBox1.Text;
    string url = "http://localhost:8083/metro/method";

    HttpClient client = new HttpClient();
    HttpResponseMessage res = await client.GetAsync(url + "/" + textBox1.Text);
    string response = await res.Content.ReadAsStringAsync();
    textBox2.Text = response;
}

metro アプリのほうでは、アドレスを指定してサーバーに接続します。Web API の REST のように「http://localhost:8083/metro/method/masuda/1000」とか「http://localhost:8083/metro/method?name=masuda&num=1000」のように呼び出すことを想定します。ここのサンプルでは適当に呼出URLを作っているだけなので、URLを作るための適当なラッパを作ると良いでしょう。

応答は、XML 形式でもよいのですが、自由に。

■Web APIを提供する desktop アプリ

HttpListener.BeginGetContext メソッド (System.Net)
http://msdn.microsoft.com/ja-jp/library/system.net.httplistener.begingetcontext(v=vs.110).aspx

を参考にして、HttpListener クラスでサーバーを作ります。前回は、同期メソッドを使ったために backgroundWorker コンポーネントでスレッドを使いましたが、今回は非同期メソッドの BeginGetContext、EndGetContext メソッドを使います。上記のサンプルコードではコールバック関数が static になっていますが、下記のように普通の内部メソッドを使うことができます。つーか、内部メソッドを使ったほうが、ListBox などの GUI にアクセスできるので便利かと。

using System.Net;
using System.IO;

namespace SampleLocalWebApiServer
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        HttpListener listener;

        private void button1_Click(object sender, EventArgs e)
        {
            string url = "http://*:8083/metro/";
            // 開始
            listener = new HttpListener();
            listener.Prefixes.Add(url);

            listener.Start();
            listBox1.Items.Add("サーバー開始");
            listener.BeginGetContext(ListenerCallback, listener);
        }

        public void ListenerCallback(IAsyncResult result)
        {
            // HttpListener listener = (HttpListener)result.AsyncState;
            HttpListenerContext context;
            try
            {
                context = listener.EndGetContext(result);
            }
            catch
            {
                // stop メソッドで例外が発生するので、対処
                return;
            }
            // var content = listener.GetContext();
            var req = context.Request;
            var url = req.RawUrl;
            var res = context.Response;

            listBox1.Items.Add("受信");

            var output = new StreamWriter( res.OutputStream ) ;
            output.WriteLine(string.Format("called {0}", url));
            output.Close();

            // 次の受信の準備
            listener.BeginGetContext(ListenerCallback, listener);
        }

        private void button2_Click(object sender, EventArgs e)
        {
            // 終了
            listener.Stop();
            listBox1.Items.Add("サーバー終了");
        }
    }
}

サーバーの停止なのですが、Stop か、Abort を呼び出します。が、ちょっと面倒なのは、Stop メソッドを呼び出した途端にコールバックが呼び出されるんですよね…で、EndGetContext メソッドの呼び出し時に例外が発生してしまうので、コードでは try-catch で、回避しています。異常終了の場合と区別がつかないので、もうちょっとなんとかしたいところですね。

呼び出した URL は、RawUrl プロパティで取得できます。URL プロパティでもいいのですが、RawURL のほうが、サーバー名とポート名を削ってくれるので、処理が楽なのです（名前が逆っぽいのは、見ないことにしよう）。

■実行してみる

サーバーを管理者権限で動かして、metro app からつなげてみます。

無事接続できていますね。サーバー側で適当に振り分けてやれば、Web API として動かすことができます。URL Encode/Decodeすれば文字列は簡単です。複雑な場合は POST で送って、適当なクラスでラップすればよいですかね。というか、シリアライズ機能を使えば ok かも。

昨日 [win8] metro アプリケーションからデスクトップアプリにプロセス間通信する の続き。

# 追記 2012/05/12
# 再度確認したところ、localhost によるループバック接続はパッケージを作った時は駄目で、Visual Studio からデバッグ実行しただけ接続できます。このあたり、hosts 書き換え、ip 指定でも駄目なので、別の方式を考えないと。以下は、参考のため残しておきます。
# 業務的には、別マシンに proxy を立てて localhost->proxy->localohst にすれば ok なんですが、もうちょっとうまい方法を考えますか。ネットワーク負荷がかかるし。

metro アプリで HttpClient クラスを使ってローカルホスト（localhost）に接続できることが分かったのですが、「さて、データ形式はどうしようか」ということで再考しておりました。 やっぱり、データ形式は XML 形式がいいよねと、どうせならばクライアントは WCF 形式で繋げられるとよいよね、と考えた挙句…ああ、WCF で使えばいいよね、とひと巡りして来てしまいました、という話。

「System.Net.HttpListenerException: アクセスが拒否されました。」と表示されてしまう
http://social.msdn.microsoft.com/Forums/ja-JP/wcfja/thread/4b1572df-a780-45b0-9488-cb4e3b95b53f

をよく見ると、実は WCF の話だったのですね。なるほど、というわけで

ServiceContractAttribute クラス (System.ServiceModel)
http://msdn.microsoft.com/ja-jp/library/system.servicemodel.servicecontractattribute.aspx
WCF クライアントを使用したサービスへのアクセス
http://msdn.microsoft.com/ja-jp/library/ms734691.aspx

を参考にしながら、

• desktop アプリで WCF サーバー
• metro アプリで WCF クライアント

を作成していきます。

■desktop アプリ（windows form アプリ）で WCF サーバー

基本は、ServiceContract、OperationContract 属性を使ってサービスで公開するメソッドを作るのと、ホストを ServiceHost クラスで作るところです。

using System.ServiceModel;
using System.ServiceModel.Description;

namespace SampleWcfMetroServer
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        ServiceHost serviceHost;
        // MetroService host;

        private void button1_Click(object sender, EventArgs e)
        {
            // 開始
            serviceHost = new ServiceHost(
                typeof(MetroService),
                new Uri("http://localhost:8082/metro"));
            //serviceHost.AddServiceEndpoint(
            //    typeof(IMetroService),
            //    new BasicHttpBinding(), "");
            ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
            smb.HttpGetEnabled = true;
            smb.MetadataExporter.PolicyVersion = PolicyVersion.Policy15;
            serviceHost.Description.Behaviors.Add(smb);

            // これは無駄
            // host = new MetroService();
            // host.OnNotiry += host_OnNotiry;

            // 自分のオブジェクトを static に登録
            Form1.me = this;

            serviceHost.Open();
            listBox1.Items.Add("サービス開始");
        }

        void host_OnNotiry(string name)
        {
            // イベントを受ける
            listBox1.Items.Add(name + " " + DateTime.Now.ToString());
        }

        private void button2_Click(object sender, EventArgs e)
        {
            serviceHost.Close();
            listBox1.Items.Add("サービス終了");
        }

        public void OnNotiry( string message )
        {
            this.listBox1.Items.Add( message );
        }

        public static Form1 me;
    }

    [ServiceContract]
    public interface IMetroService
    {
        [OperationContract]
        string GetDate(string name);
    }

    public class MetroService : IMetroService
    {
        public string GetDate(string name)
        {
            // 実行時にオブジェクトが作成されるので、こっちは効かない。
            if ( OnNotiry != null )
                OnNotiry("called GetDate");

            // 仕方がないので、static で公開したフォームに送信させる。
            Form1.me.OnNotiry("called GetDate");

            return string.Format("{0}:{1}", name, DateTime.Now.ToString());
        }

        // public Action<string> OnNotiry(string name);
        public delegate void OnNotiryHandler( string name );
        public event OnNotiryHandler OnNotiry;
    }
}

巷のサンプルでは、公開するクラス内で処理を行っていますが、そのままだと ListBox へ表示するなどの GUI 周りが使えないので、元のフォームにイベントメッセージを飛ばします。WCF で利用するクラスは、.NET リモートは違って接続時に動的に作成される（らしい）ので、フォームへのイベント飛ばしがちょっと妙なことになっています。このあたりは、あとで考えるということで。

■テスト用の WCF クライアントを作成

最初は、Windows Form アプリで試してみます。プロジェクトから先の WCF サービスを参照設定させるために、あらかじめ WCF サーバーを起動させておいて、プロジェクトから「サービスの参照を追加」します。WCF サーバーは管理者権限で起動するか、netsh を使ってポートを URL を登録しておきます。

ローカルのサービスの URL を指定して「Go」を押して検索します（このあたりは、Visual Studio 2010 も同じ）。

namespace SampleWcfMetroClient
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            // 送信
            var client = new MetroServiceReference.MetroServiceClient();
            string name = textBox1.Text;
            string res = client.GetDate(name);
            textBox2.Text = res;
        }

        private async void button2_Click(object sender, EventArgs e)
        {
            // 非同期送信
            var client = new MetroServiceReference.MetroServiceClient();
            string name = textBox1.Text;
            string res = await client.GetDateAsync(name);
            textBox2.Text = res;
        }
    }
}

面白いのは、.NET Framework 4.5 で作っているので自動的に、同期メソッドの GetDate と、非同期メソッドの GetDateAsync が用意されるところです。どちらを使ってもいいのですが、ここでは metro のために非同期版も作っておきます。

で、うまく送信ができれば準備完了。

■metro 版で WCF クライアントを作成

Form 版がテストができたので、本番の metro 版を作ります。Form 版と同じように「サービスの参照を追加」してから、適当にボタンを配置します。

namespace SampleWcfMetro
{
    /// <summary>
    /// An empty page that can be used on its own or navigated to within a Frame.
    /// </summary>
    public sealed partial class BlankPage : Page
    {
        public BlankPage()
        {
            this.InitializeComponent();
        }

        /// <summary>
        /// Invoked when this page is about to be displayed in a Frame.
        /// </summary>
        /// <param name=&quot;e&quot;>Event data that describes how this page was reached.  The Parameter
        /// property is typically used to configure the page.</param>
        protected override void OnNavigatedTo(NavigationEventArgs e)
        {
        }

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            // 非同期送信
            var client = new MetroServiceReference.MetroServiceClient();
            string name = textBox1.Text;
            string res = await client.GetDateAsync(name);
            textBox2.Text = res;
        }
    }
}

前回の HttpClient と違うのは、Desktop 版でテストをしたコードがそのまま使えるということです。これは違いが大きいですよね。metro アプリの場合、シミュレーター等と使うのでいまいちデバッグがしづらいところがあります。そうなると基本的なコードは desktop アプリで確認しておいて、metro アプリに適宜追加してくという方法をとるほうが効率的にデバッグができます。

実行するとこんな感じ。意外とすんなり動きます。これならばプロセス間通信の代用にしてもよいかなと。

発端は、.NETリモート通信を metro アプリから desktop アプリ（通常のwin8アプリ）に対して通信をさせたかった、ということです。metro アプリのデバッグログなんかを win8 アプリから見れたり、リモートデバッグしている元の PC から見られるようにするのが目的だったのです。

# 追記 2012/05/12
# 再度確認したところ、localhost によるループバック接続はパッケージを作った時は駄目で、Visual Studio からデバッグ実行しただけ接続できます。このあたり、hosts 書き換え、ip 指定でも駄目なので、別の方式を考えないと。以下は、参考のため残しておきます。
# 業務的には、別マシンに proxy を立てて localhost->proxy->localohst にすれば ok なんですが、もうちょっとうまい方法を考えますか。ネットワーク負荷がかかるし。

が、実は metro アプリでは .NET リモート通信ができません。.NET リモート通信を行うための条件として、

• TCP/IP 通信ができること（内部ではHTTPで動作している）。
• 共通のクラスを MarshalByRefObject で継承できること。
• 共通のクラスを、「共通」で使えること。

になるわけですが、metro って上記の3つとも駄目で、

• 直接 TCP/IP するクラスが用意されていない。ただし、HTTP だけは HttClient クラスがある。
• MarshalByRefObject クラスがない。
• metro のフレームワークと、.NET Framework 4.5 でそもそも異なる。

ってな感じで共通にクラスが使えません。まぁ、Windows Phone やら、他のバージョンのフレームワークに対しては「同じクラス」をアセンブリレベルでは共通に使えないので、当たり前といえば当たり前なのですが、同じ PC 内で、metro – desktop 間でアクセスできないのは、ちょっと辛い。

Client/Server の関係としては、metro が必ず Client になります。というのも、metro はばっくぐらうんどに入ってしまうとサスペンドをしてしまうので、Server にするにはあまり意味がないんですよね。それでも、iPhone の画像転送用の簡易 Http サーバーみたいなことができると便利なのですが、metro app の場合は desktop アプリとワンセットになって windows 8 として組み込まれるので、metro app 単体でなくても役に立つのです。まぁ、インストール自体が発生してしまうので、metro app の簡便性というのは低くなるのと、Store のほうがどうなのかという問題は残りますが…業務アプリならば別に問題なし。

■desktop のサーバーアプリ

HttpListener クラスを使って簡易的な HTTP サーバーを作ります。

using System.Net;
using System.IO;

namespace SampleProcessCommServer
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        // リスナー
        HttpListener listener;

        private void button1_Click(object sender, EventArgs e)
        {
            // 受け付けるURL
            string url = "http://*:8081/metro/";
            // 開始
            this.listener = new HttpListener();
            this.listener.Prefixes.Add(url);
            listener.Start();
            // スレッド開始
            backgroundWorker1.RunWorkerAsync();

            listBox1.Items.Add("サーバー開始");
        }

        private void button2_Click(object sender, EventArgs e)
        {
            // 停止
        }

        private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            while (true)
            {
                var content = listener.GetContext();
                var request = content.Request;
                var response = content.Response;

                var output = new StreamWriter(response.OutputStream);
                string text = @&quot;<response>
    <name>SampleProccessCommServer</name>
    <date>&quot; + DateTime.Now.ToString() + @&quot;</date>
</response>
&quot;;
                output.WriteLine(text);
                output.Close();
            }
        }
    }
}

画面をブロックしないように、BackgroundWorker コンポーネントを使っていますが、.NET 4.5 なので例の async/await を使っても ok です。

URL の指定の仕方は、HttpListener クラス (System.Net) を参考にしてください。URL の書き方は、.NET リモートと似ています…というか、内部的にこれを使っているかと思われます。

レスポンスは XML 形式で書いていますが、文字列であればなんでも ok です。クライアント側の解析のためは XML 形式にしておいたほうがよいでしょう。

■desktop のクライアントアプリ

テスト用に desktop 版のクライアントアプリを作って試します。

using System.Net;
using System.IO;

namespace SampleProcessCommClient
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            // 送信
            var client = new WebClient();
            string url = "http://localhost:8081/metro/sample001";
            var output = new StreamReader( client.OpenRead(url));
            string content = output.ReadToEnd();
            output.Close();
            textBox2.Text = content;
        }
    }
}

接続先は自分自身なので「localhost」にしておきます。.NET リモート風にアドレスを指定しておいて、最終的にはサーバーのほうで分岐させるという感じになります。

さて、これでテストをするときに、サーバープログラムのほうで、「System.Net.HttpListenerException: アクセスが拒否されました。」とエラーがでます。実は、windows 7 あたりから、一般ユーザーの場合はサーバーのポートを開く権限がないのですよね。「System.Net.HttpListenerException: アクセスが拒否されました。」と表示されてしまう を参考にしてポートを設定するか、アプリを「管理者権限」で立ち上げてしまいます。

ポートの設定は、「netsh http add urlacl url=http://*:8081/metro/ user=masuda」のようにします。

すると無事に送受信ができます。

■metro アプリから接続する。

先にテストしたクライアントアプリを metro に書き写してしまえば ok …と思いきや、かなりコードが違います。

using System.Net.Http;

// The Blank Page item template is documented at http://go.microsoft.com/fwlink/?LinkId=234238

namespace SampleProcessComm
{
    /// <summary>
    /// An empty page that can be used on its own or navigated to within a Frame.
    /// </summary>
    public sealed partial class BlankPage : Page
    {
        public BlankPage()
        {
            this.InitializeComponent();
        }

        /// <summary>
        /// Invoked when this page is about to be displayed in a Frame.
        /// </summary>
        /// <param name=&quot;e&quot;>Event data that describes how this page was reached.  The Parameter
        /// property is typically used to configure the page.</param>
        protected override void OnNavigatedTo(NavigationEventArgs e)
        {
        }

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            var client = new HttpClient();
            // GET で呼び出し
            var res = await client.GetAsync(&quot;http://localhost:8081/metro/sample1&quot;);
            // レスポンスを取得
            var cont = await res.Content.ReadAsStringAsync();
            textBoxOutput.Text = cont;
        }
    }
}

connect も get も非同期になるので、async/await を使う、ってのと HttpClient クラスを使うってのがミソです。

実行した結果がこんな感じ。input のところは無視していますが、きちんとレスポンスが返ってきます。

このソースの場合は localhost に送ったので、同じ PC に対してプロセス間通信をしていますが、別の PC に飛ばすこともできるので、実質 .NET リモートと同じように動作ができます。で、適当なシリアライズを考えてやれば、なにも MarshalByRefObject を継承する必要はなくて、異なる .NET Framework のバージョン間でも大丈夫という具合。当然、XML-RPC でも動くわけですから、相手が PHP や Java でも大丈夫。

まあ、このまま使うのはあまりにも面倒なので、適当にラップする必要がありますが…ってのと、Store とかに載せた場合はどうなるの？ってのがありますが。一応、プロセス間通信はできるということで。