Java查询数据库表信息导出Word

Lxinccode2025-04-27 8:56

参考: POI生成Word多级标题格式_poi设置word标题-CSDN博客

1.概述

使用jdbc查询数据库把表信息导出为word文档, 导出为word时需要下载word模板文件。

已实现数据库:

2.效果图

2.1.生成word内容

所有数据库合并

数据库不合并

2.2.生成文件列表

3.代码文件结构

4.代码实现

4.1.dto

4.1.1.DbInfoDTO.java

java 复制代码 
package cn.nordrassil.db2doc.dto;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;


@Data
@AllArgsConstructor
@NoArgsConstructor
public class DbInfoDTO {
    private String dbName;
    private String dbDescribe;
    private List<TableInfo> tableInfos;


    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    public static class TableInfo {
        private String tableName;
        private String tableDescribe;
        private List<TableField> tableFields;
        private List<List<String>> tableContents;

        public TableInfo(String tableName, String tableDescribe, List<TableField> tableFields) {
            this.tableName = tableName;
            this.tableDescribe = tableDescribe;
            this.tableFields = tableFields;
        }
    }

    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    public static class TableField {
        private String name;
        private String type;
        private Integer length;
        private String allowEmpty;
        private String isPrimaryKey;
        private String defaultValue;
        private String describe;
    }

}

4.1.2.DbConnParamDTO.java

java 复制代码 
package cn.nordrassil.db2doc.dto;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class DbConnParamDTO {
    private String host;
    private Integer port;
    private String username;
    private String password;
    // 随机填一个数据库即可
    private String randomDatabase;
    // 数据库前缀过滤
    private String dbPrefixFilter;
    // 等于true是只会导出第一张表
    private Boolean testRun;
}

4.1.3.ExportWordParamDTO

java 复制代码 
package cn.nordrassil.db2doc.dto;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExportWordParamDTO {

    // 数据信息
    private List<DbInfoDTO> ds;
    // 导出word模板文件
    private String wordTemplateFile;
    // 导出目录
    private String exportFolder;
    // 所有数据库是否合并到一个文档, 默认每个数据库一个文档
    private Boolean merge = Boolean.FALSE;
}

4.2.util

4.2.1.CommonUtil.java

java 复制代码 
package cn.nordrassil.db2doc.util;

import java.io.*;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class CommonUtil {

    private static DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");
    private static DateTimeFormatter dateFormatter2 = DateTimeFormatter.ofPattern("yyyyMMdd_HHmmss");

    public static String readByLineRs(String path) {
        StringBuffer sb = new StringBuffer();
        File file = new File(path);
        BufferedReader reader = null;
        String temp = null;
        try {
            reader = new BufferedReader(new FileReader(file));
            while ((temp = reader.readLine()) != null) {
                sb.append(temp).append("\n");
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (reader != null) {
                try {
                    reader.close();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
        return sb.toString();
    }


    /**
     * 依次替换{}
     * 例 : join("a={},b={}",1,2) => a=1,b=2
     *
     * @param str
     * @param param
     * @return
     */
    public static String join(String str, Object... param) {
        try {
            for (Object p : param) {
                String processedParam = p.toString().replace("\\", "\\\\");
                str = str.replaceFirst("\\{\\}", processedParam);
            }
        } catch (Exception e) {
            for (Object p : param) {
                str = str + p;
            }
        }
        return str;
    }

    public static void writeString(String content, String path) {
        try {
            File file = new File(path);
            if (!file.exists()) {
                file.createNewFile();
            }
            FileWriter fw = new FileWriter(file.getAbsoluteFile());
            BufferedWriter bw = new BufferedWriter(fw);
            bw.write(content);
            bw.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


    public static void info(String str, Object... param) {
        System.out.println(LocalDateTime.now().format(dateFormatter) + "|" + join(str, param));
    }

    public static String getDayTime() {
        return LocalDateTime.now().format(dateFormatter2);
    }


    public static void createDirectoryIfNotExists(String absolutePath) {
        File file = new File(absolutePath);
        // 获取文件所在的目录
        File parentDir = file.getParentFile();
        if (parentDir != null && !parentDir.exists()) {
            // 创建目录
            parentDir.mkdirs();
        }
    }

}

4.3.service

4.3.1.DbInfoExportWordService.java

java 复制代码 
package cn.nordrassil.db2doc;

import cn.nordrassil.db2doc.dto.DbInfoDTO;
import cn.nordrassil.db2doc.dto.ExportWordParamDTO;
import com.alibaba.fastjson.JSONObject;
import org.apache.poi.xwpf.usermodel.*;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcPr;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static cn.nordrassil.db2doc.util.CommonUtil.*;


// 参考: https://blog.csdn.net/qq_37945565/article/details/121518330

public class DbInfoExportWordService {

    public static List<String> tableTitles = new ArrayList<String>() {{
        add("序号");
        add("字段名");
        add("字段类型");
        add("长度");
        add("非空");
        add("主键");
        add("默认值");
        add("注释");
    }};

    public static List<String> fields = new ArrayList<String>() {{
        add("name");
        add("type");
        add("length");
        add("allowEmpty");
        add("isPrimaryKey");
        add("defaultValue");
        add("describe");
    }};

    public static void generateWord(ExportWordParamDTO paramDTO) throws Exception {
        // 获得模板文档的整体样式
        XWPFDocument template = new XWPFDocument(new FileInputStream(paramDTO.getWordTemplateFile()));
        CTStyles wordStyles = template.getStyle();

        int totalTableCount = 0;
        int index = 1;
        List<DbInfoDTO> ds = paramDTO.getDs();
        XWPFDocument document = null;
        boolean merge = paramDTO.getMerge() != null && paramDTO.getMerge();
        if (merge) {
            document = new XWPFDocument();
        }
        for (DbInfoDTO d : ds) {
            info("执行第[{}/{}]生成word文档...表数量:{}", index, ds.size(), d.getTableInfos().size());
            if (!merge) {
                document = new XWPFDocument();
            }
            // 获取新建文档对象的样式
            XWPFStyles newStyles = document.createStyles();
            // 关键行// 修改设置文档样式为静态块中读取到的样式
            newStyles.setStyles(wordStyles);
            if (merge) {
                XWPFParagraph title1 = document.createParagraph();
                title1.setStyle("2");
                XWPFRun titleRun1 = title1.createRun();
                String dbText = index + "." + d.getDbName();
                if (d.getDbDescribe() != null) {
                    dbText += "(" + d.getDbDescribe().replaceAll("\r\n", "").replaceAll("\r", "").replaceAll("\n", "") + ")";
                }
                titleRun1.setText(dbText);
            }

            List<DbInfoDTO.TableInfo> tableInfos = d.getTableInfos();
            totalTableCount += tableInfos.size();
            for (int k = 0; k < tableInfos.size(); k++) {
                DbInfoDTO.TableInfo tableInfo = tableInfos.get(k);
                XWPFParagraph title2 = document.createParagraph();
                XWPFRun titleRun2 = title2.createRun();
                String tableText;
                if (merge) {
                    title2.setStyle("3");
                    tableText = index + "." + (k + 1) + "." + tableInfo.getTableName();
                } else {
                    title2.setStyle("2");
                    tableText = (k + 1) + "." + tableInfo.getTableName();
                }
                if (tableInfo.getTableDescribe() != null) {
                    tableText += "(" + tableInfo.getTableDescribe().replaceAll("\r\n", "").replaceAll("\r", "").replaceAll("\n", "") + ")";
                }
                titleRun2.setText(tableText);
                // 创建表格(第一列为序号)
                List<DbInfoDTO.TableField> tableFields = tableInfo.getTableFields();
                XWPFTable table = document.createTable(tableFields.size(), 8);
                int titleFontSize = 10;
                int textFontSize = 8;
                // 设置表格标题样式
                for (int i = 0; i < table.getRows().get(0).getTableCells().size(); i++) {
                    XWPFTableCell cell = table.getRows().get(0).getCell(i);
                    XWPFParagraph cellParagraph = cell.getParagraphs().get(0);
                    cellParagraph.setIndentationLeft(0); // 设置左侧缩进为0
                    cellParagraph.setIndentationRight(0); // 设置右侧缩进为0
                    cellParagraph.setIndentationFirstLine(0); // 设置首行缩进为0
                    cellParagraph.setIndentationLeft(0);

                    // 设置单元格背景色为灰色
                    CTTcPr cellPr = cell.getCTTc().addNewTcPr();
                    CTShd shd = cellPr.addNewShd();
                    shd.setFill("D3D3D3");
                    cellParagraph.setAlignment(ParagraphAlignment.CENTER);
                    XWPFRun cellRun = cellParagraph.createRun();
                    cellRun.setBold(true);
                    cellRun.setText(tableTitles.get(i));
                    cellRun.setFontSize(titleFontSize);

                }
                // 写入表格内容
                for (int row = 1; row < table.getNumberOfRows(); row++) {
                    for (int col = 0; col < table.getRow(row).getTableCells().size(); col++) {
                        XWPFTableCell cell = table.getRow(row).getCell(col);
                        XWPFParagraph cellParagraph = cell.getParagraphs().get(0);
                        XWPFRun cellRun = cellParagraph.createRun();
                        if (col == 0) {
                            cellRun.setText(row + "");
                        } else {
                            DbInfoDTO.TableField tableField = tableFields.get(row - 1);
                            JSONObject jsonObject = JSONObject.parseObject(JSONObject.toJSONString(tableField));
                            cellRun.setText(jsonObject.getString(fields.get(col - 1)));
                        }
                        CTTcPr tcPr = cell.getCTTc().getTcPr();
                        if (tcPr == null) {
                            tcPr = cell.getCTTc().addNewTcPr();
                        }
                        if (!tcPr.isSetTcMar()) {
                            tcPr.addNewTcMar();
                        }
                        tcPr.getTcMar().addNewLeft().setW(0);
                        tcPr.getTcMar().addNewRight().setW(0);
                        tcPr.getTcMar().addNewTop().setW(0);
                        tcPr.getTcMar().addNewBottom().setW(0);
                        cellRun.setFontSize(textFontSize);
                        cellParagraph.setIndentationLeft(0);
                        // 设置段落左对齐
                        cellParagraph.setAlignment(ParagraphAlignment.LEFT);
                        // 设置左缩进为 0
                        cellParagraph.setIndentationLeft(0);
                    }
                }
            }

            if (!merge) {
                // 保存文档
                String outputFile = paramDTO.getExportFolder() + File.separator + d.getDbName() + ".docx";
                createDirectoryIfNotExists(outputFile);
                try (FileOutputStream out = new FileOutputStream(outputFile)) {
                    document.write(out);
                    info("第[{}/{}]数据库信息生成word文档完成, 文档路径:{}", index, ds.size(), outputFile);
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            index++;
        }
        if (merge) {
            // 保存文档
            String outputFile = paramDTO.getExportFolder() + File.separator + getDayTime() + "_all_db.docx";
            createDirectoryIfNotExists(outputFile);
            try (FileOutputStream out = new FileOutputStream(outputFile)) {
                document.write(out);
                info("所有数据库信息生成word文档完成, 文档路径:{}", outputFile);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        info("数据库已导出为word文档完成, 数据库数量:{}, 所有表总数量:{}", ds.size(), totalTableCount);
    }
}

4.3.2.GetDbInfoService.java

java 复制代码 
package cn.nordrassil.db2doc;

import cn.nordrassil.db2doc.dto.DbConnParamDTO;
import cn.nordrassil.db2doc.dto.DbInfoDTO;

import java.util.List;

public interface GetDbInfoService {

    List<DbInfoDTO> get(DbConnParamDTO dto);
}

5.依赖

5.1.mave依赖

java 复制代码 
<dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.83</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.28</version>
            <scope>provided</scope>
        </dependency>
        <!-- Apache Commons Compress 用于处理多种归档文件格式 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-compress</artifactId>
            <version>1.24.0</version>
        </dependency>
        <!-- Apache Commons IO 提供了 IO 操作的工具类 -->
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.13.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.junrar</groupId>
            <artifactId>junrar</artifactId>
            <version>7.5.5</version>
        </dependency>
        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>5.2.3</version>
        </dependency>

5.2.word文档模板

word/word模板.docx · 楽焫旒璡/public-share - 码云 - 开源中国

6.测试

6.1.MyTest.java

java 复制代码 
package cn.nordrassil.db2doc;

import cn.nordrassil.db2doc.dto.DbConnParamDTO;
import cn.nordrassil.db2doc.dto.DbInfoDTO;
import cn.nordrassil.db2doc.dto.ExportWordParamDTO;
import cn.nordrassil.db2doc.impl.GetDbInfoKingBaseEsService;
import cn.nordrassil.db2doc.util.CommonUtil;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class MyTest {

    public static void main(String[] args) throws Exception {
        String exportFolder = System.getProperty("user.dir") + File.separator + "files";
        String templateFile = "F:\\文档\\开发\\word模板.docx";
        String resultFile = exportFolder + File.separator + "result.json";
        //getDbInfo(resultFile);

        List<DbInfoDTO> ds = readData(resultFile);
        ExportWordParamDTO exportWordParamDTO = new ExportWordParamDTO(
                ds, templateFile, exportFolder, true
        );
        //DbInfoExportWordService.generateWord(exportWordParamDTO);
    }

    public static void getDbInfo(String resultFile) throws Exception {
        GetDbInfoService getDbInfoService = new GetDbInfoKingBaseEsService();
        List<DbInfoDTO> dbInfoDTOS = getDbInfoService.get(new DbConnParamDTO(
                "192.168.1.1",
                5432,
                "root",
                "123456",
                "test",
                "test",
                true
        ));
        CommonUtil.writeString(JSONObject.toJSONString(dbInfoDTOS), resultFile);
    }

    public static List<DbInfoDTO> readData(String resultFile) {
        JSONArray jas = JSONObject.parseArray(CommonUtil.readByLineRs(resultFile));
        List<DbInfoDTO> ds = new ArrayList<>();
        for (int i = 0; i < jas.size(); i++) {
            JSONObject ja = jas.getJSONObject(i);
            DbInfoDTO dbInfo = new DbInfoDTO();
            dbInfo.setDbName(ja.getString("dbName"));
            dbInfo.setDbDescribe(ja.getString("dbDescribe"));
            List<DbInfoDTO.TableInfo> tableInfos = new ArrayList<>();
            dbInfo.setTableInfos(tableInfos);
            JSONArray tis = ja.getJSONArray("tableInfos");
            for (int k = 0; k < tis.size(); k++) {
                JSONObject ti = tis.getJSONObject(k);
                DbInfoDTO.TableInfo tableInfo = new DbInfoDTO.TableInfo();
                tableInfos.add(tableInfo);
                tableInfo.setTableName(ti.getString("tableName"));
                tableInfo.setTableDescribe(ti.getString("tableDescribe"));
                JSONArray tfs = ti.getJSONArray("tableFields");
                List<DbInfoDTO.TableField> tableFields = new ArrayList<>();
                tableInfo.setTableFields(tableFields);
                for (int j = 0; j < tfs.size(); j++) {
                    JSONObject tf = tfs.getJSONObject(j);
                    tableFields.add(new DbInfoDTO.TableField(
                            tf.getString("name"),
                            tf.getString("type"),
                            tf.getInteger("length"),
                            tf.getString("allowEmpty"),
                            tf.getString("isPrimaryKey"),
                            tf.getString("defaultValue"),
                            tf.getString("describe")
                    ));
                }
            }
            ds.add(dbInfo);
        }
        return ds;
    }
}
相关推荐
东方佑6 小时前
使用Python创建带边框样式的Word表格
数据库·python·word
振宇i1 天前
Java 富文本转word
java·word·富文本·docx4j
南博萬2 天前
java将pdf转换成word
java·pdf·word
zhishishe2 天前
2025 年免费 Word 转 PDF 转换器有哪些？
android·windows·pdf·电脑·word
神奇侠20243 天前
基于PaddleOCR对图片中的excel进行识别并转换成word（一）
python·word·excel·paddleocr
zhishishe3 天前
工具指南：免费将 PDF 转换为 Word 的 10 个工具
android·windows·pdf·word
zhishishe4 天前
Word技巧：如何在 Mac 和 Windows 上检索未保存的 Word 文档
windows·macos·word
usdoc文档预览5 天前
Office文件内容提取 | 获取Word文件内容 |Javascript提取PDF文字内容 |PPT文档文字内容提取
javascript·pdf·word·ppt·office文件在线预览·word文档在线预览·ofd预览转pdf
AI偶然5 天前
AI智能体|扣子(Coze)搭建【一键转换为Word/pdf/Excel】工作流保姆级教学
人工智能·pdf·word
热门推荐
01KGG转MP3工具|非KGM文件|解密音频02从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑03我决定放弃搞 Java 了04YOLOv5改进 | 添加CA注意力机制 + 增加预测层 + 更换损失函数之GIoU05YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】06DeepSeek各版本说明与优缺点分析07西电B测-计算机网络综合实验(含验收问题)08yolov8，yolo11，yolo12 服务器训练到部署全流程 笔记09苍穹外卖面试总结10最新 Kubernetes 集群部署 + flannel 网络插件（保姆级教程，最新 K8S 版本）