iText XML Worker修改源码完美支持HTML中文字符转PDF

作者: Michael 日期: 2012 年 11 月 26 日发表评论 (54) 查看评论

目录：

介绍
中文字符转换
转换效果

[一]、介绍

XML Worker是辅助iText用于把XML、XHTML转换PDF的一个开源的软件工具库，详细介绍可以参见下面的链接：

官网地址：http://sourceforge.net/projects/xmlworker/
在线转换的Demo：http://demo.itextsupport.com/xmlworker/
在线文档：http://demo.itextsupport.com/xmlworker/itextdoc/index.html
在线文档：http://demo.itextsupport.com/xmlworker/itextdoc/flatsite.html

[二]、中文字符问题

如果HTML文件中包含中文字符，在转换成PDF是会无法显示，简单看了下它的源码，发现XML Worker无法设置默认字体，只好修改它的部分源码实现中文字符的转换。

附件提供修改后的lib包下载：xmlworker-1.2.1-micmiu.jar.zip （源码：https://github.com/micmiu/micmiu-xmlworker）

修改：com.itextpdf.tool.xml.css.apply.ChunkCssApplier.java 中的 public Chunk apply(final Chunk c, final Tag t) 这个方法，增加如下逻辑判断：

Font f = applyFontStyles(t);
// for chinese charater display @www.micmiu.com
if (null != HTMLUtils.bfCN && HTMLUtils.isChinese(c.getContent())) {
	f = new Font(HTMLUtils.bfCN, f.getSize(), f.getStyle(),
			f.getColor());
}
 float size = f.getSize();
......

Font f = applyFontStyles(t);

// for chinese charater display @www.micmiu.com

if (null != HTMLUtils.bfCN && HTMLUtils.isChinese(c.getContent())) {

f = new Font(HTMLUtils.bfCN, f.getSize(), f.getStyle(),

f.getColor());

}

float size = f.getSize();

......

在：com.itextpdf.tool.xml.html.HTMLUtils.java 中增加下面用于中文字符判断的方法：

public static BaseFont bfCN = null;
	static {
		try {
			bfCN = BaseFont.createFont("STSongStd-Light", "UniGB-UCS2-H",
					BaseFont.NOT_EMBEDDED);
		} catch (Exception e) {
		}
	}

	// add by Michael more see：http://www.micmiu.com
 	private static final boolean isChinese(char c) {
 		Character.UnicodeBlock ub = Character.UnicodeBlock.of(c);
 		if (ub == Character.UnicodeBlock.CJK_UNIFIED_IDEOGRAPHS
 				|| ub == Character.UnicodeBlock.CJK_COMPATIBILITY_IDEOGRAPHS
 				|| ub == Character.UnicodeBlock.CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A
 				|| ub == Character.UnicodeBlock.GENERAL_PUNCTUATION
 				|| ub == Character.UnicodeBlock.CJK_SYMBOLS_AND_PUNCTUATION
 				|| ub == Character.UnicodeBlock.HALFWIDTH_AND_FULLWIDTH_FORMS) {
 			return true;
 		}
 		return false;
 	}
 	// add by Michael more see：http://www.micmiu.com
 	public static final boolean isChinese(String strName) {
 		char[] ch = strName.toCharArray();
 		for (int i = 0; i < ch.length; i++) {
 			char c = ch[i];
 			if (isChinese(c)) {
 				return true;
 			}
 		}
 		return false;
 	}

public static BaseFont bfCN = null;

static {

try {

bfCN = BaseFont.createFont("STSongStd-Light", "UniGB-UCS2-H",

BaseFont.NOT_EMBEDDED);

} catch (Exception e) {

}

// add by Michael more see：http://www.micmiu.com

private static final boolean isChinese(char c) {

Character.UnicodeBlock ub = Character.UnicodeBlock.of(c);

if (ub == Character.UnicodeBlock.CJK_UNIFIED_IDEOGRAPHS

|| ub == Character.UnicodeBlock.CJK_COMPATIBILITY_IDEOGRAPHS

|| ub == Character.UnicodeBlock.CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A

|| ub == Character.UnicodeBlock.GENERAL_PUNCTUATION

|| ub == Character.UnicodeBlock.CJK_SYMBOLS_AND_PUNCTUATION

|| ub == Character.UnicodeBlock.HALFWIDTH_AND_FULLWIDTH_FORMS) {

return true;

}

return false;

}

// add by Michael more see：http://www.micmiu.com

public static final boolean isChinese(String strName) {

char[] ch = strName.toCharArray();

for (int i = 0; i < ch.length; i++) {

char c = ch[i];

if (isChinese(c)) {

return true;

}

return false;

}

[三]、转换效果

演示一个简单的HTML文件：demo-cn.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" dir="ltr" lang="zh-CN">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>iText xmlworker</title>
</head>
<body>
<div>
	<p>[ Hello iText English ]</p>
	<p>[ 你好 iText 这是中文 ]</p>
</div>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>iText xmlworker</title>

</head>

<body>

<div>

<p>[ Hello iText English ]</p>

<p>[ 你好 iText 这是中文 ]</p>

</div>

</body>

</html>

转PDF的程序: Demo4HTMLCn.java

package com.micmiu.pdf.itext;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStreamReader;

import com.itextpdf.text.Document;
import com.itextpdf.text.pdf.PdfWriter;
import com.itextpdf.tool.xml.XMLWorkerHelper;

/**
 * 测试xml worker 页面包含中文字符的转换
 *
 * @author <a href="http://www.micmiu.com">Michael Sun</a>
 */
public class Demo4HTMLCn {

	/**
	 * @param args
	 */
	public static void main(String[] args) throws Exception {
		String pdfFile = "d:/test/itext/demo-htmlcn.pdf";
		String htmlFile = "d:/test/itext/demo-cn.html";

		Document document = new Document();
		PdfWriter pdfwriter = PdfWriter.getInstance(document,
				new FileOutputStream(pdfFile));
		pdfwriter.setViewerPreferences(PdfWriter.HideToolbar);
		document.open();

		// html文件
		InputStreamReader isr = new InputStreamReader(new FileInputStream(
				htmlFile), "UTF-8");
		XMLWorkerHelper.getInstance().parseXHtml(pdfwriter, document, isr);
		document.close();

	}

}

package com.micmiu.pdf.itext;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.InputStreamReader;

import com.itextpdf.text.Document;

import com.itextpdf.text.pdf.PdfWriter;

import com.itextpdf.tool.xml.XMLWorkerHelper;

/**

* 测试xml worker 页面包含中文字符的转换

* @author <a href="http://www.micmiu.com">Michael Sun</a>

public class Demo4HTMLCn {

/**

* @param args

public static void main(String[] args) throws Exception {

String pdfFile = "d:/test/itext/demo-htmlcn.pdf";

String htmlFile = "d:/test/itext/demo-cn.html";

Document document = new Document();

PdfWriter pdfwriter = PdfWriter.getInstance(document,

new FileOutputStream(pdfFile));

pdfwriter.setViewerPreferences(PdfWriter.HideToolbar);

document.open();

// html文件

InputStreamReader isr = new InputStreamReader(new FileInputStream(

htmlFile), "UTF-8");

XMLWorkerHelper.getInstance().parseXHtml(pdfwriter, document, isr);

document.close();

}

HTML页面、修改源码前、修改源码后的效果对比图如下：

从上图可知，修改源码后，基本实现了对HTML的中文字符的支持。

本文介绍到此结束@Michael Sun.

原创文章，转载请注明： 转载自micmiu – 软件开发+生活点滴[ http://www.micmiu.com/ ]

本文链接地址: http://www.micmiu.com/opensource/expdoc/itext-xml-worker-cn/

生成文档iText, java, 中文字符

← iText生成PDF的书签

iText XML Worker实现HTML转PDF →

发表评论？

54 条评论。

tlj247 2016 年 12 月 1 日在下午 9:11

无法支持table显示，itextpdf和itext-asian版本是哪个呢，我这无法显示table？

回复
phxism 2016 年 11 月 29 日在下午 3:59

现在测试中文是可以了,但是英文的样式都变了,
What a beautiful world 样式上变成”W hata beautifu lw orld”,难道是是fontsize的原因?
com.itextpdf
itextpdf
5.5.10

com.itextpdf
itext-asian
5.2.0

com.itextpdf.tool
xmlworker
5.5.10

回复
坚持到底 2016 年 8 月 31 日在下午 8:17

你好，我把你说的源码git下来以后打包使用，中文还是在pdf上显示不出来呢？help

回复
小谭 2015 年 12 月 16 日在下午 12:18

感谢博主，我想请问一下，我在调用XMLWorkerHelper.getInstance().parseXHtml(pdfwriter, document, isr);时始终报java.lang.NoClassDefFoundError: com/itextpdf/text/log/LoggerFactory，求博主解答！

回复
- 波波 2016 年 12 月 27 日在下午 2:22
  
  我在调用XMLWorkerHelper.getInstance().parseXHtml(pdfwriter, document, isr);时始终报java.lang.NoClassDefFoundError: com/itextpdf/text/log/LoggerFactory，
  我也遇到了相同问题，百度无果，求解答，能不能给我的邮箱发一份解决办法，小菜再此感激不尽
  
  回复
烈焰 2015 年 12 月 16 日在上午 10:28

楼主你好，请问一下、我按照做好的程序，之后，除了数字和英文的变量替换后是不换行的，中文可以、、有没有办法解决，英文和数字不换行的问题

回复
青核桃 2015 年 11 月 27 日在上午 11:26

特殊字符，比如●生成pdf是空白

回复
蓝ai冰 2015 年 5 月 13 日在下午 3:48

你这个功能实在太强大了！！！ 😯 😯 😯

回复
晨晨 2015 年 3 月 30 日在上午 9:45

您好，我把你的源码放上后，发现，转化后，中午和数字都没有，只有表格，是不是对html有要求啊？有qq吗，给个，急需要解决下，谢谢，发到邮箱即可。

回复
- Michael 2015 年 4 月 13 日在上午 7:18
  
  对html 没有特别要求，只是table 中嵌套某些标签会不识别，之前有个朋友也和你一样的问题
  
  回复
dick 2015 年 2 月 2 日在下午 5:17

但如果，html中有繁体中文就会乱码的。

回复
- Michael 2015 年 2 月 3 日在上午 11:31
  
  嗯这个要自己扩展修改的
  
  回复
CCCC 2015 年 1 月 8 日在下午 3:25

为什么我和你一样的操作，代码也一样，jar包用的你修改好的，IText版本也是一样的，为什么中文还是不显示呢？好郁闷呢啊

回复
cughuan 2014 年 10 月 12 日在下午 10:25

你好，请问是否可以将xmlworker-1.2.1-micmiu.jar.zip 的源码也附上呢？我按照你的方法实现了一下，不知是否是版本问题，执行后没有效果。

回复
- Michael 2014 年 11 月 24 日在下午 5:07
  
  https://github.com/micmiu/micmiu-xmlworker
  
  回复
amy 2014 年 7 月 30 日在下午 3:37

您好，我引入 jar 版本是： 5.4.2。
修改后，将html 的转换为 element 加到 pdf 中，但是中文字符不显示。请帮忙看一下，谢谢啦

回复
qtxcf1314 2014 年 7 月 2 日在下午 6:02

您好！我用的是xmlworker-5.5.1.jar，按照您的方法改了代码后不成功呢，希望您能帮帮我

回复
Michael 2014 年 7 月 2 日在下午 12:31

苦扰了好久的问题终于解决了，谢谢大牛~

回复
zyh 2014 年 5 月 12 日在下午 5:25

😳

回复
阿纯 2014 年 4 月 25 日在下午 1:18

为什么我试了一下不好呢

回复
- Michael 2014 年 4 月 29 日在上午 9:52
  
  源码修改的地址：https://github.com/micmiu/micmiu-xmlworker，我用来转换blog的项目代码：https://github.com/micmiu/blog-exp-tool
  可以看看
  
  回复
godit 2014 年 4 月 10 日在下午 4:59

望解决：

我三个jar：itext-asian-5.1.1.jar itextpdf-5.1.2.jar xmlworker-1.2.1-micmiu.jar ，和你一样的代码，报 java.io.IOException: The document has no pages.

回复
godit 2014 年 4 月 10 日在下午 4:59

望解决：

我三个jar：itext-asian-5.1.1.jar itextpdf-5.1.2.jar xmlworker-1.2.1-micmiu.jar ，和你一样的代码，报

回复
godit 2014 年 4 月 10 日在下午 4:58

忘解决：

回复
lhf324 2014 年 3 月 28 日在下午 1:53

请问你当时用的itext版本号是多少？我下了itext5.3.4和你的 xmlworker-1.2.1-micmiu.jar一起用，但是中文还是显示不了

回复
- Michael 2014 年 3 月 31 日在下午 6:36
  
  https://github.com/micmiu/blog-exp-tool/blob/master/pom.xml 应该是5.3.2
  
  回复
lance 2013 年 11 月 18 日在上午 9:40

求助博主，我下载xmlworker-5.4.1-sources.jar包，按照您文章所说修改了源码，但是我该如何把这个.java文件编译成,class文件替换到xmlworker-5.4.1.jar包中去，谢谢 😆

回复
- Michael 2013 年 11 月 21 日在下午 4:38
  
  如果是用IDE 直接打包导出即可，如果是直接编辑源码，用 ant 或者 maven 编译，甚至是原生jdk 都可以
  
  回复
  - lance 2013 年 11 月 25 日在下午 4:22
    
    博主，能把你使用的jar包，发我邮箱吗liu.019(#)qq.com？我修改了xmlworker-5.4.0的源码,然后与itextpdf 5.1到5.42都不成功 😥
    
    回复
lyl 2013 年 8 月 14 日在下午 3:24

高手，太崇拜你了，真是帮我解决了一个大问题，非常感谢你的分享！

回复
C#怎么改~ 2013 年 5 月 7 日在上午 8:51

C#怎么改~

回复
- Michael 2013 年 5 月 12 日在上午 11:49
  
  这个不了解的
  
  回复
左耳朵猫熊 2013 年 3 月 18 日在下午 5:11

请问,如果涉及到图片的问题怎么解决的?

回复
- Michael 2013 年 3 月 18 日在下午 5:23
  
  如果是在线的网页它可以根据url自己去读取图片转换，如果是加载自己本地的需要自己写个类实现
  
  回复
  - 鱼 2013 年 4 月 27 日在上午 10:38
    
    如果是相对路径和css中的图片就加载不了这个您实现过吗？
    
    回复
    - Michael 2013 年 4 月 27 日在上午 11:06
      
      相对路径的图片是支持的，我在官方文档里看到过，但是css 中的图片我就不清楚了
      
      回复
      - 鱼 2013 年 4 月 27 日在上午 11:10
        
        我试了下相对的不行
        我能加你qq吗方便和你谈论下？
      - Michael 2013 年 4 月 27 日在下午 2:18
        
        ok 给你回复邮件了
      - 哈哈 2013 年 8 月 15 日在上午 10:07
        
        您好，昨天按照你说的中文问题已经解决了，但是图片如何显示呢，您有没有关于图片方面的文章
      - Michael 2013 年 8 月 15 日在上午 10:24
        
        img 标签本身就支持的我把我的blog都生成pdf了
      - 哈哈 2013 年 8 月 15 日在上午 10:29
        
        那为什么我这图片显示不了呢？请问有哪些可能导致的，谢谢
      - Michael 2013 年 8 月 15 日在上午 10:32
        
        如果是在线页面，只要图片没有限制访问一般没有问题，如果是本地html 需要配置本地的图片路径（这个没有具体试过）
      - 哈哈 2013 年 8 月 15 日在上午 10:36
        
        果然可以，非常感谢！！！ 😛 😛 😛
      - 哈哈 2013 年 8 月 16 日在上午 9:21
        
        大神，请问如何加载相对路径的图片呢？ 😛
      - Michael 2013 年 8 月 16 日在上午 9:23
        
        这个没有实际应用实现过，我是以前看到文档上有这方面的介绍
      - cdeng 2014 年 9 月 26 日在上午 10:28
        
        我也遇到了这个问题，如果是我在本地进行测试，将图片的地址写成相对路径，在导出PDF的时候，图片就无法导出，显示的是空白，如果我是写绝对路径，图片就会输出。请问有没有什么解决方法?我将我的应用部署到linux中，图片也还是无法导出
      - Michael 2014 年 11 月 24 日在下午 5:08
        
        相对路径是正解，当然绝对路径也可以只要保证你生成pdf时可以读到该文件
小涛 2013 年 3 月 2 日在上午 12:45

我这边,win是不加你那种方式也行,中文也没问题,但是放到Linux上面就不行了, 然后加上你的方法win上还是可以,Linux还是不行,你那是在什么服务器上的;请指教

回复
- Michael 2013 年 3 月 5 日在上午 9:12
  
  我是在win 上做的，这个没有到linux上做过测试，不过应该没有问题它加载注册的是自己带的字体，
  你可以用第一篇中的简单测试程序在linux下看能否运行成功？
  
  回复
- xiao 2016 年 11 月 9 日在上午 11:37
  
  啊我跟你一样的啊，解决了么？
  
  回复
chris 2013 年 2 月 28 日在上午 10:01

i found that some tags can’t be shown. e.g.

回复
chris 2013 年 2 月 27 日在下午 12:12

i have tried, but all style removed.

回复
zsf513 2013 年 1 月 31 日在下午 4:19

🙂 ,非常感谢，按你的代码，我运行了一遍，可以

回复
- Michael 2013 年 1 月 31 日在下午 4:46
  
  我当时也很郁闷的
  
  回复

micmiu – 软件开发+生活点滴