springboot集成easypoi導(dǎo)出word換行處理過程

更新時間：2025年08月16日 08:39:06 作者：濤哥是個大帥比

Spring?Boot集成Easypoi導(dǎo)出Word時,換行符\n失效顯示為空格,解決方法包括生成段落或替換模板中\(zhòng)n為回車,同時需確保變量{{temp}}在Map中設(shè)為"??"（帶空格空字符串）,避免空指針或殘留變量

項目場景

springboot集成easypoi導(dǎo)出word

<dependency>
	<groupId>cn.afterturn</groupId>
	<artifactId>easypoi-spring-boot-starter</artifactId>
	<version>4.4.0</version>
</dependency>

問題描述

spring boot集成easypoi導(dǎo)出word時，內(nèi)容包含換行符\n，導(dǎo)出word時換行符失效，會將換行符\n識別為空格。

解決方案

第一種：生成段落的方式

示例代碼：

import com.xinghuo.common.base.ActionResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.Cleanup;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.File;
import java.io.FileOutputStream;

@RestController
@Api(tags = "測試")
@RequestMapping("/test")
public class TestController {

    @ApiOperation("導(dǎo)出Word")
    @GetMapping("/export")
    public ActionResult export() {
        exportWord();
        return ActionResult.success();
    }

    /**
     * 導(dǎo)出Word，支持換行
     */
    public void exportWord(){
        try{
            String content = "第一行\(zhòng)n第二行中文\n"+"第三行";

            @Cleanup XWPFDocument doc = new XWPFDocument();

            if(content != null && content.contains("\n")) {
                //設(shè)置換行
                String[] text = content.split("\n");
                for (int i = 0; i < text.length; i++) {
                    XWPFParagraph p = doc.createParagraph();
                    p.createRun().setText(text[i]);
                }
            }else{
                XWPFParagraph p = doc.createParagraph();
                p.createRun().setText(content);
            }

            String name = "測試換行內(nèi)容.docx";
            String filePath = "F:"+ File.separator + name;
            @Cleanup FileOutputStream output = new FileOutputStream(filePath);
            doc.write(output);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

導(dǎo)出的word內(nèi)容

第二種：替換模板的情況，換行符替換成回車

示例代碼：

import cn.afterturn.easypoi.word.WordExportUtil;
import com.xinghuo.common.base.ActionResult;
import com.xinghuo.common.util.XSSEscape;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.Cleanup;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.File;
import java.io.FileOutputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestController
@Api(tags = "測試")
@RequestMapping("/test")
public class Test1Controller {

    @ApiOperation("導(dǎo)出Word")
    @GetMapping("/export")
    public ActionResult export() {
        exportWordTemplate();
        return ActionResult.success();
    }

    /**
     * 導(dǎo)出Word替換模板，支持換行
     */
    public void exportWordTemplate(){
        try{
            String content = "第一行\(zhòng)n第二行中文\n"+"第三行";
            Map<String, Object> map = new HashMap<>();
            map.put("content",content);

            @Cleanup XWPFDocument doc = WordExportUtil.exportWord07("F:/export_template.docx", map);
            //文本換行
            addBreakInCell(doc.getParagraphs());

            String name = "測試換行內(nèi)容-替換模板.docx";
            String filePath = "F:"+ File.separator + name;
            @Cleanup FileOutputStream output = new FileOutputStream(XSSEscape.escapePath(filePath));
            doc.write(output);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 文本換行
     */
    public static void addBreakInCell(List<XWPFParagraph> paragraphs) {
        for (XWPFParagraph p : paragraphs) {
            for (XWPFRun run : p.getRuns()) {//XWPFRun對象定義具有一組公共屬性的文本區(qū)域
                if(run.getText(0)!= null && run.getText(0).contains("\n")) {
                    String[] lines = run.getText(0).split("\n");
                    if(lines.length > 0) {
                        run.setText(lines[0], 0); // set first line into XWPFRun
                        for(int i=1;i<lines.length;i++){
                            // add break and insert new text
                            run.addBreak();//中斷
//                              run.addCarriageReturn();//回車符，但是不起作用
                            run.setText(lines[i]);
                        }
                    }
                }
            }
        }
    }
}

其中export_template.docx文件是word模板，內(nèi)容為：

導(dǎo)出的內(nèi)容

導(dǎo)出的本地文件截圖

總結(jié)

注意：模板中有變量值{{temp}}，參數(shù)Map里面對應(yīng)的temp值是null或者""，導(dǎo)出的word就會變成拋空指針異?；蛘遻{temp}}、其他帶{{ 的形式，直接在Map中設(shè)置temp的值為" "，就可以導(dǎo)出空白到模板，注意是加了空格的字符串" "。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: