メインコンテンツへスキップ

Playwrightでブラウザを自動操作してスクリーンショットを撮る

    Web ページの表示結果を証跡として保存しておかなければならなくなった。
    保存が必要なページは複数あり、一つ一つ手作業で行うのはだるい。
    そこで Playwright を使ってブラウザを自動操作し、スクリーンショットを撮ることにした。


    Playwrightとは

    Playwright は人が行うブラウザ操作をプログラムから実行できるライブラリ。
    これを使うことでブラウザ操作を自動化できる。

    Microsoft が開発している OSS で、無料で利用が可能。
    Chromium、WebKit、Firefox がサポートされている。

    言語は C# のほか、TypeScript、Python、Java にも対応している。


    主な用途

    • Web アプリのテスト
      ログイン画面表示 → ユーザーID入力 → パスワード入力 → ログインボタンクリック → メニュー画面表示 のような操作を自動実行できる。

    • スクリーンショットの取得
      アクセスしたページを画像として保存できる

    • 定型操作の自動化
      Webアプリにログイン → Excelダウンロード → ログアウト のような作業も自動化できる


    スクリーンショットを撮るサンプル

    以下の手順は、.NET のコンソールアプリで Playwright のトップページのスクリーンショットを撮る流れ。

    コンソールアプリでプロジェクトを作成する。

    dotnet new console --name Playwright1st
    cd Playwright1st

    NuGet から Playwright をインストールする。

    dotnet add package Microsoft.Playwright

    Program.cs を以下のコードで書き換える。

    using Microsoft.Playwright;
    
    using var playwright = await Playwright.CreateAsync();
    await using var browser = await playwright.Chromium.LaunchAsync(new() { Headless = false });
    var page = await browser.NewPageAsync();
    await page.GotoAsync("https://playwright.dev/dotnet");
    await page.ScreenshotAsync(new() { Path = "screenshot.png" });

    NOTE:
    動作確認のため「Headless = false」とし、実行時にブラウザが表示されるようにしている。
    確認が終わったら「Headless = true」にして、ブラウザが表示されないようにしておくとよい。

    Playwright 用ブラウザのインストールスクリプトを生成するため、初回のみビルドを実行する。

    dotnet build

    スクリプトを実行し、Playwright 用のブラウザをインストールする。
    (playwright.ps1 のパスにある "net9.0" の部分は、ターゲットフレームワークにより異なる)

    powershell -ExecutionPolicy Bypass -File .\bin\Debug\net9.0\playwright.ps1 install

    NOTE:
    Playwright 用のブラウザは「%LOCALAPPDATA%\ms-playwright」にインストールされる。
    アンインストールはフォルダごと削除で OK。

    プログラムを実行する。
    ビルドから行う場合は dotnet run、そうでない場合は .exe 実行でよい。

    dotnet run
    または
    bin\Debug\net9.0\Playwright1st.exe

    正常終了すると、カレントディレクトリに screenshot.png が保存される。


    複数ページのスクリーンショット取得

    以下のコードは、Playwright、.NET、NuGet の3ページ分のスクリーンショットを撮る。

    using Microsoft.Playwright;
    
    using var playwright = await Playwright.CreateAsync();
    await using var browser = await playwright.Chromium.LaunchAsync(new() { Headless = false });
    var page = await browser.NewPageAsync();
    
    string[] urls = 
    {
        "https://playwright.dev/dotnet",
        "https://dotnet.microsoft.com/ja-jp/",
        "https://www.nuget.org/packages/Microsoft.Playwright",
    };
    
    foreach (var url in urls)
    {
        await page.GotoAsync(url);
        await page.ScreenshotAsync(new() { Path = $"{Guid.NewGuid()}.png" });
    }


    ウィンドウサイズ固定でスクリーンショット取得

    以下のコードは、1024×576 でスクリーンショットを撮る。

    using Microsoft.Playwright;
    
    using var playwright = await Playwright.CreateAsync();
    await using var browser = await playwright.Chromium.LaunchAsync(new() { Headless = false });
    var page = await browser.NewPageAsync(new()
    {
        ViewportSize = new()
        {
            Width = 1024,
            Height = 576
        }
    });
    await page.GotoAsync("https://playwright.dev/dotnet");
    await page.ScreenshotAsync(new() { Path = "screenshot.png" });

    以下のように SetViewportSizeAsync() でウィンドウサイズを設定してもよい。

    var page = await browser.NewPageAsync();
    await page.SetViewportSizeAsync(1024, 576);
     
     
    お酒とカメラ、生き物飼育(アクアリウム、カブトムシが主)が最近の楽しみ。

    あなたへのおすすめ