本文介紹了一個用Java編寫的自動化文檔生成工具,通過讀取開發清單文本自動生成格式規范的Word文檔。該工具的主要特點包括:
- 采用Apache POI庫處理Word文檔,支持多級標題和段落自動生成
- 實現中文數字轉換功能,將編號轉換為"一、二、三"等樣式
- 預設標準的文檔結構(輸入/流程/輸出/財務/異常/源代碼等章節)
- 通過Maven打包成可執行JAR,只需將清單文本與JAR同目錄即可運行
使用該工具可將原本繁瑣的手動文檔編寫工作自動化,顯著提高開發文檔的編寫效率。
單位要寫開發文檔,文檔大致結構是上面有一個表格,填入開發內容清單,比如是這樣:
1 | 新增用戶 |
2 | 刪除用戶 |
3 | 查詢用戶 |
下面需要有對應的二級標題和三級標題,我就需要每次都去復制粘貼,改編號,很是麻煩。干脆用java寫個腳本來處理吧。
核心思路是,把開發清單復制到txt文本,然后去讀取,生成一個新的word,帶上這些格式,再拷貝回去即可,省了不少時間。
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com</groupId><artifactId>doc-server</artifactId><version>1.0-SNAPSHOT</version><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>4.1.2</version></dependency></dependencies><build><plugins><!-- 其他插件 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>3.5.0</version><configuration><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs><archive><manifest><mainClass>main.WordGenerator</mainClass> <!-- 替換為你的主類 --></manifest></archive></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build></project>
WordGenerator.java
package main;import org.apache.poi.xwpf.usermodel.*;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.*;import java.io.*;
import java.math.BigInteger;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;public class WordGenerator {/*** 使用BufferedReader按行讀取文件*/public static List<String> readLinesWithBufferedReader(String filePath) {List<String> lines = new ArrayList<>();try (BufferedReader reader = new BufferedReader(new InputStreamReader(new FileInputStream(filePath), StandardCharsets.UTF_8))) {String line;while ((line = reader.readLine()) != null) {lines.add(line);}} catch (IOException e) {System.err.println("讀取文件失敗: " + e.getMessage());}return lines;}static class Transaction {private String num;private String content;public Transaction(String num, String content) {this.num = num;this.content = content;}public String getNum() {return num;}public String getContent() {return content;}@Overridepublic String toString() {return "Transaction{" +"num='" + num + '\'' +", content='" + content + '\'' +'}';}}public static String getPath(){String path = WordGenerator.class.getProtectionDomain().getCodeSource().getLocation().getPath();System.out.println("原始路徑:" + path);if(System.getProperty("os.name").contains("dows")){//path -> file:/D:/Haier/hlmcheckup-admin.jar!/BOOT-INF/lib/hlmcheckup-common-1.0.0.jar!///如果是windows系統,前面有可能有“file:”要替換掉。path = path.replace("file:", "");path = path.substring(1,path.length());System.out.println("原始路徑:" + path);}if(path.contains("jar")){//這里根據你jar包名稱分割//D:/Haier/hlmcheckup-admin.jar!/BOOT-INF/lib/hlmcheckup-common-1.0.0.jar!/// -> D:/Haier/String[] split = path.split("doc-server-1.0-SNAPSHOT-jar-with-dependencies.jar");System.out.println("jar包路徑:" + split[0]);return split[0];}//"hlmcheckup-common/target/classes/" 為當前類路徑 linux與macos需要替換掉return path.replace("hlmcheckup-common/target/classes/", "");}public static String getParentDirectory(String jarFilePath) {if (jarFilePath == null || jarFilePath.isEmpty()) {return null;}File jarFile = new File(jarFilePath);File parentDir = jarFile.getParentFile();if (parentDir != null && parentDir.exists() && parentDir.isDirectory()) {return parentDir.getAbsolutePath();}return null;}public static void main(String[] args) throws Exception {File jarFile = new File( getPath() + "\\1.txt" );System.out.println(jarFile.getAbsoluteFile());List<String> lines = readLinesWithBufferedReader(jarFile.getAbsolutePath());List<Transaction> transactionList = new ArrayList<>();System.out.println("讀取的行數: " + lines.size());for (int i = 0; i < lines.size(); i++) {transactionList.add(new Transaction(lines.get(i).split("\\t")[0],lines.get(i).split("\\t")[2]));}System.out.println(transactionList);// 創建新的Word文檔try (XWPFDocument document = new XWPFDocument()) {ensureHeadingStylesExist(document);for (Transaction transaction: transactionList) {int index = 1;String chinese = NumberToChinese.toChinese(Long.parseLong(transaction.getNum()));// 創建一級標題createHeading(document, " 交易" + chinese + ":" + transaction.getContent(), 2);createHeading(document, " 輸入" , 3 );createParagraph(document, " " + transaction.getContent() + " 輸入參數" );createHeading(document, " 流程" , 3 );createParagraph(document, " 開始 -> " + transaction.getContent() + " -> 結束");createHeading(document, " 輸出" , 3 );createParagraph(document, " " + transaction.getContent() + " 輸出參數");createHeading(document, " 財務" , 3 );createParagraph(document, " 無");createHeading(document, " 異常" , 3 );createParagraph(document, " 無");createHeading(document, " 源代碼" , 3 );createParagraph(document, " 無");}// 保存文檔try (FileOutputStream out = new FileOutputStream(new File("out.docx"))) {document.write(out);System.out.println("Word文檔生成成功!");}} catch (IOException e) {e.printStackTrace();}}/*** 創建標題段落* @param document Word文檔對象* @param text 標題文本* @param level 標題級別(1-9)*/private static void createHeading(XWPFDocument document, String text, int level) {XWPFParagraph paragraph = document.createParagraph();paragraph.setStyle("Heading" + level); // 設置標題樣式XWPFRun run = paragraph.createRun();run.setText(text);run.setFontSize(16 - (level - 1) * 2); // 標題1:16pt, 標題2:14pt, 依此類推run.setBold(true);}/*** 創建正文段落* @param document Word文檔對象* @param text 段落文本*/private static void createParagraph(XWPFDocument document, String text) {XWPFParagraph paragraph = document.createParagraph();XWPFRun run = paragraph.createRun();run.setText(text);run.setFontSize(12); // 正文默認12pt}// 確保文檔包含必要的標題樣式private static void ensureHeadingStylesExist(XWPFDocument document) {try {XWPFStyles styles = document.getStyles();if (styles == null) {styles = document.createStyles();}// 檢查Heading 1樣式是否存在,不存在則創建if (!hasStyle(styles, "Heading1")) {createHeadingStyle(document, "Heading1", "Heading 1", 1, 24);}if (!hasStyle(styles, "Heading2")) {createHeadingStyle(document, "Heading2", "Heading 2", 2, 18);}if (!hasStyle(styles, "Heading3")) {createHeadingStyle(document, "Heading3", "Heading 3", 3, 14);}} catch (Exception e) {System.err.println("創建標題樣式失敗: " + e.getMessage());}}// 檢查樣式是否存在private static boolean hasStyle(XWPFStyles styles, String styleId) {return styles.getStyle(styleId) != null;}// 創建標題樣式(兼容所有POI版本)private static void createHeadingStyle(XWPFDocument document, String styleId, String styleName, int level, int fontSize) {XWPFStyles styles = document.getStyles();// 創建新樣式CTStyle ctStyle = CTStyle.Factory.newInstance();ctStyle.setStyleId(styleId);// 設置樣式名稱CTString name = CTString.Factory.newInstance();name.setVal(styleName);ctStyle.setName(name);// 設置樣式類型為段落ctStyle.setType(STStyleType.PARAGRAPH);// 設置為標題樣式CTDecimalNumber indentNumber = CTDecimalNumber.Factory.newInstance();indentNumber.setVal(BigInteger.valueOf(level));ctStyle.setUiPriority(indentNumber);// 設置基于Normal樣式ctStyle.setBasedOn(CTString.Factory.newInstance());ctStyle.getBasedOn().setVal("Normal");// 設置段落屬性CTPPr ppr = ctStyle.addNewPPr();ppr.addNewSpacing().setAfter(BigInteger.valueOf(100)); // 段后間距// 設置字體和大小(兼容舊版POI)CTRPr rpr = ctStyle.addNewRPr();CTFonts fonts = rpr.addNewRFonts();fonts.setAscii("宋體");fonts.setEastAsia("宋體");rpr.addNewSz().setVal(BigInteger.valueOf(fontSize * 2)); // 字體大小(Twips單位)rpr.addNewB().setVal(STOnOff.TRUE); // 加粗// 添加樣式到文檔XWPFStyle newStyle = new XWPFStyle(ctStyle);styles.addStyle(newStyle);}
}
NumberToChinese.java 工具類
package main;import java.math.BigDecimal;public class NumberToChinese {// 中文數字字符映射private static final String[] CN_NUMBERS = {"零", "一", "二", "三", "四", "五", "六", "七", "八", "九"};private static final String[] CN_INTEGER_UNITS = {"", "十", "百", "千", "萬", "十", "百", "千", "億", "十", "百", "千", "兆"};private static final String[] CN_DECIMAL_UNITS = {"角", "分", "厘", "毫"};// 中文金額單位映射(用于財務場景)private static final String[] CN_FINANCIAL_UNITS = {"", "拾", "佰", "仟", "萬", "拾", "佰", "仟", "億", "拾", "佰", "仟", "兆"};private static final String CN_ZERO = "零";private static final String CN_INTEGER = "整";private static final String CN_NEGATIVE = "負";/*** 將數字轉換為中文大寫(普通模式)* 例如:1234 → 一千二百三十四*/public static String toChinese(long number) {if (number == 0) {return CN_NUMBERS[0];}StringBuilder result = new StringBuilder();boolean isNegative = number < 0;if (isNegative) {number = -number;result.append(CN_NEGATIVE);}String numStr = String.valueOf(number);int length = numStr.length();for (int i = 0; i < length; i++) {int digit = numStr.charAt(i) - '0';int unitIndex = length - i - 1;// 處理零的情況if (digit == 0) {// 避免多個連續的零if (i > 0 && numStr.charAt(i - 1) != '0') {result.append(CN_NUMBERS[0]);}// 處理萬億等單位if (unitIndex % 4 == 0 && i < length - 1 && numStr.charAt(i + 1) != '0') {result.append(CN_INTEGER_UNITS[unitIndex]);}continue;}result.append(CN_NUMBERS[digit]);result.append(CN_INTEGER_UNITS[unitIndex]);}return result.toString();}/*** 將數字轉換為中文大寫(財務模式)* 例如:1234.56 → 壹仟貳佰叁拾肆元伍角陸分*/public static String toFinancialChinese(double number) {// 使用BigDecimal避免浮點數精度問題BigDecimal bd = new BigDecimal(String.valueOf(number));boolean isNegative = bd.signum() < 0;if (isNegative) {bd = bd.negate();}// 分離整數和小數部分BigDecimal integerPart = bd.setScale(0, BigDecimal.ROUND_DOWN);BigDecimal decimalPart = bd.subtract(integerPart).multiply(new BigDecimal(100)); // 轉換為分StringBuilder result = new StringBuilder();if (isNegative) {result.append(CN_NEGATIVE);}// 處理整數部分String integerStr = integerPart.toPlainString();if (integerStr.equals("0")) {result.append(CN_NUMBERS[0]);} else {int length = integerStr.length();for (int i = 0; i < length; i++) {int digit = integerStr.charAt(i) - '0';int unitIndex = length - i - 1;// 處理零的情況if (digit == 0) {if (i > 0 && integerStr.charAt(i - 1) != '0') {result.append(CN_ZERO);}if (unitIndex % 4 == 0 && i < length - 1 && integerStr.charAt(i + 1) != '0') {result.append(CN_FINANCIAL_UNITS[unitIndex]);}continue;}result.append(CN_NUMBERS[digit]);result.append(CN_FINANCIAL_UNITS[unitIndex]);}}result.append("元");// 處理小數部分int decimalInt = decimalPart.intValue();if (decimalInt == 0) {result.append(CN_INTEGER);} else {int jiao = decimalInt / 10;int fen = decimalInt % 10;if (jiao > 0) {result.append(CN_NUMBERS[jiao]).append(CN_DECIMAL_UNITS[0]);} else if (decimalInt > 9) {result.append(CN_ZERO);}if (fen > 0) {result.append(CN_NUMBERS[fen]).append(CN_DECIMAL_UNITS[1]);}}return result.toString();}// 測試示例public static void main(String[] args) {System.out.println("普通模式:");System.out.println("1234 → " + toChinese(1234));System.out.println("10001 → " + toChinese(10001));System.out.println("10030 → " + toChinese(10030));System.out.println("100000001 → " + toChinese(100000001));System.out.println("-123 → " + toChinese(-123));System.out.println("\n財務模式:");System.out.println("1234.56 → " + toFinancialChinese(1234.56));System.out.println("1000.01 → " + toFinancialChinese(1000.01));System.out.println("0.50 → " + toFinancialChinese(0.50));System.out.println("1000000 → " + toFinancialChinese(1000000));System.out.println("-123.45 → " + toFinancialChinese(-123.45));}
}
用maven打包后,將1.txt和jar放在同一個目錄,雙擊jar,就會生成目標word文件。
1.txt
1?? ?無?? ?新增用戶
2?? ?無?? ?刪除用戶
3?? ?無?? ?查詢用戶
生成out
目錄大綱也是正常的