Jasper Reports 简明教程

Unicode Support

在 JasperReports 中，处理文本需要一些专门的工具来处理字符表示和文本格式化属性。任何文本都可以看作具有特定表示结构的字符序列。文本外观包括布局（和段落）和字体设置。但在大多数情况下，文本布局保持不变，在不同区域设置中运行报表时，字体设置可能会发生变化。

我们知道，不同的语言需要不同的字符集来表示特定字符。因此，处理文本意味着处理字体。但是，有关如何在 JasperReports 中使用字体的详细讨论可在章节 Report Fonts 中找到。

有关给定报表中文本内容的一项主要功能是使其国际化的可能性。这意味着，我们可以在不同的本地化环境中运行报表，使用不同的语言和其他本地化设置，而无需进行任何硬编码修改。当报表打算国际化时，字符编码是一项重要功能。

Character Encoding

字符是传达有意义信息的最小书写单位。它是一个抽象概念，字符没有视觉外观。“大写拉丁语 A”不同于“小写拉丁语 a”以及“大写西里尔语 A”和“大写希腊 Alpha”。

字符的可视表示称为 glyph 。某一组字形称为 font 。“大写拉丁语 A”、“大写西里尔语 A”和“大写希腊 Alpha”可能具有相同的字形，但它们是不同的字符。同时，在 Times New Roman、Gill Sans 和 Poetica Chancery Italic 中，“大写拉丁语 A”的字形看起来可能非常不同，但它们仍然表示相同的字符。

可用字符集称为字符库。库中给定字符的位置（索引）称为其代码位置或代码点。在给定库中用数字表示代码点的方法称为 character encoding 。

编码通常用八位字节表示。八位字节是一组八个二进制数字，即八个一和零。一个八位字节可以用 0 到 255 或 0x00 到 0xFF（使用十六进制符号）之间的数值范围表示。

Unicode

Unicode 是一种字符库，其中包含世界上大多数语言中使用的字符。它可以容纳数百万个字符，并且已经包含数十万个字符。Unicode 被划分为 64K 字符的“平面”。在大多数情况下，只使用一个平面，称为基本多语言平面或 BMP。

UTF-8 是推荐的编码。它使用可变数量的八位字节来表示不同的字符。

在 JRXML 文件中，对编码属性在标题中进行了指定。在报告编译过程中，它用于对 XML 内容进行解码。例如，如果报告仅包含法语单词和 ç、é、â 等字符，那么 ISO-8859-1（又名 Latin-1）编码就足够了。

<?xml version = "1.0" encoding = "ISO-8859-1"?>

如上所见，理想情况下，我们可以选择适合最小字符集的编码，它可以正确显示文档中的所有字符。但在处理多语言文档（即包含拼写了多种语言的单词的文档）时，应选择适合最小字符集的编码，即使它们属于不同的语言，也能正确显示文档中的所有字符。能够处理多语言文档的字符编码之一是 UTF-8 ，它用作 JasperReports 的默认编码值。

在国际化过程中，文本通常保存在资源包文件中，而不是保存在文档中。因此，有时 JRXML 本身看起来完全兼容 ASCII，但运行时生成的报告确实包含无法通过 ASCII 读取的文本。因此，对于特定类型的文档导出格式（如 CSV、HTML、XHTML、XML 和文本），人们还必须了解生成文档的编码。不同的语言由不同的字符编码提供支持。因此，每次我们都需要在本地化环境中运行报告。此外，我们还必须知道，哪个是最适合生成文档语言的字符编码。在这种情况下，JRXML 文件中自行定义的编码属性可能不再有用。

要解决此类问题，我们可以使用一个称为 net.sf.jasperreports.export.character.encoding 的导出自定义属性。此导出自定义属性默认为 UTF-8，并且存在于 JasperReports 中。

此默认值在 default.jasperreports.properties 文件中设置。对于导出时的更具体选项， CHARACTER_ENCODING 导出参数也可用。

Example

为了演示在 Jasperreports 中使用 unicode 支持，我们新建一个报告模板（jasper_report_template.jrxml）。 Save it to C:\tools\jasperreports-5.0.1\test 目录。在这里，我们将使用 Unicode 字符（\uXXXX）显示不同语言的文本。使用 UTF-8 编码的任何字符都可以仅使用其 4 位十六进制代码进行显示。例如，希腊字母 Γ 可以写成 \u0393。当遇到此类表示法时，引擎会调用字符集中适当的字符表示法，并且只会打印出该特定字符。JRXML 的内容如下所示：

<?xml version = "1.0" encoding = "UTF-8"?>

<jasperReport xmlns = "http://jasperreports.sourceforge.net/jasperreports"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://jasperreports.sourceforge.net/jasperreports
   http://jasperreports.sourceforge.net/xsd/jasperreport.xsd"
   name = "jasper_report_template" language = "groovy" pageWidth = "595"
   pageHeight = "842" columnWidth = "555" leftMargin = "20" rightMargin = "20"
   topMargin = "20" bottomMargin = "20">

   <parameter name = "GreekText" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression><![CDATA["\u0394\u03B5\u03BD "+
         "\u03BA\u03B1\u03C4\u03B1\u03BB\u03B1\u03B2\u03B1\u03AF"+
         "\u03BD\u03C9 \u0395\u03BB\u03BB\u03B7\u03BD\u03B9\u03BA\u03AC"]]>
      </defaultValueExpression>
   </parameter>

   <parameter name = "CyrillicText" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression><![CDATA["\u042F \u043D\u0435 "+
         "\u043C\u043E\u0433\u0443 \u043F\u043E\u043D\u044F\u0442\u044C "+
         "\u0433\u0440\u0435\u0447\u0435\u0441\u043A\u0438\u0439"]]>
      </defaultValueExpression>
   </parameter>

   <parameter name = "ArabicText" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression><![CDATA["\u0627\u0646\u0646\u0649 \u0644\u0627 "+
         "\u0627\u0641\u0647\u0645 \u0627\u0644\u0644\u063A\u0629 "+
         "\u0627\u0644\u0639\u0631\u0628\u064A\u0629"]]>
      </defaultValueExpression>
   </parameter>

   <parameter name = "HebrewText" class = "java.lang.String" isForPrompting = "false">
      <defaultValueExpression><![CDATA["\u05D0\u05E0\u05D9 \u05DC\u05D0 "+
         "\u05DE\u05D1\u05D9\u05DF \u05E2\u05D1\u05E8\u05D9\u05EA"]]>
      </defaultValueExpression>
   </parameter>

   <title>
      <band height = "782">

         <textField>
            <reportElement x = "0" y = "50" width = "200" height = "60"/>

            <textElement>
               <font fontName = "DejaVu Sans" size = "14"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{GreekText} + "\n" + $P{CyrillicText}]]>
            </textFieldExpression>
         </textField>

         <staticText>
            <reportElement x = "210" y = "50" width = "340" height = "60"/>
            <textElement/>

            <text>
               <![CDATA["GreekText and CyrillicText"]]>
            </text>
         </staticText>

         <textField>
            <reportElement x = "0" y = "120" width = "200" height = "60"/>

            <textElement>
               <font fontName = "DejaVu Sans" size = "14" isBold = "true"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{GreekText} + "\n" + $P{CyrillicText}]]>
            </textFieldExpression>

         </textField>

         <staticText>
            <reportElement x = "210" y = "120" width = "340" height = "60"/>
            <textElement/>
            <text><![CDATA["GreekText and CyrillicText"]]></text>
         </staticText>

         <textField>
            <reportElement x = "0" y = "190" width = "200" height = "60"/>

            <textElement>
               <font fontName = "DejaVu Sans" size = "14" isItalic = "true"
                  isUnderline = "true"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{GreekText} + "\n" + $P{CyrillicText}]]>
            </textFieldExpression>

         </textField>

         <staticText>
            <reportElement x = "210" y = "190" width = "340" height = "60"/>
            <textElement/>
            <text><![CDATA["GreekText and CyrillicText"]]></text>
         </staticText>

         <textField>
            <reportElement x = "0" y = "260" width = "200" height = "60"/>

            <textElement>
               <font fontName = "DejaVu Sans" size = "14" isBold = "true"
                  isItalic = "true" isUnderline = "true"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{GreekText} + "\n" + $P{CyrillicText}]]>
            </textFieldExpression>

         </textField>

         <staticText>
            <reportElement x = "210" y = "260" width = "340" height = "60"/>
            <textElement/>
            <text><![CDATA["GreekText and CyrillicText"]]></text>
         </staticText>

         <textField>
            <reportElement x = "0" y = "330" width = "200" height = "60"/>

            <textElement textAlignment = "Right">
               <font fontName="DejaVu Sans" size = "22"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{ArabicText}]]>
            </textFieldExpression>

         </textField>

         <textField>
            <reportElement x = "210" y = "330" width = "340" height = "60"/>

            <textElement textAlignment = "Right">
               <font fontName = "DejaVu Sans" size = "22"/>
            </textElement>

            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{HebrewText}]]>
            </textFieldExpression>

         </textField>

      </band>
   </title>

</jasperReport>

在上述文件中，我们可以看到 UTF-8 编码的存在。本地化的 Unicode 文本片段也存储在文档参数中。

用于填充和生成报告的 java 代码如下。我们将此文件保存在 JasperUnicodeReportFill.java 于 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint 目录中。

package com.tutorialspoint;

import net.sf.jasperreports.engine.JREmptyDataSource;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JasperFillManager;

public class JasperUnicodeReportFill {
   public static void main(String[] args) {
      String sourceFileName ="C://tools/jasperreports-5.0.1/test/" +
         "jasper_report_template.jasper";

      try {
         JasperFillManager.fillReportToFile(sourceFileName, null,
            new JREmptyDataSource());
      } catch (JRException e) {
         // TODO Auto-generated catch block
         e.printStackTrace();
      }

   }
}

在此处，我们在使用 JREmptyDataSource 填充报告时模拟了一个数据源，其中只有一条记录，但该单条记录中的所有字段都为空。

Report Generation

我们将使用常规的 ANT 构建过程编译并执行以上文件。文件 build.xml（保存在 C:\tools\jasperreports-5.0.1\test 目录下）的内容如下。

导入文件 - baseBuild.xml 从第 Environment Setup 章节中选取，且应放置在与 build.xml 相同的目录中。

<?xml version = "1.0" encoding = "UTF-8"?>
<project name = "JasperReportTest" default = "viewFillReport" basedir = ".">
   <import file = "baseBuild.xml" />

   <target name = "viewFillReport" depends = "compile,compilereportdesing,run"
      description = "Launches the report viewer to preview the report
      stored in the .JRprint file.">

      <java classname = "net.sf.jasperreports.view.JasperViewer" fork = "true">
         <arg value = "-F${file.name}.JRprint" />
         <classpath refid = "classpath" />
      </java>

   </target>

   <target name = "compilereportdesing" description = "Compiles the JXML file and
      produces the .jasper file.">

      <taskdef name = "jrc" classname = "net.sf.jasperreports.ant.JRAntCompileTask">
         <classpath refid = "classpath" />
      </taskdef>

      <jrc destdir = ".">
         <src>
            <fileset dir = ".">
               <include name = "*.jrxml" />
            </fileset>
         </src>
         <classpath refid = "classpath" />
      </jrc>

   </target>

</project>

接下来，我们打开命令行窗口并转到放置 build.xml 的目录。最后，执行命令 ant -Dmain-class=com.tutorialspoint.JasperUnicodeReportFill （viewFullReport 是默认目标），如下所示：

C:\tools\jasperreports-5.0.1\test>ant  -Dmain-class=com.tutorialspoint.JasperUnicodeReportFill
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

clean-sample:
   [delete] Deleting directory C:\tools\jasperreports-5.0.1\test\classes
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jasper
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrprint

compile:
   [mkdir] Created dir: C:\tools\jasperreports-5.0.1\test\classes
   [javac] C:\tools\jasperreports-5.0.1\test\baseBuild.xml:28:
   warning: 'includeantruntime' was not set, defaulting t
   [javac] Compiling 1 source file to C:\tools\jasperreports-5.0.1\test\classes

compilereportdesing:
   [jrc] Compiling 1 report design files.
   [jrc] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
   [jrc] log4j:WARN Please initialize the log4j system properly.
   [jrc] log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
   [jrc] File : C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrxml ... OK.

run:
   [echo] Runnin class : com.tutorialspoint.JasperUnicodeReportFill
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.

viewFillReport:
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.

BUILD SUCCESSFUL
Total time: 4 minutes 1 second

作为上述编译的结果，一个 JasperViewer 窗口会打开，如以下给出的屏幕截图所示 -

report unicode example

在这里，我们可以看到显示的文本属于不同的语言。我们还可以看到，这些语言分组在同一页面上，而且还混入同一文本元素中。