ag-psd 项目使用教程

ag-psd 项目使用教程

ag-psd Javascript library for reading and writing PSD files 项目地址: https://gitcode.com/gh_mirrors/ag/ag-psd

1. 项目介绍

ag-psd 是一个用于读取和写入 PSD 文件（Photoshop Document files）的 JavaScript 库。该项目实现了根据官方文档的 PSD 文件格式规范，并通过大量的试验和错误进行开发。ag-psd 支持多种颜色模式（如 RGB），但不支持某些高级功能，如 16 位通道、大型文档格式（PSB）、动画、3D 效果等。

2. 项目快速启动

安装

首先，通过 npm 安装 ag-psd：

npm install ag-psd

使用示例

Node.js 环境

import * as fs from 'fs';
import 'ag-psd/initialize-canvas'; // 仅在读取图像数据和缩略图时需要
import { readPsd, writePsdBuffer } from 'ag-psd';

// 读取 PSD 文件
const buffer = fs.readFileSync('my-file.psd');
const psd = readPsd(buffer);
console.log(psd);

// 写入 PSD 文件
const newPsd = {
  width: 300,
  height: 200,
  children: [
    { name: 'Layer #1' }
  ]
};
const newBuffer = writePsdBuffer(newPsd);
fs.writeFileSync('new-file.psd', newBuffer);

浏览器环境

import { readPsd, writePsd } from 'ag-psd';

// 读取 PSD 文件
const xhr = new XMLHttpRequest();
xhr.open('GET', 'my-file.psd', true);
xhr.responseType = 'arraybuffer';
xhr.addEventListener('load', function () {
  const buffer = xhr.response;
  const psd = readPsd(buffer);
  console.log(psd);
  document.body.appendChild(psd.children[0].canvas);
}, false);
xhr.send();

// 写入 PSD 文件
const newPsd = {
  width: 300,
  height: 200,
  children: [
    { name: 'Layer #1' }
  ]
};
const buffer = writePsd(newPsd);
const blob = new Blob([buffer], { type: 'application/octet-stream' });
saveAs(blob, 'new-file.psd');

3. 应用案例和最佳实践

应用案例

1. 图像处理工具：使用 ag-psd 读取 PSD 文件，提取图层信息并进行图像处理。
2. 自动化设计流程：在设计自动化流程中，使用 ag-psd 生成或修改 PSD 文件，以实现设计元素的自动化管理。

最佳实践

• 优化读取速度：在读取 PSD 文件时，可以通过设置 skipLayerImageData、skipCompositeImageData 和 skipThumbnail 选项来跳过不需要的数据，从而提高读取速度。
• 内存管理：在处理大型 PSD 文件时，注意内存使用情况，避免内存溢出。

4. 典型生态项目

• node-canvas：用于在 Node.js 环境中处理图像数据和缩略图。
• FileSaver.js：用于在浏览器环境中保存生成的 PSD 文件。
• OffscreenCanvas：在浏览器 Web Worker 中处理图像数据，提高性能。

通过这些生态项目的结合使用，可以进一步提升 ag-psd 的功能和性能。

ag-psd Javascript library for reading and writing PSD files 项目地址: https://gitcode.com/gh_mirrors/ag/ag-psd