.NET(C#)で Web ページや HTML ファイルのスクリーンショットを撮影
Selenium WebDriver を使ってヘッドレス Chrome でページを開き、表示中のビューポートを PNG として保存します。以下の C# コンソールアプリケーションは、ローカル HTML のパスまたは HTTP URL を受け取り、準備完了を示す要素を待ってから、既存のファイルを置き換えずにスクリーンショットを保存します。
前提条件
このチュートリアルでは、Linux 上の Bash、.NET 10 SDK、およびインストール済みの Chrome または Chromium と、それに対応する ChromeDriver を使用します。SDK 10.0.111 と Chromium/ChromeDriver 152.0.7977.82 で動作を確認しています。.NET 10 は現在もサポートされている LTS リリースです。最新のサービス更新プログラムをインストールしてください。任意で実行するローカル HTTP の例には、保守が継続されている Python 3 と、http.server --bind および --directory オプションも必要です。この例は Python 3.14.7 で動作を確認しています。
信頼できるページと HTML ファイルだけをレンダリングしてください。ブラウザーは、それらの JavaScript を実行したり、ネットワークリクエストを送信したりできます。この例では、空白領域も含めてビューポートを撮影します。スクロールするページ全体の撮影、HTTP ステータスコードの検証、任意のアプリケーションの読み込み完了の確認は行いません。
プロジェクトを作成する前に、インストール済みのツールを確認してください。
dotnet --version && chromium --version && chromedriver --version
HTTP の例では、プロジェクトを作成する前に Python を確認し、ヘルプに両方のオプションが記載されていることを確かめてください。
python3 --version && python3 -m http.server --help
Google Chrome を使用する場合は、chromium をその実行ファイルに置き換えてください。これらのパスには、使用するマシン上のブラウザーと対応するドライバーの実際のパスを設定します。この Linux の例では、次のパスを使用しています。
export CHROME_BINARY=/usr/bin/chromium &&
export CHROMEDRIVER_PATH=/usr/bin/chromedriver
Selenium WebDriver の使用
既存の .NET リポジトリの外にある、書き込み可能なディレクトリで作業を始めてください。上位ディレクトリの SDK、NuGet、MSBuild の構成によって、新しいプロジェクトの動作が変わることがあります。次のセットアップ処理は、そうした上位ディレクトリのファイルや、既存の WebpageScreenshots が作成先にある場合、何も作成せずに中止します。Bash から実行してください。
(
cd -P . || exit 1
parent="$PWD"
while :; do
for config in global.json NuGet.Config NuGet.config nuget.config \
Directory.Build.props Directory.Build.targets Directory.Packages.props; do
if [ -e "$parent/$config" ]; then
printf 'Choose a directory outside this .NET configuration: %s\n' "$parent/$config" >&2
exit 1
fi
done
[ "$parent" = / ] && break
parent=${parent%/*}
[ -n "$parent" ] || parent=/
done
if [ -e WebpageScreenshots ]; then
printf 'WebpageScreenshots already exists; keep it and choose a new directory.\n' >&2
exit 1
fi
dotnet new console -n WebpageScreenshots --framework net10.0 --no-restore &&
dotnet add WebpageScreenshots package Selenium.WebDriver --version 4.28.0 &&
dotnet add WebpageScreenshots package Selenium.Support --version 4.28.0
)
パッケージは、検証済みの Selenium 4.28.0 リリースに固定しています。パッケージのインストールに失敗した場合は、新しいプロジェクトを残したまま、報告された NuGet またはネットワークの問題を解決し、同じ親ディレクトリから依存関係の設定を再試行してください。
dotnet add WebpageScreenshots package Selenium.WebDriver --version 4.28.0 &&
dotnet add WebpageScreenshots package Selenium.Support --version 4.28.0
生成された WebpageScreenshots/Program.cs を、次のプログラム全体で置き換えてください。引数は input output.png width height ready-element-id timeout-seconds です。幅と高さは CSS ピクセル単位のビューポート寸法です。タイムアウトは、ナビゲーションと準備完了の待機にそれぞれ個別に適用されます。
using System.Globalization;
using System.Text.Json;
using System.Text.RegularExpressions;
using OpenQA.Selenium;
using OpenQA.Selenium.Chrome;
using OpenQA.Selenium.Support.Extensions;
using OpenQA.Selenium.Support.UI;
try
{
if (args.Length == 3 && args[0] == "cleanup")
{
int days = int.Parse(args[2], CultureInfo.InvariantCulture);
if (days < 1) throw new ArgumentException("Retention must be at least one day.");
string directory = Path.GetFullPath(args[1]);
DateTime cutoff = DateTime.UtcNow.AddDays(-days);
foreach (string file in Directory.EnumerateFiles(directory, "webshot-*.png"))
{
if (Regex.IsMatch(Path.GetFileName(file), @"\Awebshot-[A-Za-z0-9_-]+\.png\z")
&& File.GetLastWriteTimeUtc(file) < cutoff)
{
File.Delete(file);
Console.WriteLine($"Deleted {file}");
}
}
return 0;
}
if (args.Length != 6)
throw new ArgumentException("Usage: input output.png width height ready-element-id timeout-seconds; or cleanup directory days");
int width = int.Parse(args[2], CultureInfo.InvariantCulture);
int height = int.Parse(args[3], CultureInfo.InvariantCulture);
int seconds = int.Parse(args[5], CultureInfo.InvariantCulture);
if (width < 200 || width > 3840 || height < 200 || height > 2160)
throw new ArgumentException("Choose a viewport from 200x200 to 3840x2160.");
if (seconds < 1 || seconds > 60 || string.IsNullOrWhiteSpace(args[4]))
throw new ArgumentException("Supply a readiness element ID and a timeout from 1 to 60 seconds.");
string url;
if (Uri.TryCreate(args[0], UriKind.Absolute, out Uri? remote)
&& (remote.Scheme == "http" || remote.Scheme == "https"))
{
url = remote.AbsoluteUri;
}
else
{
string path = Path.GetFullPath(args[0]);
if (!File.Exists(path)) throw new FileNotFoundException("HTML file not found.", path);
// Escape each Linux path segment so literal %, #, and ? keep their filename identity.
url = "file://" + string.Join("/", path.Split('/').Select(Uri.EscapeDataString));
}
string outputPath = Path.GetFullPath(args[1]);
if (!outputPath.EndsWith(".png", StringComparison.OrdinalIgnoreCase))
throw new ArgumentException("The output filename must end in .png.");
if (File.Exists(outputPath) || Directory.Exists(outputPath))
throw new IOException("Output already exists; choose a new filename.");
string browser = Environment.GetEnvironmentVariable("CHROME_BINARY")
?? throw new ArgumentException("Set CHROME_BINARY to your browser executable.");
string driverPath = Environment.GetEnvironmentVariable("CHROMEDRIVER_PATH")
?? throw new ArgumentException("Set CHROMEDRIVER_PATH to your driver executable.");
if (!File.Exists(browser) || !File.Exists(driverPath))
throw new FileNotFoundException("Browser or ChromeDriver executable not found.");
var options = new ChromeOptions { BinaryLocation = browser };
options.AddArgument("--headless=new");
using var service = ChromeDriverService.CreateDefaultService(
Path.GetDirectoryName(driverPath), Path.GetFileName(driverPath));
byte[] png;
object result;
using (var driver = new ChromeDriver(service, options, TimeSpan.FromSeconds(30)))
{
driver.Manage().Timeouts().PageLoad = TimeSpan.FromSeconds(seconds);
driver.Manage().Window.Size = new System.Drawing.Size(Math.Max(800, width), Math.Max(600, height));
driver.ExecuteCdpCommand("Emulation.setDeviceMetricsOverride", new Dictionary<string, object>
{
["width"] = width,
["height"] = height,
["deviceScaleFactor"] = 1,
["mobile"] = false
});
driver.Navigate().GoToUrl(url);
var wait = new WebDriverWait(driver, TimeSpan.FromSeconds(seconds));
wait.Until(d => d.FindElement(By.Id(args[4])).Displayed);
png = driver.TakeScreenshot().AsByteArray;
var window = driver.Manage().Window.Size;
result = new
{
url = driver.Url,
viewportWidth = driver.ExecuteScript("return window.innerWidth"),
viewportHeight = driver.ExecuteScript("return window.innerHeight"),
windowWidth = window.Width,
windowHeight = window.Height,
devicePixelRatio = driver.ExecuteScript("return window.devicePixelRatio")
};
}
Directory.CreateDirectory(Path.GetDirectoryName(outputPath)!);
using (var output = new FileStream(outputPath, FileMode.CreateNew, FileAccess.Write))
output.Write(png);
Console.WriteLine($"Saved {args[1]}");
Console.WriteLine(JsonSerializer.Serialize(result));
return 0;
}
catch (Exception error)
{
Console.Error.WriteLine($"Screenshot failed: {error.Message}");
return 1;
}
using スコープは、正常終了時も例外発生時も、ブラウザーとドライバーサービスを破棄します。プログラムは保存先を開く前に PNG をバッファリングするため、ナビゲーションや準備完了の待機に失敗してもスクリーンショットは作成されません。FileMode.CreateNew は、最初の確認後に作成された出力ファイルも拒否します。ディスクへの書き込みに失敗すると、不完全な新規ファイルが残る場合があります。再試行する前に、そのファイルだけを確認して削除してください。
ブラウザーの互換性
この実装では、Chrome と ChromeDriver を明示的に選択します。両者のバージョンには互換性が必要です。対応する組み合わせの入手方法は、ChromeDriver のバージョン選択ガイドを参照してください。Selenium Manager はドライバーを検出してダウンロードできますが、このプログラムでは、指定されたパスを使用します。Firefox と Edge には、それぞれ専用のドライバーとオプションクラスが必要です。このチュートリアルでは扱いません。
ローカル HTML ファイルの撮影
次のページを WebpageScreenshots/sample.html として保存してください。青い背景と、LOCAL PAGE と書かれた白いカードがあります。準備完了マーカーは最初から存在します。
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>Local screenshot example</title>
<style>
html, body { margin: 0; background: #0c5393; }
#content-loaded { margin: 32px; padding: 24px; background: white; color: black;
font: bold 32px sans-serif; }
</style>
<h1 id="content-loaded">LOCAL PAGE</h1>
</html>
親ディレクトリからビルドして実行してください。&& は、ビルド失敗時に古いバイナリが実行されるのを防ぎます。-- は、残りの引数をアプリケーションに渡します。
dotnet build WebpageScreenshots --disable-build-servers &&
dotnet run --project WebpageScreenshots --no-build -- \
WebpageScreenshots/sample.html screenshots/webshot-local.png 800 600 content-loaded 10
成功すると、ターミナルに Saved screenshots/webshot-local.png が出力され、続いて実際の URL、ビューポート、ウィンドウの外寸、ピクセル比を示す JSON が出力されます。その PNG を開いてください。画像は 800 × 600 ピクセルで、上部付近に LOCAL PAGE のカード全体が表示され、青い背景が下端まで広がっているはずです。JSON のビューポートは 800 × 600、ピクセル比は 1 であるはずです。空でない PNG が生成されただけでは、目的のページを撮影できた証拠にはなりません。
動的コンテンツへの対応
ナビゲーションはドキュメントの読み込みを待ちますが、その後に JavaScript がページを更新することがあります。目的のコンテンツの準備ができたときにだけアプリケーションが表示する、準備完了要素を使用してください。データの読み込み中も表示されているラッパーは、適切な合図にはなりません。
次の二つ目のページを WebpageScreenshots/delayed.html として保存してください。カードは最初は非表示で、1.5 秒後に表示されます。背景が緑色になるため、早すぎるタイミングで撮影した画像を見分けやすくなっています。
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>Delayed screenshot example</title>
<style>
html, body { margin: 0; background: white; }
#content-loaded { margin: 32px; padding: 24px; background: white; color: black;
font: bold 32px sans-serif; }
</style>
<h1 id="content-loaded" hidden>DELAYED PAGE</h1>
<script>
setTimeout(() => {
document.documentElement.style.background = '#198754';
document.body.style.background = '#198754';
document.getElementById('content-loaded').hidden = false;
}, 1500);
</script>
</html>
再現可能な HTTP ソースを用意するため、python3 --version を確認してから、別のターミナルで同じ親ディレクトリに移動し、次のサーバーをフォアグラウンドで実行してください。このサーバーは、選択したディレクトリをループバック上で公開します。
python3 -m http.server 8765 --bind 127.0.0.1 --directory WebpageScreenshots
そのポートが使用中の場合は、未使用のポートを選び、以下の両方の URL を更新してください。静的ページと遅延表示ページを撮影する間は、サーバーを実行したままにします。
dotnet run --project WebpageScreenshots --no-build -- \
http://127.0.0.1:8765/sample.html screenshots/webshot-http.png 800 600 content-loaded 10 &&
dotnet run --project WebpageScreenshots --no-build -- \
http://127.0.0.1:8765/delayed.html screenshots/webshot-delayed.png 800 600 content-loaded 10
両方のファイルを開いてください。静的ページの画像は、青いローカルページと一致するはずです。遅延表示ページの画像は 800 × 600 ピクセルで、緑色の背景に白いカードが表示され、カードには DELAYED PAGE と書かれているはずです。遅延表示ページの画像が全面白色なら、撮影が早すぎたことを意味します。完了したら、サーバーのターミナルで Ctrl+C を押して停止してください。マーカーが存在しないか、非表示のままの場合、待機時間が過ぎると CLI は終了ステータス 1 で終了し、新しい PNG は作成されません。実際のアプリケーションでは、content-loaded を実際の準備完了要素の ID に置き換えてください。
スクリーンショットの保存管理
自分が所有するディレクトリに撮影し、保持する画像には毎回新しいファイル名を指定してください。保存先のファイルが既に存在する状態でコマンドを繰り返すと、処理は失敗し、そのファイルは保持されます。撮影処理が同じディレクトリ内の他の PNG に変更を加えることはありません。
保持期間を任意で設定する場合は、webshot-[letters, digits, underscores, or hyphens].png に一致するファイル名を、このアプリケーション専用にしてください。親ディレクトリから次のコマンドを実行すると、サブディレクトリには入らず、最終書き込み時刻から 7日を超えた、一致するファイルを削除します。
dotnet run --project WebpageScreenshots --no-build -- cleanup screenshots 7
他のファイル名のファイルは変更しません。接頭辞は命名規則にすぎないため、この削除処理は、自分が管理し、一致するすべてのファイルがこのアプリケーションに属するディレクトリでのみ使用してください。すべてのスクリーンショットを保持する場合は、削除処理を省略してください。削除エラーが発生すると終了ステータス 1 を返しますが、同じ実行で既に削除されたファイルは復元されません。
さまざまな画面サイズへの対応
CLI は Chrome のデバイスメトリクスのオーバーライドを使い、ビューポートと、1 に設定したピクセル比を指定します。特に幅が狭い場合、ブラウザーウィンドウの外寸はビューポートより大きくなることがあります。この方法では、ユーザーエージェントを変更したり、モバイルのタッチエミュレーションを有効にしたりせずに、CSS ブレークポイントをテストします。特定のスマートフォンを再現するものではありません。
狭いビューポートで撮影するには、入力と準備完了マーカーを変えずに、寸法を変更してください。
dotnet run --project WebpageScreenshots --no-build -- \
WebpageScreenshots/sample.html screenshots/webshot-narrow.png 375 667 content-loaded 10
PNG が 375 × 667 ピクセルで、カードが引き続き読みやすいことを確認してください。プログラムが受け付ける幅は 200 から 3,840、高さは 200 から 2,160 です。それより大きな画像の撮影は、この例の制限を超えます。
撮影失敗の原因の診断
CLI の非ゼロの終了ステータスとエラーメッセージから、失敗した処理を特定してください。HTML ファイルが見つからない場合は、Chrome の起動前に報告されます。ブラウザーやドライバーが存在しない、または互換性がない場合は、セッションを開始できません。準備完了の待機がタイムアウトした場合は、ID と、要素が表示されるかどうかを確認してください。タイムアウトを延ばしても、マーカーの誤りは解決しません。出力エラーの場合は、ディレクトリの権限を確認し、未使用のファイル名を選んでください。以前のスクリーンショットを保持したまま入力や設定を修正し、新しい保存先を指定して同じコマンドを再実行してください。
