1. 程式人生 > >UWP: 通過命令行啟動 UWP 應用

UWP: 通過命令行啟動 UWP 應用

cnblogs 主頁 active dialog pan info 文本編輯 cto pda

原文:UWP: 通過命令行啟動 UWP 應用

最近在開發應用的過程中,我遇到了如標題所述的需求,其實主要是為了能夠快捷啟動應用,正像我們可以在“運行”對話框中可以輸入一些可執行程序的名稱後,就能夠直接啟動它;這樣做,可以增加 App 的易用性。在查了一些文檔後,得知在 Windows Build 16266 之後,就加入相關的 API,因此要實現以及使用這一功能,Window 系統和 SDK 的版本都要大於 16266,Fall Creators Update (Build 16299) 則完全滿足這一條件。

實現

要使用命令行啟動 UWP 應用,其實非常簡單,只需要兩步:首先,在 Package.appxmanifest 中添加 appExecutionAlias 擴展;然後,在 App.OnActived 事件中做相應的處理。

1. 修改Package.appxmanifest

右擊項目中的 Package.appxmanifest 文件,在快捷菜單中選擇“打開方式“->”XML 文本編輯器“。打開後,對它的內容按以下修改:

<Package
  xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
  xmlns:mp="http://schemas.microsoft.com/appx/2014/phone/manifest"
  xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
xmlns:uap5="http://schemas.microsoft.com/appx/manifest/uap/windows10/5" IgnorableNamespaces="uap mp uap5"> ... <Applications> <Application ... <Extensions> <uap5:Extension Category="windows.appExecutionAlias" Executable
="TestCmdLineApp.exe" EntryPoint="TestCmdLineApp.App"> <uap5:AppExecutionAlias> <uap5:ExecutionAlias Alias="App.exe" /> </uap5:AppExecutionAlias> </uap5:Extension>
</Extensions> </Application> </Applications> ... </Pakage>

其中加粗部分是我們需要補充的內容。可以看到,我們添加了一個名為 appExecutionAlias 的擴展 (Extension)。在 Extension 節點中包括了幾個屬性,它們的意義分別如下:

1) Category 屬性指明 Extension 的類別,對於我們當前的需求,它的值固定為 windows.appExecutionAlias,即為應用的運行提供別名;
2) Executable 屬性指明當前應用的 exe 名稱,也即:程序集名稱 + ".exe";
3) EntryPoint 屬性指明當前應用的入口點,也即 App 類的完整名稱(包含其所在的命名空間);
4) 在 AppExecutionAlias\ExecutionAlias 節點中的 Alias 屬性,就是我們為要為當前應用定義的命令行啟動名稱;這裏需要說明三點:

a) 它可以與前面 Executable 屬性值相同,也可以不同,比如更簡短一些,便於用戶記住與輸入;
b) 如果定義的別名,已經被當前機器上安裝的其它應用占用了,那麽它就不會生效,也即,誰先占用就對誰有效(當然,如果先前占用的應用被卸載了,那麽這個別名就可以被你的應用使用);
c) 可以添加多個 ExecutionAlias 節點,為應用指定多個別名。通過為應用提供更多的別名,可以解決別名被占用的問題(如果確實存在這個問題)。

2. 處理 OnActivated 事件

在 App.OnActived 事件中,我們對 IActivatedEventArgs 參數類型判斷,如果其 Kind 屬性為 CommandLineLaunch,則認為是命令行啟動,接下來所做的就像在 OnLaunched 事件中一樣,對 Frame 初始化並導航到應用的主頁,如下:

        protected override void OnActivated(IActivatedEventArgs args)
        {
            if (args.Kind == ActivationKind.CommandLineLaunch)
            {
                // ...
            }

            Frame rootFrame = Window.Current.Content as Frame;

            if (rootFrame == null)
            {
                rootFrame = new Frame();
                rootFrame.NavigationFailed += OnNavigationFailed;
                Window.Current.Content = rootFrame;
            }

            rootFrame.Navigate(typeof(MainPage));

            Window.Current.Activate();
            base.OnActivated(args);
        }

3. 參數處理

使用命令行啟動應用有一個很大的好處,用戶在啟動時可以攜帶參數,如: app.exe a, app.exe a b, app.exe /type:a 等,而應用則根據用戶提供的參數作相應的處理。要得到用戶傳遞的參數,只要將 IActivatedEventArgs 類型的參數轉換為 CommandLineActivatedEventArgs,通過它的 Operation.Arguments 屬性即可得到,剩下的就是對參數進行分析並根據參數進行相應的處理。除了參數,我們也能夠得到用戶是從哪個目錄啟動 App 的,這是通過 Operation.CurrentDirectoryPath 屬性得到的。完整代碼如下:

        protected async override void OnActivated(IActivatedEventArgs args)
        {
            string arugment = string.Empty;

            if (args.Kind == ActivationKind.CommandLineLaunch)
            {
                var cmdArgs = args as CommandLineActivatedEventArgs;
                StringBuilder sb = new StringBuilder();
                sb.AppendLine($"Argument: {cmdArgs.Operation.Arguments}");
                sb.AppendLine($"CurrentDirectoryPath: {cmdArgs.Operation.CurrentDirectoryPath}");
                await new MessageDialog(sb.ToString()).ShowAsync();
            }

            Frame rootFrame = Window.Current.Content as Frame;

            if (rootFrame == null)
            {
                rootFrame = new Frame();
                rootFrame.NavigationFailed += OnNavigationFailed;
                Window.Current.Content = rootFrame;
            }

            rootFrame.Navigate(typeof(MainPage), arugment);

            Window.Current.Activate();
            base.OnActivated(args);
        }

最後,要測試效果,需要部署(Deploy)應用。

部署完成後,在“運行”(Win + R)對話框中輸入上面定義的別名(和參數),即可。當然,在“命令提示符”窗口甚至在“資源管理器”窗口的地址欄中,你都可以輸入別名來啟動應用。

背後原理

為什麽在上述這些位置我們輸入別名後,就可以運行應用呢?為了解決這個問題,首先我們使用 where 命令得看看對應的命令究竟在哪裏。在“命令提示符”窗口中,輸入: where 別名,得到這樣的結果:

C:\Users\Admin>where app
C:\Users\Admin\AppData\Local\Microsoft\WindowsApps\App.exe

在“資源管理器”中打開對應的路徑,會看到在這個目錄下存放了當前機器中所有那些使用別名的應用,其實這裏的文件可以認為是一個快捷方式。

不僅如此,這個目錄也在 PATH 環境變量中(可在“命令提示符”中使用 path 命令查看或在“系統屬性”的“環境變量”對話框中查看),因此,我們才可以在任何位置都能啟動應用。

除此以外,作為用戶,我們還可以在桌面(或其它任何目錄)為應用創建快捷方式,右擊桌面->創建快捷方式,然後輸入別名 和參數(可選)。通過雙擊快捷方式圖標,也可以啟動應用。這一點類似於創建磁貼,不過,它要比磁貼更靈活。我們甚至還可以為不同的參數創建多個快捷方式,也可以為每個快捷方式指定不同的圖標。這樣,是不是感覺更像 Win32 應用了呢?

總結

本文主要提到了如何使用命令行來啟動 UWP 應用,為應用提供這一特性可以為其增加易用性以及靈活性。作為 App 的使用者,可以更便利、更靈活地打開、使用應用。這樣,使得 UWP 應用和 Win32 程序的行為更加一致。

參考資料:

Command-Line Activation of Universal Windows Apps

UWP: 通過命令行啟動 UWP 應用