使用Node.js实现Word文档差异比较并高亮标注工具

npm install docx mammoth diff fs-extra

/**
 * Word文档差异比较工具
 * 本脚本使用Node.js比较两个Word(.docx)文件的内容差异，并生成带有颜色标注的比较结果文档
 */

const fs = require('fs');
const path = require('path');
const { Document, Paragraph, TextRun, HeadingLevel, Packer } = require('docx');
const mammoth = require('mammoth');
const diff = require('diff');

/**
 * 比较两个Word文件并生成差异报告
 * @param {string} file1Path - 第一个Word文件路径(原始文件)
 * @param {string} file2Path - 第二个Word文件路径(修改后的文件)
 * @param {string} outputPath - 差异报告输出路径
 * 
 * 技术原理：
 * 1. 使用mammoth库提取两个Word文档的纯文本内容
 * 2. 使用diff库进行文本差异比较，识别添加、删除和未更改的部分
 * 3. 使用docx库构建新的Word文档，用不同颜色和样式标注差异部分
 */
async function compareWordFiles(file1Path, file2Path, outputPath) {
    try {
        // 提取两个Word文件的文本内容
        // mammoth.extractRawText会解析docx文件的XML结构，提取所有文本内容
        const file1Content = await extractTextFromDocx(file1Path);
        const file2Content = await extractTextFromDocx(file2Path);

        // 使用diff库比较文本差异
        // diffWords函数会将文本分解为单词级别的差异，返回一个差异对象数组
        // 每个差异对象包含value(文本内容)和added/removed标志
        const differences = diff.diffWords(file1Content, file2Content);

        // 使用docx库创建新的Word文档
        // Document对象表示整个Word文档，包含一个或多个sections
        const doc = new Document({
            sections: [{
                properties: {},
                children: [
                    // 文档标题
                    new Paragraph({
                        text: "Word文档差异比较结果",
                        heading: HeadingLevel.HEADING_1,
                        spacing: { after: 200 } // 设置段后间距(单位:twip,1/20磅)
                    }),
                    // 原始文件信息
                    new Paragraph({
                        text: `原文件: ${path.basename(file1Path)}`,
                        spacing: { after: 100 }
                    }),
                    // 修改后文件信息
                    new Paragraph({
                        text: `新文件: ${path.basename(file2Path)}`,
                        spacing: { after: 200 }
                    }),
                    // 插入差异内容段落
                    ...generateDiffParagraphs(differences)
                ]
            }]
        });

        // 将Document对象转换为Buffer并写入文件
        // Packer.toBuffer内部使用JSZip库打包docx文件(本质上是ZIP格式的XML文件集合)
        const buffer = await Packer.toBuffer(doc);
        fs.writeFileSync(outputPath, buffer);
        console.log(`差异比较结果已保存到: ${outputPath}`);
    } catch (error) {
        console.error('比较过程中出错:', error);
    }
}

/**
 * 从Word文档中提取纯文本内容
 * @param {string} filePath - Word文件路径
 * @returns {Promise<string>} 提取的纯文本内容
 * 
 * 技术原理：
 * mammoth库解析docx文件(实际是ZIP压缩的XML文件)，
 * 遍历document.xml中的段落和文本节点，拼接成纯文本字符串
 */
async function extractTextFromDocx(filePath) {
    const result = await mammoth.extractRawText({ path: filePath });
    return result.value;
}

/**
 * 根据差异结果生成带有样式标注的段落数组
 * @param {Array} differences - diff库生成的差异数组
 * @returns {Array} 包含Paragraph对象的数组
 * 
 * 技术原理：
 * 1. 处理diff库输出的差异数组，每个部分可能是added/removed/unchanged
 * 2. 按换行符分割文本，确保每个段落独立
 * 3. 为不同差异类型创建不同样式的TextRun:
 *    - 新增内容: 蓝色(#1800a1)、加粗
 *    - 删除内容: 红色(#FF0000)、删除线
 *    - 未更改内容: 黑色(#000000)
 */
function generateDiffParagraphs(differences) {
    const paragraphs = [];
    let currentParagraph = [];

    // 遍历每个差异部分
    differences.forEach(part => {
        // 按换行符分割文本，处理多行内容
        const lines = part.value.split('\n');
        
        lines.forEach((line, lineIndex) => {
            // 跳过空行
            if (line.trim() === '') return;
            
            let textRun;
            if (part.added) {
                // 新增内容样式
                textRun = new TextRun({
                    text: line,
                    color: '1800a1', // 蓝色表示新增
                    bold: true       // 加粗突出显示
                });
            } else if (part.removed) {
                // 删除内容样式
                textRun = new TextRun({
                    text: line,
                    color: 'FF0000', // 红色表示删除
                    strike: true      // 删除线表示已移除
                });
            } else {
                // 未更改内容样式
                textRun = new TextRun({
                    text: line,
                    color: '000000'  // 黑色表示未更改
                });
            }
            
            // 将文本段添加到当前段落
            currentParagraph.push(textRun);
            
            // 如果不是最后一行，创建新段落
            if (lineIndex < lines.length - 1) {
                paragraphs.push(new Paragraph({
                    children: currentParagraph
                }));
                currentParagraph = []; // 重置当前段落
            }
        });
    });

    // 添加最后一个未完成的段落
    if (currentParagraph.length > 0) {
        paragraphs.push(new Paragraph({
            children: currentParagraph
        }));
    }

    return paragraphs;
}

// 使用示例
const file1 = path.join(__dirname, './word/dl_v1.docx');
const file2 = path.join(__dirname, './word/js_xg_v1.docx');
const output = path.join(__dirname, './word/comparison_result.docx');

// 执行比较
compareWordFiles(file1, file2, output);