Mac Book Pro 10.13.6
Jaspersoft Studio community version 6.6.9
JDK 8
安裝 Jaspersoft Studio
Jasper Report 分為專業版（收費）和社群版（免費），如果只是用來設計一些 基本的報表模板，社群版就足夠了。從這裡可以下載，選擇 Jaspersoft Studio。
安裝時可能遇到的問題
如果在安裝時一切順利，那麼可以直接跳過本小節。
如果安裝過程中遇到如上錯誤，可以嘗試一下 解決辦法：
- Step 1
System Preferences -> Security & Privacy -> General
- Step 2
如果 Step 1 不能解決問題，開啟 Terminal，執行如下命令：
# sudo bash
# xattr -cr "/Applications/TIBCO Jaspersoft Studio 6.6.0.app"
如果你對這個 xattr 感到好奇，可以執行 man xattr 讀一讀解釋。
理解 Report Band
Jasper Studio 內建了很多種 Band，不同的 Band 有不同的用途，也有些不同預設行為。除了 Background Band，其他的 Band 的總高度要小於或等於一頁的最大高度減去頂部和底部的邊距。
Title
預設只會出現在第一頁的最頂部。也可以像下面這樣控制它顯示在單獨的一頁上。
Page Header
頁首預設會出現在每一頁的頂部。當 Title 和 Summary Band 設定為顯示在單獨的一頁上時，頁首則不會顯示出來。
Detail
Detail Band 比較神奇，它能夠自動的迭代 DataSource 中的所有元素，如果 DataSource 為 null，則只有靜態文字會顯示出來。預設情況下，Main Dataset 的 Query 有多少條記錄，Detail Band 就會重複多少遍。
更加詳細一點的解釋看這裡。
Page Footer
頁尾預設會出現在每一頁的底部。
Last Page Footer
如果想在最後一頁的頁尾上放一些不同的內容，就可以考慮使用這個 Band。
Summary
預設會顯示在報表的最後，和 Title Band 一樣，也可以設定為顯示在單獨的一頁上。如果是基於統計的報表，一般會放一些計算出來的內容，比如：最大值，最小值，平均值，總值等。當然，根據實際需要，也可以放任意內容。
Background
顧名思義，這個一般就是放報表的背景的，比如水印之類的。它的最大高度可以和報表一頁的高度相同。
其他的 Band
Column Header, Group Header, Group Footer, Column Footer, No Data 這些 Band 根據名字也比較容易理解，具體的解釋在這篇文章中講解的比較詳細。
全域性設定
在頁面的全域性設定中可以設定頁面的大小，邊距，尺寸單位，頁面方向等。
一個小建議是，如果設計稿是什麼計量單位，這裡就設定成什麼計量單位，然後把尺寸設定的和設計稿一樣，避免在設計模板的時候做繁瑣的尺寸換算。
關於頁面邊距需要注意的一點是，即使將上下左右都設定為 0，最終匯出 PDF 列印出來，邊距也不見得是 0，因為印表機的設定中可能還會有預設的邊距設定。
頁碼
在報表中，幾乎都會有顯示頁碼的需求，比如 Page x of y 這種。看似很簡單，並且 Jasper Studio 中已經提供預設好的元件。
這個內建的元件是通過兩個 Text Field 實現的，如果對對齊的精度要求不高，直接使用這個元件也是挺方便的。其原理就是使用了兩次 $V{PAGE_NUMBER} 變數，只是設定不同的求值時機即可。對於每一頁的頁碼設定 Evaluation Time 為 Now，對於總頁碼設定為 Report。
但是如果對精度要求非常高的話，這個方式就不太合適了，我們需要用一個 Text Field 來實現，具體的做法參考這裡。
設定中英文為不同的字型（Font Set）
相信用 Word 軟體進行過中英文排版的可能應對過這種需求，就是對一篇文章中的中英文需要設定不同 的字型，在 Word 中是有這個選單項可以設定的，但是在 Jasper Report 中要實現這個需求就不那麼簡單了。
主要涉及到下面這些步驟：
建立 Font Set
建立 Font Extension 和 Font Set 的步驟比較直觀，參考官方文件即可。
在 Java 程式碼中引用字型檔案
如果伺服器所在的系統中沒有相應的字型，在 Jasper Report 嘗試生成 PDF 的時候就會報錯。需要以下幾步來解決：
-
首先需要從 Jasper Studio 中匯出包含字型的 Jar 包，一次點選
Window > Preferences > Jaspersoft Studio > Fonts，選中建立的 Font Set 和其包含的字型並點選Export。 -
在匯出 Font 到 Jar 包的對話方塊中寫上名稱並儲存。比如
SampleFontSet.jar。這個 Jar 包和一般普通的 Jar 包不同，它包含了一些 Jaspersoft 需要的額外資訊。 -
在程式碼依賴中引入字型 Jar 包。
將字型嵌入到 PDF 中
有人可能會懷疑將報表中用到的字型嵌入到匯出的 PDF 中是否會帶來效能問題，畢竟一般漢字的字型檔案體積都比較大，大幾十兆。在用 Japser 匯出 PDF 的時候，只會嵌入用到的字型檔案的子集，所以 幾乎不用擔心匯出的 PDF 的體積。
測量 Text Field 的實際寬度（使用 Font Set ）
如果在 Text Field 上設定的字型是自定義的 Font Set，那麼需要注意了，不是那麼容易能夠測量出真實的寬度。目前的解決辦法是先分離出文字中的漢字字元和非漢字字元，然後分別設定成相應的字型，再各自測量出寬度，最後相加即為文字所佔的實際寬度。
- 分離漢字字元和非漢字字元
private static Pair<String, String> splitHanAndOthers(String str) {
StringBuilder hanToken = new StringBuilder();
StringBuilder othersToken = new StringBuilder();
for (int i = 0; i < str.length(); ) {
final int codePoint = str.codePointAt(i);
if (UnicodeScript.of(codePoint) == UnicodeScript.HAN) {
hanToken.append(str.charAt(i));
} else {
othersToken.append(str.charAt(i));
}
i += Character.charCount(codePoint);
}
return Pair.of(hanToken.toString(), othersToken.toString());
}
- 測量文字的實際寬度
private static float getWidth(JRPrintText jrPrintText, String text, String fontName) {
final DefaultJasperReportsContext instance = DefaultJasperReportsContext.getInstance();
final JRDefaultStyleProvider defaultStyleProvider = jrPrintText.getDefaultStyleProvider();
JRPrintText printText = new JRBasePrintText(defaultStyleProvider);
printText.setText(text);
printText.setFontName(fontName);
printText.setFontSize(jrPrintText.getFontsize());
final JRStyledText hanTextFullStyledText = printText.getFullStyledText(JRStyledTextAttributeSelector.getAllSelector(instance));
final JRTextMeasurer measure = JRTextMeasurerUtil.getInstance(instance).createTextMeasurer(jrPrintText);
final JRMeasuredText measuredText = measure.measure(hanTextFullStyledText, 0, 0, false);
return measuredText.getTextWidth();
}
- 計算總寬度
private float getTotalWidth(JRPrintText jrPrintText, String text) {
final Pair<String, String> hanAndOthers = splitHanAndOthers(text);
final String han = hanAndOthers.getLeft();
final String others = hanAndOthers.getRight();
final float hanWidth = getWidth(jrPrintText, han, "JianSong");
final float othersWidth = getWidth(jrPrintText, others, "CorporateS");
return hanWidth + othersWidth;
}
Image
顯示圖片
- 路徑問題
在 Jasper Studio 中新增一個 Image 元件，正確的設定一個圖片的路徑，點選預覽就可以看到顯示出來的圖片了。但是細心的同學會發現在 .jrxml 模板檔案中圖片的路徑是一個絕對路徑，這在實際生產過程中肯定是不行的。
因此，通過搜尋找出了一個方法，可以解決靜態圖片的路徑問題。在 Image 元件的表示式中寫上這樣的表示式：
this.getClass().getResourceAsStream("/images/logo.png")
還有幾種其他的場景可能直接寫相對路徑也能工作，我沒有驗證過。
- 傳參問題
其實，Image 元件的表示式中不僅支援寫圖片的路徑，也可以在程式碼中將圖片讀入記憶體然後直接以 InputStream 的形式傳遞，不過要確保每個 Stream 只能被消費一次，不要複用同一個 InputStream，如果想要複用，考慮使用 Image 元件的 isUsingCache 屬性。不過 Jasper 支援的型別除此之外，還有好幾種：
* java.lang.String
* java.io.File
* java.net.URL
* java.io.InputStream
* java.awt.Image
* net.sf.jasperreports.engine.JRRenderable
例子可以參考這個。
使用 InputStream 時可能遇到的問題
net.sf.jasperreports.engine.JRException: java.io.IOException: The byte array is not a recognized imageformat.
at net.sf.jasperreports.engine.export.JRPdfExporter$InternalImageProcessor.processImageRetainShape(JRPdfExporter.java:1747)
at net.sf.jasperreports.engine.export.JRPdfExporter$InternalImageProcessor.process(JRPdfExporter.java:1604)
at net.sf.jasperreports.engine.export.JRPdfExporter$InternalImageProcessor.access$300(JRPdfExporter.java:1532)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportImage(JRPdfExporter.java:1472)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportElements(JRPdfExporter.java:1090)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportFrame(JRPdfExporter.java:3117)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportElements(JRPdfExporter.java:1098)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportPage(JRPdfExporter.java:1053)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportReportToStream(JRPdfExporter.java:917)
at net.sf.jasperreports.engine.export.JRPdfExporter.exportReport(JRPdfExporter.java:537)
at net.sf.jasperreports.engine.JasperExportManager.exportToPdfFile(JasperExportManager.java:155)
at net.sf.jasperreports.engine.JasperExportManager.exportReportToPdfFile(JasperExportManager.java:503)
at com.finger.hr.controllers.HRCreatePDFController$2.run(HRCreatePDFController.java:244)
Caused by: java.io.IOException: The byte array is not a recognized imageformat.
at com.lowagie.text.Image.getInstance(Unknown Source)
at net.sf.jasperreports.engine.export.JRPdfExporter$InternalImageProcessor.processImageRetainShape(JRPdfExporter.java:1742)
... 12 more
解決辦法很奇特，到現在我也不知道為什麼。
如果傳遞的引數是一個獨立的 InputStream 型別的欄位，就會有上述錯誤。 解決辦法就是把這個單獨的 欄位包到一個 Java 物件中（:D）。
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class PhotoDto {
private InputStream photo;
}
List
List 顯示行號
不管是 List 還是 Table 如果只是想顯示簡單的行號，最簡單的辦法就是使用 $V{REPORT_COUNT}。 如果對行號還有一些比較複雜的計算邏輯，則最好在程式碼中處理好，然後作為資料的一個欄位傳遞給 Jasper 直接渲染。
_THIS 大法
如果傳遞給 List 的（或者是 Table）資料是一個基本型別（這裡姑且把 String 也看做基本型別，其實只要是不包含屬性的物件都滿足條件）的資料的集合，那麼在引用單個資料的時候就得注意了，因為基本型別的資料不存在欄位一說，所以需要在 Field 的命名上做點文章。
比如說 dataSource 是 List<String>，那麼在定義 Field 的時候就沒辦引用物件的欄位名了，這時候我們只需要將欄位名定義為 _THIS 即可，在引用的地方寫 $F{_THIS}。更多解釋參考這裡。
Table
Dataset
Table 巢狀中的坑
Table 中巢狀 Table 可以實現類似合併單元格的效果，但是如果最外層的 Table 中一行的高度超過了頁面的最大高度就會直接報錯，而不是分頁。
Table 中實現分組效果
- Merge Cell？impossible！
在 Table 元件中不能直接做合併單元格的操作，只能通過巢狀 Table 來實現類似的效果。
- Table Cell 中的負數縮排
在使用 Jasper Studio 6.6.0 版的設計器的時候，在介面上設定座標值的時候，會出現儲存不成功的情況。只能通過直接修改模板原始檔的方式設定負數座標。感覺是 IDE 的 Bug，在後續版本應該修復了。
設定 right indent 為負數的時候，left indent 不能為 0，如果為 0 right indent 不會生效 :( (至今不知道為什麼 :boom:)
- 利用 Table 元件的特性
如果有分組的需求，可以考慮使用 Table 的 Group Header 和 Group Footer 來顯示組名和小計之類的資料。
Text Field & Static Text
- Strech
關於 Strech，在設計器裡有一個屬性叫做 Strech With Overflow，當這個屬性被勾選後，表示當資料的長度超過元件的長度時會自動折行，相當於垂直方向上的 Overflow，而 Jasper 也不支援水平方向的 Overflow。
- Pattern
在 Jasper 中可以很方便的設定一些特殊文字的顯示格式，比如： 日期，時間，貨幣，數字，百分比等。
SubReport
- Compile 問題
在 Jasper Studio 的設計器裡可以通過直接引用 *.jasper 檔案的方式，在主報表中引用子報表。但是如果在實際的產品程式碼中這樣做，非常不利於對原始碼的版本控制，因為這個 *.jasper 檔案是一個經過編譯之後的臨時檔案。
我們在生產程式碼中可以先將子報表的模板預編譯好，然後直接以引數的形式傳遞給主報表（例如如下程式碼將編譯好的 “checklist.jrxml” 子報表作為引數傳給主報表，然後在主報表中的引用表示式寫成$P{checklist}）。
String subreport = "checklist";
JasperReport jasperReport = null;
try (InputStream inputStream = getResourceAsStream(subreport + ".jrxml")) {
jasperReport = JasperCompileManager.compileReport(inputStream);
} catch (IOException | JRException e) {
e.printStackTrace();
}
params.put(subreport, jasperReport);
Detail Band 重複多次的問題
Detail Band 被渲染的次數是由 Main Dataset 中資料條數決定的，如果發現 Detail Band 被重複渲染了多次，那麼請檢查是否新增了 Main Dataset 的 Query，並且查詢出來的資料不止一條。如果沒有要設定 Main Dataset 的場景，可以選擇 One Empty Record。
頁面的多列排版
在頁面設定中的多列設定，只對 Detail Band，Column Header，Column Footer 有影響。
HTML Markup 的限制
對於 HTML Markup 的使用，其實沒有想象中的那麼美好，使用起來功能比較有限。只能支援文字格式相關的標籤和屬性，不支援佈局相關的標籤。所以想通過 CSS 實現 一些效果，基本上都行不通。
支援的 HTML 標籤如下：
- b
- u
- i
- font
- sup
- sub
- li
- br
這個列表是從原始碼中 找出來的，並沒有什麼文件（也有可能是我沒搜到）明確的列出來。 原始碼參考這裡。
Position Type 設定為 Float 中的誤區
一開始我不是特別理解這個 Float Position Type 的原理，走了很多彎路，經過很長時間的摸索才理解 Float Position Type 的用法。其實主要是因為 Jaser Studio 設計器中顯示出來的樣子容易誤導使用的人。
正常情況下，在設計模板的時候我們會把一些元件擺放的規規矩矩，整整齊齊的，看著都覺得舒服。Float 是相對於設計器裡離它最近的元素漂移的，其相對位置在設計模板的階段就決定好了。而有的元件在設計器裡展示的形狀比較大，如果要擺放整齊，需要 Float 的元素就會有比較大的相對距離出現。其實，這個時候我們不能相信我們眼睛看到的，也不能有強迫症，在設計器裡。因為很多時候需要一些元素看上去是疊在一起的，渲染出來的效果反而是我們需要的。
我們在實際專案中有一個模板設計出來是這樣的，是不是看著感覺很亂，但是要使用 Float 達到我們想要的效果，還必須要設計成這樣。
時間的時區問題
解決報表中時區問題很簡單，只需要給報表內建的一個變數傳入相應的時區就行了。
Map<String, Object> params = new HashMap<>();
params.put("REPORT_TIME_ZONE", TimeZone.getTimeZone(ZoneId.of("Asia/Shanghai")));
通過程式碼定位元素座標（終極大法）
如果在 Jasper Studio 中無法實現元件的動態定位，基本上也就只有這麼一條路可以走了。如果這條路也實現不了，要麼改需求，要麼換掉 Jasper Report 解決方案。
參考連結
- https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v71/getting-started-jaspersoft-studio-0
- https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v630/understanding-bands
- https://community.jaspersoft.com/wiki/report-structure-jaspersoft-studio
- https://communities.ca.com/blogs/rob.ensinger/2015/12/28/how-to-single-textbox-page-x-of-y-page-counts-in-jaspersoft-reports
- https://stackoverflow.com/questions/10673263/show-page-x-of-y-using-a-single-text-field
- https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v630/working-font-extensions
- https://stackoverflow.com/questions/3623420/image-expression-url-in-jasper-reports
- https://stackoverflow.com/questions/11949333/passing-the-list-of-primitive-type-objects-as-datasource-for-subreport
- https://stackoverflow.com/questions/27903072/print-liststring-each-element-in-new-field
- https://stackoverflow.com/questions/11949333/passing-the-list-of-primitive-type-objects-as-datasource-for-subreport