原文： http://zetcode.com/articles/javaservletpdf/

Java servlet PDF 教程展示了如何从 Java servlet 返回 PDF 数据。 我们使用 iText 库处理 PDF。 该 Web 应用已部署在 Tomcat 服务器上。

PDF 格式

便携式文档格式（PDF）是用于以独立于应用软件，硬件和操作系统的方式呈现文档的文件格式。 PDF 由 Adobe 发明，现在是国际标准化组织（ISO）维护的开放标准。

Java Servlet

Servlet 是 Java 类，可响应特定类型的网络请求-最常见的是 HTTP 请求。 Java servlet 用于创建 Web 应用。 它们在 servlet 容器（例如 Tomcat 或 Jetty）中运行。 现代 Java Web 开发使用在 servlet 之上构建的框架。

iText

iText 是一个开放源代码库，用于在 Java 中创建和处理 PDF 文件。

Java Servlet PDF 应用

以下 Web 应用使用 Java Servlet 将 PDF 文件发送到客户端。 它从对象列表生成 PDF。

  1. $ tree
  2. .
  3. ├── pom.xml
  4. └── src
  5.     ├── main
  6.     │   ├── java
  7.     │   │   └── com
  8.     │   │       └── zetcode
  9.     │   │           ├── bean
  10.     │   │           │   └── City.java
  11.     │   │           ├── service
  12.     │   │           │   └── CityService.java
  13.     │   │           ├── util
  14.     │   │           │   └── GeneratePdf.java
  15.     │   │           └── web
  16.     │   │               └── MyServlet.java
  17.     │   └── webapp
  18.     │       ├── index.html
  19.     │       ├── META-INF
  20.     │       │   └── context.xml
  21.     │       └── WEB-INF
  22.     └── test
  23.         └── java

这是项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" 
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
  5. http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6.     <modelVersion>4.0.0</modelVersion>
  8.     <groupId>com.zetcode</groupId>
  9.     <artifactId>JavaServletPDF</artifactId>
  10.     <version>1.0-SNAPSHOT</version>
  11.     <packaging>war</packaging>
  13.     <name>JavaServletPDF</name>
  15.     <properties>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.         <maven.compiler.source>1.8</maven.compiler.source>
  18.         <maven.compiler.target>1.8</maven.compiler.target>
  19.     </properties>
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>javax.servlet</groupId>
  24.             <artifactId>javax.servlet-api</artifactId>
  25.             <version>3.1.0</version>
  26.             <scope>provided</scope>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>com.lowagie</groupId>
  31.             <artifactId>itext</artifactId>
  32.             <version>4.2.2</version>
  33.         </dependency>         
  35.     </dependencies>
  37.     <build>
  38.         <plugins>
  40.             <plugin>
  41.                 <groupId>org.apache.maven.plugins</groupId>
  42.                 <artifactId>maven-war-plugin</artifactId>
  43.                 <version>2.3</version>
  44.                 <configuration>
  45.                     <failOnMissingWebXml>false</failOnMissingWebXml>
  46.                 </configuration>
  47.             </plugin>
  49.         </plugins>
  50.     </build>   
  52. </project>

这是 Maven POM 文件。 我们有两个工件：用于 Java 的 servlet 的javax.servlet-api和用于 PDF 生成的itext。 maven-war-plugin负责收集 Web 应用的所有工件依赖项，类和资源，并将它们打包到 Web 应用存档（WAR）中。

context.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Context path="/JavaServletPdf"/>

在 Tomcat context.xml文件中，我们定义了上下文路径。 它是 Web 应用的名称。

City.java

  1. package com.zetcode.bean;
  3. public class City {
  5.     private Long id;
  6.     private String name;
  7.     private int population;
  9.     public City() {
  10.     }
  12.     public City(Long id, String name, int population) {
  13.         this.id = id;
  14.         this.name = name;
  15.         this.population = population;
  16.     }
  18.     public Long getId() {
  19.         return id;
  20.     }
  22.     public void setId(Long id) {
  23.         this.id = id;
  24.     }
  26.     public String getName() {
  27.         return name;
  28.     }
  30.     public void setName(String name) {
  31.         this.name = name;
  32.     }
  34.     public int getPopulation() {
  35.         return population;
  36.     }
  38.     public void setPopulation(int population) {
  39.         this.population = population;
  40.     }
  42.     @Override
  43.     public String toString() {
  44.         return "City{" + "id=" + id + ", name=" + name + 
  45.                 ", population=" + population + '}';
  46.     }
  47. }

这是City bean。 它具有三个属性：id，name和population。

MyServlet.java

  1. package com.zetcode.web;
  3. import com.zetcode.bean.City;
  4. import com.zetcode.service.CityService;
  5. import com.zetcode.util.GeneratePdf;
  6. import java.io.ByteArrayOutputStream;
  7. import java.io.IOException;
  8. import java.util.List;
  9. import javax.servlet.ServletException;
  10. import javax.servlet.ServletOutputStream;
  11. import javax.servlet.annotation.WebServlet;
  12. import javax.servlet.http.HttpServlet;
  13. import javax.servlet.http.HttpServletRequest;
  14. import javax.servlet.http.HttpServletResponse;
  16. @WebServlet(name = "MyServlet", urlPatterns = {"/MyServlet"})
  17. public class MyServlet extends HttpServlet {
  19.     @Override
  20.     protected void doGet(HttpServletRequest request, HttpServletResponse response)
  21.             throws ServletException, IOException {
  23.         response.setContentType("application/pdf;charset=UTF-8");
  25.         response.addHeader("Content-Disposition", "inline; filename=" + "cities.pdf");
  26.         ServletOutputStream out = response.getOutputStream();
  28.         List<City> cities = CityService.getCities();
  30.         ByteArrayOutputStream baos = GeneratePdf.getPdfFile(cities);
  31.         baos.writeTo(out);
  32.     }
  33. }

这是MyServlet servlet。 它从服务类检索数据，从数据生成 PDF 文件，然后将 PDF 文件返回给客户端。

  1. response.setContentType("application/pdf;charset=UTF-8");

我们将响应对象的内容类型设置为application/pdf。

  1. response.addHeader("Content-Disposition", "inline; filename=" + "cities.pdf");

Content-Disposition响应标头指示内容应在浏览器中显示为inline，即作为 Web 页面或 Web 页面的一部分，或作为attachment在本地下载和保存。 。 可选的filename伪指令指定传输文件的名称。

  1. ServletOutputStream out = response.getOutputStream();

我们从响应对象获得ServletOutputStream。

  1. List<City> cities = CityService.getCities();

从CityService中，我们可以获得城市列表。

  1. List<City> cities = CityService.getCities();

从CityService中，我们可以获得城市列表。

  1. ByteArrayOutputStream baos = GeneratePdf.getPdfFile(cities);
  2. baos.writeTo(out);

我们根据数据生成 PDF 文件，并将返回的ByteArrayOutputStream写入ServletOutputStream。

CityService.java

  1. package com.zetcode.service;
  3. import com.zetcode.bean.City;
  4. import java.util.ArrayList;
  5. import java.util.List;
  7. public class CityService {
  9.     public static List<City> getCities() {
  11.         List<City> cities = new ArrayList<>();
  13.         cities.add(new City(1L, "Bratislava", 432000));
  14.         cities.add(new City(2L, "Budapest", 1759000));
  15.         cities.add(new City(3L, "Prague", 1280000));
  16.         cities.add(new City(4L, "Warsaw", 1748000));
  17.         cities.add(new City(5L, "Los Angeles", 3971000));
  18.         cities.add(new City(6L, "New York", 8550000));
  19.         cities.add(new City(7L, "Edinburgh", 464000));
  20.         cities.add(new City(8L, "Berlin", 3671000));
  22.         return cities;
  23.     }
  24. }

CityService的getCities()方法返回城市对象的列表。

GeneratePdf.java

  1. package com.zetcode.util;
  3. import com.itextpdf.text.Document;
  4. import com.itextpdf.text.DocumentException;
  5. import com.itextpdf.text.Element;
  6. import com.itextpdf.text.Font;
  7. import com.itextpdf.text.FontFactory;
  8. import com.itextpdf.text.Phrase;
  9. import com.itextpdf.text.pdf.PdfPCell;
  10. import com.itextpdf.text.pdf.PdfPTable;
  11. import com.itextpdf.text.pdf.PdfWriter;
  12. import com.zetcode.bean.City;
  13. import java.io.ByteArrayOutputStream;
  14. import java.util.List;
  15. import java.util.logging.Level;
  16. import java.util.logging.Logger;
  18. public class GeneratePdf {
  20.     public static ByteArrayOutputStream getPdfFile(List<City> cities) {
  22.         Document document = new Document();
  23.         ByteArrayOutputStream bout = new ByteArrayOutputStream();
  25.         try {
  27.             PdfPTable table = new PdfPTable(3);
  28.             table.setWidthPercentage(60);
  29.             table.setWidths(new int[]{1, 3, 3});
  31.             Font headFont = FontFactory.getFont(FontFactory.HELVETICA_BOLD);
  33.             PdfPCell hcell;
  34.             hcell = new PdfPCell(new Phrase("Id", headFont));
  35.             hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
  36.             table.addCell(hcell);
  38.             hcell = new PdfPCell(new Phrase("Name", headFont));
  39.             hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
  40.             table.addCell(hcell);
  42.             hcell = new PdfPCell(new Phrase("Population", headFont));
  43.             hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
  44.             table.addCell(hcell);
  46.             for (City city : cities) {
  48.                 PdfPCell cell;
  50.                 cell = new PdfPCell(new Phrase(city.getId().toString()));
  51.                 cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
  52.                 cell.setHorizontalAlignment(Element.ALIGN_CENTER);
  53.                 table.addCell(cell);
  55.                 cell = new PdfPCell(new Phrase(city.getName()));
  56.                 cell.setPaddingLeft(5);
  57.                 cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
  58.                 cell.setHorizontalAlignment(Element.ALIGN_LEFT);
  59.                 table.addCell(cell);
  61.                 cell = new PdfPCell(new Phrase(String.valueOf(city.getPopulation())));
  62.                 cell.setVerticalAlignment(Element.ALIGN_MIDDLE);
  63.                 cell.setHorizontalAlignment(Element.ALIGN_RIGHT);
  64.                 cell.setPaddingRight(5);
  65.                 table.addCell(cell);
  66.             }
  68.             PdfWriter.getInstance(document, bout);
  69.             document.open();
  70.             document.add(table);
  72.             document.close();
  74.         } catch (DocumentException ex) {
  76.             Logger.getLogger(GeneratePdf.class.getName()).log(Level.SEVERE, null, ex);
  77.         }
  79.         return bout; 
  80.     }
  81. }

GeneratePdf根据提供的数据创建 PDF 文件。

  1. ByteArrayOutputStream bout = new ByteArrayOutputStream();

数据将被写入ByteArrayOutputStream。 ByteArrayOutputStream实现了一个输出流，其中数据被写入字节数组。

  1. PdfPTable table = new PdfPTable(3);

我们将数据放在表格中； 为此，我们有PdfPTable类。 该表具有三列：ID，名称和人口。

  1. Font headFont = FontFactory.getFont(FontFactory.HELVETICA_BOLD);

我们使用粗体 Helvetica 字体作为表标题。

  1. PdfPCell hcell;
  2. hcell = new PdfPCell(new Phrase("Id", headFont));
  3. hcell.setHorizontalAlignment(Element.ALIGN_CENTER);
  4. table.addCell(hcell);

数据放置在表单元格内，由PdfPCell表示。 setHorizontalAlignment()方法使文本水平对齐。

  1. PdfWriter.getInstance(document, bout);

使用PdfWriter，将文档写入ByteArrayOutputStream。

  1. document.open();
  2. document.add(table);

该表将插入到 PDF 文档中。

  1. document.close();

为了将数据写入ByteArrayOutputStream，必须关闭文档。

  1. return bout;

最后，数据返回为ByteArrayOutputStream。

在本教程中，我们从 Java servlet 发送了 PDF 数据。

您可能也对以下相关教程感兴趣： Java RequestDispatcher ， Java Servlet 图表教程，从 Java Servlet 提供纯文本， Java Servlet 检查框教程， Java servlet 图像教程， Java Servlet HTTP 标头或 Java 教程