Pull to refresh

Свое представление (view) в Spring MVC

Java *
Если вы работали с Spring MVC то наверняка обращали внимание, что он поддерживает множество различных представлений (view), которые позволяют генерировать pdf, excel, csv использовать jstl, freemarker, velocity и jasperReports. Но что делать если вам потребовалось заполнить какой либо документ в формате docx по шаблону и передать его пользователю? С одной стороны можно в методе воспользоваться доступом к стандартному response и если планируется использовать такую генерацию множество раз, то вынести ее в отдельный класс. Но такое решение не слишком изящно и нарушает MVC-паттерн. Чтобы этого не происходило можно написать свое представление (view). Для этого вам потребуется унаследоваться от одного из абстрактных представлений (view) к примеру от AbstractTemplateView. Для docx этот view выглядит так:
package ru.habrahabr.spring.view;
 
import org.apache.commons.codec.binary.Base64;
import org.docx4j.XmlUtils;
import org.docx4j.openpackaging.io.SaveToZipFile;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart;
import org.docx4j.wml.Document;
import org.springframework.web.servlet.view.AbstractTemplateView;
 
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
 
public class DocxView extends AbstractTemplateView {
 
public DocxView() {
setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
}
 
@Override
protected boolean generatesDownloadContent() {
return true;
}
 
@Override
protected void renderMergedTemplateModel(Map<String, Object> model, 
HttpServletRequest request, HttpServletResponse response) throws Exception {
 
WordprocessingMLPackage wordMLPackage =
WordprocessingMLPackage.load(getApplicationContext().getResource(getUrl()).getFile());
 
MainDocumentPart documentPart = wordMLPackage.getMainDocumentPart();
org.docx4j.wml.Document wmlDocumentEl = (org.docx4j.wml.Document) documentPart.getJaxbElement();
String xml = XmlUtils.marshaltoString(wmlDocumentEl, true);
 
HashMap<String, String> mappings = new HashMap<String, String>();
for (Object key : model.keySet()) {
      mappings.put(key.toString(), model.get(key).toString());
}
 
Object obj = XmlUtils.unmarshallFromTemplate(xml, mappings);
documentPart.setJaxbElement((Document) obj);
 
String name = model.get("filename")+".docx";
 
response.setHeader("Content-Disposition""attachment" + name);
 
ServletOutputStream out = response.getOutputStream();
(new SaveToZipFile(wordMLPackage)).save(out);
 
out.flush();
 
}
 
public boolean checkResource(Locale locale) {
return getApplicationContext().getResource(getUrl()).exists();
}
 
}
 

В конструкторе задаем тип контента, а в методе generatesDownloadContent указываем, что тип контента скачиваемый. А в renderMergedTemplateModel осуществляем считывание файла получая путь до него из getUrl и заполняем документ по шаблону. Чтение данных шаблона происходит из model. checkResouce необходим для проверки наличия файла представления.

Теперь когда представление готово необходимо настроить цепочку локаторов представлений (ResolveViewers), для этого в mvc-config.xml добавляем:
    <bean id="docxViewResolver" class="org.springframework.web.servlet.view.UrlBasedViewResolver">
     <property name="viewClass" value="ru.habrahabr.spring.view.DocxView"></property>
     <property name="order" value="1"/>
        <property name="prefix" value="/WEB-INF/views/"/>
        <property name="suffix" value=".docx"/>
    </bean>
 
    <bean id="jspViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/views/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
 

  • InternalResourceViewResolver — стандартный локатор представлений.
  • UrlBasedViewResolver — локатор на базе url. В качестве url подразумеваются url представлений.

На настройке UrlBasedViewResolver стоит остановиться поподробнее. Этот локатор позволяет использовать любые View в том числе и самописные, что указывается через viewClass, далее указываются prefix, suffix точно так же как и для стандартного локатора представлений, order необходим для указания порядка обработки локаторов в цепочке. В результате сначала будет происходить обращение к локатору UrlBasedViewResolver который создаст View и вызовет метод checkResource() для проверки наличия необходимого файла для представления. Если его нет, то метод вернет ложь, а локатор вместо представления вернет null и произойдет переход по цепочке к InternalResourceViewResolver.
Далее можно в views поместить test.docx файл к примеру в каталог views/docx. И далее обычным образом создаем метод контроллера:
package ru.habrahabr.spring.controller;
 
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.RequestMapping;
 
Controller
public class DocxController {
 
@RequestMapping(value = "/get/docx", method = RequestMethod.GET)
public String doGenerate(Model model) {
model.addAttribute("filename","test");
model.addAttribute("test","test");
return "docx/test";
 

Далее вызываем метод get/docx и получаем файл в docx.
Tags:
Hubs:
Total votes 20: ↑19 and ↓1 +18
Views 14K
Comments Comments 20