Apryse がお悩みに回答！PDF 生成の課題を解決

概要: Apryse SDK は、ドキュメント処理に関するさまざまな課題を解決します。「Apryse Answers」では、Developer Relations Manager の April Schuppel 氏が開発者コミュニティに寄せられたリアルな質問を取り上げ、Apryse による解決策を実演します。第 1 回では、Apryse テンプレート生成機能を紹介します。

PDF 生成が難しい理由
質問 1: 大量のカスタムレポートを生成したい
質問 2: 動的データから PDF を生成したい
質問 3: HTML から PDF を生成したい
Apryse によるドキュメント生成
1. 主な特長
サンプルコード
さいごに

PDF 生成が難しい理由

PDF 生成のアプローチには PDF-Lib などのオープンソース JavaScript ライブラリをはじめ、さまざまな選択肢があります。しかし、カスタマイズ性、処理速度、見栄えのよいプロフェッショナルなドキュメント出力という点では、基本的なライブラリでは限界があります。

Apryse はブラッシュアップされた DOCX テンプレート内の {{文字列}} を置換してドキュメントを生成しますが、多くの PDF 生成ライブラリはテンプレートからの生成ではなく、PDF の「作成」にとどまります。

また、HTML/CSS でレイアウトやスタイルを定義してから PDF に変換する「HTML-to-PDF ワークフロー」を採用する開発者もいます。ただし、このアプローチではフォント、ズームレベル、改ページなどの問題が発生しやすく、保守コストがかかります。

それでは、実際に寄せられた 3 つの質問を見ていきましょう。

質問 1: 大量のカスタムレポートを生成したい

私はスタートアップの開発者です。数万件 (またはそれ以上) の PDF レポート (グラフやテキスト中心の 2〜3 ページ) を自動生成するツールを探しています。

処理は週次または月次の定期実行を想定しており、おおまかな流れは次のとおりです。

レポートに使うデータを取得する (API または DB)

レポートを生成する

生成した PDF を AWS S3 に保存する (任意。自前で対応も可能)

このような規模に対応でき、自動化できるツールはありますか？

カスタム開発も考えていますが、コストが高くなりそうで、テンプレートのメンテナンスも開発者が担うことになります。

この投稿が示す主な課題は以下のとおりです。

API サービスは大量処理になるとコストが増大する
内部データへの接続 (場合によってはデータ抽出も含む) が必要で、複数のオープンソースライブラリの統合が求められることがある
カスタム開発はエンジニアリングコストが高く、継続的なメンテナンスも必要になる

質問 2: 動的データから PDF を生成したい

現在、ユーザーが購入した商品の PDF レポートをアプリ内で生成する必要がありますが、どう実装すればよいかわかりません。

静的な PDF (値をいくつか置換する程度のもの) は作れましたが、ページ数が 1〜数十ページに変動するような動的データを扱う方法がわかりません。

ライブラリ、アプローチ、チュートリアルなど何でも教えていただけると助かります！

静的 PDF の生成は比較的シンプルですが、動的データになると難易度が上がります。たとえば、名前フィールドが 10 文字の場合と 100 文字の場合では、テンプレートやレイアウトが崩れてしまうことがあります。

質問 3: HTML から PDF を生成したい

HTML と CSS で作った請求書テンプレートがあります。このテンプレートに顧客データを差し込み、OK を押したら Electron が PDF ファイルを生成する、という動作を実現したいです。Electron でこれは可能でしょうか？

これは HTML-to-PDF ワークフローを選んだ開発者の典型的な例です。Apryse SDK は Electron をサポートしていますが、不安定でメンテナンスコストの高い HTML ワークフローを使わなくても、Apryse ならよりシンプルにドキュメント生成を実現できます。

Apryse によるドキュメント生成

Apryse Answers Episode 1 動画内で紹介したのは、GitHub 上のサンプルアプリです。このアプリを使って、個別ドキュメントの生成とプログラムによる一括生成の両方のワークフローを実演しました。

仕組みは以下のとおりです。

テンプレートを用意する – Office ドキュメント (.docx など) をテンプレートとして提供します
置換データを用意する – JSON 形式でデータを渡します
Apryse SDK が PDF を生成する – テンプレートにデータをマージして PDF を効率的に出力します

主な特長

ループ、条件分岐、画像、表生成などに完全対応
使い慣れた Office ツールでテンプレートを作成でき、プロフェッショナルな仕上がりを実現
JSON 形式のデータを受け付けるため、データベースからの動的データにも対応
SDK 内にすべての処理が完結し、外部依存がないためデータセキュリティやプライバシーのコンプライアンス対応が容易
画像やテキストに加え、表などのドキュメント書式にも対応
データ量に応じてテキストが自動的にリフローされ、正しく表示される

Microsoft Office ドキュメントをテンプレートとして使うことで、エンドユーザーは慣れ親しんだツールでテンプレートをカスタマイズできます。また、外部依存がなくすべての処理が SDK 内で完結するため、データセキュリティやプライバシーに関するコンプライアンス上の懸念を回避できます。

サンプルコード

生成フレームワークは、最小限のコードで起動できます。通常のOffice変換を開始するだけで、オプションの TemplateParamsJson パラメーターセットを指定します。

# 入力された Office ファイルから TemplateDocument オブジェクトを作成します。
template_doc = Convert.CreateOfficeTemplate(input_path, None)

# JSON 文字列のデータをテンプレートに流し込み、PDF ドキュメントを生成します。
pdfdoc = template_doc.FillTemplateJson(json_data_string);

# PDF をファイルに保存します。
pdfdoc.Save(output_path, SDFDoc.e_linearized)