SpringBoot整合Freemarker模版引擎導(dǎo)出Word及性能優(yōu)化，看這篇就夠了！
共 4483字，需瀏覽 9分鐘
·
2024-07-14 00:00
大家好，我是鋒哥。最近不少粉絲問鋒哥SpringBoot項(xiàng)目里的Freemarker模版引擎導(dǎo)出Word及性能優(yōu)化，今天鋒哥來總結(jié)下關(guān)于SpringBoot項(xiàng)目里的Freemarker模版引擎導(dǎo)出Word及性能優(yōu)化，大家可以參考學(xué)習(xí)。
最近鋒哥也開始收一些Java學(xué)員，有意向可以找鋒哥。
導(dǎo)出Word文檔是在實(shí)際開發(fā)中常見的需求之一，特別是在需要生成報(bào)告或者定制化文檔的場景下。結(jié)合Spring Boot和FreeMarker模板引擎，我們可以輕松地實(shí)現(xiàn)這一功能，并且通過一些性能優(yōu)化措施來提升應(yīng)用程序的效率。本文將詳細(xì)介紹如何在Spring Boot項(xiàng)目中使用FreeMarker來導(dǎo)出Word文檔，并提供性能優(yōu)化的建議和示例代碼。
1. 添加依賴
首先，需要在pom.xml文件中添加Spring Boot和FreeMarker的依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
這將會引入Spring Boot對FreeMarker的集成支持。
2. 創(chuàng)建Word導(dǎo)出服務(wù)類
接下來，創(chuàng)建一個用于生成并導(dǎo)出Word文檔的服務(wù)類。在這個例子中，我們將使用FreeMarker模板引擎來生成動態(tài)內(nèi)容。
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.apache.poi.xwpf.usermodel.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.io.*;
import java.util.HashMap;
import java.util.Map;
@Service
public class WordExportService {
@Autowired
private Configuration freemarkerConfig;
public void exportWordDocument(Map<String, Object> dataModel) throws IOException, TemplateException {
// 創(chuàng)建一個新的文檔對象
XWPFDocument document = new XWPFDocument();
// 獲取FreeMarker模板
Template template = freemarkerConfig.getTemplate("word-template.ftl");
// 合并數(shù)據(jù)模型和模板內(nèi)容
StringWriter stringWriter = new StringWriter();
template.process(dataModel, stringWriter);
// 添加生成的內(nèi)容到Word文檔
XWPFParagraph paragraph = document.createParagraph();
XWPFRun run = paragraph.createRun();
run.setText(stringWriter.toString());
// 導(dǎo)出文檔
FileOutputStream out = new FileOutputStream(new File("generated-document.docx"));
document.write(out);
out.close();
document.close();
}
}
3. FreeMarker模板
創(chuàng)建一個FreeMarker模板文件 word-template.ftl，用于定義Word文檔的內(nèi)容。這里是一個簡單的示例：
<!DOCTYPE html>
<html>
<head>
<title>Generated Document</title>
</head>
<body>
<h1>${title}</h1>
<p>${content}</p>
</body>
</html>
4. 控制器端點(diǎn)導(dǎo)出文檔
創(chuàng)建一個REST控制器來觸發(fā)文檔導(dǎo)出操作。
import freemarker.template.TemplateException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
@RestController
@RequestMapping("/api")
public class WordExportController {
@Autowired
private WordExportService wordExportService;
@GetMapping("/export-word")
public String exportWord() {
try {
Map<String, Object> dataModel = new HashMap<>();
dataModel.put("title", "Generated Document");
dataModel.put("content", "This is the content of the generated document.");
wordExportService.exportWordDocument(dataModel);
return "Word document exported successfully!";
} catch (IOException | TemplateException e) {
return "Error exporting Word document: " + e.getMessage();
}
}
}
5. 性能優(yōu)化建議
緩存FreeMarker配置
在Spring Boot應(yīng)用程序中，F(xiàn)reeMarker的Configuration對象是線程安全的，因此可以在應(yīng)用啟動時配置一次，然后重復(fù)使用。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean;
@Configuration
public class FreeMarkerConfig {
@Bean
public FreeMarkerConfigurationFactoryBean freeMarkerConfiguration() {
FreeMarkerConfigurationFactoryBean bean = new FreeMarkerConfigurationFactoryBean();
bean.setTemplateLoaderPath("classpath:/templates/");
return bean;
}
}
異步導(dǎo)出
如果導(dǎo)出操作比較耗時，可以考慮使用異步方法來處理，以避免阻塞主線程。
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
@Service
public class WordExportService {
@Async
public void exportWordDocumentAsync(Map<String, Object> dataModel) throws IOException, TemplateException {
// 導(dǎo)出文檔的代碼略...
}
}
6. 配置和運(yùn)行
確保依賴和類都正確配置后，啟動Spring Boot應(yīng)用程序，并訪問 /api/export-word 端點(diǎn)即可觸發(fā)Word文檔的生成和導(dǎo)出操作。
本文介紹了如何在Spring Boot應(yīng)用中使用FreeMarker模板引擎來生成并導(dǎo)出Word文檔。通過結(jié)合FreeMarker的靈活性和Apache POI的功能，我們可以輕松地生成包含動態(tài)內(nèi)容的文檔。同時，通過性能優(yōu)化措施如緩存配置和異步處理，可以提高應(yīng)用程序的效率和響應(yīng)速度，更好地滿足實(shí)際需求。