https://github.com/HubSpot/jinjava
Jinja template engine for Java
https://github.com/HubSpot/jinjava
Last synced: 8 months ago
JSON representation
Jinja template engine for Java
- Host: GitHub
- URL: https://github.com/HubSpot/jinjava
- Owner: HubSpot
- License: apache-2.0
- Created: 2014-10-13T17:39:22.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-13T18:43:39.000Z (8 months ago)
- Last Synced: 2025-05-13T19:52:09.463Z (8 months ago)
- Language: Java
- Homepage:
- Size: 6.36 MB
- Stars: 727
- Watchers: 164
- Forks: 170
- Open Issues: 119
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Jinja
README
# jinjava
[](https://travis-ci.org/HubSpot/jinjava)
[](https://codecov.io/github/HubSpot/jinjava)
[](https://maven-badges.herokuapp.com/maven-central/com.hubspot.jinjava/jinjava)
[](https://gitter.im/HubSpot/jinjava?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Java-based template engine based on django template syntax, adapted to render jinja templates (at least the subset of jinja in use in HubSpot content). Currently used in production to render thousands of websites with hundreds of millions of page views per month on the [HubSpot CMS](http://www.hubspot.com/products/sites).
*Note*: Requires Java >= 8. Originally forked from [jangod](https://code.google.com/p/jangod/).
Get it:
-------
```xml
com.hubspot.jinjava
jinjava
{ LATEST_VERSION }
```
where LATEST_VERSION is the [latest version from CHANGES](CHANGES.md).
or if you're stuck on java 7:
```xml
com.hubspot.jinjava
jinjava
2.0.11-java7
```
Example usage:
--------------
my-template.html:
```html
Hello, {{ name }}!
```
java code:
```java
Jinjava jinjava = new Jinjava();
Map context = Maps.newHashMap();
context.put("name", "Jared");
String template = Resources.toString(Resources.getResource("my-template.html"), Charsets.UTF_8);
String renderedTemplate = jinjava.render(template, context);
```
result:
```html
Hello, Jared!
```
Voila!
Advanced Topics
---------------
### Template loading
Jinjava needs to know how to interpret template paths, so it can properly handle tags like:
```
{% extends "foo/bar/base.html" %}
```
By default, it will load only a `ClasspathResourceLocator` which will allow loading from ANY file in the classpath inclusing class files. If you want to allow Jinjava to load any file from the
file system, you can add a `FileResourceLocator`. Be aware the security risks of allowing user input to prevent a user
from adding code such as `{% include '/etc/password' %}`.
You will likely want to provide your own implementation of
`ResourceLoader` to hook into your application's template repository, and then tell jinjava about it:
```java
JinjavaConfig config = new JinjavaConfig();
Jinjava jinjava = new Jinjava(config);
jinjava.setResourceLocator(new MyCustomResourceLocator());
```
To use more than one `ResourceLocator`, use a `CascadingResourceLocator`.
```java
JinjavaConfig config = new JinjavaConfig();
Jinjava jinjava = new Jinjava(config);
jinjava.setResourceLocator(new MyCustomResourceLocator(), new FileResourceLocator());
```
### Custom tags, filters and functions
You can provide custom jinja tags, filters, and static functions to the template engine.
```java
// define a custom tag implementing com.hubspot.jinjava.lib.Tag
jinjava.getGlobalContext().registerTag(new MyCustomTag());
// define a custom filter implementing com.hubspot.jinjava.lib.Filter
jinjava.getGlobalContext().registerFilter(new MyAwesomeFilter());
// define a custom public static function (this one will bind to myfn:my_func('foo', 42))
jinjava.getGlobalContext().registerFunction(new ELFunctionDefinition("myfn", "my_func",
MyFuncsClass.class, "myFunc", String.class, Integer.class);
// define any number of classes which extend Importable
jinjava.getGlobalContext().registerClasses(Class extends Importable>... classes);
```
### See also
- [Javadocs](http://www.javadoc.io/doc/com.hubspot.jinjava/jinjava)