flying sauser 将 html 转 pdf (含图片)

灰太狼 2022-02-01 22:45 464阅读 0赞

之前呢用过 poi 和 itext 处理 pdf 结果不美观 很多 样式字体无法识别而且对网页元素要求极高  
[poi生成文档csdn链接][poi_csdn]  
经过查找 发现 flying sauser能够处理 样式 问题  
贴上 这些技术的对比  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjExODI4NA_size_16_color_FFFFFF_t_70]  
然后闲话不多说 贴上源码  
注：这块源码是近期需求 在 csdn 中找到的  
添加Maven依赖：

<dependency>
    			<groupId>com.itextpdf</groupId>
    			<artifactId>itext-asian</artifactId>
    			<version>5.2.0</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.xhtmlrenderer</groupId>
    			<artifactId>flying-saucer-pdf-itext5</artifactId>
    			<version>9.0.3</version>
    		</dependency>
    		 
    		 <dependency>
    		    <groupId>com.itextpdf</groupId>
    		    <artifactId>itextpdf</artifactId>
    		    <version>5.5.9</version>
    		</dependency>
    		 
    		<dependency>
    		    <groupId>com.itextpdf.tool</groupId>
    		    <artifactId>xmlworker</artifactId>
    		    <version>5.5.9</version>
    		</dependency>
    		<dependency>
    			<groupId>org.freemarker</groupId>
    			<artifactId>freemarker</artifactId>
    		</dependency>

创建工具类 ： com.util.flying  
创建：FreemarkerConfiguration.java

package com.util.flying;
    
    import com.changdao.controller.FastdfsController;
    
    import freemarker.template.Configuration;
    /** 
    * @author  作者 : 小布
    * @version 创建时间 : 2019年5月9日 下午1:55:56 
    * @explain 类说明 : 
    */
    public class FreemarkerConfiguration {
    	private static Configuration config = null;
    
    	/**
    	 * Static initialization.
    	 * 
    	 * Initialize the configuration of Freemarker.
    	 */
    	static {
    		config = new Configuration();
    		config.setClassForTemplateLoading(FreemarkerConfiguration.class,
    				"/static/");
    	}
    
    	public static Configuration getConfiguation() {
    		return config;
    	}
    }

创建：HtmlGenerator.java

package com.util.flying;
    /** 
    * @author  作者 : 小布
    * @version 创建时间 : 2019年5月9日 下午1:55:08 
    * @explain 类说明 : 
    */
    import java.io.BufferedWriter;
    import java.io.StringWriter;
    import java.util.Map;
    
    import freemarker.template.Configuration;
    import freemarker.template.Template;
    
    public class HtmlGenerator {
    
    	/**
    	 * Generate html string.
    	 * 
    	 * @param template
    	 *            the name of freemarker teamlate.
    	 * @param variables
    	 *            the data of teamlate.
    	 * @return htmlStr
    	 * @throws Exception
    	 */
    	public static String generate(String template, Map<String, Object> variables)
    			throws Exception {
    		Configuration config = FreemarkerConfiguration.getConfiguation();
    		Template tp = config.getTemplate(template);
    		StringWriter stringWriter = new StringWriter();
    		BufferedWriter writer = new BufferedWriter(stringWriter);
    		tp.setEncoding("UTF-8");
    		tp.process(variables, writer);
    		String htmlStr = stringWriter.toString();
    		writer.flush();
    		writer.close();
    		return htmlStr;
    	}
    }

创建：PdfGenerator.java

package com.util.flying;
    
    import java.io.ByteArrayInputStream;
    import java.io.File;
    import java.io.IOException;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.io.OutputStream;
    import java.nio.charset.Charset;
    
    import javax.xml.parsers.DocumentBuilder;
    import javax.xml.parsers.DocumentBuilderFactory;
    
    import org.apache.commons.lang3.StringUtils;
    import org.xhtmlrenderer.pdf.ITextRenderer;
    
    import com.changdao.controller.FastdfsController;
    import com.itextpdf.text.Document;
    import com.itextpdf.text.DocumentException;
    import com.itextpdf.text.Font;
    import com.itextpdf.text.Image;
    import com.itextpdf.text.PageSize;
    import com.itextpdf.text.pdf.PdfWriter;
    import com.itextpdf.tool.xml.Pipeline;
    import com.itextpdf.tool.xml.XMLWorker;
    import com.itextpdf.tool.xml.XMLWorkerFontProvider;
    import com.itextpdf.tool.xml.XMLWorkerHelper;
    import com.itextpdf.tool.xml.html.CssAppliersImpl;
    import com.itextpdf.tool.xml.html.Tags;
    import com.itextpdf.tool.xml.net.FileRetrieve;
    import com.itextpdf.tool.xml.net.ReadingProcessor;
    import com.itextpdf.tool.xml.parser.XMLParser;
    import com.itextpdf.tool.xml.pipeline.css.CSSResolver;
    import com.itextpdf.tool.xml.pipeline.css.CssResolverPipeline;
    import com.itextpdf.tool.xml.pipeline.end.PdfWriterPipeline;
    import com.itextpdf.tool.xml.pipeline.html.AbstractImageProvider;
    import com.itextpdf.tool.xml.pipeline.html.HtmlPipeline;
    import com.itextpdf.tool.xml.pipeline.html.HtmlPipelineContext;
    import com.itextpdf.tool.xml.pipeline.html.ImageProvider;
    /** 
    * @author  作者 : 小布
    * @version 创建时间 : 2019年5月9日 下午1:55:00 
    * @explain 类说明 : 
    */
    public class PdfGenerator {
    
    	/**
    	 * Output a pdf to the specified outputstream
    	 * 
    	 * @param htmlStr
    	 *            the htmlstr
    	 * @param out
    	 *            the specified outputstream
    	 * @throws Exception
    	 */
    	public static void generate(String htmlStr, OutputStream out)
    			throws Exception {
    		DocumentBuilder builder = DocumentBuilderFactory.newInstance()
    				.newDocumentBuilder();
    		org.w3c.dom.Document doc = builder.parse(new ByteArrayInputStream(htmlStr
    				.getBytes()));
    		ITextRenderer renderer = new ITextRenderer();
    		renderer.setDocument(doc, null);
    		renderer.layout();
    		renderer.createPDF(out);
    		out.close();
    	}
    	
    	public static void generatePlus(String htmlStr, OutputStream out) throws IOException, DocumentException {
    		final String charsetName = "UTF-8";
    		
    		Document document = new Document(PageSize.A4, 30, 30, 30, 30);
            document.setMargins(30, 30, 30, 30);
            PdfWriter writer = PdfWriter.getInstance(document, out);
            document.open();
            
            // html内容解析
            HtmlPipelineContext htmlContext = new HtmlPipelineContext(
                    new CssAppliersImpl(new XMLWorkerFontProvider() {
                        @Override
                        public Font getFont(String fontname, String encoding,
                                            float size, final int style) {
                            if (fontname == null) {
                            	// 操作系统需要有该字体, 没有则需要安装; 当然也可以将字体放到项目中， 再从项目中读取
                                fontname = "SimSun";        
                            }
                            return super.getFont(fontname, encoding, size,
                                    style);
                        }
                    })) {
                @Override
                public HtmlPipelineContext clone()
                        throws CloneNotSupportedException {
                    HtmlPipelineContext context = super.clone();
                    ImageProvider imageProvider = this.getImageProvider();
    				context.setImageProvider(imageProvider);
                    return context;
                }
            };
            
            // 图片解析
            htmlContext.setImageProvider(new AbstractImageProvider() {
            	
            	String rootPath = FastdfsController.class.getResource("/").getPath()+"static/images/";
            	
                @Override
                public String getImageRootPath() {
                	return rootPath;
                }
    
                @Override
                public Image retrieve(String src) {
                    if (StringUtils.isEmpty(src)) {
                        return null;
                    }
                    try {
                        Image image = Image.getInstance(new File(rootPath, src).toURI().toString());
                        // 图片显示位置
                        image.setAbsolutePosition(400, 400);		
                        if (image != null) {
                            store(src, image);
                            return image;
                        }
                    } catch (Throwable e) {
                    	e.printStackTrace();
                    }
                    return super.retrieve(src);
                }
            });
            htmlContext.setAcceptUnknown(true).autoBookmark(true).setTagFactory(Tags.getHtmlTagProcessorFactory());
            
            // css解析
            CSSResolver cssResolver = XMLWorkerHelper.getInstance().getDefaultCssResolver(true);
            cssResolver.setFileRetrieve(new FileRetrieve() {
                @Override
                public void processFromStream(InputStream in,
                                              ReadingProcessor processor) throws IOException {
                    try (
                            InputStreamReader reader = new InputStreamReader(in, charsetName)) {
                        int i = -1;
                        while (-1 != (i = reader.read())) {
                            processor.process(i);
                        }
                    } catch (Throwable e) {
                    }
                }
    
                // 解析href
                @Override
                public void processFromHref(String href, ReadingProcessor processor) throws IOException {
                	InputStream is = new ByteArrayInputStream(href.getBytes());
                	try {
                		InputStreamReader reader = new InputStreamReader(is,charsetName);
                        int i = -1;
                        while (-1 != (i = reader.read())) {
                            processor.process(i);
                        }
    				} catch (Exception e) {
    					System.out.println("message:"+e.getMessage());
    				}
                	
                }
            });
    
            HtmlPipeline htmlPipeline = new HtmlPipeline(htmlContext, new PdfWriterPipeline(document, writer));
            Pipeline<?> pipeline = new CssResolverPipeline(cssResolver, htmlPipeline);
            XMLWorker worker = null;
            worker = new XMLWorker(pipeline, true);
            XMLParser parser = new XMLParser(true, worker, Charset.forName(charsetName));
            try (InputStream inputStream = new ByteArrayInputStream(htmlStr.getBytes())) {
                parser.parse(inputStream, Charset.forName(charsetName));
            }
            document.close();
    	}
    }

controller ：

@PostMapping("/generatePDF")
    	@ApiOperation(value="generatePDF")
    	public Map<String, Object> generatePDF(){
    		Map<String, Object> mp = new HashMap<String, Object>();
    		try {
    			String outputFile = "D:\\test\\pdf\\"+System.currentTimeMillis()+uuid+".pdf";//生成后的路径
    			Map<String, Object> dataMap = new HashMap<String, Object>();			
    			
    			dataMap.put("name","张三");
    	        dataMap.put("img1", "1.png");
    
    			String htmlStr = HtmlGenerator.generate("html/template.html", dataMap);
    			System.out.println(htmlStr);
    			
    			OutputStream out = new FileOutputStream(outputFile);
    			PdfGenerator.generatePlus(htmlStr, out);
    			mp.put("code", "200");
    			mp.put("url", outputFile);
    		} catch (Exception ex) {
    			//System.out.println(ex.getMessage());
    			mp.put("code", "500");
    		}
    		return mp;
    	}

html：

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title></title>
    <style type="text/css" rel="stylesheet">
    * {
    	margin: 0;
    	padding: 0;
    }
    body {
    	font-family: "SimSun";
    	font-size: 16px;
    	margin: 0 auto;
    	max-width: 794px;
    	max-height: 1090px;
    	padding: 20px;
    }
    </style>
    </head>
    <body>
    <h1>${name}</h1>
    <img src="${img1}"  alt="" height="30px">
    </body>
    </html>

注：需要注意的地方就是 配置文件中的路径 默认已经配置好了 可以自行调试去看看源码

若出现过这样的问题 是由于jar包导致，需要更换jar，不过我这Maven已经改好了不会出现这样问题

java.lang.NoSuchMethodError: com.itextpdf.text.pdf.PdfDiv.setKeepTogether(Z)V

[poi_csdn]: https://blog.csdn.net/weixin_42118284/article/details/89475467
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjExODI4NA_size_16_color_FFFFFF_t_70]: /images/20220202/3f90a02f48e94d10bc96dfa9374fa480.png