Unterstützung mehrerer Profile unter einem einzelnen Benutzerdatenordner

Artikel
04/04/2023

Mit der WebView2-API für mehrere Profile können Sie Benutzerprofile erstellen und bearbeiten, um mit Ihren WebView2-Steuerelementen zu arbeiten. Profile in WebView2 ähneln den Profilen in Microsoft Edge. Die Unterstützung mehrerer Profile ermöglicht es einer WebView2-App, mehrere Profile unter einem einzelnen Benutzerdatenordner zu haben.

Jedes Profil verfügt über einen dedizierten Profilordner zum Speichern von Browserdaten, der einen separaten Browserdatenspeicher für jeden Benutzer bereitstellt, z. B. Cookies, Benutzereinstellungen und zwischengespeicherte Ressourcen. Alle WebView2-Steuerelemente, die demselben Benutzerprofil zugeordnet sind, verwenden einen einzelnen Profilordner.

Vorheriger Ansatz: Verwenden eines anderen Benutzerdatenordners für jedes WebView2-Steuerelement

Bisher konnte eine WebView2-App ohne Unterstützung mehrerer Profile unterschiedliche Benutzerdatenordner für verschiedene WebView2-Steuerelemente verwenden, um die Datentrennung zu erreichen. Bei diesem Ansatz müssen Sie jedoch mehrere WebView2-Runtimeinstanzen ausführen (jede umfasst einen Browserprozess und eine Reihe von untergeordneten Prozessen), die mehr Systemressourcen verbraucht haben, einschließlich Arbeitsspeicher, CPU-Speicherbedarf und Speicherplatz.

Angeben des Profils beim Erstellen einer WebView2

Erstellen eines Optionsobjekts, das ein Profil definiert

Die CreateCoreWebView2ControllerOptions -Methode für CoreWebView2Environment erstellt ein Optionsobjekt, CoreWebView2ControllerOptions, um bestimmte Informationen zu einem Profil bereitzustellen, einschließlich ProfileName und IsInPrivateModeEnabled. Verwenden Sie dieses Objekt, um das Zielprofil beim Erstellen einer WebView2-Steuerelementinstanz anzugeben.

CoreWebView2Environment.CreateCoreWebView2ControllerOptions-Methode
- CoreWebView2ControllerOptions-Klasse

Erstellen eines WebView2-Steuerelements, das das Profil verwendet

Jede Create...Controller Methode, die einen options Parameter akzeptiert, erstellt ein WebView2-Steuerelement und ordnet es dem von Ihnen angegebenen Profil zu. Wenn das angegebene Profil nicht vorhanden ist, wird ein neues Profil erstellt.

Beispiel für die Angabe des Profils beim Erstellen einer WebView2

public async void CreateWebView2Controller(object sender, RoutedEventArgs e)
{
    var hwnd = new HwndForWV2();
    Window window = new Window();
    window.Content = hwnd;
    window.Show();

    var env = await CoreWebView2Environment.CreateAsync();
    var options = env.CreateCoreWebView2ControllerOptions();
    options.ProfileName = "MyProfile";
    options.IsInPrivateModeEnabled = true;
    var controller = await env.CreateCoreWebView2ControllerAsync(hwnd.Handle, options);

    controller.Bounds = new System.Drawing.Rectangle(0, 0, 800, 600);
    controller.CoreWebView2.Navigate("https://www.bing.com/");
    controller.CoreWebView2.NavigationStarting += CoreWebView_NavigationStarting;
}

public async Task InitializeCoreWebView2()
{
    CoreWindow coreWindow = Windows.UI.Core.CoreWindow.GetForCurrentThread();
    CoreWebView2Environment env = await CoreWebView2Environment.CreateAsync();
    CoreWebView2ControllerWindowReference windowReference = CoreWebView2ControllerWindowReference.CreateFromCoreWindow(coreWindow);
    CoreWebView2ControllerOptions options = env.CreateCoreWebView2ControllerOptions();
    options.ProfileName = "MyProfile";
    options.IsInPrivateModeEnabled = true;
    CoreWebView2Controller controller = await env.CreateCoreWebView2ControllerAsync(windowReference, options);

    controller.CoreWebView2.NavigationStarting += WebView2_NavigationStarting;
    controller.CoreWebView2.Navigate("https://www.bing.com");
}

HRESULT AppWindow::CreateControllerWithOptions()
{
    auto webViewEnvironment10 = m_webViewEnvironment.try_query<ICoreWebView2Environment10>();
    if (!webViewEnvironment10)
    {
        FeatureNotAvailable();
        return S_OK;
    }

    wil::com_ptr<ICoreWebView2ControllerOptions> options;
    // The validation of parameters occurs when setting the properties.
    HRESULT hr = webViewEnvironment10->CreateCoreWebView2ControllerOptions(&options);
    if (hr == E_INVALIDARG)
    {
        ShowFailure(hr, L"Unable to create WebView2 due to an invalid profile name.");
        CloseAppWindow();
        return S_OK;
    }
    CHECK_FAILURE(hr);

    // If call 'put_ProfileName' with an invalid profile name, the 'E_INVALIDARG' returned
    // immediately. ProfileName could be reused.
    CHECK_FAILURE(options->put_ProfileName(m_webviewOption.profile.c_str()));
    CHECK_FAILURE(options->put_IsInPrivateModeEnabled(m_webviewOption.isInPrivate));

#ifdef USE_WEBVIEW2_WIN10
    if (m_dcompDevice || m_wincompCompositor)
#else
    if (m_dcompDevice)
#endif
    {
        CHECK_FAILURE(webViewEnvironment10->CreateCoreWebView2CompositionControllerWithOptions(
            m_mainWindow, options.get(),
            Callback<ICoreWebView2CreateCoreWebView2CompositionControllerCompletedHandler>(
                [this](
                    HRESULT result,
                    ICoreWebView2CompositionController* compositionController) -> HRESULT {
                    auto controller =
                        wil::com_ptr<ICoreWebView2CompositionController>(compositionController)
                            .query<ICoreWebView2Controller>();
                    return OnCreateCoreWebView2ControllerCompleted(result, controller.get());
                })
                .Get()));
    }
    else
    {
        CHECK_FAILURE(webViewEnvironment10->CreateCoreWebView2ControllerWithOptions(
            m_mainWindow, options.get(),
            Callback<ICoreWebView2CreateCoreWebView2ControllerCompletedHandler>(
                this, &AppWindow::OnCreateCoreWebView2ControllerCompleted)
                .Get()));
    }

    return S_OK;
}

Zugreifen auf das Profil und Bearbeiten des Profils

Sie können das Profilobjekt abrufen, indem Sie auf die Profile -Eigenschaft eines WebView2-Steuerelements zugreifen.

CoreWebView2.Profile-Eigenschaft

Nachdem Sie das Profilobjekt abgerufen haben, können Sie es bearbeiten. Verwenden Sie CoreWebView2Profile , um Profilinformationen abzurufen und profilweite Einstellungen und Vorgänge auszuführen.

CoreWebView2Profile-Klasse

Beispiel für den Zugriff auf und das Bearbeiten des Profils

string profileName = controller.CoreWebView2.Profile.ProfileName;
bool inPrivate = controller.CoreWebView2.Profile.IsInPrivateModeEnabled;

// update window title with profileName
UpdateAppTitle(profileName);

// update window icon
SetAppIcon(inPrivate);

string profileName = controller.CoreWebView2.Profile.ProfileName;
bool inPrivate = controller.CoreWebView2.Profile.IsInPrivateModeEnabled;

// update window title with profileName
UpdateAppTitle(profileName);

// update window icon
SetAppIcon(inPrivate);

// This is the callback passed to CreateCoreWebView2Controller.
// Here we can get the profile property of the WebView2 control, then manipulate it.
HRESULT AppWindow::OnCreateCoreWebView2ControllerCompleted(HRESULT result, ICoreWebView2Controller* controller)
{
    // ...

    m_controller = controller;
    wil::com_ptr<ICoreWebView2> coreWebView2;
    CHECK_FAILURE(m_controller->get_CoreWebView2(&coreWebView2));
    // We should check for failure here because if this app is using a newer
    // SDK version compared to the install of the Edge browser, the Edge
    // browser might not have support for the latest version of the
    // ICoreWebView2_N interface.
    coreWebView2.query_to(&m_webView);
    // Save PID of the browser process serving last WebView created from our
    // CoreWebView2Environment. We know the controller was created with
    // S_OK, and it hasn't been closed (we haven't called Close and no
    // ProcessFailed event could have been raised yet) so the PID is
    // available.
    CHECK_FAILURE(m_webView->get_BrowserProcessId(&m_newestBrowserPid));
    auto webView2_13 = coreWebView2.try_query<ICoreWebView2_13>();
    if (webView2_13)
    {
        wil::com_ptr<ICoreWebView2Profile> profile;
        CHECK_FAILURE(webView2_13->get_Profile(&profile));
        wil::unique_cotaskmem_string profile_name;
        CHECK_FAILURE(profile->get_ProfileName(&profile_name));
        m_profileName = profile_name.get();
        BOOL inPrivate = FALSE;
        CHECK_FAILURE(profile->get_IsInPrivateModeEnabled(&inPrivate));

        if (!m_webviewOption.downloadPath.empty())
        {
            CHECK_FAILURE(profile->put_DefaultDownloadFolderPath(
                m_webviewOption.downloadPath.c_str()));
        }

        // update window title with m_profileName
        UpdateAppTitle();

        // update window icon
        SetAppIcon(inPrivate);
    }

    // ...
}

Siehe auch

Mehrere Profile in Übersicht über WebView2-Features und -APIs.
Verwalten des Benutzerdatenordners
Löschen von Browserdaten aus dem Benutzerdatenordner
Spezifikation für die Unterstützungs-API für mehrere Profile

Freigeben über