Gerir a ativação do protocolo URI numa aplicação .NET

A ativação de protocolo (também chamada de ligação profunda ou ativação de URI) permite que outra aplicação, um navegador ou a linha de comandos lance a sua aplicação navegando até um URI como myapp://action?param=value.

Este artigo mostra código especificamente para uma aplicação WPF. Para orientações completas, consulte o artigo principal sobre ativação de URI de Handle . Para detalhes completos sobre ativação rica com a SDK de Aplicações Windows, consulte Ativação rica com a API do ciclo de vida da aplicação.

Registo para ativação do protocolo

Deve registar a sua aplicação para gerir a ativação do protocolo. Para uma aplicação sem embalagem, regista-se diretamente no código. Para uma aplicação empacotada, faz o registo no manifesto da aplicação.

Aplicativo não empacotado

Para uma aplicação .NET não empacotada (a configuração padrão WPF/WinForms), registe o teu protocolo no arranque usando ActivationRegistrationManager. Os registos são por utilizador e mantêm-se, por isso é seguro anunciar isto em cada lançamento.

Em App.xaml.cs, sobreescreve OnStartup:

using Microsoft.Windows.AppLifecycle;

protected override void OnStartup(StartupEventArgs e)
{
    // Register the URI scheme "myapp://" for this app.
    // For the logo, pass the exe path + resource index (or "" to use the default icon).
    string exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule?.FileName ?? "";
    string logo = string.IsNullOrEmpty(exePath) ? "" : exePath + ",0";
    ActivationRegistrationManager.RegisterForProtocolActivation(
        "myapp",                // URI scheme (no "://")
        logo,                   // logo: exe path + resource index, or "" for default icon
        "My App",               // display name for the protocol
        exePath);               // path of this EXE; pass "" to default to the current process

    base.OnStartup(e);
}

Para limpar o registo (por exemplo, num passo de desinstalação), ligue para ActivationRegistrationManager.UnregisterForProtocolActivation("myapp", "").

Aplicação empacotada

Para uma aplicação .NET empacotada, declare o protocolo em Package.appxmanifest sob o elemento <Applications><Application>:

<Applications>
  <Application ...>
    <Extensions>
      <uap:Extension Category="windows.protocol">
        <uap:Protocol Name="myapp">
          <uap:DisplayName>My App</uap:DisplayName>
        </uap:Protocol>
      </uap:Extension>
    </Extensions>
  </Application>
</Applications>

Certifique-se de que o uap namespace XML está declarado no Package elemento: xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10".

Tratar da ativação

Recuperar os argumentos de ativação usando AppInstance.GetCurrent(). GetActivatedEventArgs. O exemplo seguinte inclui código para uma aplicação de WPF não empacotada, que chama RegisterForProtocolActivation no arranque. As aplicações empacotadas são ativadas através do registo do manifesto, por isso podem saltar a RegisterForProtocolActivation chamada.

using Microsoft.Windows.AppLifecycle;
using Windows.ApplicationModel.Activation;

protected override void OnStartup(StartupEventArgs e)
{
    // Unpackaged apps only: register the protocol at startup.
    // Packaged apps (MSIX): skip these lines — the manifest handles registration.
    string exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule?.FileName ?? "";
    string logo = string.IsNullOrEmpty(exePath) ? "" : exePath + ",0";
    ActivationRegistrationManager.RegisterForProtocolActivation(
        "myapp", logo, "My App", exePath);

    // Get the activation args for this specific launch.
    AppActivationArguments args = AppInstance.GetCurrent().GetActivatedEventArgs();
    if (args?.Kind == ExtendedActivationKind.Protocol)
    {
        var protocolArgs = (ProtocolActivatedEventArgs)args.Data;
        HandleProtocolActivation(protocolArgs.Uri);
    }

    base.OnStartup(e);
}

private void HandleProtocolActivation(Uri uri)
{
    // Navigate to or open content based on uri.AbsolutePath or uri.Query.
}

Note

aplicações WPF e Windows Forms devem chamar AppInstance.GetCurrent().GetActivatedEventArgs() para recuperar dados de ativação do URI. Ao contrário das aplicações Win32 em C++, as aplicações .NET não recebem argumentos de ativação através de um parâmetro de entrada inicial.

Lidar com redirecionamento de instância única

Se a sua aplicação tiver de correr apenas uma instância de cada vez, use AppInstance.FindOrRegisterForKey para redirecionar os lançamentos subsequentes de URI para a instância em execução:

protected override void OnStartup(StartupEventArgs e)
{
    string exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule?.FileName ?? "";
    string logo = string.IsNullOrEmpty(exePath) ? "" : exePath + ",0";
    ActivationRegistrationManager.RegisterForProtocolActivation(
        "myapp", logo, "My App", exePath);

    // Try to claim the "main" key. If another instance already has it, redirect and exit.
    AppInstance currentInstance = AppInstance.FindOrRegisterForKey("main");
    if (!currentInstance.IsCurrent)
    {
        var activationArgs = AppInstance.GetCurrent().GetActivatedEventArgs();
        // Run the async redirect on a thread-pool thread to avoid a potential deadlock
        // with the WPF SynchronizationContext. Signal completion via an event so that
        // this code path exits cleanly without re-entering the STA message pump.
        var redirectCompleted = new System.Threading.ManualResetEventSlim(false);
        System.Threading.Tasks.Task.Run(async () =>
        {
            await currentInstance.RedirectActivationToAsync(activationArgs);
            redirectCompleted.Set();
        });
        redirectCompleted.Wait();
        Shutdown();
        return;
    }

    // This is the first instance. Subscribe to future activations.
    currentInstance.Activated += OnActivated;
    base.OnStartup(e);
}

private void OnActivated(object sender, AppActivationArguments args)
{
    Dispatcher.Invoke(() =>
    {
        if (args.Kind == ExtendedActivationKind.Protocol)
        {
            var protocolArgs = (ProtocolActivatedEventArgs)args.Data;
            HandleProtocolActivation(protocolArgs.Uri);
        }
        MainWindow?.Activate();
    });
}

Para mais informações sobre instanciação de aplicações, consulte Instanciação de aplicações com a API do ciclo de vida da aplicação.

Conteúdo relacionado

  • Last updated on