4 Star 17 Fork 12

SpencerCai / 基于wkhtmltopdf和PDFBOX的Html转PDF图片工具

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

动态生成HTML并生成PDF和图片

项目说明

项目参考自参考链接,修正其不能在linux内正常使用的问题(原项目的LinuxPath并不正确), 并使用Apache PdfBox将生成出来的PDF文件转化为PNG图片,以解决用wkhtmltoimage生成出来的图片过大的问题。 即通过转PDF省去一步图片压缩的任务,而PDF又正好是业务需要的。使用字符串拼接,帮助用户拼接wkhtmltopdf需要 的参数指令,避免不必要的麻烦。

工程说明

/html2file 工程输出文件目录

/html2file/plugin wkhtmltox的位置,pdf就是靠调用它生成出来的

/html2file/html /html2file/image /html2file/pdf 生成的3种文件存放目录

description.html 是一份以 wkhtmltopdf--helpdoc 的方式导出的说明文档。

src/main/java/top/spencercjh/controller#getCert(String data) 具体写了我需要的业务逻辑

MyService MyServiceImpl 我的业务逻辑:将前端传入的数据替换掉template.html中的内容

top.spencercjh.config.WebConfig 中配置了filter,允许用户能够访问生成出来的资源。

接口说明

  • POST:/getCert

  • Request Parameter:

    {
          "userId": "spencercjh",
              "certificate": [
                "经链证算法检验数据对象为安全,未经篡改",
                "y3dP63zF2BYyRBfYBg6ECLUlGkV6usPC",
                "XXX链证平台",
                "上链证书",
                "MD5+SHA512",
                "基于wkhtmltopdf和PDFBOX的Html转PDF图片工具.git",
                "cX4MpCXmY5nauwHaZx6WDbXYNDcCU9f9gUjIgkrKaBysviaCgpekvE4Gw7Sf8GV6",
                "2018年12月9日",
                "gK4KYq1iBMbEbai0NnZXjmbV2aqUxQXvLGoWrsBYne5KLMLzQ16hHLfB5aW0GCa2",
                "GVZESwAmsfrR18nbi5vHnX4hqHIfLFXn"
              ],
          "option": {
                "margin-bottom": "0",
                "margin-left": "0",
                "margin-right": "0",
                "margin-top": "0",
                "page-height": "125",
                "page-width": "88"
          }
    }
  • 说明:certificate对应template.html上的10个需要替换的字段,option是要拼接到指令中的参数Key和Value, 单位为毫米mm。

    margin-bottom:设置页面底部边距;

    margin-left:设置页面左边距(默认为10mm);

    margin-right:设置页面右边距(默认为10mm);

    margin-top: 设置页面上边距;

    page-height:页面高度;

    page-width:页面宽度;

读了description.html后,如有需要其他参数请发issue

  • Response:
     {
         "pdfPath": "D:/test/html2file/pdf/20181209/7bd88f09857042b8bed411c8604a44f4.pdf",
         "imagePath": "D:/test/html2file/image/20181209/3d8671f74e4342519e272244b91be3bf.png"
     }
  • 说明:返回2个加了主机信息就可以访问到的URI,比如在本地运行的话访问图片的URL就应该是 localhost:8090/image/dce4774314f44b95a6a19ff9df268076.png,pdf同理。

部署说明

已经在所有的业务流程中区分了Windows/Linux,请用户务必去修改对应的目录。

若没有SSL需要配置,删除或注释application.properties中的

    server.ssl.key-store-password=1523355275441
    server.ssl.key-store=1523355275441.pfx
    server.ssl.key-store-type=PKCS12

否则将不能正常运行。

若需要配置,修改上述字段,并将秘钥文件放入相应位置

Windows平台部署

将项目中html2file文件夹移到你想要的位置,修改application.properties中的以下配置信息

    windows-template-path=D:/test/html2file/template.html
    windows-output-html-path=D:/test/html2file/html/
    windows-output-image-path=D:/test/html2file/image/
    windows-output-pdf-path=D:/test/html2file/pdf/
    windows-plugin-path=D:/test/html2file/plugin/window/wkhtmltopdf/bin/wkhtmltopdf

Windows操作系统默认GB2312编码,而我们的开发工作都使用UTF-8,我已经很努力地去解决这个问题了。

如果你直接在IDEA里运行SpringBoot项目,我可以保证全程UTF-8并使生成结果无乱码。

如果你使用java -jar html2Pdf-2.0-SNAPSHOT.jar在Windows上部署Jar包,那么生成出来的东西仍然会有乱码,我无力解决 ,知道的请联系我。

Linux平台部署

将项目中html2file文件夹移到你想要的位置,修改application.properties中的以下配置信息

    linux-template-path=/root/html2file/template.html
    linux-output-html-path=/root/html2file/html/
    linux-output-image-path=/root/html2file/image/
    linux-output-pdf-path=/root/html2file/pdf/
    linux-plugin-path=/root/html2file/plugin/linux/wkhtmltox/bin/wkhtmltopdf

一般情况下你是不可能直接成功运行的 参考链接

  • 环境变量: vi /etc/profile,在最后加上 export PATH=你的html2file目录/plugin/linux/wkhtmltox/bin:$PATH,保存退出后执行 source /etc/profile

  • 安装需要的图形库:

         apt-get/yum install libXrender*
         apt-get/yum install libfontconfig*
         apt-get/yum install libXext*    
  • 配置服务器中文字体 参考链接

    安装字体库yum -y install fontconfig

    /usr/shared/中要能看到fontsfontconfig

    在/fonts中mkdir chinese

    将一些中文字体上传进去;

    修改chinese目录的权限:chmod -R 755 /usr/share/fonts/chinese

    安装ttmkfdir来搜索目录中所有的字体信息,并汇总生成fonts.scale文件,输入命令:yum -y install ttmkfdir

    执行ttmkfdir -e /usr/share/X11/fonts/encodings/encodings.dir

    修改字体配置文件,vi /etc/fonts/fonts.conf

    Fort directory list部分中添加<dir>/usr/share/fonts/chines</dir>,保存退出

    刷新内存字体缓存fc-cache

    执行fc-list,能看到中文字和中文字体

你可以选择将本Spring Boot项目以Jar包或者tomcat+War包的形式部署在Linux服务器中,这里介绍Jar包方式—— 参考链接

   nohup java -jar html2Pdf-2.0-SNAPSHOT.jar > log.txt & 

即能部署成功,并生成log日志文件

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

业务逻辑:传入参数—》生成HTML—》生成PDF—》生成图片 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/spencercjh/myHtmlToPdfImage.git
git@gitee.com:spencercjh/myHtmlToPdfImage.git
spencercjh
myHtmlToPdfImage
基于wkhtmltopdf和PDFBOX的Html转PDF图片工具
master

搜索帮助