WP8 - App2App Communication - Protocol (URI Schema) | Pou's IT Life - 點部落

2012-12-04

WP8 - App2App Communication - Protocol (URI Schema)

3907
0
Windows Phone
2016-03-04

Windows Phone 8 - App2App Communication - Protocol (URI Schema)

終於等到Windows Phone 8提供讓應用程式之間可以相溝通的能力了，記得在Windows Phone 7.1的時候，

開發者們聊天時如果談到應用程式溝通在Android/iOS裡都相當容易時，但在7.1 SDK時並未支援這樣豐富的功能，

好在這樣的需求終於在Windows Phone 8有了解決的方式。

馬上來看看Windows Phone 8如何提供應用程式之間互動的溝通吧。

〉Protocol：

在WP8 SDK提供開發人員可設計自己的應用程式，可以接受其他程式的串聯或是針對某特定檔案類型進行讀取，

讓應用程式與特定檔案之間可以溝通，那其中的關鍵在於：Protocol。例如：email中夾帶的附件是PDF，那在自己

的應用程式裡增加對PDF的識別，即可以在email中開啟PDF附件的程式清單出現自己的應用程式；或是程式裡有一

個Web URL可以串聯Browser進行瀏覽；更或是有多個程式可以管理航班資訊，可定義Protocol來與其他旅行用的應

用程式互相串聯，如同一個航班到達一個目的地，即串聯該旅行程式的相關資訊。

上述說明可以了解WP8開始支援互動的方式，因此，每一個應用程式可以宣告一個固定的URI Schema Name與File Type

來進行處理，當系統遇到固定的URI Schema Name或File Type時，即會執行有宣告的應用程式。

在Windows Phone 8 SDK裡針對應用程式之間的互動提供二個重要的關聯方式：(1) File Association；(2) URI Schema；

關於File Associations使用，可參考<Windows Phone 8 - 應用程式互相溝通方式(App-to-App Communication) - 2>的說明。

以下針對Protocol Invoke (URI Schema) 進行說明：

〉Protocol Invoke (URI Schema)：

針對特定的URI格式來啟動另一個應用程式。其原理在實作一個應用程式並註冊它監聽某一個特定的Protocol，

當有其他應用程式利用此Protocol建立一個URI並呼叫它時，該監聽的應用程式會自動收到並啟動。其URI裡也可以

額外夾帶參數進行傳遞，如同網頁的QueryString使用方式。

A. 設定URI schema name associations：以recipe://為例；

今天想讓應用程式接收固定的URI schema，假設宣告對 recipe:// 該URI Schema的監聽。那應用程式要如何調整才能在

系統遇到該URI Schema時可找得到應用程式。

(A-1). 開啟WMAppManifest.xml中的<Extension />標籤中加入新的標籤，來註冊要監聽的URI Schema；

[注意]

1. 注意<Extension />的標籤必需接在<Token />標籤之後；

2. 定義的URI Schema name不可以為保留字(例如：http、tel、mailto等)，使用保留字系統會自動勿略不註冊；

<Extensions>

    <!-- 注意Name與NaviUriFragment的屬性值 -->

    <!-- Name 代表 URI Schema name -->

    <!-- NavUriFragment 代表 App收到的完整URI資料，%s是系統放值的部分，LaunchUri是前註詞，可自訂 -->

    <Protocol Name="recipe" TaskID="_default" 

              NavUriFragment="LaunchUri=%s" />

</Extensions>

(A-2). 定義URI Mapping處理URI Schema的Associations；

要如何實作URI Mapping，如果大家有讀過<WP7 修練 DAY 02：如何在頁面顯示前自動轉向到其他頁面>與

<Windows Phone 7 - 動態轉換初始的Default Page>便可得知SDK裡提供一個UriMapBase的類別與UriMapper類別，

讓開發者可以自訂應用程式一開始要進入的Page。因此，相同的道理套入，往下便加以說明如何處理URI Mapping

與Query String的使用；

(A-2-1). 建立個新的Class，並繼承UriMapBase，修改MapUri方法，為收到特定的URI可以轉向指定的Page；

定義了一個目標的Page：SecondPage.xaml，準備接受來自URI Schema的串聯；然而，下方有一個變數：

ProtocolTemplate，該變數的值有注意到了嗎？它與在WMAppManifest.xml中的NavUriFragement是相同的，

只是前方加上了"/Protocol?"字段。因此，可以導出，在運作MapUri()這個方法時，預期會收到的完整URI字串為：

"/Protocol?LaunchUri=recipe%3A%2F%2FShowRecipe%2F%3FName%3D1003%26Age%3D29"，透過HttpUtility.UrlDecode()

變成"/Protocol?LaunchUri=recipe://ShowRecipe/?Name=1003&Age=29"。

public class MyUriMapper :UriMapperBase

{

    //指定要前往的Page

    private static string TargetPageName = "SecondPage.xaml";

    //指定要拆解的Protocol Template，該字段是固定由系統組合的，在拆時可以先去掉；

    private static string ProtocolTemplate = "/Protocol?LaunchUri=";

    private static int ProtocolTemplateLength = ProtocolTemplate.Length;

    private string tempUri;

  

    //必須需作的override範圍

    public override Uri MapUri(Uri uri)

    {

        tempUri = uri.ToString();

        //判斷URI是否具有/Protocol的字段，有此字段代表是URI Schema Associations；

        if (tempUri.Contains("/Protocol") == true)

        {

            //UrlDecoding

            tempUri = HttpUtility.UrlDecode(tempUri);

            //判斷是否具有監控的Schema

            if (tempUri.Contains("recipe:") == true)

            {

                return GetMappedUri(tempUri, 0);

            }

        }

        return uri;

    }

  

    private Uri GetMappedUri(string pUri, int X)

    {

        string tQueryString = string.Empty;

        if (pUri.IndexOf(ProtocolTemplate) > -1)

        {

            //由於組合的來的URI為：/Protocol?LaunchUri=recipe://ShowRecipe?ID=1003

            //因此，拆出?{parameter}={value}&{parameter}={value}.的值

            int operationLen = pUri.IndexOf("?", ProtocolTemplateLength);

            //取得實際用的QueryString

            tQueryString = pUri.Substring(operationLen + 1);

        }

        //重建一個新的URI

        string tNewUri = string.Format("/{0}?{1}", TargetPageName, tQueryString);

        return new Uri(tNewUri, UriKind.Relative);

    }

}

(A-3). 將實作好的UriMapper取代App.cs.InitializePhoneApplication()裡RootFrame的UriMapper：

只有實作(A-2). 的UriMapper作好是不足的，還要用它去取代掉現有RootFrame.UriMapper才有辦法完成轉換URI的功能；

// Do not add any additional code to this method

private void InitializePhoneApplication()

{

    if (phoneApplicationInitialized)

        return;

  

    // Create the frame but don't set it as RootVisual yet; this allows the splash

    // screen to remain active until the application is ready to render.

    RootFrame = new PhoneApplicationFrame();

    RootFrame.Navigated += CompleteInitializePhoneApplication;

  

    // Handle navigation failures

    RootFrame.NavigationFailed += RootFrame_NavigationFailed;

  

    // Handle reset requests for clearing the backstack

    RootFrame.Navigated += CheckForResetNavigation;

  

    //使用自訂的UriMapper，才能實現轉換URI的功能

    RootFrame.UriMapper = new MyUriMapper();

  

    // Ensure we don't initialize again

    phoneApplicationInitialized = true;

}

(A-4). 實作SecondPage.xaml接收來自URI Schema所帶入的QueryString：Name與Age二個Key：

很簡單在SencondPage.xaml進行override它的OnNavigatedTo，以取得QueryString中的值並且顯示於畫面上，如下：

protected override void OnNavigatedTo(NavigationEventArgs e)

{

    base.OnNavigatedTo(e);

    //確認在QueryString中是否有存在的Key

    if (NavigationContext.QueryString.ContainsKey("Name") == true)

    {

        string tName = NavigationContext.QueryString["Name"];

        string tOld = NavigationContext.QueryString["Age"];

        //取得值後並顯示於畫面上

        tblName.Text = tName;

        tblOld.Text = tOld;

    }

}

以上的步驟就實作完成讓自己的應用程式可以支援特定URI Schema的互動，總結其中重點在於：UriMapper的改寫，實作出可

自訂的URI Mapping Rules以及取出必要的QueryString值，以轉接給目標的Page或任務進行執行。

最後，還有一個步驟即是撰寫一個簡單的App，來完成App-to-App Communication的情境。

B. 建立一個簡單的Windows Phone專案，並且加上一個按鈕，按鈕事件則是呼叫A定義好的URI Schema；

如下程式段，透過指定的URI Schema來與註冊監聽該Schema的App進行互動；

private void Button_Click_1(object sender, RoutedEventArgs e)

{

    //注意uURI Schema一定要與App註冊的相同

    Uri tUri = new Uri("recipe://ShowRecipe?Name=1003&Age=29");

    Windows.System.Launcher.LaunchUriAsync(tUri);

}

上述程式有一段使用Windows.System.Launcher.LaunchUriAsync，這個是新的指令。特別用於指定的URI來啟動應用程式。

[執行結果]

圖示分別代表由：Another App把Name與Age帶至Second Page中的Name與Age。

[範例程式]

[補充]

‧UriMapperBase：

一個基礎的類別根據指定的Mapping Rules轉換一個URI的請求至另一個新URI的機制。

透過Override該類別的MapUri方法即可以自訂轉換的邏輯。

另外，自訂好的UriMapper 必須指定給Silverlight應用程式中的Frame物件，才會有效果。

‧Windows.System.Launcher.LaunchUriAsync：

專用於透過指定的URI去關聯並啟動應用程式。啟動的方式有三種，如下：

Option	Method	Description
Default Launch	LaunchUriAsync(Uri)	Launch the specified Uri with the default handler.
Launch with a warning dialog	LaunchUriAsync (Uri, LauncherOptions)	Windows will show a warning dialog before launching the specified uri.
Launch with a recommended app fallback	LaunchUriAsync (Uri, LauncherOptions)	Launch the specified Uri with the default handler. If no handler is installed on the system recommend an app in the Windows Store to the user.