JasperReportsチュートリアル:JasperReportsとは何か Java?

⚡ スマートサマリー

JasperReports Java Jaspersoft Studioは、アプリケーションデータをピクセル単位で正確なドキュメントに変換するオープンソースのレポートエンジンです。この記事では、レポート作成のライフサイクル、Jaspersoft Studioのインストール、レポートテンプレートの作成、バンド構造、Pentahoとの比較、そしてチームが直面する実際的な制約について説明します。

  • 📊 コア定義: JasperReportsは Java 画面、プリンター、PDF、HTML、XLS、RTF、CSV、XML、ODT、TXT形式でデータをレンダリングするクラスライブラリ。
  • 🔄 ライフサイクルのステージ: 処理は、JRXMLの設計、.jasperファイルへのコンパイル、データの入力、結果のエクスポートという4つの段階を順番に実行します。
  • 甘いもの<XNUMXxXNUMX><XNUMXxXNUMX><XNUMXxAXNUMX><XNUMXxAXNUMX>️️ 設計環境: Jaspersoft Studio Community Editionにはビジュアルデザイナーが搭載されており、現在のコミュニティリリース版はバージョン6.21.3です。
  • 🧩 バンド構成: タイトル、ページヘッダー、列ヘッダー、詳細、列フッター、ページフッター、およびサマリーバンドは、各要素の印刷位置を制御します。
  • 🔌 データの柔軟性: 1 つのレポートで組み合わせることができます JavaBeansコレクション、SQL結果セット、XMLファイル、およびカスタムデータアダプタ。
  • <XNUMXxEXNUMX><XNUMXxEXNUMX><XNUMXxXNUMXA><XNUMXxXNUMX><XNUMXxXNUMXA>️️ プラットフォームの比較: Jaspersoftはドキュメント作成とモバイルビジネスインテリジェンスの分野で主導的な役割を果たしており、Pentahoはダッシュボードとデータマイニングの分野で主導的な役割を果たしている。
  • ⚠️ 既知の制限事項: レポートは実行前にコンパイルする必要があるため、すべてのレポート開発者は完全な Java SDKがインストールされました。

JasperReports チュートリアル

JasperReportsの用途 Java?

ジャスパーレポート オープンソースのレポートツールです Java これはアプリケーションのレポート作成に使用されます。このレポート作成ツールは、リッチコンテンツを画面、プリンター、またはHTML、PDF、XLS、RTF、CSV、XML、ODT、TXTなどのさまざまなファイルに書き込むのに役立ちます。JasperReportsは、 Java対応アプリケーション Java 動的コンテンツを生成する EE または Web アプリケーション。

ほとんどの議論では3つの製品名が一緒に登場するため、早い段階でそれらを分けておくことで、このページの後半での混乱を防ぐことができます。

名前 それは何ですか 誰が使うのか
JasperReportsライブラリ その Java レポートのコンパイル、入力、エクスポートを行うライブラリ Java 開発者がアプリケーションにレポートを埋め込む
ジャスパーソフトスタジオ その Eclipse JRXMLファイルを生成するビジュアルデザイナー レポートデザイナーによる建物レイアウト
JasperReportsサーバー レポートを保存、スケジュール設定、配信するスタンドアロンサーバー ビジネスユーザーにレポートを配布するチーム

このページでは、ライブラリとJaspersoft Studioに焦点を当てています。なぜなら、最初のレポートを設計して実行するために必要なのは、この2つのコンポーネントだけだからです。なお、JasperReports Serverはコミュニティ版のダウンロード提供が終了したため、コミュニティ版ではこの2つのコンポーネントのみをカバーしていることにご注意ください。

Jasper レポートを使用する理由

Jasperレポートツールを使用する理由は数多くあります。

  • レポート生成のパフォーマンスとユーザーへの配信を提供します。
  • データをテキストまたはグラフィック形式で表現するのに役立ちます。
  • これは、レポートの編集と実行のためのスタンドアロンの組み込みレポート サーバーです。
  • これにより、リポジトリ内のすべてのレポートに対するロールベースのアクセス制御が可能になります。
  • Spring Securityフレームワークは、社内認証システムとの統合に利用可能です。
  • 安全で、スケジュール設定が可能で、自動的に配信されるインタラクティブなレポートエンジンを提供します。
  • レポートを埋め込むことができます Java または非Java 分野の様々なアプリケーションで使用されています。
  • さまざまな形式のレポートをエクスポートできます。
  • プライマリ画像の上に透かしを生成できます。
  • 完全なセットを提供します 石鹸、REST、および Web サービス。
  • 複数のデータ ソースからの単一のレポート データを使用できます。

このライブラリはLGPLライセンスで公開されているため、シートごとの料金なしで商用製品にバンドルすることができ、これが多くの Java チームは、独自のレポートエンジンよりもこちらを選択する。

ジャスパーレポートの特徴

それでは、JasperReportsの機能について説明します。

Jasper Reportsツールの重要な機能は以下のとおりです。

  • バンド、列、自由形式領域にわたる柔軟なレポートレイアウトを提供します。
  • 開発者は、以下のような複数の方法でデータを提供できます。 JavaBeansコレクション、SQLクエリ、およびXMLドキュメント。
  • サブレポートとデータアダプタを使用することで、複数のデータソースを単一のレポート内に組み合わせることができます。
  • 透かしは、元の画像の上に重ねて表示することもできます。
  • 親レイアウト内にネストされたサブレポートを生成できます。
  • 次のようなさまざまな形式でレポートをエクスポートするのに役立ちます。 PDFHTML、RTF、および Microsoft Excelファイル。
  • このエンジンでは、レポート定義に棒グラフ、円グラフ、折れ線グラフ、時系列グラフなどのチャートを含めることができます。
  • レポート式は次のように記述できます Java, Groovyまたは Java脚本。

これらの機能は、固定された処理シーケンスを通じて利用可能となり、次のセクションではその処理シーケンスを段階ごとに説明します。

JasperReports のライフサイクル

それでは、JasperReportsのライフサイクルについて学びましょう。

Jasper Reportsのライフサイクルの一般的な流れは以下のとおりです。

JasperReports のライフサイクル

上の図は、4つの段階を順番に示しています。各段階では、次の段階への入力となるファイルが生成されます。そのため、この順序を逆にすることはできません。

ステージ 入力 出力 ファイル拡張子
設計 レイアウトに関する決定 レポートテンプレート .jrxml
コンパイル .jrxmlファイル コンパイル済みバイナリテンプレート 。碧玉
実行中 .jasperファイルとデータ 記入済みレポート .jrprint
エクスポート .jrprintファイル 最終文書 .pdf、.html、.xls、その他

レポートの設計

まず最初のステップとして、JRXMLファイルを作成します。これはレポートのレイアウトを定義するシンプルなXMLドキュメントです。このファイルは、任意のテキストエディタまたはレポートデザイナーを使用して作成できます。

ただし、レポートデザイナーを使用している場合は、レポートのレイアウトを視覚化できるため、JRXMLの実際の構造は無視できます。

報告書の作成

このライフサイクル段階では、最初の段階で作成されたJRXMLがコンパイルされ、Jasperファイル(拡張子がjasperのファイル)と呼ばれるバイナリオブジェクトが生成されます。

このコンパイルは、実行時のパフォーマンスを向上させるために行われます。 これらの生成された Jasper ファイルは、レポートを実行するアプリケーションと一緒に出荷される必要があります。

レポートの実行

この段階では、アプリケーションからのデータが収集され、編集されたレポート形式に記入されます。 net.sf.jasperreports.engine.JasperFillManager というクラスがあり、レポートにデータを入力する関数を提供します。

出力はJasperの印刷ファイル(拡張子がjrprintのファイル)に保存され、このファイルを使用してレポートを印刷またはエクスポートできます。

レポートを希望の形式にエクスポートする

この最後の段階では、JasperExportManager クラスを使用して、前に作成した Jasper 印刷ファイルを任意の形式にエクスポートする必要があります。 Jasper は複数の形式のエクスポートを提供しているため、同じ入力を使用してデータのさまざまな表現を作成できます。

Jasper Reportsのインストール方法 – 環境設定

それでは、JasperReports環境のセットアップ手順を順を追って見ていきましょう。以下のスクリーンショットは、バージョン6.9のインストーラーを使用して取得したものです。現在のコミュニティリリースは2024年4月23日に公開されたバージョン6.21.3で、ファイル名のバージョン番号は異なりますが、画面の順序は変わりません。

ステップ1) Jasper Reports コミュニティ エディションをダウンロード
これに行く リンク そして、「今すぐダウンロード」オプションをクリックして、Jasper Reports Community Editionをインストールしてください。

Jasper Reports のインストール - 環境セットアップ

ステップ2) Jaspersoft Studio CE を選択します
コミュニティ版から、Jaspersoft Studio CEを選択してください。

Jasper Reports のインストール - 環境セットアップ

ステップ3) ジャスパーソフトスタジオをダウンロード
これに行く ダウンロードボタンをクリックし、ダウンロードしたインストーラー実行ファイルを開いて、お使いのオペレーティングシステムに対応させてください。

Jasper Reports のインストール - 環境セットアップ

ステップ4) 同意ボタンをクリックしてください
次の画面が表示されます。「同意する」ボタンを選択してください。

Jasper Reports のインストール - 環境セットアップ

ステップ5) 場所を選択
インストール場所を選択し、「次へ」ボタンをクリックしてください。

Jasper Reports のインストール - 環境セットアップ

ステップ6) 現在進捗状況が進行中です
次の画面で進行状況が表示されます。

Jasper Reports のインストール - 環境セットアップ

ステップ7) 完了ボタンをクリックします
次の画面で、「完了」ボタンをクリックします。

Jasper Reports のインストール - 環境セットアップ

ステップ8) 進行状況は完了しました
次の画面がウィンドウに表示されます。

Jasper Reports のインストール - 環境セットアップ

ステップ9) 今すぐ始める
次に、「開始する」オプションをクリックしてください。

Jasper Reports のインストール - 環境セットアップ

ステップ10) Jasper Reports スタジオの使用を開始する
次の画面が表示され、Jasper Reports Studio の操作を開始できます。

Jasper Reports のインストール - 環境セットアップ

💡ヒント: Jaspersoft Studioは Eclipse ベースアプリケーションであり、互換性が必要です Java マシンにランタイムがインストールされていることを確認してください。インストーラーが起動しない場合は、再インストールする前にインストールされているJDKのバージョンを確認してください。

レポートテンプレートの作成例

それでは、JasperReportsでレポートテンプレートを作成する方法を学びましょう。

JasperReportsで使用されるレポートテンプレートファイルは、拡張子がjrxmlのシンプルなXMLファイルです。このファイルのルート要素には、jasperReportタグが含まれています。JasperReportsフレームワークは、さまざまな種類のデータソースを処理できます。

レポートテンプレートは、以下の手順で設計および作成されます。

ステップ1) Jaspersoft Studio で JRXML ファイルを作成します。

  1. 「ファイル」オプションを選択してください。
  2. 「新規」サブメニューを選択してください。
  3. 「Jasper Report」オプションをクリックしてください。

レポートテンプレートの作成例

ステップ2) 希望のテンプレートを選択します。

  1. テンプレート (チェリーなど) を選択します。
  2. 「次へ」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ3) 親フォルダーを選択します。

  1. 「MyReports」フォルダを選択してください。
  2. ファイル名を入力します(例:「Cherry Report」)。
  3. 「次へ」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ4) データソースウィンドウで、「新規」ボタンをクリックして、新しいデータアダプタを作成します。

レポートテンプレートの作成例

ステップ5) データアダプターの選択。

  1. リストボックスからデータアダプタを選択します。例:「コレクション Java豆。"
  2. 「次へ」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ6) データアダプタの詳細を入力し、工場クラスを選択します。

  1. アダプターの名前を入力します。
  2. 「…」ボタンをクリックして、工場クラスを選択してください。

レポートテンプレートの作成例

ステップ7) 接頭辞またはパターンを入力してください。

  1. 名前のプレフィックスまたはパターンを入力します。
  2. 一致する項目をクリックします。
  3. 「OK」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ8) ファクトリークラスを定義し、jarファイルへのパスを追加します。

  1. ファクトリ クラスの静的メソッドの名前を入力します。 この Jasper レポートの例では、これは createBeanCollection です。
  2. もしあなたの JavaBeansの定義にはフィールドの説明が含まれており、Jaspersoft Studioでこれらの説明を名前として使用したい場合は、「フィールドの説明を使用する」チェックボックスをオンにしてください。
  3. jar ファイルへのパスを追加します。
  4. 「完了」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ9) 「次へ」ボタンをクリックしてください。

レポートテンプレートの作成例

ステップ10) おめでとうございます!必要なレポート作成情報をすべて正常に入力できました。「完了」ボタンをクリックしてください。

レポートテンプレートの作成例

レポートは、以下の画面に示すように生成されます。

レポートテンプレートの作成例

上記のファイルは、JasperReportバイナリ形式(jasperファイルと呼ばれる)にコンパイルする必要があります。

JasperReportsライブラリの一部であるインターフェースnet.sf.jasperreports.engine.design.JRCompilerは、このレポートテンプレートファイルのコンパイルにおいて重要な役割を果たします。

このインターフェースの実装は次のように記述できます。 Java, Javaスクリプト, Groovy、またはその他のスクリプト言語。

JRXMLファイルは、以下の2つの方法でコンパイルできます。

  • プログラムによるコンパイル Java コー​​ド。
  • コンパイル アパッチアント タスク。

以下のコードスニペットはプログラムによる処理を示しており、1行目でテンプレートをコンパイルし、2行目でテンプレートにデータを挿入します。 Java豆のコレクション。

import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

public class ReportRunner {

    public static void main(String[] args) throws JRException {

        // 1. Compile the JRXML template into a .jasper file
        JasperReport report = JasperCompileManager.compileReport("CherryReport.jrxml");

        // 2. Fill the compiled template with a collection of beans
        JRBeanCollectionDataSource source =
                new JRBeanCollectionDataSource(EmployeeFactory.createBeanCollection());

        JasperPrint print = JasperFillManager.fillReport(report, null, source);

        // 3. Export the filled report to PDF
        JasperExportManager.exportReportToPdfFile(print, "CherryReport.pdf");

        System.out.println("Report exported successfully");
    }
}

出力:

Report exported successfully

さまざまなレポートバンドを理解する

JasperReportsのレイアウトは、バンドと呼ばれる水平方向のセクションに分割されています。各バンドには固定の印刷ルールがあり、これらのルールを理解することで、デザイナーは完成したドキュメント内で値が表示される場所を正確に制御できるようになります。

以下は、ほとんどの市販レポート作成ツールで採用されている標準的なレポート区分です。

  • Title
  • ページヘッダー
  • 列ヘッダー
  • Detail
  • 列フッター
  • ページフッター
  • 最終ページのフッター
  • 製品概要
  • グループヘッダー
  • グループフッター
  • 経歴
  • データなし

それでは、各報告区分について詳しく見ていきましょう。

Title

このバンドはレポートの冒頭に表示されます。属性を設定することで、最初のページに単独で配置することもできます。 isTitleNewPage="true".

ページヘッダー

ページヘッダーバンドは各ページの先頭に表示されます。タイトルバンドが使用されている場合は最初のページが除外され、サマリーバンドが使用されている場合は最後のページが除外されます。 isSummaryWithPageHeaderAndFooter="false".

列ヘッダー

列ヘッダーは、各ページの詳細バンドの前に表示されます。

Detail

詳細セクションは、指定されたデータソース内の各レコードに対して繰り返し処理されます。また、複数の詳細バンド(1、2など)を設定することも可能です。

列フッター

このセクションは、詳細バンドが存在する各ページで、詳細バンドの下に表示されます。デフォルト設定ではページの末尾に表示されますが、属性を設定することで最後の詳細バンドの下に配置するように変更できます。 isFloatColumnFooter="true".

ページフッター

このセクションは、要約欄、タイトル欄、および最後の要約以外の欄を除き、各ページの最後に表示されます。

最終ページフッター

このセクションは、要約バンドが表示されない場合、通常のページフッターの代わりに最終ページに表示されます。

製品概要

要約セクションは、レポートの最後に新しいページに表示されます。 isSummaryNewPage="true" 設定されており、ページヘッダーとフッターがある場合 isSummaryWithPageHeaderAndFooter="true" 設定されています。

グループヘッダー

このセクションは、定義された場合にのみ、グループ式が変更されるたびに、詳細バンドの前に表示されます。

グループフッター

このセクションは、詳細バンドの後、グループ式が変更されるたびに、グループが定義されている場合にのみ表示されます。

経歴

これは、他のすべてのレポートバンドの背景として、すべてのページに表示されます。

データなし

データソースが渡されなかったか、データソースが空で、 whenNoDataType="NoDataSection" 設定されています。

ジャスパー vs. ペンタホ

それでは、JasperとPentahoの違いについて学びましょう。

JasperとPentahoの主な違いは以下のとおりです。

技術パラメータ 碧玉 Pentahoの
レポート Jasperはレポートの設計にJaspersoft Studioを使用しています。 Pentaho Report Designerを使用します。
ETLのサポート JaspersoftはETL処理にTalend Open Studioを使用しています。 デフォルトとしてPentaho Data Integratorを使用します ETLツール.
ダッシュボード ダッシュボード機能は、Jaspersoftのエンタープライズ版のみに搭載されています。 Pentahoは、ダッシュボードに幅広い機能を提供しています。
モバイル ビジネス インテリジェンス JaspersoftはモバイルBIのサポートが優れている。 Pentahoは、モバイルBIエクスペリエンスを向上させるために、サードパーティ製のツールに頼る必要がある。
ドキュメント マーケティング、サイト、ドキュメントの改善。 ドキュメントのサポートが貧弱です。
最良の特徴 必要なものを調べて見つけやすくなります。 データマイニング機能とiPhone連携機能を提供します。
有料版 有料版では次のような機能が提供されます アドホッククエリ ウェブUIとダッシュボード作成用ウェブUI。 LDAP連携、SSO、監査などの機能を提供します。

既に投資しているチームは Java スタックは通常 Jasper を選択するが、レポート作成と並行して高度なデータ統合が必要なチームは、 Pentahoの.

JasperReports の作成中に直面する課題

Jasper Reportsを作成する際に直面するであろう課題をいくつかご紹介します。

  • コア部分の変更 – ビジネスルールが変更または拡張された場合、レポートのコアロジックを変更する必要があります。
  • 複雑なレポート、例えばサブレポートやクロス集計レポートなどが良い例です。
  • グラフ、XY線グラフ、円グラフ、棒グラフ、時系列グラフ、メーターグラフなどの図表レポートまたは視覚的なグラフ。

Jasper レポートを使用するデメリット

Jasper Reportsを使用する際の欠点は以下のとおりです。

  • パッケージの一部に変更を加えたり、機能を削除したりすると、デフォルトのパッケージ設定に戻すのは非常に困難になります。
  • 柔軟性に欠け、行の編集やクロス集計表の作成は困難な作業です。
  • グループ化されたレポートの小計を指定するなど、一般的な作業の中には、他のレポート作成ツールの方が簡単なものもあります。
  • Jasperでは、レポートを実行する前にコンパイルする必要があります。つまり、レポート開発者はレポートの全体を把握している必要があります。 Java SDKがインストールされました。
  • レポートを編集すると、Web 上に表示されるものと同じプレビューが表示されない場合があります。

よくあるご質問

.jrxmlファイルは、設計者が編集する人間が読めるXMLテンプレートです。.jasperファイルは、そこから生成されたコンパイル済みのバイナリファイルであり、実行時にはコンパイル済みのファイルのみが実行されます。

JasperReportsライブラリおよびJaspersoft Studio Community Editionはオープンソースライセンスでリリースされており、商用製品に組み込むことができます。ダッシュボード、スケジュール機能、およびセキュリティ機能を使用するには、有料版が必要です。

はい。Jaspersoft StudioでJDBCデータアダプタを作成し、ドライバjarファイルと接続文字列を指定してから、レポート内にクエリを記述してください。パラメータはドル記号と中括弧の構文で渡します。

はい。jasperreportsの依存関係を追加し、コンパイル済みの.jasperファイルをクラスパスに配置して、サービス クラスからJasperFillManagerを呼び出してください。エクスポートされたバイト列は、HTTPレスポンスに直接ストリーミングできます。

AIアシスタントはJRXMLの骨組みと式構文を迅速に作成できます。バンドの高さや要素の座標は手動で修正する必要がある場合が多いため、生成されたファイルは必ずJaspersoft Studioで開いてください。

AIダッシュボードでは生成されない、請求書や明細書といったピクセル単位で正確な運用文書を処理します。モデルの出力はデータベースに書き込まれ、Jasperがそれをレンダリングして配信します。