ScreenshotFramer扩展开发：如何添加自定义导出格式和功能-平芜编程栈

ScreenshotFramer扩展开发：如何添加自定义导出格式和功能

【免费下载链接】ScreenshotFramerCreate localized App Store screenshots项目地址: https://gitcode.com/gh_mirrors/sc/ScreenshotFramer

ScreenshotFramer是一款强大的本地化App Store截图创建工具，它允许开发者轻松生成适用于不同设备和语言的应用截图。本文将详细介绍如何为ScreenshotFramer添加自定义导出格式和功能，帮助开发者更好地满足特定项目需求。

了解ScreenshotFramer的核心导出功能

ScreenshotFramer的导出功能主要由ExportController类负责处理，该类位于Screenshot Framer/Document Window/Content View Controller/Help Controller/ExportController.swift文件中。它提供了多种导出方式，包括单张图片导出、批量导出以及预览功能。

ScreenshotFramer的导出界面，展示了各种导出选项和设置

自定义导出格式的基本步骤

要添加自定义导出格式，需要完成以下几个关键步骤：

1. 扩展OutputConfig结构

OutputConfig结构定义了导出配置，位于Screenshot Framer/Model/OutputConfig.swift文件中。我们可以通过扩展这个结构来添加新的导出格式选项。

struct OutputConfig: Codable { let transparent: Bool? let output: String let fromImageNumber: Int let toImageNumber: Int // 添加自定义格式属性 let exportFormat: ExportFormat? } enum ExportFormat: String, Codable { case png case jpeg case pdf // 添加自定义格式 }

2. 修改ExportController类

在ExportController类中，找到处理图片导出的方法，通常是saveSingleImage和saveAllImages函数。这些函数目前使用pngData方法导出PNG格式图片，我们需要修改它们以支持新的格式。

3. 添加格式转换逻辑

根据新添加的导出格式，实现相应的图片格式转换逻辑。例如，如果要添加JPEG导出，可以添加如下代码：

if let data = view.pngData(transparent: self.lastLayerState.outputConfig.transparent ?? false) { if outputFormat == .jpeg { // 转换为JPEG格式 if let image = NSImage(data: data), let jpegData = image.jpegData(compressionQuality: 0.9) { try? jpegData.write(to: url, options: .atomic) } } else { try? data.write(to: url, options: .atomic) } }

实现自定义导出功能的高级技巧

添加自定义文件名格式

ScreenshotFramer允许通过output属性定义导出文件的路径和名称。我们可以扩展这一功能，添加更多自定义变量。例如，在FileController类中（位于Screenshot Framer/Document Window/Content View Controller/Help Controller/FileController.swift），可以修改文件名生成逻辑：

var file = layerState.outputConfig.output .replacingOccurrences(of: "$image", with: "\(viewState.imageNumber)") .replacingOccurrences(of: "$format", with: exportFormat.rawValue) // 添加更多自定义变量替换

添加水印功能

要为导出的图片添加水印，可以在LayoutController中添加水印绘制逻辑。首先创建一个新的WatermarkLayer类，然后在布局层次结构中添加该图层：

class WatermarkLayer: LayoutableObject { var text: String = "Confidential" override func draw(in rect: NSRect) { super.draw(in: rect) // 绘制水印文本 text.draw(in: rect, withAttributes: [ .font: NSFont.systemFont(ofSize: 12), .foregroundColor: NSColor.white.withAlphaComponent(0.5) ]) } }

然后在LayoutController的layoutHierarchy方法中添加水印图层：

func layoutHierarchy(layers: [LayoutableObject]) -> NSView? { let view = NSView() // 添加现有图层 for layer in layers { view.addSubview(layer.view) } // 添加水印图层 let watermark = WatermarkLayer() view.addSubview(watermark.view) return view }

实现导出进度回调

ExportControllerDelegate协议定义了导出进度更新的方法。我们可以扩展这个协议，添加更多详细的进度信息：

protocol ExportControllerDelegate: AnyObject { func exportController(_ exportController: ExportController, didUpdateProgress progress: Double, file: String, layoutErrors: [LayoutError]) // 添加自定义进度回调 func exportController(_ exportController: ExportController, didCompleteExport file: String) }

测试自定义导出功能

添加自定义导出功能后，需要进行充分测试。可以创建一个测试用例，位于Screenshot Framer Tests/ScreenshotFramerTests.swift文件中：

func testCustomExportFormat() { let outputConfig = OutputConfig( transparent: false, output: "Export/$language/$device-$image.$format", fromImageNumber: 1, toImageNumber: 5, exportFormat: .jpeg ) // 执行导出测试 }

ScreenshotFramer支持多设备和多语言的截图导出，自定义导出功能可以进一步扩展其灵活性