Ghost4J と Ghostscript による Java の PDF 処理
Ghostscript は PDF と PostScript ドキュメントをレンダリングします。このチュートリアルでは当初、ネイティブライブラリの Java ラッパーである Ghost4J を使用していました。更新版のサンプルでは、Ghostscript を個別のプロセスで実行し、Apache PDFBox でフォントを調べることで、Ghost4J の時代遅れの依存関係を避けています。
Ghostscript の概要
Ghostscript は PDF のページを画像にレンダリングし、ドキュメント形式を変換できます。以下の Java コードでは、引数リストを渡してコマンドラインインターフェースを直接起動します。ファイル名がシェルコマンドになることはなく、レンダリングジョブごとに専用のプロセスと出力ディレクトリを使用します。
Ghost4J とは?
Ghost4J は、ネイティブバインディングを介して Ghostscript をラップします。公開されている 1.0.1 の POM では、Log4j 1.2.17、JNA 4.1.0、iText 2.1.7 が固定されています。ネイティブのシングルトンを Java のエグゼキューターで囲んでも、安全に並行実行できるようにはなりません。そのため、このガイドでは、新しいアプリケーションにその構成を推奨するのではなく、Ghost4J への依存を置き換えます。
プロセスを分離すると、ネイティブインタープリターの状態を隔離できます。ただし、セキュリティサンドボックスにはなりません。信頼できないドキュメントは、ファイルシステムへのアクセスを制限し、ネットワークへのアクセスを禁止したワーカーで処理し、メモリ、CPU、出力サイズの上限を強制してください。Ghostscript には常にパッチを適用してください。-dSAFER はインタープリターに追加の制限を設けるものであり、これらの対策の代わりにはなりません。
Java プロジェクトへの Ghostscript と PDFBox の導入
保守されている JDK 21、Ghostscript、curl を個別にインストールしてください。以下のコマンドは、Linux 上で OpenJDK 21.0.12.1、Ghostscript 10.07.1、PDFBox 3.0.8 を使って検証しています。JDK 21 の後続のセキュリティ更新も使用できます。Ghostscript は、サポート対象でパッチ適用済みのビルドを使用してください。JDK 21 はこのサンプルで選んだランタイムであり、PDFBox の最小要件ではありません。
ローカルの input.pdf、first.pdf、second.pdf ファイルを同じディレクトリに置き、そこで作業してください。以下の Java プログラムは三つともそこに保存します。java、javac、gs が実行できることを確認してから、フォントのサンプルに必要な依存関係を含むスタンドアロンの PDFBox アプリケーション JAR をダウンロードしてください。
java -version &&
javac -version &&
gs --version &&
curl --fail --location --output pdfbox-app-3.0.8.jar \
https://repo.maven.apache.org/maven2/org/apache/pdfbox/pdfbox-app/3.0.8/pdfbox-app-3.0.8.jar
Maven アプリケーションで対応するライブラリの依存関係は org.apache.pdfbox:pdfbox:3.0.8 です。これらのサンプルを実行するために Ghost4J を追加しないでください。リリースのチェックサムは PDFBox のダウンロードページ、レンダリングオプションは Ghostscript の使用方法ドキュメント を参照してください。確認やダウンロードに失敗した場合は、その前提条件を満たしてから、コンパイル前にセットアップのブロックを再実行してください。コマンドでは && を使用しているため、セットアップやビルドが失敗すると、それに依存するコマンドは実行されません。
PDF から画像への変換
これを PDFToImage.java として保存してください。信頼できる Ghostscript 実行ファイルのパス、入力 PDF、新しい出力ディレクトリを渡します。固定の相対出力パターンにより、ディレクトリ名のパーセント記号が
Ghostscript の書式指定子として解釈されるのを防ぎます。
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.TimeUnit;
public final class PDFToImage {
public static void render(Path executable, Path input, Path output) throws Exception {
Path source = input.toRealPath();
if (!Files.isRegularFile(source)) throw new IOException("Input must be a regular file");
Path binary = executable.toRealPath();
Files.createDirectory(output);
Path destination = output.toRealPath();
Process process = new ProcessBuilder(
binary.toString(), "-dSAFER", "-dBATCH", "-dNOPAUSE", "-dNOPROMPT",
"-sDEVICE=png16m", "-r144", "-sOutputFile=page-%03d.png", "-f", source.toString()
).directory(destination.toFile()).redirectErrorStream(true)
.redirectOutput(destination.resolve("ghostscript.log").toFile()).start();
try {
if (!process.waitFor(120, TimeUnit.SECONDS)) {
throw new IOException("Rendering timed out for " + source);
}
if (process.exitValue() != 0) {
throw new IOException("Rendering failed for " + source + "; inspect "
+ destination.resolve("ghostscript.log"));
}
try (var files = Files.list(destination)) {
if (files.noneMatch(path -> path.getFileName().toString().endsWith(".png"))) {
throw new IOException("No pages rendered for " + source);
}
}
} finally {
if (process.isAlive()) {
process.destroyForcibly();
process.waitFor();
}
}
}
public static void main(String[] args) throws Exception {
if (args.length != 3) throw new IllegalArgumentException("gs-path input.pdf output-directory");
render(Path.of(args[0]), Path.of(args[1]), Path.of(args[2]));
}
}
インストール済みの実行ファイルのパスに置き換えて、コンパイルして実行してください。
javac PDFToImage.java &&
java PDFToImage /usr/bin/gs input.pdf rendered
rendered/page-001.png を開いてください。以降のページは page-002.png のように採番され、解像度は 144 DPI です。144 × 72 PDF ポイントのページから、288 × 144 ピクセルの画像が生成されます。出力ディレクトリは新規でなければなりません。rendered がすでに存在する状態で再実行すると失敗し、既存のファイルは保持されます。再試行には別のディレクトリを選び、失敗したジョブのログと生成途中の画像は診断用に残してください。
レンダリングでは、意図的にドキュメントをフラット化します。検索可能なテキスト、フォーム、署名、アクセシビリティ構造は保持されません。失敗した場合は、出力ディレクトリを非公開のまま診断用に保持し、生成途中の画像を公開しないでください。
PDF の並行処理
これを ConcurrentPDFProcessing.java として保存してください。各ワーカーは独自の Ghostscript プロセスを起動します。エグゼキューターは送信済みの処理が完了するまで待機し、タスクの失敗はコマンドラインの呼び出し元に伝わります。同時に実行するレンダリングプロセスは最大二つです。これは実行中のジョブ数の制限であり、キューに入る入力リストの制限ではありません。
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
public final class ConcurrentPDFProcessing {
public static void main(String[] args) throws Exception {
if (args.length < 3) throw new IllegalArgumentException("gs-path new-output-directory PDFs...");
Path output = Files.createDirectory(Path.of(args[1]));
try (ExecutorService executor = Executors.newFixedThreadPool(2)) {
var results = new ArrayList<Future<Void>>();
for (int i = 2; i < args.length; i++) {
Path input = Path.of(args[i]);
Path destination = output.resolve("document-" + (i - 2));
results.add(executor.submit((Callable<Void>) () -> {
PDFToImage.render(Path.of(args[0]), input, destination);
return null;
}));
}
for (Future<Void> result : results) result.get();
}
}
}
javac PDFToImage.java ConcurrentPDFProcessing.java &&
java ConcurrentPDFProcessing /usr/bin/gs batch-output first.pdf second.pdf
batch-output/document-0 には first.pdf のページが、document-1 には second.pdf のページが格納されます。バッチ用のディレクトリも新規でなければなりません。いずれかのジョブが失敗すると、送信済みの残りのジョブが完了した後、コマンドはゼロ以外の終了ステータスで終了します。成功したジョブの完成画像と、失敗したジョブの生成途中の出力が混在することがあります。バッチの出力を使用する前に、該当する入力とログを確認してください。
PDF ドキュメント内のフォントの解析
PDFBox 3 は、Loader.loadPDF() を介してファイルを読み込みます。リソースのフォント名は COSName のキーです。各キーを PDResources.getFont() で解決してください。これらのリソースを列挙するためにテキスト抽出処理を実行する必要はありません。PDFBox 移行ガイドを参照してください。
これを FontAnalysis.java として保存してください。すべてのページと入れ子の Form XObject をたどり、リソースの循環参照を防ぎながら、宣言されたフォント名を重複なくソート順で一行ずつ出力します。名前のない Type 3 フォントなど、名前のないフォントにはリソースキーをラベルとして使用します。これはリソースの一覧であり、列挙されたすべてのフォントが可視テキストの描画に使われる証拠でも、パターンや Type 3 グリフ内のフォントを含む完全な監査でもありません。
import java.io.IOException;
import java.nio.file.Path;
import java.util.Collections;
import java.util.IdentityHashMap;
import java.util.Set;
import java.util.TreeSet;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
public final class FontAnalysis {
private static void collect(PDResources resources, Set<COSDictionary> visited,
Set<String> fonts) throws IOException {
if (resources == null || !visited.add(resources.getCOSObject())) return;
for (COSName name : resources.getFontNames()) {
var font = resources.getFont(name);
if (font == null) continue;
String fontName = font.getName();
fonts.add(fontName == null ? "Unnamed font (resource /" + name.getName() + ")" : fontName);
}
for (COSName name : resources.getXObjectNames()) {
if (resources.getXObject(name) instanceof PDFormXObject form) {
collect(form.getResources(), visited, fonts);
}
}
}
public static void main(String[] args) throws Exception {
if (args.length != 1) throw new IllegalArgumentException("input.pdf");
Set<COSDictionary> visited = Collections.newSetFromMap(new IdentityHashMap<>());
Set<String> fonts = new TreeSet<>();
try (PDDocument document = Loader.loadPDF(Path.of(args[0]).toFile())) {
for (var page : document.getPages()) collect(page.getResources(), visited, fonts);
}
for (String font : fonts) System.out.println(font);
}
}
同じディレクトリからフォントのサンプルを実行してください。
javac -cp pdfbox-app-3.0.8.jar FontAnalysis.java &&
java -cp '.:pdfbox-app-3.0.8.jar' FontAnalysis input.pdf
パフォーマンスの考慮事項とベストプラクティス
解像度によって出力サイズと必要なメモリ量が決まります。ワーカー数を少なく設定し、代表的なファイルで測定してください。出力のページ数、画像サイズ、表示内容を確認してください。終了ステータスがゼロであることだけでは、空白や見切れのあるレンダリング結果を検出できません。正常な PDF に加えて不正な形式の PDF もテストし、ドキュメントの内容をログに記録したり、非公開の診断ログを共有したりしないでください。
まとめ
マネージドな変換ワークフローを希望する場合は、Transloadit のドキュメント処理サービスを参照してください。
