JasperReports-plugin 技术文档

1. 安装指南

1.1 环境要求

• Java 开发环境
• Maven 构建工具

1.2 安装步骤

1. 在项目的 pom.xml 文件中添加 jasperreports-plugin 插件。
2. 配置插件的 groupId、artifactId 和 version。
3. 根据需要配置插件的其他选项。

示例配置如下：

<build>
    <plugins>
        <plugin>
            <groupId>com.alexnederlof</groupId>
            <artifactId>jasperreports-plugin</artifactId>
            <version>2.8</version>
            <executions>
                <execution>
                    <phase>process-sources</phase>
                    <goals>
                        <goal>jasper</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!-- 默认配置 -->
                <compiler>net.sf.jasperreports.engine.design.JRJdtCompiler</compiler>
                <sourceDirectory>src/main/jasperreports</sourceDirectory>
                <outputDirectory>${project.build.directory}/jasper</outputDirectory>
                <outputFileExt>.jasper</outputFileExt>
                <xmlValidation>true</xmlValidation>
                <verbose>false</verbose>
                <numberOfThreads>4</numberOfThreads>
                <failOnMissingSourceDirectory>true</failOnMissingSourceDirectory>
                <sourceScanner>org.codehaus.plexus.compiler.util.scan.StaleSourceScanner</sourceScanner>
            </configuration>
        </plugin>
    </plugins>
</build>

2. 项目的使用说明

2.1 插件的基本使用

在 pom.xml 中配置好插件后，Maven 会在 process-sources 阶段自动编译 Jasper 文件到目标目录。

2.2 自定义配置

可以通过 configuration 标签自定义插件的配置，例如：

• Jasper 编译器选项：

  <configuration>
      <additionalProperties>
          <net.sf.jasperreports.awt.ignore.missing.font>true</net.sf.jasperreports.awt.ignore.missing.font>
          <net.sf.jasperreports.default.pdf.font.name>Courier</net.sf.jasperreports.default.pdf.font.name>
          <net.sf.jasperreports.default.pdf.encoding>UTF-8</net.sf.jasperreports.default.pdf.encoding>
          <net.sf.jasperreports.default.pdf.embedded>true</net.sf.jasperreports.default.pdf.embedded>
      </additionalProperties>
  </configuration>
  

• 添加额外的 classpath 元素：

  <configuration>
      <classpathElements>
          <element>your.classpath.element</element>
      </classpathElements>
  </configuration>
  

• 使用 JAR 文件的替代方法：

  <configuration>
      <additionalClasspath>/web/lib/ServiceBeans.jar;/web/lib/WebForms.jar</additionalClasspath>
  </configuration>
  

3. 项目API使用文档

3.1 插件目标

• jasper：编译 Jasper 文件到目标目录。

3.2 配置参数

• compiler：指定 Jasper 编译器，默认为 net.sf.jasperreports.engine.design.JRJdtCompiler。
• sourceDirectory：Jasper 文件的源目录，默认为 src/main/jasperreports。
• outputDirectory：输出目录，默认为 ${project.build.directory}/jasper。
• outputFileExt：输出文件的扩展名，默认为 .jasper。
• xmlValidation：是否启用 XML 验证，默认为 true。
• verbose：是否启用详细输出，默认为 false。
• numberOfThreads：编译线程数，默认为 4。
• failOnMissingSourceDirectory：如果源目录不存在是否失败，默认为 true。
• sourceScanner：源文件扫描器，默认为 org.codehaus.plexus.compiler.util.scan.StaleSourceScanner。

3.3 自定义属性

可以通过 additionalProperties 标签添加自定义的 Jasper 编译器选项。

3.4 额外的 classpath

可以通过 classpathElements 或 additionalClasspath 标签添加额外的 classpath 元素。

4. 项目安装方式

4.1 Maven 安装

通过在 pom.xml 中添加插件配置，Maven 会自动下载并安装插件。

4.2 手动安装

如果需要手动安装插件，可以从 Maven 中央仓库下载插件的 JAR 文件，并将其添加到项目的 classpath 中。

---

通过以上步骤，您可以成功安装并使用 JasperReports-plugin 插件，编译 Jasper 文件并生成目标文件。