Java 導出帶圖片和列表的 Word

雖然 Apache POI 是非常強大的針對 Microsoft Office 讀寫的工具,但是其太過于復雜,往往不太好編寫代碼,且編寫出的代碼不宜維護(也可能只是網上大家分享的代碼大多都不好好整理的原因)。所以在導出讀取 Excel 方面有阿里簡化后的 easyexcel 可供使用,關于導出 word 我們可以使用 freemarker 模板引擎。

1、在 springboot 項目中添加 freemarker 的依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

2、使用 word 做一個你需要的文件模板,并將其中需要改變的部分編程變量(注:圖片建議先貼上大小相等的其他圖片),類似下面:


test.docx

3、制作完成之后,將其另存為xml格式


test.docx 轉存 xml 格式

4、將轉存的 xml 文件使用文本編輯器例如 notepad++ 等打開,將其中紅色區域的刪除掉,那些是圖片的base64編碼后的信息,然后替換為一個圖片變量,傳入新的圖片的 base64 編碼即可導出你所要的圖片,一般來說導出的圖片都是由前臺 echarts 等工具生成的。


test.xml

改圖片變量

5、導出列表的話還需要在 xml 中找到 <w:tr> ,在其前加入 <#list list as list> (注意第一個list 不能變,第二個list 為變量名,第三個list 為別名),和</w:tr> 后加入 </#list> ,此外需將 name 改成 list.name,gender 改成 list.gender 。

6、復制 xml 粘貼至項目文件中,并將后綴名更改為 .ftl


test.ftl

7、編寫導出 Word 工具類

@Slf4j
public class ExportWordUtil {
    private Configuration config;

    public ExportWordUtil() {
        config = new Configuration(DEFAULT_INCOMPATIBLE_IMPROVEMENTS);
        config.setDefaultEncoding("utf-8");
    }

    /**
     * FreeMarker生成Word
     * @param dataMap 數據
     * @param templateName 模板名
     * @param response HttpServletResponse
     * @param fileName 導出的word文件名
     */
    public void exportWord(Map<String, Object> dataMap, String templateName, HttpServletResponse response, String fileName) {
        //加載模板(路徑)數據,也可使用setServletContextForTemplateLoading()方法放入到web文件夾下
        config.setClassForTemplateLoading(this.getClass(), "/templates");
        //設置異常處理器 這樣的話 即使沒有屬性也不會出錯 如:${list.name}...不會報錯
        config.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
        try {
            if(templateName.endsWith(".ftl")) {
                templateName = templateName.substring(0, templateName.indexOf(".ftl"));
            }
            Template template = config.getTemplate(templateName + ".ftl");
            response.setContentType("application/msword");
            response.setHeader("Content-disposition", "attachment;filename="+ URLEncoder.encode(fileName, StandardCharsets.UTF_8));
            OutputStream outputStream = response.getOutputStream();
            Writer out = new BufferedWriter(new OutputStreamWriter(outputStream));

            //將模板中的預先的代碼替換為數據
            template.process(dataMap, out);
            log.info("由模板文件:" + templateName + ".ftl" + " 生成Word文件 " + fileName + " 成功??!");
            out.flush();
        } catch (TemplateNotFoundException e) {
            log.info("模板文件未找到");
            e.printStackTrace();
        } catch (MalformedTemplateNameException e) {
            log.info("模板類型不正確");
            e.printStackTrace();
        } catch (TemplateException e) {
            log.info("填充模板時異常");
            e.printStackTrace();
        } catch (IOException e) {
            log.info("IO異常");
            e.printStackTrace();
        }
    }

}

8、編寫簡單的Controller方法

@RestController
public class Controller {

    /**
     * @param image 注意該image參數為前臺傳過來圖片
     */
    @PostMapping("/exportWord")
    public void exportWord(HttpServletResponse response, @RequestParam("image") MultipartFile image){
        ExportWordUtil ewUtil = new ExportWordUtil();
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("title", "荒野大鏢客2人物");
        Base64.Encoder base64 = Base64.getEncoder();
        try {
            dataMap.put("image", base64.encodeToString(image.getBytes()));
        } catch (Exception e){
            
        }

        List<User> userList = new ArrayList<>();
        userList.add(new User("亞當·摩根","男"));
        userList.add(new User("達奇","男"));
        userList.add(new User("阿比蓋爾·馬斯頓","女"));
        dataMap.put("list", userList);
        ewUtil.exportWord(dataMap, "test.ftl", response, "荒野大鏢客2人物.doc");
    }
}

9、application.yml 中設置下 size,防止圖片的字節數過大

spring:
  servlet:
    multipart:
      max-file-size: 1024MB
      max-request-size: 1024MB

10、啟動項目,傳入某個圖片進行測試【注意:盡量前臺直接傳圖片,而不是傳圖片的 base64 編碼的字符串,這可能導致 word 中圖片顯示不完整】


導出的 word

代碼地址:https://github.com/Econfer/exportword

參考如下:

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,837評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,196評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,688評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,654評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,456評論 6 406
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,955評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,044評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,195評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,725評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,608評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,802評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,318評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,048評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,422評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,673評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,424評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,762評論 2 372

推薦閱讀更多精彩內容

  • 最近在使用Echarts做圖表分析,同時要求有導出分析報告的功能,這時Echarts自帶的保存圖片功能就不能滿足自...
    浮生丷閱讀 11,442評論 5 7
  • Swift1> Swift和OC的區別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴謹 對...
    cosWriter閱讀 11,120評論 1 32
  • 需求 在開發項目途中遇到了一個需求,就是將一個整個HTML界面導出到word文檔,其中包含了echarts圖表,經...
    易佳輝閱讀 7,144評論 2 1
  • FreeMarker的模板文件并不比HTML頁面復雜多少,FreeMarker模板文件主要由如下4個部分組成: 1...
    年輕小伙程序員閱讀 3,020評論 0 5
  • 我去過麗江的束河、白沙古鎮,又到過湘西的鳳凰古城!而到成都,就必然要去黃龍溪。 而去過黃龍溪便會生出一種感覺,這感...
    瑞德堂主閱讀 1,031評論 0 0