Sharp 中文网

Appearance

元数据 API ​

Sharp 提供了丰富的元数据操作功能，可以读取、修改和写入图像的元数据信息。

读取元数据 ​

基本用法 ​

javascript
import sharp from 'sharp';

// 读取图像元数据
const metadata = await sharp('input.jpg').metadata();
console.log(metadata);

元数据对象结构 ​

javascript
{
  format: 'jpeg',           // 图像格式
  width: 1920,              // 宽度
  height: 1080,             // 高度
  space: 'srgb',            // 颜色空间
  channels: 3,              // 通道数
  depth: 'uchar',           // 位深度
  density: 72,              // 分辨率
  hasProfile: false,        // 是否有颜色配置文件
  hasAlpha: false,          // 是否有透明度通道
  isOpaque: true,           // 是否不透明
  orientation: 1,           // EXIF 方向
  exif: { ... },            // EXIF 数据
  icc: { ... },             // ICC 配置文件
  iptc: { ... },            // IPTC 数据
  xmp: { ... },             // XMP 数据
  tifftagPhotoshop: { ... } // Photoshop TIFF 标签
}

EXIF 数据 ​

读取 EXIF ​

javascript
const metadata = await sharp('input.jpg').metadata();

if (metadata.exif) {
  console.log('EXIF 数据:', metadata.exif);
  
  // 解析 EXIF 数据
  const exif = sharp.exif(metadata.exif);
  console.log('拍摄时间:', exif.DateTime);
  console.log('相机型号:', exif.Model);
  console.log('ISO:', exif.ISOSpeedRatings);
}

写入 EXIF ​

javascript
// 创建 EXIF 数据
const exif = sharp.exif({
  IFD0: {
    ImageDescription: 'Sharp 处理的图像',
    Copyright: '© 2024'
  },
  IFD1: {
    Orientation: 1
  },
  EXIF: {
    DateTimeOriginal: new Date().toISOString(),
    UserComment: '使用 Sharp 处理'
  }
});

// 写入 EXIF 数据
await sharp('input.jpg')
  .withMetadata({ exif })
  .jpeg()
  .toFile('output.jpg');

ICC 颜色配置文件 ​

读取 ICC 配置文件 ​

javascript
const metadata = await sharp('input.jpg').metadata();

if (metadata.icc) {
  console.log('ICC 配置文件:', metadata.icc);
}

嵌入 ICC 配置文件 ​

javascript
// 嵌入 sRGB 配置文件
await sharp('input.jpg')
  .withMetadata({ icc: 'srgb' })
  .jpeg()
  .toFile('output.jpg');

// 嵌入自定义 ICC 配置文件
const iccProfile = fs.readFileSync('custom.icc');
await sharp('input.jpg')
  .withMetadata({ icc: iccProfile })
  .jpeg()
  .toFile('output.jpg');

IPTC 数据 ​

读取 IPTC ​

javascript
const metadata = await sharp('input.jpg').metadata();

if (metadata.iptc) {
  console.log('IPTC 数据:', metadata.iptc);
}

写入 IPTC ​

javascript
const iptc = {
  '2:05': 'Object Name',
  '2:15': 'Category',
  '2:25': 'Keywords',
  '2:55': 'Date Created',
  '2:80': 'By-line',
  '2:116': 'Copyright'
};

await sharp('input.jpg')
  .withMetadata({ iptc })
  .jpeg()
  .toFile('output.jpg');

XMP 数据 ​

读取 XMP ​

javascript
const metadata = await sharp('input.jpg').metadata();

if (metadata.xmp) {
  console.log('XMP 数据:', metadata.xmp);
}

写入 XMP ​

javascript
const xmp = `
<x:xmpmeta xmlns:x="adobe:ns:meta/">
  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
    <rdf:Description rdf:about=""
      xmlns:dc="http://purl.org/dc/elements/1.1/">
      <dc:title>Sharp 处理的图像</dc:title>
      <dc:creator>Sharp</dc:creator>
    </rdf:Description>
  </rdf:RDF>
</x:xmpmeta>
`;

await sharp('input.jpg')
  .withMetadata({ xmp })
  .jpeg()
  .toFile('output.jpg');

方向信息 ​

读取方向 ​

javascript
const metadata = await sharp('input.jpg').metadata();
console.log('图像方向:', metadata.orientation);

自动旋转 ​

javascript
// 根据 EXIF 方向自动旋转
await sharp('input.jpg')
  .rotate()  // 自动旋转
  .jpeg()
  .toFile('output.jpg');

分辨率信息 ​

读取分辨率 ​

javascript
const metadata = await sharp('input.jpg').metadata();
console.log('分辨率:', metadata.density);

设置分辨率 ​

javascript
await sharp('input.jpg')
  .withMetadata({ density: 300 })
  .jpeg()
  .toFile('output.jpg');

保留元数据 ​

保留所有元数据 ​

javascript
// 保留所有现有元数据
await sharp('input.jpg')
  .resize(800, 600)
  .withMetadata()
  .jpeg()
  .toFile('output.jpg');

选择性保留 ​

javascript
// 只保留 EXIF 数据
await sharp('input.jpg')
  .resize(800, 600)
  .withMetadata({ exif: true })
  .jpeg()
  .toFile('output.jpg');

// 保留 EXIF 和 ICC
await sharp('input.jpg')
  .resize(800, 600)
  .withMetadata({ exif: true, icc: true })
  .jpeg()
  .toFile('output.jpg');

移除元数据 ​

移除所有元数据 ​

javascript
// 移除所有元数据
await sharp('input.jpg')
  .resize(800, 600)
  .jpeg()
  .toFile('output.jpg');

移除特定元数据 ​

javascript
// 移除 EXIF 但保留其他
await sharp('input.jpg')
  .resize(800, 600)
  .withMetadata({ exif: false })
  .jpeg()
  .toFile('output.jpg');

批量处理元数据 ​

批量读取 ​

javascript
const fs = require('fs').promises;

async function batchReadMetadata(directory) {
  const files = await fs.readdir(directory);
  const results = [];
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      try {
        const metadata = await sharp(`${directory}/${file}`).metadata();
        results.push({ file, metadata });
      } catch (error) {
        console.error(`读取 ${file} 元数据失败:`, error.message);
      }
    }
  }
  
  return results;
}

批量写入 ​

javascript
async function batchWriteMetadata(directory, metadata) {
  const files = await fs.readdir(directory);
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      try {
        await sharp(`${directory}/${file}`)
          .withMetadata(metadata)
          .toFile(`${directory}/processed_${file}`);
      } catch (error) {
        console.error(`处理 ${file} 失败:`, error.message);
      }
    }
  }
}

元数据验证 ​

验证元数据完整性 ​

javascript
async function validateMetadata(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    
    // 检查基本属性
    if (!metadata.width || !metadata.height) {
      throw new Error('缺少尺寸信息');
    }
    
    // 检查格式
    if (!metadata.format) {
      throw new Error('缺少格式信息');
    }
    
    // 检查通道数
    if (!metadata.channels) {
      throw new Error('缺少通道信息');
    }
    
    return {
      valid: true,
      metadata
    };
  } catch (error) {
    return {
      valid: false,
      error: error.message
    };
  }
}

性能优化 ​

只读取需要的元数据 ​

javascript
// 只读取基本信息，不解析 EXIF
const metadata = await sharp('input.jpg')
  .metadata({ pages: -1 });

// 只读取 EXIF
const metadata = await sharp('input.jpg')
  .metadata({ exif: true });

流式处理 ​

javascript
const fs = require('fs');

// 流式读取元数据
const stream = fs.createReadStream('input.jpg');
const metadata = await sharp(stream).metadata();

错误处理 ​

javascript
try {
  const metadata = await sharp('input.jpg').metadata();
  console.log('元数据:', metadata);
} catch (error) {
  if (error.code === 'VipsForeignLoad') {
    console.error('不支持的图像格式');
  } else if (error.code === 'VipsForeignLoadLimit') {
    console.error('图像太大');
  } else {
    console.error('读取元数据失败:', error.message);
  }
}

相关链接 ​

Released under the Apache 2.0 License.

Copyright © 2013-present Lovell Fuller and contributors