Apache FreeMarker™

Что такое Apache FreeMarker™?

Apache FreeMarker™ — это «движок шаблонов», универсальный инструмент для генерации текстового вывода (от HTML до автоматически сгенерированного исходного кода) на основе шаблонов. Это пакет Java, библиотека классов для программистов на Java. Сам по себе он не является приложением для конечных пользователей, но чем-то, что программисты могут встроить в свои продукты. FreeMarker разработан для практического использования при создании HTML-страниц, особенно приложениями на основе сервлетов, следующими шаблону MVC (Model View Controller).

FreeMarker лицензируется под лицензией Apache версии 2.0.

Подробности см. в файле LICENSE!

Документация

Онлайн: https://freemarker.apache.org/docs/

Офлайн: полная документация доступна в бинарном дистрибутиве в каталоге documentation/index.html.

Установка

Если вы используете Maven, просто добавьте эту зависимость:

  <!--
  Внимание: убедитесь, что ничто не использует старую зависимость с groupId
  «freemarker» (без «org.»), потому что тогда у вас будет две freemarker.jar-ы и непредсказуемое поведение во время выполнения!
  -->
  <dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker-gae</artifactId>
    <version>{version}</version>
  </dependency>

В противном случае просто скопируйте freemarker.jar в место, где его найдёт ClassLoader вашего приложения Java. Например, если вы используете FreeMarker в веб-приложении, вы, вероятно, захотите поместить freemarker.jar в каталог WEB-INF/lib вашего веб-приложения.

У FreeMarker нет обязательных зависимостей. У него есть несколько необязательных зависимостей, но обычно вам не нужно иметь с ними дело, потому что если вы используете дополнительную функцию, это, безусловно, связано с тем, что ваше приложение уже использует связанную библиотеку.

Внимание: если вы переходите на OpenJDK 9 или более позднюю версию и используете запросы XPath в шаблонах, вам потребуется добавить Apache Xalan в качестве зависимости, поскольку freemarker.ext.dom больше не может использовать поддержку XPath, включённую в OpenJDK. Это не требуется для Oracle Java 9 или если FreeMarker настроен на использование Jaxen для XPath.

Минимальная требуемая версия Java в настоящее время — Java SE 8. (Наличие более поздней версии обнаруживается во время выполнения и автоматически используется FreeMarker.)

Журнал изменений

Онлайн (только для стабильных выпусков): https://freemarker.apache.org/docs/app_versions.html

Офлайн: в бинарном выпуске откройте documentation/index.html, и вы найдёте ссылку.

Сборка FreeMarker

Если вы ещё этого не сделали, загрузите исходный релиз или получите FreeMarker из репозитория исходного кода. См. расположение репозиториев здесь: https://freemarker.apache.org/sourcecode.html

Вам необходимо установить JDK 8, JDK 16 и JDK 17 (только для некоторых тестов), чтобы они были установлены (и видимы для Gradle). Это связано с тем, что разные части исходного кода нацелены на разные версии Java, а Gradle требует точную версию JDK (не выше) для каждой.

Убедитесь, что ваша версия Java по умолчанию (которую Gradle должен использовать автоматически) не ниже 17!