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键从与报表模板关联的资源包中提取String值来显示报表的标题。

  • 根据报表区域设置格式化不同语言的消息，报表中有一个内置方法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 https://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 Report Example
打印页面
上一页
下一页
广告
© . All rights reserved.