Apache Tiles в Spring Framework 6

Куда делся Apache Tiles в Spring Framework 6? Проблема достаточно серьезна, так как многие проекты сильно завязались на нём. Сам проект Apache Tiles больше не разрабатывается, а на его странице висит плашка:

This project has retired. For details please refer to its Attic page.

Но что же делать, если ваш проект зависит от него? Вообще, сама технология Java Server Pages морально устарела, хотя она все ещё поддерживается, даже новые спецификации до сих пор выходят. Сам Spring Framework рекомендует использовать Thymeleaf или Freemarker. Для новых проектов так и следует поступить.

Однако что же делать с нашим старым проектом, который был построен на JSP, JSTL и Apache Tiles? Можно полностью переписать проект на Thymeleaf, например, но это трудоемко по времени. Мы можем пойти по более простому пути. Для перехода на Spring Framework 6 нам придётся избавиться от Apache Tiles, а вместо использовать custom-теги.

Свой custom-тег нам нужно создать в каталоге WEB-INF/tags. Например:

<?xml version="1.0" encoding="UTF-8"?>
<html xmlns:jsp="http://java.sun.com/JSP/Page"
    xmlns:c="http://java.sun.com/jsp/jstl/core"
    xmlns:spring="http://www.springframework.org/tags">
<jsp:output doctype-root-element="html"
    doctype-system="about:legacy-compat" omit-xml-declaration="yes" />

<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<spring:theme code="stylesheet" var="stylesheet_var" />
<spring:url value="${stylesheet_var}" var="stylesheet_url" />
<link rel="stylesheet" href="${stylesheet_url}" type="text/css"
    media="screen" />
</head>
<body>
    <div class = "header">
        <jsp:include page="/WEB-INF/views/header.jspx"/>
    </div>
    <div class="menu">
        <jsp:include page="/WEB-INF/views/menu.jspx"/>
    </div>
    <div class="body">
        <jsp:doBody />
    </div>
    <div class="footer">
        <jsp:include page="/WEB-INF/views/footer.jspx"/>
    </div>
</body>
</html>

<?xml version="1.0" encoding="UTF-8"?>

<html xmlns:jsp="http://java.sun.com/JSP/Page"

xmlns:c="http://java.sun.com/jsp/jstl/core"

xmlns:spring="http://www.springframework.org/tags">

<jsp:output doctype-root-element="html"

doctype-system="about:legacy-compat" omit-xml-declaration="yes" />

<head>

<spring:theme code="stylesheet" var="stylesheet_var" />

<spring:url value="${stylesheet_var}" var="stylesheet_url" />

media="screen" />

</head>

<body>

<jsp:include page="/WEB-INF/views/header.jspx"/>

</div>

<jsp:include page="/WEB-INF/views/menu.jspx"/>

</div>

<jsp:doBody />

</div>

<jsp:include page="/WEB-INF/views/footer.jspx"/>

</div>

</body>

</html>

Это обычная JSPX-страница, в которую мы подключили страницы с заголовком (header.jspx), меню (menu.jspx) и подвалом (footer.jspx). А само тело страницы подключается с помощью тега jsp:doBody.

Сами меню, заголовок и подвал просто описывают небольшой кусок страницы. Например, меню:

<?xml version="1.0" encoding="UTF-8"?>
<div xmlns:jsp="http://java.sun.com/JSP/Page"
    xmlns:c="http://java.sun.com/jsp/jstl/core"
    xmlns:spring="http://www.springframework.org/tags"
    >
    <jsp:directive.page contentType="text/html;charset=UTF-8" pageEncoding="UTF-8" />
    <jsp:output omit-xml-declaration="yes" />
    
    <spring:message code="ru.urvanov.spring6customjsp.index_page" var="index_page_var" />
    <spring:message code="ru.urvanov.spring6customjsp.second_page" var="second_page_var" />
    <spring:url value="/" var="index_page_url" />
    <spring:url value="/second" var="second_page_url" />
    <ul>
    <li><a href="${index_page_url}">${index_page_var}</a></li>
    <li><a href="${second_page_url}">${second_page_var}</a></li>
    </ul>
</div>

<?xml version="1.0" encoding="UTF-8"?>

<div xmlns:jsp="http://java.sun.com/JSP/Page"

xmlns:c="http://java.sun.com/jsp/jstl/core"

xmlns:spring="http://www.springframework.org/tags"

<jsp:directive.page contentType="text/html;charset=UTF-8" pageEncoding="UTF-8" />

<jsp:output omit-xml-declaration="yes" />

<spring:message code="ru.urvanov.spring6customjsp.index_page" var="index_page_var" />

<spring:message code="ru.urvanov.spring6customjsp.second_page" var="second_page_var" />

<spring:url value="/" var="index_page_url" />

<spring:url value="/second" var="second_page_url" />

<ul>

<li><a href="${index_page_url}">${index_page_var}</a></li>

<li><a href="${second_page_url}">${second_page_var}</a></li>

</ul>

</div>

Как видите, мы просто описали div, внутри которого две ссылки: на главную страницу и на вторую страницу. Аналогичным образом описываются подвал и заголовок.

Теги spring:message используются для локализованных сообщений, но вы можете вставлять текст прямо в JSPX-страницу, если хотите. Хотя я бы вам рекомендовал сразу использовать spring:message, если ваш проект подразумевает несколько языков.

Пример страницы, которая использует наш тег:

<?xml version="1.0" encoding="UTF-8"?>
<custom:defaultLayout xmlns:jsp="http://java.sun.com/JSP/Page"
    xmlns:c="http://java.sun.com/jsp/jstl/core"
    xmlns:spring="http://www.springframework.org/tags"
    xmlns:custom="urn:jsptagdir:/WEB-INF/tags">
<div id="main">
<jsp:directive.page contentType="text/html;charset=UTF-8" />
<jsp:output omit-xml-declaration="yes" />

    <spring:message code="ru.urvanov.spring6customjsp.index_page_text" var="welcome_message1_var" />
    ${welcome_message1_var}
    
    
</div>
</custom:defaultLayout>

<?xml version="1.0" encoding="UTF-8"?>

<custom:defaultLayout xmlns:jsp="http://java.sun.com/JSP/Page"

xmlns:c="http://java.sun.com/jsp/jstl/core"

xmlns:spring="http://www.springframework.org/tags"

xmlns:custom="urn:jsptagdir:/WEB-INF/tags">

<jsp:directive.page contentType="text/html;charset=UTF-8" />

<jsp:output omit-xml-declaration="yes" />

<spring:message code="ru.urvanov.spring6customjsp.index_page_text" var="welcome_message1_var" />

${welcome_message1_var}

</div>

</custom:defaultLayout>

Здесь тоже ничего сверхъестественного. Мы просто с помощью custom, который мы подключили из «urn:jsptagdir:/WEB-INF/tags» указали тег defaultLayout, который создали ранее. Само содержимое представляет собой просто кусок JSPX, генерирующий HTML, который будет вставлен в doBody нашего custom-тега.

Исходный код работоспособного примера можете посмотреть на GitHub. Пример использует Maven, Spring Framework 6 с морально устаревшей XML-конфигурацией (но раз вы используете Java Server Pages, то это вас не должно пугать) и деплоится на Apache Tomcat 10.

В “web.xml” проекта в принципе всё вполне стандартно, мы просто объявляем DispatcherServlet из Spring Framework, указывая запросы какого пути он будет обрабатывать:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
                      https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd"
  version="6.0"
  metadata-complete="true">
    
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            /WEB-INF/spring/servlet-context.xml
        </param-value>
    </context-param>

    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value></param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>appServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee

https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd"

version="6.0"

metadata-complete="true">

<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

</listener>

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>

/WEB-INF/spring/servlet-context.xml

</param-value>

</context-param>

<filter-name>CharacterEncodingFilter</filter-name>

<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>

<init-param>

<param-name>encoding</param-name>

<param-value>UTF-8</param-value>

</init-param>

<init-param>

<param-name>forceEncoding</param-name>

<param-value>true</param-value>

</init-param>

</filter>

<filter-mapping>

<filter-name>CharacterEncodingFilter</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

<servlet-name>appServlet</servlet-name>

<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

<init-param>

<param-name>contextConfigLocation</param-name>

<param-value></param-value>

</init-param>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>appServlet</servlet-name>

<url-pattern>/</url-pattern>

</servlet-mapping>

</web-app>

Тут даже объяснять особо нечего, любой проект на Spring Framework обычно примерно такой “web.xml” и содержал, а чаще даже сложнее.

Конфигурация контекста Spring в файле “servlet-context.xml”, по большому счёту тоже вполне стандартная.

Мы просто включаем Spring MVC, основанную на аннотациях @Controller:

<!-- Enables the Spring MVC @Controller programming model -->
<annotation-driven />

1 2	<!-- Enables the Spring MVC @Controller programming model --> <annotation-driven />

Следующие два interceptor-а нужны для манипуляции с текущей локалью и различными темами оформления в страницах JSP и JSPX:

<interceptors>
    <beans:bean
        class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"
        p:paramName="theme" />
    <beans:bean
        class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"
        p:paramName="locale" />
</interceptors>

<!-- i18n localization -->
<!-- Remember to set defaultEncoding property! -->
<beans:bean id="messageSource"
    class="org.springframework.context.support.ReloadableResourceBundleMessageSource"
    p:basenames="/WEB-INF/i18n/application"
    p:defaultEncoding="UTF-8" 
    p:fallbackToSystemLocale="false" />


<beans:bean id="localeResolver"
    class="org.springframework.web.servlet.i18n.CookieLocaleResolver"
    p:cookieName="locale" />

<beans:bean id="themeSource"
    class="org.springframework.ui.context.support.ResourceBundleThemeSource" />

<beans:bean id="themeResolver"
    class="org.springframework.web.servlet.theme.CookieThemeResolver"
    p:cookieName="theme" p:defaultThemeName="standard" />

<beans:bean

class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"

p:paramName="theme" />

<beans:bean

class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"

p:paramName="locale" />

</interceptors>

<beans:bean id="messageSource"

class="org.springframework.context.support.ReloadableResourceBundleMessageSource"

p:basenames="/WEB-INF/i18n/application"

p:defaultEncoding="UTF-8"

p:fallbackToSystemLocale="false" />

<beans:bean id="localeResolver"

class="org.springframework.web.servlet.i18n.CookieLocaleResolver"

p:cookieName="locale" />

<beans:bean id="themeSource"

class="org.springframework.ui.context.support.ResourceBundleThemeSource" />

<beans:bean id="themeResolver"

class="org.springframework.web.servlet.theme.CookieThemeResolver"

p:cookieName="theme" p:defaultThemeName="standard" />

Обратите внимание, что в ThemeChangeInterceptor и в LocaleChangeInterceptor указываются свойства paramName. Для ThemeChangeInterceptor это theme, а для LocaleChangeInterceptor ставится locale. Это означает, что при обращении к страницам мы сможем в URL запроса указывать соответствующие параметры запроса ?theme=<название_темы>&locale=<локаль>, для того чтобы сменить тему и язык на необходимые нам.

Бин localeResolver нужен, чтобы выбранная пользователем тема сохранялась в куках, конкретно в нашем случае в куке locale, как указано в cookieName. Бин messageSource использует properties-файлы из “/WEB-INF/i18n/application” в качестве источников строк для разных языков. Обязательно нужно указать кодировку UTF-8, иначе все русские символы внутри properties-файлов придётся писать через код символа (например, \u00A9). По умолчанию локаль определяется по заголовкам в HTTP-запросе браузера и используются строки из файла с соответствующим суффиксом в имени (например, _ru), если файл с подходящей локалью не найден, то используются строки из файла без префикса, так как мы указали fallbackToSystemLocale=false.

Бин themeSource указывают, что темы будут браться из стандартного java.util.ResourceBundle. Обратите внимание на файлы в каталоге “WEB-INF/classes” нашего проекта, именно там и хранятся настройки для наших тем, а themeResolver сохраняет выбранную пользователем тему в куках браузера.

Дальше мы указываем пакеты, в которых находятся контроллеры для Spring MVC:

<context:component-scan
    base-package="ru.urvanov.spring6customjsp.controller" />

1 2	<context:component-scan base-package="ru.urvanov.spring6customjsp.controller" />

Но в нашем проекте их почти нет.

В этом простом примере нам не нужно особых обработок в контроллерах, поэтому мы просто создаём простые контроллеры, возвращающие необходимые нам JSPX-страницы ( path — обрабатывай путь, view-name — соответствующая страница:

<view-controller path="/" view-name="index" />
<view-controller path="second" view-name="second" />
<view-controller path="simple" view-name="simple" />

<view-controller path="/" view-name="index" />

<view-controller path="second" view-name="second" />

<view-controller path="simple" view-name="simple" />

Ну и стандартный InternalResourceViewResolver, который собственно и обрабатывает наши Java Server Pages:

<beans:bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <beans:property name="prefix" value="/WEB-INF/views/"/>
    <beans:property name="suffix" value=".jspx"/>
</beans:bean>

<beans:bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">

<beans:property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>

<beans:property name="prefix" value="/WEB-INF/views/"/>

<beans:property name="suffix" value=".jspx"/>

</beans:bean>

В нем мы просто указали префикс и суффикс пути для наших JSPX-файлов внутри webapp.

Ну и, разумеется, нужно не забыть указать, чтобы файлы CSS-стилей, картинок и JavaScript-файлов просто возвращались пользователю без особой обработки, как и должны поступать ресурсы:

<!-- Handles HTTP GET requests for /resources/** by efficiently serving 
    up static resources in the ${webappRoot}/resources directory -->
<resources mapping="/resources/**" location="/resources/" />

<!-- Handles HTTP GET requests for /resources/** by efficiently serving

up static resources in the ${webappRoot}/resources directory -->

Исходный код на GitHub

Скачать ZIP-архив с исходными кодами проекта Скачать

Один комментарий к “Apache Tiles в Spring Framework 6”

Маг и волшебник Рушель Блаво:

13.08.2023 в 23:49

Знакомо…
В рецепте зелья указан какой-нибудь коготь виверны, но они вымерли. Ладно коготь вымершего создания, а если сказано «капля крови» или «капля слюны»?
Или указано «чешуя дракона», но когда писался рецепт, имелась в виду чешуя красного дракона, а вокруг лишь чёрные драконы, поэтому маги мучаются, что зелье работает не так, как описано в рецепте.

Ответить

Пн	Вт	Ср	Чт	Пт	Сб	Вс
					1	2
3	4	5	6	7	8	9
10	11	12	13	14	15	16
17	18	19	20	21	22	23
24	25	26	27	28	29	30
31

Один комментарий к “Apache Tiles в Spring Framework 6”

Добавить комментарий Отменить ответ