区块链存证证书生成

2023-10-29

使用 selenium 实现

搭建Web站点，放入HTML页面，后端Query方式传入参数，生成证书页面，使用Chrome驱动和Chrome浏览器无界面模式加载页面，使用selenium截图页面，保存页面到File，上传OSS，存储访问相对路径到数据表storage的certificate_url字段。在File上传OSS之后，需要删除临时File。

生成证书和上传OSS建议异步实现，前端先展示证书正在生成中；或者同步返回，同步会慢一些。看需求。

版本关系：chrome-browser、chrome-driver、selenium-chrome-driver版本需要统一，自行查阅版本对应关系。

需要在使用环境安装chrome-browser和chrome-driver。

引入依赖

// https://mvnrepository.com/artifact/org.apache.commons/commons-io
implementation group: 'org.apache.commons', name: 'commons-io', version: '1.3.2'

// https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload
implementation group: 'commons-fileupload', name: 'commons-fileupload', version: '1.5'

// https://mvnrepository.com/artifact/org.jsoup/jsoup
implementation group: 'org.jsoup', name: 'jsoup', version: '1.15.4'

// https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java
implementation group: 'org.seleniumhq.selenium', name: 'selenium-java', version: '4.10.0'

// https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-chrome-driver
implementation group: 'org.seleniumhq.selenium', name: 'selenium-chrome-driver', version: '4.0.0'

配置驱动路径

1
2
3

# 浏览器驱动路径
chrome:
  driver-path: /opt/chromedriver

截屏类

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeOptions;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.io.File;
import java.net.URLDecoder;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 截取网页为图片
 * @date 2023/7/20 9:31 PM
 */
@Slf4j
@Component
public class WebpageScreenshotHelper {

    @Value("${chrome.driver-path}")
    private String chromeDriverPath;

    /**
     * 截取网页为图片
     *
     * @param url 网页地址
     * @param lineNumber 表格行数 1，2
     * @return 图片文件
     */
    public File screenshot(String url, Integer lineNumber) {

        // 设置Chrome浏览器驱动路径
        System.setProperty("webdriver.chrome.driver", chromeDriverPath);

        // 创建Chrome浏览器选项
        ChromeOptions options = new ChromeOptions();
        // 设置浏览器无界面模式
        options.addArguments("--headless");
        // 禁言消息条（就上面经常一条黄色的那个）
        options.addArguments("--disable-infobars");
        // 禁用插件
        options.addArguments("--disable-extensions");
        // 禁用沙盒模式否则会报错
        options.addArguments("--no-sandbox");
        options.addArguments("--disable-dev-shm-usage");
        // 隐藏滚动条
        options.addArguments("--hide-scrollbars");
        // 允许远程连接
        options.addArguments("--remote-allow-origins=*");

        // 创建Chrome浏览器实例
        WebDriver driver = new ChromeDriver(options);

        try {
            // 使用JSoup解析网页内容
            // Document document = Jsoup.connect(url).get();

            // 获取网页的宽度和高度
            //            int width =
            //                    Integer.parseInt(
            //
            // Objects.requireNonNull(document.select("body").first()).attr("width"));
            //            int height =
            //                    Integer.parseInt(
            //
            // Objects.requireNonNull(document.select("body").first()).attr("height"));

            // 设置浏览器窗口大小
            //            driver.manage().window().setSize(new Dimension(width, height));

            // 取body宽高失败，直接设置实际值
            // HTML的body宽高变化，注意修改
            // driver.manage().window().setSize(new Dimension(715, 1181));
            //            if (lineNumber == 1) {
            //                driver.manage().window().setSize(new Dimension(715, 1200));
            //            } else {
            //                driver.manage().window().setSize(new Dimension(715, 1300));
            //            }

            // 证书高度计算
            int addNum = (int) Math.ceil((lineNumber * 45 + 355) / 71);
            int height = addNum * 71 + 845 + 60;

            // 根据著作权人数设置浏览器窗口大小
            driver.manage().window().setSize(new Dimension(715, height));

            // 编码URL
            String urlStr = URLDecoder.decode(url, "UTF-8");
            // 打开网页
            driver.get(urlStr);

            // 截取屏幕截图
            // 指定了OutputType.FILE做为参数传递给getScreenshotAs()方法，其含义是将截取的屏幕以文件形式返回。
            File screenshotFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);

            // 保存为图片文件
            File file = new File("/tmp/" + System.currentTimeMillis() + ".png");
            FileUtils.copyFile(screenshotFile, file);

            // 返回图片文件
            return file;

        } catch (Exception e) {
            log.error("截取网页为图片异常，原因：{}", e.getMessage(), e);
            return null;
        } finally {
            // 关闭浏览器
            driver.quit();
        }
    }
}

调用示例

    // 构造访问路径
    String url = buildCertificateUrl(evidenceEntity, evidenceCopyrightEntityList);
    // 打印访问路径
    log.info("证书访问路径：{}", url);

    // 调用截屏获取证书文件
    File file = webpageScreenshotHelper.screenshot(url, evidenceCopyrightEntityList.size());

    // 上传证书文件
    // 定义目录
    String dir = "certificate";
    // 上传文件
// File文件上传OSS之后，需要删除File临时文件。
    String fileUrl = ossHelper.uploadFile2OSS(file, dir);
    // 检查文件是否上传成功
    if (StringUtils.isBlank(fileUrl)) {
        log.error("证书文件上传失败");

        throw new YouyuException("证书文件上传失败，请重试！");
    }

    // 返回证书文件url
    return fileUrl;

构造访问路径

@Override
public String buildCertificateUrl(
        EvidenceEntity evidenceEntity,
        List<EvidenceCopyrightEntity> evidenceCopyrightEntityList) {

    // 构造访问路径
    StringBuilder stringBuilder = new StringBuilder().append(chromeBaseUrl);

    // 添加证书html
    stringBuilder.append(CertificateHtmlTypeEnum.DEFAULT.getValue()).append("?");

    // 设置标题
    stringBuilder.append("title=").append(evidenceEntity.getWorksName()).append("&");
    // 设置音乐哈希
    if (StringUtils.isNotBlank(evidenceEntity.getWorksMusicHash())) {
        stringBuilder
                .append("musicHash=")
                .append(evidenceEntity.getWorksMusicHash())
                .append("&");
    }
    // 设置歌词哈希
    if (StringUtils.isNotBlank(evidenceEntity.getWorksLyricHash())) {
        stringBuilder
                .append("lyricsHash=")
                .append(evidenceEntity.getWorksLyricHash())
                .append("&");
    }
    // 设置存证编号
    stringBuilder
            .append("storageNumber=")
            .append(evidenceEntity.getEvidenceNumber())
            .append("&");
    // 设置存证时间
    stringBuilder
            .append("storageTime=")
            .append(DateUtil.format(evidenceEntity.getEvidenceTime(), "yyyy-MM-dd HH:mm:ss"))
            .append("&");
    // 设置交易哈希
    stringBuilder.append("payHash=").append(evidenceEntity.getTransactionHash()).append("&");
    // 设置合约地址
    stringBuilder
            .append("contractAddress=")
            .append(evidenceEntity.getContractAddress())
            .append("&");
    // 设置存证平台
    stringBuilder
            .append("storgePlatform=")
            .append(evidenceEntity.getEvidencePlatform())
            .append("&");

    // 拼接著作权人信息
    StringBuilder authorList = new StringBuilder().append("[");
    // 遍历著作权人信息
    for (int i = 0; i < evidenceCopyrightEntityList.size(); i++) {

        // 拼接单个著作权人信息
        String author =
                "{musicAuthorstypeName="
                        + evidenceCopyrightEntityList.get(i).getCopyrightRoleName()
                        + "&musicAuthorsname="
                        + evidenceCopyrightEntityList.get(i).getCopyrightName()
                        + "&musicAuthorsnumber="
                        + evidenceCopyrightEntityList.get(i).getCopyrightIdCard()
                        + "}";

        // 追加著作权人信息
        authorList.append(author);

        // 如果是最后一条，不增加&
        if (i != evidenceCopyrightEntityList.size() - 1) {
            authorList.append("&");
        }
    }
    // 追加著作权人结束符
    authorList.append("]");

    // 追加著作权人
    stringBuilder.append("musicAuthorlist=").append(authorList);

    // 返回证书访问url
    return stringBuilder.toString();
}