在 macOS 上使用 C# 从 JSON 创建格式良好的 Word 文档

从 JSON 数据生成动态 Word 文档

使用基于模板的方法和占位符，在 .NET 8 中使用 C# 为 macOS 实现

// Import necessary libraries
using System;
using System.IO;
using Newtonsoft.Json;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
// Define the data model for employees
public class Employee
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string DateOfBirth { get; set; }
}
// Main program
class Program
{
    static void Main(string[] args)
    {
        // Load JSON data
        string jsonFilePath = "employees.json";
        var employees = JsonConvert.DeserializeObject<List<Employee>>(File.ReadAllText(jsonFilePath));
        // Define template path and output path
        string templatePath = "template.docx";
        string outputPath = "output.docx";
        // Open the Word template
        using (var wordDoc = WordprocessingDocument.Open(templatePath, true))
        {
            var body = wordDoc.MainDocumentPart.Document.Body;
            // Replace placeholders
            foreach (var employee in employees)
            {
                foreach (var text in body.Descendants<Text>())
                {
                    text.Text = text.Text.Replace("{FirstName}", employee.FirstName)
                                          .Replace("{LastName}", employee.LastName)
                                          .Replace("{DateOfBirth}", employee.DateOfBirth);
                }
            }
        }
        // Save as a new file
        File.Copy(templatePath, outputPath, true);
        Console.WriteLine("Document generated successfully!");
    }
}

无需模板即可以编程方式生成 Word 文档

在 C# 中使用基于纯代码的方法和 Open XML SDK

// Import necessary libraries
using System;
using System.IO;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using Newtonsoft.Json;
// Define the data model for employees
public class Employee
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string DateOfBirth { get; set; }
}
// Main program
class Program
{
    static void Main(string[] args)
    {
        // Load JSON data
        string jsonFilePath = "employees.json";
        var employees = JsonConvert.DeserializeObject<List<Employee>>(File.ReadAllText(jsonFilePath));
        // Define output path
        string outputPath = "output_from_code.docx";
        // Create Word document
        using (var wordDoc = WordprocessingDocument.Create(outputPath, DocumentFormat.OpenXml.WordprocessingDocumentType.Document))
        {
            // Add a main document part
            var mainPart = wordDoc.AddMainDocumentPart();
            mainPart.Document = new Document();
            var body = mainPart.Document.AppendChild(new Body());
            // Add content for each employee
            foreach (var employee in employees)
            {
                var para = body.AppendChild(new Paragraph());
                var run = para.AppendChild(new Run());
                run.AppendChild(new Text($"Name: {employee.FirstName} {employee.LastName}, DOB: {employee.DateOfBirth}"));
            }
        }
        Console.WriteLine("Document generated successfully!");
    }
}

有关自动化 Word 文档的常见问题

1. 在 C# 中处理 Word 文档的最佳库是什么？
2. 这 Open XML SDK 被广泛认为是以编程方式操作 Word 文档的最强大的选项。
3. 如何替换 Word 模板中的占位符？
4. 你可以使用 Text.Replace 查找占位符并将其替换为动态内容，例如 {FirstName}。
5. 如果我的 JSON 文件包含意外数据，会发生什么情况？
6. 使用 JsonConvert.DeserializeObject 验证可确保您的 JSON 数据得到正确处理，即使它包含意外字段。
7. 我可以通过编程方式将图像添加到我的 Word 文档中吗？
8. 是的，您可以使用嵌入图像 ImagePart 在 Open XML SDK 中动态添加徽标或照片。
9. 如何确保我的文档与公司品牌相符？
10. 准备一个预先格式化的模板，其中包括自定义样式、字体和颜色，您的脚本可使用该模板来生成文档。
11. 是否可以处理嵌套的 JSON 数据？
12. 您可以预处理 JSON 以展平嵌套对象，或使用循环动态填充 Word 文档中的多个占位符。
13. 哪种方法更适合复杂文档：模板还是基于代码？
14. 模板通常更适合复杂的设计，而基于代码的方法则适合更简单的结构或高度定制。
15. 如何防止覆盖原始模板？
16. 使用 File.Copy 将输出保存为新文件，同时保留原始模板。
17. 我可以一次生成多个Word文档吗？
18. 是的，您可以迭代 JSON 数据，使用脚本中的循环为每个条目创建一个新文档。
19. 最适合此工作流程的 IDE 是什么？
20. 虽然您可以使用 Visual Studio 或 Visual Studio Code，但后者是轻量级的并且可以很好地与 macOS 配合使用。

使用 JSON 和 C# 制作动态 Word 文档

基于模板的方法因其灵活性和易用性而脱颖而出，特别是在创建设计良好的专业文档方面。通过结合手动格式化和自动数据插入，您可以节省时间，同时保持质量和一致性。 📝

或者，以编程方式从头开始生成 Word 文档可以提供更好的自定义功能，但需要更多的精力来进行详细的格式化。借助 Open XML SDK 等工具，此方法非常适合简单或重复的文档，只需进行最少的样式调整。选择适合您的工作流程的方法。 🚀