JasperReports - 国际化


有时,我们需要不同语言的报告。为每种不同的语言编写相同的报告意味着大量的冗余工作。只有不同语言的文本片段才应该单独编写,并在运行时加载到文本元素中,具体取决于区域设置。这就是报告国际化的目的。国际化的报告,一旦编写就可以在任何地方运行。

在以下步骤中,我们列出了如何生成不同语言的报告以及报告国际化的一些其他功能 -

  • 将资源包java.util.ResourceBundle与报告模板关联。有两种方法可以将 java.util.ResourceBundle 对象与报告模板关联起来。

    • 在设计时,通过将报表模板对象的resourceBundle属性设置为目标资源包的基本名称。

    • 可以通过在报告填充时提供java.util.ResourceBundle对象作为 REPORT_RESOURCE_BUNDLE 参数的值来建立动态/运行时关联。

    • 如果需要在与当前不同的区域设置中生成报表,则可以使用内置 REPORT_LOCALE 参数在填充报表时指定运行时区域设置。

  • 为了促进报表国际化,报表表达式内部可以使用特殊语法$R{}来引用放置在与报表关联的java.util.ResourceBundle对象内的java.lang.String资源。$ R{}字符语法根据必须放在括号之间的键从资源包中提取特定于区域设置的资源 -

<textFieldExpression>
   $R{report.title}
</textFieldExpression>

上面的文本字段通过根据运行时提供的区域设置和report.title键从与报告模板关联的资源包中提取字符串值来显示报告的标题。

  • 根据报告区域设置以不同语言格式化消息,报告中有一个内置方法net.sf.jasperreports.engine.fill.JRCalculator。此方法提供与java.text.MessageFormat类类似的功能。此方法 msg() 具有三个方便的签名,允许您在消息中使用最多三个消息参数。

  • 内置str()方法(相当于报表表达式中的 $R{} 语法),可根据报表区域设置访问资源包内容。

  • 对于日期和时间格式,可以使用内置 REPORT_TIME_ZONE 参数来确保正确的时间转换。

  • 在生成的输出中,该库保留有关文本运行方向的信息,以便可以正确呈现以从右到左书写的语言(如阿拉伯语和希伯来语)生成的文档。

  • 如果应用程序依赖内置的 Swing 查看器来显示生成的报告,则需要通过调整按钮工具提示或显示的其他文本来对其进行国际化。这很容易做到,因为查看器依赖于预定义的资源包来提取特定于区域设置的信息。该资源包的基本名称是net.sf.jasperreports.view.viewer。

例子

为了演示国际化,让我们编写新的报告模板(jasper_report_template.jrxml)。JRXML的内容如下所示。将其保存到 C:\tools\jasperreports-5.0.1\test 目录。

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

<!DOCTYPE jasperReport PUBLIC "//JasperReports//DTD Report Design//EN"
   "http://jasperreports.sourceforge.net/dtds/jasperreport.dtd">

<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" resourceBundle = "localizationdemo">
   
   <title>
      <band height = "552">
         
         <textField>
            <reportElement positionType = "Float" x = "150" y = "20" 
               width = "400" height = "50"/>
            
            <textElement>
               <font size = "24"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{REPORT_LOCALE}.getDisplayName ($P{REPORT_LOCALE})]]>
            </textFieldExpression>
         </textField>

         <textField isStretchWithOverflow = "true" isBlankWhenNull = "true">
            <reportElement positionType = "Float" x = "20" y = "125" 
               width = "530" height = "20"/>
            
            <textElement textAlignment = "Justified">
               <font size = "14"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$R{localization.text1}]]>
            </textFieldExpression>
         
         </textField>
      
      </band>
   </title>

</jasperReport>

在上面的文件中, <jasperReport>元素的resourceBundle属性告诉JasperReports从哪里获取用于报告的本地化字符串。我们需要创建一个根名称与属性值匹配的属性文件。填写报告时,该文件必须存在于 CLASSPATH 中的任何位置。在此示例中,属性文件localizationdemo.properties保存在目录C:\tools\jasperreports-5.0.1\test下。该文件的内容如下 -

localization.text1 = This is English text.

要使用不同的区域设置,文件名必须是localizationdemo[locale].properties。在这里,我们将为西班牙语语言环境编写一个文件。将此文件保存为 - C:\tools\jasperreports-5.0.1\test\localizationdemo_es.properties。该文件的内容如下 -

localization.text1 = Este texto es en Español.

获取resourceBundle属性值的语法是$R{key}。

为了让 JasperReports 知道我们希望使用什么区域设置,我们需要为内置参数分配一个值。该参数的名称被定义为一个名为 REPORT_LOCALE 的常量,并且该常量在net.sf.jasperreports.engine.JRParameter类中定义。该常量的值必须是java.util.Locale的实例。该逻辑被合并到java代码中来填充和生成报告。让我们将此文件JasperReportFillI18.java保存到 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint 目录。文件内容如下 -

package com.tutorialspoint;

import java.util.HashMap;
import java.util.Locale;

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

public class JasperReportFillI18 {

   public static void main(String[] args) {
      String sourceFileName = "C://tools/jasperreports-5.0.1/test/"
         + "jasper_report_template.jasper";
      HashMap parameterMap = new HashMap();
      if (args.length > 0) {
         parameterMap.put(JRParameter.REPORT_LOCALE, new Locale(args[0]));
      }
      try {
         JasperFillManager.fillReportToFile(sourceFileName, null, 
            new JREmptyDataSource());
      } catch (JRException e) {
         // TODO Auto-generated catch block
         e.printStackTrace();
      }

   }
}

报告生成

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

导入文件 - baseBuild.xml 取自“环境设置”一章,并且应放置在与 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.JasperReportFillI18(viewFullReport 是默认目标),如下所示 -

C:\tools\jasperreports-5.0.1\test>ant  -Dmain-class=com.tutorialspoint.JasperReportFillI18
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 to
   [javac] Compiling 1 source file to C:\tools\jasperreports-5.0.1\test\classes
   [javac] Note: C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\
      JasperReportFillI18.java
   uses unchecked or u
   [javac] Note: Recompile with -Xlint:unchecked for details.

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.JasperReportFillI18
   [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: 3 minutes 28 seconds

作为上述编译的结果,JasperViewer 窗口将打开,如下面给出的屏幕所示 -

Jasper 报告示例