Open-XML-SDK 项目中插入图片到 Excel 的现代实现方案

在 Open-XML-SDK 3.0 及以上版本中，插入图片到 Excel 文档的实现方式发生了一些变化，这导致许多旧代码示例不再适用。本文将详细介绍如何在最新版本的 Open-XML-SDK 中正确实现图片插入功能。

旧版本代码的问题

许多开发者参考的早期代码示例中使用了 .Close() 方法来关闭文档，这个方法在 Open-XML-SDK 3.0 及以上版本中已被移除。直接使用这些旧代码会导致运行时错误或生成的 Excel 文件损坏。

现代实现方案

现代推荐的做法是使用 using 语句来管理资源，这比直接调用 .Dispose() 方法更加安全和可靠。以下是完整的实现代码：

using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Spreadsheet;
using DocumentFormat.OpenXml.Drawing.Spreadsheet;
using D = DocumentFormat.OpenXml.Drawing;
using S = DocumentFormat.OpenXml.Drawing.Spreadsheet;
using System.Drawing;

void CreateExcelWithImage(string filePath, string imagePath)
{
    if (File.Exists(filePath))
    {
        File.Delete(filePath);
    }
    
    using (var spreadsheet = SpreadsheetDocument.Create(filePath, SpreadsheetDocumentType.Workbook))
    {
        // 创建工作簿部分
        var workbookPart = spreadsheet.AddWorkbookPart();
        workbookPart.Workbook = new Workbook();

        // 创建工作表部分
        var worksheetPart = workbookPart.AddNewPart<WorksheetPart>();
        worksheetPart.Worksheet = new Worksheet(new SheetData());

        // 添加工作表到工作簿
        var sheets = spreadsheet.WorkbookPart.Workbook.AppendChild(new Sheets());
        sheets.Append(new Sheet()
        {
            Id = spreadsheet.WorkbookPart.GetIdOfPart(worksheetPart),
            SheetId = 1,
            Name = "图片工作表"
        });

        // 添加绘图部分
        var drawingsPart = worksheetPart.AddNewPart<DrawingsPart>();
        if (!worksheetPart.Worksheet.ChildElements.OfType<Drawing>().Any())
        {
            worksheetPart.Worksheet.Append(new Drawing { Id = worksheetPart.GetIdOfPart(drawingsPart) });
        }

        if (drawingsPart.WorksheetDrawing == null)
        {
            drawingsPart.WorksheetDrawing = new WorksheetDrawing();
        }

        // 添加图片部分
        var imagePart = drawingsPart.AddImagePart(ImagePartType.Jpeg);
        using (var imageStream = new FileStream(imagePath, FileMode.Open))
        {
            imagePart.FeedData(imageStream);
        }

        // 计算图片尺寸
        using (var bitmap = new Bitmap(imagePath))
        {
            var extentsCx = (long)bitmap.Width * 914400L / (long)bitmap.HorizontalResolution;
            var extentsCy = (long)bitmap.Height * 914400L / (long)bitmap.VerticalResolution;

            // 设置图片位置和属性
            var oneCellAnchor = new S.OneCellAnchor(
                new S.FromMarker
                {
                    ColumnId = new S.ColumnId("4"),  // 第5列(0-based)
                    RowId = new S.RowId("9"),       // 第10行(0-based)
                    ColumnOffset = new S.ColumnOffset("0"),
                    RowOffset = new S.RowOffset("0")
                },
                new S.Extent { Cx = extentsCx, Cy = extentsCy },
                new S.Picture(
                    new S.NonVisualPictureProperties(
                        new S.NonVisualDrawingProperties { 
                            Id = 1U, 
                            Name = "插入的图片", 
                            Description = "示例图片" 
                        },
                        new S.NonVisualPictureDrawingProperties(
                            new D.PictureLocks { NoChangeAspect = true })
                    ),
                    new S.BlipFill(
                        new D.Blip { 
                            Embed = drawingsPart.GetIdOfPart(imagePart), 
                            CompressionState = D.BlipCompressionValues.Print 
                        },
                        new D.Stretch(new D.FillRectangle())
                    ),
                    new S.ShapeProperties(
                        new D.Transform2D(
                            new D.Offset { X = 0, Y = 0 },
                            new D.Extents { Cx = extentsCx, Cy = extentsCy }
                        ),
                        new D.PresetGeometry { Preset = D.ShapeTypeValues.Rectangle }
                    )
                ),
                new S.ClientData()
            );

            drawingsPart.WorksheetDrawing.Append(oneCellAnchor);
        }
    }
}

关键点解析

1. 资源管理：使用 using 语句确保所有资源(包括 SpreadsheetDocument 和 Bitmap)都能被正确释放。

2. 图片尺寸计算：通过读取图片的物理尺寸和分辨率，转换为 Excel 内部使用的 EMU(English Metric Unit)单位。

3. 定位系统：Excel 使用基于单元格的定位系统，可以精确控制图片在单元格中的位置。

4. 图片属性：可以设置图片的各种属性，如锁定纵横比、名称和描述等。

常见问题

1. 图片不显示：确保图片部分已正确添加到绘图部分，并且 Embed 属性指向正确的图片部分 ID。

2. 文件损坏：确保所有流在使用后都被正确关闭，避免文件写入不完整。

3. 尺寸不正确：仔细检查 EMU 单位的计算过程，确保考虑了图片的分辨率。

通过以上方法，开发者可以在最新版本的 Open-XML-SDK 中可靠地实现图片插入功能，生成的 Excel 文件能够被正常打开和使用。