实用工具 API

Sharp 提供了多种实用工具函数，用于辅助图像处理和格式转换。

格式检测

检测支持的格式

import sharp from 'sharp';

// 获取支持的输入格式
console.log('支持的输入格式:', sharp.format);

// 获取支持的输出格式
console.log('支持的输出格式:', sharp.format);

检查文件格式

async function checkImageFormat(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    return {
      format: metadata.format,
      width: metadata.width,
      height: metadata.height,
      channels: metadata.channels
    };
  } catch (error) {
    return { error: error.message };
  }
}

颜色空间

颜色空间常量

// 可用的颜色空间
sharp.colourspace.srgb      // sRGB
sharp.colourspace.rgb       // RGB
sharp.colourspace.cmyk      // CMYK
sharp.colourspace.grey      // 灰度
sharp.colourspace.multiband // 多波段
sharp.colourspace.lab       // Lab
sharp.colourspace.xyz       // XYZ
sharp.colourspace.ycbcr     // YCbCr

颜色空间转换

// 转换为灰度
sharp('input.jpg')
  .grayscale()
  .toFile('output.jpg');

// 转换为 CMYK
sharp('input.jpg')
  .toColourspace(sharp.colourspace.cmyk)
  .tiff()
  .toFile('output.tiff');

内核和滤镜

调整内核

// 可用的调整内核
sharp.kernel.nearest      // 最近邻
sharp.kernel.cubic        // 三次插值
sharp.kernel.mitchell     // Mitchell-Netravali
sharp.kernel.lanczos2     // Lanczos 2-lobed
sharp.kernel.lanczos3     // Lanczos 3-lobed (默认)

使用自定义内核

// 使用自定义调整内核
sharp('input.jpg')
  .resize(300, 200, { kernel: sharp.kernel.lanczos3 })
  .toFile('output.jpg');

位置常量

位置选项

// 可用的位置选项
sharp.position.top         // 顶部
sharp.position.right       // 右侧
sharp.position.bottom      // 底部
sharp.position.left        // 左侧
sharp.position.center      // 中心 (默认)
sharp.position.centre      // 中心 (英式拼写)
sharp.position.north       // 北 (顶部)
sharp.position.east        // 东 (右侧)
sharp.position.south       // 南 (底部)
sharp.position.west        // 西 (左侧)
sharp.position.northeast   // 东北
sharp.position.southeast   // 东南
sharp.position.southwest   // 西南
sharp.position.northwest   // 西北

通道操作

通道常量

// 通道常量
sharp.channel.red          // 红色通道
sharp.channel.green        // 绿色通道
sharp.channel.blue         // 蓝色通道
sharp.channel.alpha        // 透明度通道
sharp.channel.grey         // 灰度通道

通道操作

// 提取红色通道
sharp('input.jpg')
  .extractChannel(sharp.channel.red)
  .toFile('red-channel.jpg');

// 提取所有通道
const channels = await sharp('input.jpg').separate();

错误处理

错误类型

// 常见的 Sharp 错误
sharp.errors.InputError     // 输入错误
sharp.errors.ProcessError   // 处理错误
sharp.errors.OutputError    // 输出错误

错误处理示例

try {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} catch (error) {
  if (error instanceof sharp.errors.InputError) {
    console.error('输入文件错误:', error.message);
  } else if (error instanceof sharp.errors.ProcessError) {
    console.error('处理错误:', error.message);
  } else if (error instanceof sharp.errors.OutputError) {
    console.error('输出错误:', error.message);
  } else {
    console.error('未知错误:', error.message);
  }
}

性能监控

内存使用

// 获取 Sharp 内存使用情况
const stats = sharp.cache();
console.log('缓存统计:', stats);

// 清空缓存
sharp.cache(false);

并发控制

// 设置并发限制
sharp.concurrency(4); // 最多4个并发操作

// 获取当前并发数
console.log('当前并发数:', sharp.concurrency());

工具函数

创建测试图像

// 创建纯色图像
const redImage = sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    background: { r: 255, g: 0, b: 0 }
  }
});

// 创建渐变图像
const gradient = sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    background: { r: 0, g: 0, b: 0 }
  }
});

图像合成

// 合成多个图像
const composite = await sharp('background.jpg')
  .composite([
    {
      input: 'overlay.png',
      top: 100,
      left: 100
    }
  ])
  .jpeg()
  .toBuffer();

批量处理工具

批量调整大小

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

async function batchResize(inputDir, outputDir, width, height) {
  const files = await fs.readdir(inputDir);
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      try {
        await sharp(`${inputDir}/${file}`)
          .resize(width, height)
          .jpeg({ quality: 80 })
          .toFile(`${outputDir}/${file}`);
        
        console.log(`处理完成: ${file}`);
      } catch (error) {
        console.error(`处理失败 ${file}:`, error.message);
      }
    }
  }
}

批量格式转换

async function batchConvert(inputDir, outputDir, format) {
  const files = await fs.readdir(inputDir);
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      const outputFile = file.replace(/\.[^.]+$/, `.${format}`);
      
      try {
        const image = sharp(`${inputDir}/${file}`);
        
        switch (format) {
          case 'jpg':
          case 'jpeg':
            await image.jpeg({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
          case 'png':
            await image.png().toFile(`${outputDir}/${outputFile}`);
            break;
          case 'webp':
            await image.webp({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
          case 'avif':
            await image.avif({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
        }
        
        console.log(`转换完成: ${file} -> ${outputFile}`);
      } catch (error) {
        console.error(`转换失败 ${file}:`, error.message);
      }
    }
  }
}

验证工具

验证图像完整性

async function validateImage(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    
    // 检查基本属性
    if (!metadata.width || !metadata.height) {
      return { valid: false, error: '缺少尺寸信息' };
    }
    
    if (metadata.width <= 0 || metadata.height <= 0) {
      return { valid: false, error: '无效的尺寸' };
    }
    
    if (!metadata.format) {
      return { valid: false, error: '缺少格式信息' };
    }
    
    // 尝试处理图像
    await sharp(filePath).resize(1, 1).toBuffer();
    
    return { valid: true, metadata };
  } catch (error) {
    return { valid: false, error: error.message };
  }
}

检查文件大小

const fs = require('fs');

function checkFileSize(filePath, maxSize = 10 * 1024 * 1024) { // 10MB
  const stats = fs.statSync(filePath);
  const sizeInMB = stats.size / (1024 * 1024);
  
  return {
    size: stats.size,
    sizeInMB,
    isValid: stats.size <= maxSize,
    maxSizeInMB: maxSize / (1024 * 1024)
  };
}

相关链接

• Sharp 构造函数
• 图像处理 API
• 输出格式 API
• 元数据 API