Java SpringBoot集成Freemarker将Html转图片

本文转载自查看原文 2021-11-05 16:40 1978 JAVA

有个关于会员营销的功能：在用户下单后将订单参与的活动信息随机生成一张宣传海报，并附带一个绑定用户优惠特权信息的二维码，最后用户可以直接下载这张海报。

当时比较麻烦的就是需要按照设计部门设计的多个样式生成海报，二维码也是根据用户信息动态的生成的，每个人的海报携带的信息都是不一样的。最后使用了Freemarker语法填充Html，再将Html转为Png的方法，在数据库配置多个海报样式模版，按照用户的条件取到不同的模版后，给模版传入用户的Map型数据，自动填充后就能根据传入的数据生成不同信息的海报了。

新建一个SpringBoot项目，在 pom.xml 文件里面引入：Cssbox 和 Freemarker 依赖:

<dependencies>
　　...
   <dependency>
     <groupId>net.sf.cssbox</groupId>
     <artifactId>cssbox</artifactId>
     <version>4.12</version>
   </dependency>
　<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-freemarker</artifactId>
　</dependency>
　　... 
</dependencies>

因为涉及到从数据库里面动态获取海报模版，还需要引入连接数据库的依赖，不过基础的这里就不赘述了。

第一步创建一个配置类来配置 Freemarker 的自定义模版加载器：FreemarkerConfig.java :

package com.demo.htmltopng.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;

/**
 * @author AnYuan
 */

@Configuration
public class FreemarkerConfig{

    /**
     * 自定义的模版加载器
     * @param demoTemplateLoader demoTemplateLoader 自定义从数据库取样式
     * @return FreeMarkerConfigurer
     */

    @Bean
    public FreeMarkerConfigurer freeMarkerConfigurer(DemoTemplateLoader demoTemplateLoader) {
        FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
        configurer.setPreTemplateLoaders(demoTemplateLoader);
        return configurer;
    }
}

写好配置类的后，再创建一个模版加载器DemoTemplateLoader.java ，实现Freemarker包的TemplateLoader接口。这一步主要是能够通过条件需要从数据库自定义查询模版样式。

package com.demo.htmltopng.config;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.demo.htmltopng.model.entity.DemoFreemarkerTemplate;
import com.demo.htmltopng.service.DemoTemplateService;
import freemarker.cache.TemplateLoader;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.time.LocalDateTime;
import java.time.ZoneOffset;

/**
 * @author AnYuan
 */

@Slf4j
@Component("DemoTemplateLoader")
public class DemoTemplateLoader implements TemplateLoader {

    @Autowired
    private DemoTemplateService demoTemplateService;

    /**
     * 从mysql根据 code 查询一个样式模版
     * @param code 查询条件
     * @return Object 模版html
     * @throws IOException IOException
     */
    @Override
    public Object findTemplateSource(String code) throws IOException {
        return  demoTemplateService.getOne(new QueryWrapper<DemoFreemarkerTemplate>().lambda().eq(DemoFreemarkerTemplate::getCode, code));
    }

    /**
     * 获取模版的最后更新时间 这里直接使用当前时间
     * @param o 模版
     * @return long 最后时间
     */
    @Override
    public long getLastModified(Object o) {
        return LocalDateTime.now().toEpochSecond(ZoneOffset.of("+8"));
    }

    /**
     * 根据查询的模版得到Reader
     * @param Object 模版对象
     * @param String s
     * @return Reader
     * @throws IOException IOException
     */
    @Override
    public Reader getReader(Object o, String s) throws IOException {
        return new StringReader(((DemoFreemarkerTemplate) o).getValue());
    }

    /**
     * 关闭模版源
     * @param Object o
     * @throws IOException IOException
     */
    @Override
    public void closeTemplateSource(Object o) throws IOException {

    }
}

因为样式模版是多条配置在数据库，这里先创建一个表：

CREATE TABLE `demo_freemarker_template` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `code` varchar(4) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT '模版名称',
    `value` text COLLATE utf8_unicode_ci COMMENT '模版样式Html',
    PRIMARY KEY (`id`)
)  DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;


# 模拟数据
INSERT INTO demo_freemarker_template(`code`, `value`) VALUES ('T001', '<html><head><title>Welcome!</title></head><body style=\"margin:0px\"><h1>Welcome ${user}!</h1><img src=\"${info.url}\"></body></html>');

创建一个实体类接收数据库的模版数据：DemoFreemarkerTemplate.java :

package com.demo.htmltopng.model.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.io.Serializable;

/**
 * @author AnYuan
 */

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class DemoFreemarkerTemplate implements Serializable {

    private static final long serialVersionUID=1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    private String code;

    private String value;
}

还有一个 DemoTemplateService.java 接口类：

package com.demo.htmltopng.service;

import com.demo.htmltopng.model.entity.DemoFreemarkerTemplate;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * <p>
 *  服务类
 * </p>
 *
 * @author AnYuan
 */
public interface DemoTemplateService extends IService<DemoFreemarkerTemplate> {

}

接口接口实现类：DemoTemplateServiceImpl.java ：

package com.demo.htmltopng.service.impl;

import com.demo.htmltopng.model.entity.DemoFreemarkerTemplate;
import com.demo.htmltopng.repository.DemoTemplateMapper;
import com.demo.htmltopng.service.DemoTemplateService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

/**
 * <p>
 *  服务实现类
 * </p>
 *
 * @author AnYuan
 */
@Service
public class DemoTemplateServiceImpl extends ServiceImpl<DemoTemplateMapper, DemoFreemarkerTemplate> implements DemoTemplateService {

}

后面这三个类都是用 Mybatis-Generator 自动生成的，为了方便数据库操作的，这里只贴代码就不详细描述了。

准备工作做好后，最后写html生成png的逻辑：写一个服务接口：HtmlToPngService.java :

package com.demo.htmltopng.service;

/**
 * @author AnYuan
 * 生成png服务接口
 */
public interface HtmlToPngService {

    void htmlToPng() throws Exception;
}

一个接口实现类：HtmlToPngServiceImpl.java :

package com.demo.htmltopng.service.impl;

import com.demo.htmltopng.service.HtmlToPngService;
import freemarker.template.Template;
import lombok.extern.slf4j.Slf4j;
import org.fit.cssbox.css.CSSNorm;
import org.fit.cssbox.css.DOMAnalyzer;
import org.fit.cssbox.io.DOMSource;
import org.fit.cssbox.io.DefaultDOMSource;
import org.fit.cssbox.io.DocumentSource;
import org.fit.cssbox.io.StreamDocumentSource;
import org.fit.cssbox.layout.BrowserCanvas;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;

import javax.imageio.ImageIO;
import java.awt.*;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * @author AnYuan
 * 生成png服务实现
 */

@Slf4j
@Service
public class HtmlToPngServiceImpl implements HtmlToPngService {

    /**
     * Mock 的数据
     * @return Map<String, String>
     */
    private Map<String, String> getUser() {

        HashMap info = new HashMap(2);
        info.put("age", "18");
        info.put("url", "https://pic.cnblogs.com/avatar/2319511/20210304170859.png");

        Map user = new HashMap(2);
        user.put("user", "安逺");
        user.put("info", info);

        return user;
    }

    @Autowired
    private FreeMarkerConfigurer configuration;

    @Override
    public void htmlToPng() throws Exception {

        // 查询模版条件
        String templateCode = "T001";

        // png图片宽度
        int width = 220;
        // png图片高度
        int height = 150;

        // 从数据库查询一个模版
        Template template = configuration.getConfiguration().getTemplate(templateCode);
        // 将数据替换模版里面的参数
        String readyParsedTemplate = FreeMarkerTemplateUtils.processTemplateIntoString(template, getUser());

        // 创建一个字节流
        InputStream is = new ByteArrayInputStream(readyParsedTemplate.getBytes(StandardCharsets.UTF_8));
        // 创建一个文档资源
        DocumentSource docSource = new StreamDocumentSource(is, null, "text/html; charset=utf-8");
        // 创建一个文件流
        String fileName = UUID.randomUUID().toString();
        FileOutputStream out = new FileOutputStream("./" + new File(fileName + ".png"));

        try {
            // 解析输入文档
            DOMSource parser = new DefaultDOMSource(docSource);
            // 创建CSS解析器
            DOMAnalyzer da = new DOMAnalyzer(parser.parse(), docSource.getURL());

            // 设置样式属性
            da.attributesToStyles();
            da.addStyleSheet(null, CSSNorm.stdStyleSheet(), DOMAnalyzer.Origin.AGENT);
            da.addStyleSheet(null, CSSNorm.userStyleSheet(), DOMAnalyzer.Origin.AGENT);
            da.addStyleSheet(null, CSSNorm.formsStyleSheet(), DOMAnalyzer.Origin.AGENT);
            da.getStyleSheets();
            BrowserCanvas contentCanvas = new BrowserCanvas(da.getRoot(), da, docSource.getURL());
            contentCanvas.createLayout(new Dimension(width, height));

            // 生成png文件
            ImageIO.write(contentCanvas.getImage(), "png", out);

        } catch (Exception e) {
           log.info("HtmlToPng Exception", e);

        } finally {
            out.close();
            is.close();
            docSource.close();
        }
    }
}

以上就已经能够根据Html填充数据后生成一张Png的图了，最后我们写一个测试类：HtmlToPngServiceImplTest.java ：

package com.demo.htmltopng.service.impl;

import com.demo.htmltopng.service.HtmlToPngService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@Slf4j
@SpringBootTest
class HtmlToPngServiceImplTest {

    @Autowired
    private HtmlToPngService htmlToPngService;


    @Test
    public void htmlToPngTest(){
        try {
            htmlToPngService.htmlToPng();
        }catch (Exception e) {
            log.info("PngError:{}", e.getMessage());
        }
    }
}

运行这个测试类就会在逻辑里面设置好的路径生成一张Png的图片了，这里生成的Png在项目根目录：

只要先把Html的样式先写好配置在数据库，再传入与Html模版里面填充的字段名相同的Map数据，就能直接生成Html页面对应的Png图片了。

Freemarker语法参考：http://freemarker.foofun.cn/

本篇代码Github地址：https://github.com/Journeyerr/cnblogs/tree/master/htmltopng

免责声明！

本站转载的文章为个人学习借鉴使用，本站对版权不负任何法律责任。如果侵犯了您的隐私权益，请联系本站邮箱yoyou2525@163.com删除。

猜您在找 JAVA中集成Freemarker生成静态html springboot 集成 freemarker springboot整合freemarker(转) SpringBoot集成Freemarker前端模板 SpringBoot集成Freemarker模板技术 Java iText+FreeMarker生成PDF(HTML转PDF) springboot 使用FreeMarker模板（转） springboot集成模板引擎freemarker和thymeleaf SpringBoot整合Freemarker生成动态Html文件，并转成png图片 SpringBoot集成OpenOffice实现doc文档转html