macOS命令行工具NSGraphicsContext内存泄漏问题及解决

初始需求与实现代码 #

我想要创建一个小型工具类，用于将多个图像逐层叠加绘制，实现代码如下：

struct DrawingLayer {
   let image: NSImage
   let point: CGPoint
}

class DrawingHelper {

    let offscreenRep: NSBitmapImageRep

    init() {
        guard let offscreenRep = NSBitmapImageRep(bitmapDataPlanes: nil,
                                        pixelsWide: 2500,
                                        pixelsHigh: 2500,
                                        bitsPerSample: 8,
                                        samplesPerPixel: 4,
                                        hasAlpha: true,
                                        isPlanar: false,
                                        colorSpaceName: .calibratedRGB,
                                        bitmapFormat: .alphaFirst,
                                        bytesPerRow: 0,
                                        bitsPerPixel: 32) else { fatalError() }
        self.offscreenRep = offscreenRep
    }

    func draw(layers: [DrawingLayer], filename: String) {
       autoreleasepool {
            guard let ctx = NSGraphicsContext(bitmapImageRep: offscreenRep) else { fatalError("Failed to create context") }
            NSGraphicsContext.saveGraphicsState()
            NSGraphicsContext.current = ctx
            
            layers.forEach { layer in
                layer.image.draw(in: CGRect(origin: layer.point, size: CGSize(width: 2500, height: 2500)))
            }

            NSGraphicsContext.current = nil
            NSGraphicsContext.restoreGraphicsState()
            
            guard let data = offscreenRep.representation(using: .png, properties: [:]) else { fatalError() }
            do {
                try data.write(to: URL(fileURLWithPath: filename))
            } catch {
                fatalError("\(error)")
            }
        }
    }
}

问题现象 #

实例化该类后，每次调用绘制方法时传入由DrawingLayer组成的数组，每个图层对应最终图像中需要绘制的小尺寸图片。测试时发现如果每次调用draw方法时都实例化NSGraphicsContext，程序内存占用会持续上涨。使用Allocations性能分析工具查看可以发现ImageIO_PNG_Data对象占用的内存不断增加，但Leaks工具未检测到内存泄漏。

解决方案 #

注意：通过将NSGraphicsContext的创建、绘制、图片导出逻辑全部包裹在autoreleasepool中即可解决该问题，上述代码已经是更新后的可用版本。

问题原因说明 #

AppKit框架中NSGraphicsContext实例、PNG数据导出过程中生成的大量临时对象都属于自动释放对象，默认会被加入当前线程的自动释放池。如果在主线程频繁调用绘制方法，主线程的自动释放池要等到RunLoop下一次循环才会清空，这些临时对象就会持续堆积，出现内存不断上涨的现象。
手动添加autoreleasepool包裹绘制逻辑后，每次draw方法执行完成，块内产生的所有自动释放对象都会被立即回收，不会出现内存堆积。

可选优化项 #

• 画布尺寸固定的场景下，可以直接复用NSGraphicsContext实例，不需要每次调用draw方法都重新创建，进一步减少临时对象的生成开销
• 导出PNG时可根据需求调整压缩等级参数，降低导出环节的内存占用
• 每次绘制前可手动清空离屏位图的旧数据，避免上一次绘制内容残留的同时减少不必要的内存占用

内容的提问来源于stack exchange，提问作者plato