Представления XSLT

XSLT – это язык преобразования XML, который популярен в качестве технологии представления в веб-приложениях. XSLT может быть продуманным выбором в качестве технологии представления, если ваше приложение естественным образом работает с XML или если вашу модель можно легко преобразовать в XML. В следующем разделе показано, как создать XML-документ в качестве данных модели и преобразовать его с помощью XSLT в приложении на Spring Web MVC.

Этот пример представляет собой простейшее приложение Spring, которое создает список слов в Контроллер и добавляет их в Map модели. Возвращается Map, а также имя представления нашего XSLT-представления. Контроллер XSLT превращает список слов в простой XML-документ, готовый к преобразованию.

Бины

Конфигурация является стандартной для простого веб-приложения Spring: Конфигурация MVC должна определять бин XsltViewResolver и обычную конфигурацию аннотаций MVC. В следующем примере показано, как это сделать:

@EnableWebMvc
@ComponentScan
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Bean
    public XsltViewResolver xsltViewResolver() {
        XsltViewResolver viewResolver = new XsltViewResolver();
        viewResolver.setPrefix("/WEB-INF/xsl/");
        viewResolver.setSuffix(".xslt");
        return viewResolver;
    }
}

@EnableWebMvc
@ComponentScan
@Configuration
class WebConfig : WebMvcConfigurer {
    @Bean
    fun xsltViewResolver() = XsltViewResolver().apply {
        setPrefix("/WEB-INF/xsl/")
        setSuffix(".xslt")
    }
}

Контроллер

Нам также требуется контроллер, который инкапсулирует нашу логику генерации слов.

Логика контроллера заключена в классе, помеченном аннотацией @Controller, а метод обработчика определяется следующим образом:

@Controller
public class XsltController {
    @RequestMapping("/")
    public String home(Model model) throws Exception {
        Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
        Element root = document.createElement("wordList");
        List<String> words = Arrays.asList("Hello", "Spring", "Framework");
        for (String word : words) {
            Element wordNode = document.createElement("word");
            Text textNode = document.createTextNode(word);
            wordNode.appendChild(textNode);
            root.appendChild(wordNode);
        }
        model.addAttribute("wordList", root);
        return "home";
    }
}

import org.springframework.ui.set
@Controller
class XsltController {
    @RequestMapping("/")
    fun home(model: Model): String {
        val document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument()
        val root = document.createElement("wordList")
        val words = listOf("Hello", "Spring", "Framework")
        for (word in words) {
            val wordNode = document.createElement("word")
            val textNode = document.createTextNode(word)
            wordNode.appendChild(textNode)
            root.appendChild(wordNode)
        }
        model["wordList"] = root
        return "home"
    }
}

Пока что мы лишь создали DOM-документ и добавили его в Map модели. Обратите внимание, что также можно загрузить XML-файл в качестве Resource и использовать его вместо кастомного DOM-документа.

Существуют программные пакеты, которые автоматически "DOMифицируют" объектный граф, но Spring обеспечивает всецелую гибкость в части создания DOM из вашей модели любым выбранным вами способом. Это позволяет предотвратить преобразование XML, играющее слишком большую роль в структуре данных вашей модели, что представляет опасность при использовании инструментов для управления процессом DOMификации.

Преобразование

Наконец, XsltViewResolver разрешает "домашний" файл шаблона XSLT и объединяет в нем DOM-документ для создания нашего представления. Как показано в конфигурации XsltViewResolver, шаблоны XSLT работают в файле war в каталоге WEB-INF/xsl и имеют расширение файла xslt.

В следующем примере показано преобразование XSLT:

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:output method="html" omit-xml-declaration="yes"/>
    <xsl:template match="/">
        <html>
            <head><title>Hello!</title></head>
            <body>
                <h1>My First Words</h1>
                <ul>
                    <xsl:apply-templates/>
                </ul>
            </body>
        </html>
    </xsl:template>
    <xsl:template match="word">
        <li><xsl:value-of select="."/></li>
    </xsl:template>
</xsl:stylesheet>

Предшествующее преобразование визуализируется в виде следующего HTML:

<html>
    <head>
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Hello!</title>
    </head>
    <body>
        <h1>My First Words</h1>
        <ul>
            <li>Hello</li>
            <li>Spring</li>
            <li>Framework</li>
        </ul>
    </body>
</html>