HTML-Datei in eine PDF-Datei mit java-wkhtmltopdf-wrapper
Lösungen, um aus Java heraus eine HTML-Datei eine PDF-Datei zu generieren gibt es einige, allerdings ist die Qualität nicht immer gut. Unter Zuhilfenahme der freien Software wkhtmltopdf auf der Basis der WebKit Rendering Engine gibt es mitunter bessere Ergebnisse. Für wkhtmltopdf gibt es mit java-wkhtmltopdf-wrapper von Jhonny Mertz einen passendem quelloffenen Java-Wrapper.
wkhtmltopdf
Wkhtmltopdf ist eine Open Source Applikation die Headless (ohne jegliche grafische Oberfläche) eine HTML-Datei rendert und als PDF-Datei speichert. Gesteuert wird das Programm über die Kommandozeile im folgenden Format:
$ wkhtmltopdf ein Beispiel zum besseren Verständnis:
$ wkhtmltopdf www.google.com google.pdfUm erfolgreich aufgerufen zu werden, muss entweder die Kommandozeile im Installationsverzeichnis von wkhtmltopdf befinden oder wkhtmltopdf in den Umgebungsvariablen (PATH) hinzugefügt werden, andernfalls kann die Anwendung nicht gefunden werden.
Des weiteren kann der Applikation eine Vielzahl von Parametern übergeben werden, um das Ergebnis den eigenen Bedürfnissen anzupassen, z. B. mit dem Parameter -s kann man die Größe der PDF-Datei festlegen. Der Standard liegt hier bei DIN A4.
Ein Beispiel für DIN A3 Format:
$ wkhtmltopdf www.google.com google.pdf -s “A3“Dies ist natürlich nur ein Bruchteil der möglichen Parameter, eine vollständige Liste in Englisch finden Sie hier:
Global Options:
--collate Collate when printing multiple copies
(default)
--no-collate Do not collate when printing multiple
copies
--cookie-jar Read and write cookies from and to the
supplied cookie jar file
--copies Number of copies to print into the pdf
file (default 1)
-d, --dpi Change the dpi explicitly (this has no
effect on X11 based systems)
-H, --extended-help Display more extensive help, detailing
less common command switches
-g, --grayscale PDF will be generated in grayscale
-h, --help Display help
--htmldoc Output program html help
--image-dpi When embedding images scale them down to
this dpi (default 600)
--image-quality When jpeg compressing images use this
quality (default 94)
--license Output license information and exit
-l, --lowquality Generates lower quality pdf/ps. Useful to
shrink the result document space
--manpage Output program man page
-B, --margin-bottom Set the page bottom margin
-L, --margin-left Set the page left margin (default 10mm)
-R, --margin-right Set the page right margin (default 10mm)
-T, --margin-top Set the page top margin
-O, --orientation Set orientation to Landscape or Portrait
(default Portrait)
--page-height Page height
-s, --page-size Set paper size to: A4, Letter, etc.
(default A4)
--page-width Page width
--no-pdf-compression Do not use lossless compression on pdf
objects
-q, --quiet Be less verbose
--read-args-from-stdin Read command line arguments from stdin
--readme Output program readme
--title The title of the generated pdf file (The
title of the first document is used if not
specified)
-V, --version Output version information and exit
Outline Options:
--dump-default-toc-xsl Dump the default TOC xsl style sheet to
stdout
--dump-outline Dump the outline to a file
--outline Put an outline into the pdf (default)
--no-outline Do not put an outline into the pdf
--outline-depth Set the depth of the outline (default 4)
Page Options:
--allow Allow the file or files from the specified
folder to be loaded (repeatable)
--background Do print background (default)
--no-background Do not print background
--cache-dir Web cache directory
--checkbox-checked-svg Use this SVG file when rendering checked
checkboxes
--checkbox-svg Use this SVG file when rendering unchecked
checkboxes
--cookie Set an additional cookie (repeatable),
value should be url encoded.
--custom-header Set an additional HTTP header (repeatable)
--custom-header-propagation Add HTTP headers specified by
--custom-header for each resource request.
--no-custom-header-propagation Do not add HTTP headers specified by
--custom-header for each resource request.
--debug-javascript Show javascript debugging output
--no-debug-javascript Do not show javascript debugging output
(default)
--default-header Add a default header, with the name of the
page to the left, and the page number to
the right, this is short for:
--header-left='[webpage]'
--header-right='[page]/[toPage]' --top 2cm
--header-line
--encoding Set the default text encoding, for input
--disable-external-links Do not make links to remote web pages
--enable-external-links Make links to remote web pages (default)
--disable-forms Do not turn HTML form fields into pdf form
fields (default)
--enable-forms Turn HTML form fields into pdf form fields
--images Do load or print images (default)
--no-images Do not load or print images
--disable-internal-links Do not make local links
--enable-internal-links Make local links (default)
-n, --disable-javascript Do not allow web pages to run javascript
--enable-javascript Do allow web pages to run javascript
(default)
--javascript-delay Wait some milliseconds for javascript
finish (default 200)
--load-error-handling Specify how to handle pages that fail to
load: abort, ignore or skip (default
abort)
--load-media-error-handling Specify how to handle media files
that fail to load: abort, ignore or skip
(default ignore)
--disable-local-file-access Do not allowed conversion of a local file
to read in other local files, unless
explicitly allowed with --allow
--enable-local-file-access Allowed conversion of a local file to read
in other local files. (default)
--minimum-font-size Minimum font size
--exclude-from-outline Do not include the page in the table of
contents and outlines
--include-in-outline Include the page in the table of contents
and outlines (default)
--page-offset Set the starting page number (default 0)
--password HTTP Authentication password
--disable-plugins Disable installed plugins (default)
--enable-plugins Enable installed plugins (plugins will
likely not work)
--post Add an additional post field (repeatable)
--post-file Post an additional file (repeatable)
--print-media-type Use print media-type instead of screen
--no-print-media-type Do not use print media-type instead of
screen (default)
-p, --proxy Use a proxy
--radiobutton-checked-svg Use this SVG file when rendering checked
radiobuttons
--radiobutton-svg Use this SVG file when rendering unchecked
radiobuttons
--run-script Run this additional javascript after the
page is done loading (repeatable)
--disable-smart-shrinking Disable the intelligent shrinking strategy
used by WebKit that makes the pixel/dpi
ratio none constant
--enable-smart-shrinking Enable the intelligent shrinking strategy
used by WebKit that makes the pixel/dpi
ratio none constant (default)
--stop-slow-scripts Stop slow running javascripts (default)
--no-stop-slow-scripts Do not Stop slow running javascripts
--disable-toc-back-links Do not link from section header to toc
(default)
--enable-toc-back-links Link from section header to toc
--user-style-sheet Specify a user style sheet, to load with
every page
--username HTTP Authentication username
--viewport-size Set viewport size if you have custom
scrollbars or css attribute overflow to
emulate window size
--window-status Wait until window.status is equal to this
string before rendering page
--zoom Use this zoom factor (default 1)
Headers And Footer Options:
--footer-center Centered footer text
--footer-font-name Set footer font name (default Arial)
--footer-font-size Set footer font size (default 12)
--footer-html Adds a html footer
--footer-left Left aligned footer text
--footer-line Display line above the footer
--no-footer-line Do not display line above the footer
(default)
--footer-right Right aligned footer text
--footer-spacing Spacing between footer and content in mm
(default 0)
--header-center Centered header text
--header-font-name Set header font name (default Arial)
--header-font-size Set header font size (default 12)
--header-html Adds a html header
--header-left Left aligned header text
--header-line Display line below the header
--no-header-line Do not display line below the header
(default)
--header-right Right aligned header text
--header-spacing Spacing between header and content in mm
(default 0)
--replace Replace [name] with value in header and
footer (repeatable)
TOC Options:
--disable-dotted-lines Do not use dotted lines in the toc
--toc-header-text The header text of the toc (default Table
of Contents)
--toc-level-indentation For each level of headings in the toc
indent by this length (default 1em)
--disable-toc-links Do not link from toc to sections
--toc-text-size-shrink For each level of headings in the toc the
font is scaled by this factor (default
0.8)
--xsl-style-sheet Use the supplied xsl style sheet for
printing the table of contentQuelle:
java-wkhtmltopdf-wrapper
Dank der Zuhilfenahme des wkhtmltopdf-wrappers, welchen ich in mein Projekt eingebunden habe, durch die Einbindung der Maven-Dependency, ist es nun recht mühelos mit wkhtmltopdf aus Java heraus zu arbeiten. Am einfachsten ist es, denke ich, an einem Codebeispiel mit Kommentaren zu erkennen:
import java.io.IOException;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.page.PageType;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param;
public class WkhtmltopdfTest {
public static void main( String[] args ) {
// Erzeugen eines neuen Pdf Objekts als Parameter wir eine WrapperConfig übergeben, die den Pfad der wkhtmltopdf.exe definiert.
Pdf pdf = new Pdf(new WrapperConfig("C:\\Program Files\\wkhtmltopdf\\bin\\wkhtmltopdf.exe"));
//Hinzufügen einer test HTML-Datei und Festlegung auf den Typ File aus dem Enum PageType
pdf.addPage( "C:\\test\\test.html", PageType.file );
//Hinzufügen diverser Parameter wie Format, Orientierung und Randgröße
pdf.addParam( new Param( "-s", "A6" ), new Param( "-O", "landscape" ),
new Param( "-B", "0" ), new Param( "-R", "0" ),
new Param( "-T", "0" ), new Param( "-L", "0" ) );
try {
//Speichern der PDF-Datei unter dem angebenen Pfad
pdf.saveAs( "C:\\test\\test.pdf" );
}
catch ( IOException | InterruptedException e ) {
e.printStackTrace();
}
}
}Dieses Programm erzeugt aus einer HTML-Datei mit dem Namen “test.html“, welche im Ordner “C:\test\“ liegt, eine “test.pdf“ im selben Verzeichnis.
Autor: André Fischer