Getting started with j2html
Import TagCreator to get started. j2html's syntax is fluent and closely matched to HTML:
import static j2html.TagCreator.*;
public class Main {
public static void main(String[] args) {
body(
h1("Hello, World!"),
img().withSrc("/img/hello.png")
).render();
}
}
The Java code above becomes the HTML below:
<body>
<h1>Hello, World!</h1>
<img src="/img/hello.png">
</body>
Check out some more examples (OLD VERSION OF WEBSITE).
Intended use
Consider using j2html if:
- You love type safety. You love catching errors at compile time instead of waiting for some poor user to notice that something is wrong
- You like to dynamically reuse your view code
- You think template engines are too slow. This index page was rendered 100 000 times in less than a second on an i5-4670. That's about a thousand times faster than Apache 'Velocity' (hah!)
Be careful about using j2html if:
- You don't know Java and HTML well
- You're creating a classic "website" that has a lot of static HTML (if it's all generated then it's fine)
- Your application has a lot of text and you don't use language files / a database (string concatenation would get very annoying)
- You use a CSS framework which relies on a lot of copy pasting HTML from docs. You'll have to translate these snippets to j2html
Why did you make this library?
First: j2html is a Java HTML builder. It's not a template engine, and it doesn't want to compete with template engines. We were looking for a good way to create HTML for a complex login solution which had many different forms (with different configurations, depending on user state and user actions, etc.), but very little actual HTML per page. The result was j2html. We decided to release the Java HTML builder we made, since it seems better than all the other Java HTML builders we found while researching the subject. Hopefully someone will find it useful!