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

背景介绍

在使用Open XML SDK处理Excel文件时，开发者经常需要将图片插入到工作表中。然而，随着SDK版本的更新，一些旧的实现方法已经不再适用，导致开发者在使用过程中遇到各种问题。

问题分析

在Open XML SDK v3.0及更高版本中，.Close()方法已被移除。如果继续使用旧版本的代码示例，会导致以下问题：

1. 图片无法正确显示
2. Excel文件打开时报错
3. 资源无法正确释放

现代解决方案

1. 使用Dispose替代Close

最直接的修改方案是将.Close()方法替换为.Dispose()。这是解决兼容性问题的最快方法，但并不是最佳实践。

2. 推荐使用using语句

更现代且安全的做法是使用using语句，它能确保资源被正确释放，即使在代码执行过程中发生异常。

using (SpreadsheetDocument spreadsheetDocument = SpreadsheetDocument.Create(sFile, SpreadsheetDocumentType.Workbook))
{
    // 文档操作代码
}

3. 完整实现方案

以下是插入图片到Excel工作表的完整现代实现：

void CreateExcelWithImage(string filePath, string imagePath)
{
    if (File.Exists(filePath))
    {
        File.Delete(filePath);
    }

    using (SpreadsheetDocument doc = SpreadsheetDocument.Create(filePath, SpreadsheetDocumentType.Workbook))
    {
        // 创建工作簿部分
        WorkbookPart workbookPart = doc.AddWorkbookPart();
        workbookPart.Workbook = new Workbook();

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

        // 添加工作表到工作簿
        Sheets sheets = doc.WorkbookPart.Workbook.AppendChild<Sheets>(new Sheets());
        Sheet sheet = new Sheet()
        {
            Id = doc.WorkbookPart.GetIdOfPart(worksheetPart),
            SheetId = 1,
            Name = "数据工作表"
        };
        sheets.Append(sheet);

        // 添加绘图部分
        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 stream = new FileStream(imagePath, FileMode.Open))
        {
            imagePart.FeedData(stream);
        }

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

        // 设置图片位置和属性
        var oneCellAnchor = new OneCellAnchor(
            // 位置信息
            new FromMarker
            {
                ColumnId = new ColumnId("4"), // 第5列(0-based)
                RowId = new RowId("9"),       // 第10行(0-based)
                ColumnOffset = "0",
                RowOffset = "0"
            },
            // 尺寸信息
            new Extent { Cx = extentsCx, Cy = extentsCy },
            // 图片属性
            new Picture(
                new NonVisualPictureProperties(
                    new NonVisualDrawingProperties { 
                        Id = GetNextId(worksheetDrawing), 
                        Name = "公司Logo",
                        Description = "插入的图片说明"
                    },
                    new NonVisualPictureDrawingProperties(
                        new PictureLocks { NoChangeAspect = true })
                ),
                // 图片填充
                new BlipFill(
                    new Blip { 
                        Embed = drawingsPart.GetIdOfPart(imagePart),
                        CompressionState = BlipCompressionValues.Print 
                    },
                    new Stretch(new FillRectangle())
                ),
                // 形状属性
                new ShapeProperties(
                    new Transform2D(
                        new Offset { X = 0, Y = 0 },
                        new Extents { Cx = extentsCx, Cy = extentsCy }
                    ),
                    new PresetGeometry { Preset = ShapeTypeValues.Rectangle }
                )
            ),
            new ClientData()
        );

        worksheetDrawing.Append(oneCellAnchor);
    }
}

关键点解析

1. 资源管理：使用using语句确保所有资源被正确释放
2. 图片尺寸计算：需要将像素转换为EMU(English Metric Units)单位
3. 位置设置：通过FromMarker设置图片的单元格位置
4. 唯一标识：为每个图片元素分配唯一的ID

常见问题处理

1. 图片不显示：检查图片部分的Embed属性是否正确引用了imagePart
2. 文件损坏：确保所有流在使用后都被正确关闭
3. 尺寸异常：验证EMU单位的计算是否正确

最佳实践建议

1. 对于批量插入多张图片，考虑使用辅助方法管理ID分配
2. 封装图片插入逻辑为可重用组件
3. 添加异常处理确保程序健壮性
4. 考虑图片压缩选项以减小文件体积

通过采用这些现代实现方法，开发者可以确保在最新版本的Open XML SDK中稳定可靠地将图片插入Excel文档。