Spring Boot Web JasperReports 集成 · ZetCode 中文系列教程

# Spring Boot Web JasperReports 集成 > 原文： [http://zetcode.com/articles/jasperspringbootweb/](http://zetcode.com/articles/jasperspringbootweb/) 在本教程中，我們展示如何在 Spring Boot 框架中使用 JasperReports。我們創建一個 Web 應用。 JasperReports 是一個 Java 開源報告庫。它可以創建各種格式的報告，包括 PDF，HTML，XLS 或 CSV。 JasperReports 以一種簡單而靈活的方式創建了面向頁面的可打印文檔。 `JdbcTemplate`是一個 Spring 庫，可以幫助程序員創建與關系數據庫和 JDBC 一起使用的應用。它會處理許多繁瑣且容易出錯的底層細節，例如處理事務，清理資源以及正確處理異常。 `JdbcTemplate`在 Spring 的`spring-jdbc`模塊中提供。 Spring 是用于開發 Java 企業應用的 Java 應用框架。它還有助于集成各種企業組件。 Spring Boot 使創建具有 Spring 動力的生產級應用和服務變得很容易，而對安裝的要求卻最低。 Apache Derby 是完全用 Java 實現的開源關系數據庫。它占地面積小，易于部署和安裝。它可以在嵌入式和客戶端/服務器模式下運行。 ## `CARS`表我們使用下表： `cars.sql` ```java -- SQL for the CARS table CREATE TABLE CARS(ID BIGINT NOT NULL PRIMARY KEY GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1), NAME VARCHAR(30), PRICE INT); INSERT INTO CARS(Name, Price) VALUES('Audi', 52642); INSERT INTO CARS(Name, Price) VALUES('Mercedes', 57127); INSERT INTO CARS(Name, Price) VALUES('Skoda', 9000); INSERT INTO CARS(Name, Price) VALUES('Volvo', 29000); INSERT INTO CARS(Name, Price) VALUES('Bentley', 350000); INSERT INTO CARS(Name, Price) VALUES('Citroen', 21000); INSERT INTO CARS(Name, Price) VALUES('Hummer', 41400); INSERT INTO CARS(Name, Price) VALUES('Volkswagen', 21600); ``` `cars.sql`文件創建`CARS`表。 ```java $ $DERBY_HOME/bin/ij ij version 10.11 ij> CONNECT 'jdbc:derby:testdb'; ij> RUN 'cars.sql'; ``` 一種選擇是使用`ij`工具從 SQL 腳本創建表。請參考 [Apache Derby 教程](/db/apachederbytutorial/)以熟悉 Derby。 ```java $ $DERBY_HOME/bin/NetworkServerControl start & ``` 使用`NetworkServerControl`工具啟動 Derby 服務器。 ## 應用以下 Spring Boot 應用從數據庫表加載數據，并使用 JasperReports 庫從中生成 PDF 報告。該應用與嵌入式 Tomcat 服務器一起運行。 ```java $ tree . ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── zetcode │ │ ├── Application.java │ │ ├── bean │ │ │ └── Car.java │ │ ├── conf │ │ │ ├── AppConfig.java │ │ │ └── MvcConf.java │ │ ├── controller │ │ │ └── MyController.java │ │ └── service │ │ ├── CarService.java │ │ └── ICarService.java │ └── resources │ ├── application.yml │ ├── report2.jrxml │ └── static │ └── index.html └── test └── java ``` 這是項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>JasperSpringBootWeb</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.2.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.apache.derby</groupId> <artifactId>derbyclient</artifactId> <version>10.13.1.1</version> </dependency> <dependency> <groupId>net.sf.jasperreports</groupId> <artifactId>jasperreports</artifactId> <version>6.4.0</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ``` Maven `pom.xml`文件包含 JasperReports 庫，Derby 驅動程序和 Spring Boot 的依賴項。 `report2.xml` ```java <?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="report2" pageWidth="595" pageHeight="842" columnWidth="555" leftMargin="20" rightMargin="20" topMargin="20" bottomMargin="20"> <field name="Id" class="java.lang.Long"> <fieldDescription><![CDATA[id]]></fieldDescription> </field> <field name="Name" class="java.lang.String"> <fieldDescription><![CDATA[name]]></fieldDescription> </field> <field name="Price" class="java.lang.Integer"> <fieldDescription><![CDATA[price]]></fieldDescription> </field> <detail> <band height="15"> <textField> <reportElement x="0" y="0" width="50" height="15" /> <textElement textAlignment="Right" verticalAlignment="Middle"/> <textFieldExpression class="java.lang.Long"> <![CDATA[$F{Id}]]> </textFieldExpression> </textField> <textField> <reportElement x="150" y="0" width="100" height="15" /> <textElement textAlignment="Left" verticalAlignment="Middle"/> <textFieldExpression class="java.lang.String"> <![CDATA[$F{Name}]]> </textFieldExpression> </textField> <textField> <reportElement x="200" y="0" width="100" height="15"/> <textElement textAlignment="Right" verticalAlignment="Middle"/> <textFieldExpression class="java.lang.Integer"> <![CDATA[$F{Price}]]> </textFieldExpression> </textField> </band> </detail> </jasperReport> ``` 這是報告模板文件。它位于`src/main/resources`目錄中。模板僅包含明細帶。在詳細信息區域內，將對數據源提供的每個記錄重復每個元素。 ```java <field name="Id" class="java.lang.Long"> <fieldDescription><![CDATA[id]]></fieldDescription> </field> <field name="Name" class="java.lang.String"> <fieldDescription><![CDATA[name]]></fieldDescription> </field> <field name="Price" class="java.lang.Integer"> <fieldDescription><![CDATA[price]]></fieldDescription> </field> ``` 報告中有三個字段。這些字段映射到數據源 bean 的元素。 ```java <textField> <reportElement x="0" y="0" width="50" height="15" /> <textElement textAlignment="Right" verticalAlignment="Middle"/> <textFieldExpression class="java.lang.Long"> <![CDATA[$F{Id}]]> </textFieldExpression> </textField> ``` 文本字段是充滿動態數據的元素。我們將一個字段中的值放在文本字段中。我們使用`$F{}`語法引用該變量。 `Car.java` ```java package com.zetcode.bean; public class Car { private Long id; private String name; private int price; public Car() {} public Car(Long id, String name, int price) { this.id = id; this.name = name; this.price = price; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getPrice() { return price; } public void setPrice(int price) { this.price = price; } @Override public String toString() { return "Car{" + "id=" + id + ", name=" + name + ", price=" + price + '}'; } } ``` 這是`Car` bean 類。它包含商品 ID，名稱和價格。 `application.yml` ```java datasource: url: jdbc:derby://localhost:1527/testdb username: app password: app driverClassName: org.apache.derby.jdbc.ClientDriver ``` `application.yml`是主要的 Spring Boot 配置文件。它包含 Derby 數據源。 `AppConfig.java` ```java package com.zetcode.conf; import javax.sql.DataSource; import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary; @Configuration public class AppConfig { @Bean @Primary @ConfigurationProperties(prefix = "datasource") public DataSource primaryDataSource() { return DataSourceBuilder.create().build(); } } ``` `AppConfig`是 Java 配置類。它從配置文件創建數據源 bean。 `MyController.java` ```java package com.zetcode.controller; import com.zetcode.service.ICarService; import java.util.HashMap; import java.util.Map; import java.util.logging.Level; import java.util.logging.Logger; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.servlet.ModelAndView; import org.springframework.web.servlet.view.jasperreports.JasperReportsPdfView; @Controller public class MyController { @Autowired private ApplicationContext appContext; @Autowired private ICarService carService; @RequestMapping(path = "/pdf", method = RequestMethod.GET) public ModelAndView report() { JasperReportsPdfView view = new JasperReportsPdfView(); view.setUrl("classpath:report2.jrxml"); view.setApplicationContext(appContext); Map<String, Object> params = new HashMap<>(); params.put("datasource", carService.findAll()); return new ModelAndView(view, params); } } ``` 在`MyController`中，我們有兩種方法可以響應兩個請求。 ```java @Autowired private ICarService carService; ``` 我們將`CarService`對象注入到屬性中。服務對象用于從數據庫檢索數據。 ```java @RequestMapping(path = "/pdf", method = RequestMethod.GET) public ModelAndView report() { JasperReportsPdfView view = new JasperReportsPdfView(); view.setUrl("classpath:report2.jrxml"); view.setApplicationContext(appContext); Map<String, Object> params = new HashMap<>(); params.put("datasource", carService.getCars()); return new ModelAndView(view, params); } ``` 在`report()`方法中，將生成報告并將其發送回客戶端。 `JasperReportsPdfView`是 Spring 類，可從提供的模板和數據生成 PDF 報告。 `ICarService.java` ```java package com.zetcode.service; import com.zetcode.bean.Car; import java.util.List; public interface ICarService { public List<Car> findAll(); } ``` `ICarService`提供了一種從數據源獲取所有汽車的契約方法。 `CarService.java` ```java package com.zetcode.service; import com.zetcode.bean.Car; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.BeanPropertyRowMapper; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.stereotype.Service; @Service public class CarService implements ICarService { @Autowired private JdbcTemplate jtm; @Override public List<Car> findAll() { String sql = "SELECT * FROM Cars"; List<Car> cars = jtm.query(sql, new BeanPropertyRowMapper(Car.class)); return cars; } } ``` `CarService`包含`findAll()`方法的實現。我們借助`JdbcTemplate`從`CARS`表中檢索所有汽車。 ```java @Autowired private JdbcTemplate jtm; ``` 注入`JdbcTemplate`。 ```java String sql = "SELECT * FROM Cars"; ``` 這是要執行的 SQL。我們從`CARS`表中選擇所有汽車。 ```java List<Car> cars = jtm.query(sql, new BeanPropertyRowMapper(Car.class)); ``` `BeanPropertyRowMapper`將一行轉換為指定映射目標類的新實例。 `index.html` ```java <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Home Page</title> </head> <body> <a href="/pdf.html">Generate report</a> </body> </html> ``` `index.html`文件包含一個生成 PDF 報告的鏈接。 `Application.java` ```java package com.zetcode; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` `Application`設置 Spring Boot 應用。在本教程中，我們使用 JasperReports 創建了 PDF 報告。該應用使用 Spring Boot 框架，并在 Web 環境中運行。您可能也對這些相關教程感興趣： [Spring Boot JasperReports CMD 集成](/articles/jasperspringbootcmd/)，[使用 JasperReports API 創建報告](/articles/jasperprog/)，[使用 JasperReports](/articles/jaspercsv/) 從 CSV 創建報告。 [Java 教程](/lang/java/)。