Skip to content

基本示例

這裡提供了一些 Sharp 的基本使用示例,幫助你快速上手。

調整圖像大小

簡單調整大小

javascript
import sharp from 'sharp';

// 調整到指定尺寸
await sharp('input.jpg')
  .resize(300, 200)
  .toFile('output.jpg');

保持寬高比

javascript
// 只指定寬度,高度自動計算
await sharp('input.jpg')
  .resize(300)
  .toFile('output.jpg');

// 只指定高度,寬度自動計算
await sharp('input.jpg')
  .resize(null, 200)
  .toFile('output.jpg');

適應模式

javascript
// cover: 保持寬高比,裁剪超出部分
await sharp('input.jpg')
  .resize(300, 200, { fit: 'cover' })
  .toFile('output.jpg');

// contain: 保持寬高比,添加背景
await sharp('input.jpg')
  .resize(300, 200, { fit: 'contain', background: { r: 255, g: 255, b: 255 } })
  .toFile('output.jpg');

格式轉換

JPEG 轉 PNG

javascript
await sharp('input.jpg')
  .png()
  .toFile('output.png');

PNG 轉 JPEG

javascript
await sharp('input.png')
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

轉換為 WebP

javascript
await sharp('input.jpg')
  .webp({ quality: 80 })
  .toFile('output.webp');

轉換為 AVIF

javascript
await sharp('input.jpg')
  .avif({ quality: 80 })
  .toFile('output.avif');

圖像旋轉

旋轉 90 度

javascript
await sharp('input.jpg')
  .rotate(90)
  .toFile('output.jpg');

自動旋轉(根據 EXIF)

javascript
await sharp('input.jpg')
  .rotate()  // 自動旋轉
  .toFile('output.jpg');

圖像翻轉

垂直翻轉

javascript
await sharp('input.jpg')
  .flip()
  .toFile('output.jpg');

水平翻轉

javascript
await sharp('input.jpg')
  .flop()
  .toFile('output.jpg');

圖像裁剪

裁剪指定區域

javascript
await sharp('input.jpg')
  .extract({ left: 100, top: 100, width: 300, height: 200 })
  .toFile('output.jpg');

裁剪並調整大小

javascript
await sharp('input.jpg')
  .extract({ left: 100, top: 100, width: 300, height: 200 })
  .resize(150, 100)
  .toFile('output.jpg');

濾鏡效果

灰度轉換

javascript
await sharp('input.jpg')
  .grayscale()
  .toFile('output.jpg');

模糊效果

javascript
await sharp('input.jpg')
  .blur(5)
  .toFile('output.jpg');

銳化效果

javascript
await sharp('input.jpg')
  .sharpen()
  .toFile('output.jpg');

反轉顏色

javascript
await sharp('input.jpg')
  .negate()
  .toFile('output.jpg');

顏色調整

亮度調整

javascript
await sharp('input.jpg')
  .modulate({ brightness: 1.2 })
  .toFile('output.jpg');

飽和度調整

javascript
await sharp('input.jpg')
  .modulate({ saturation: 0.8 })
  .toFile('output.jpg');

色相調整

javascript
await sharp('input.jpg')
  .modulate({ hue: 180 })
  .toFile('output.jpg');

透明度處理

添加透明度

javascript
await sharp('input.jpg')
  .ensureAlpha()
  .png()
  .toFile('output.png');

移除透明度

javascript
await sharp('input.png')
  .flatten({ background: { r: 255, g: 255, b: 255 } })
  .jpeg()
  .toFile('output.jpg');

質量設置

JPEG 質量

javascript
// 高質量
await sharp('input.png')
  .jpeg({ quality: 95 })
  .toFile('output.jpg');

// 中等質量
await sharp('input.png')
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

// 低質量(小文件)
await sharp('input.png')
  .jpeg({ quality: 50 })
  .toFile('output.jpg');

WebP 質量

javascript
await sharp('input.jpg')
  .webp({ quality: 80, lossless: false })
  .toFile('output.webp');

鏈式操作

多個操作組合

javascript
await sharp('input.jpg')
  .resize(800, 600)
  .rotate(90)
  .blur(2)
  .sharpen()
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

條件處理

javascript
const image = sharp('input.jpg').resize(300, 200);

if (needsBlur) {
  image.blur(3);
}

if (needsSharpen) {
  image.sharpen();
}

await image.jpeg({ quality: 80 }).toFile('output.jpg');

錯誤處理

基本錯誤處理

javascript
try {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} catch (error) {
  console.error('圖像處理失敗:', error.message);
}

檢查文件存在

javascript
const fs = require('fs');

if (fs.existsSync('input.jpg')) {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} else {
  console.error('輸入文件不存在');
}

流式處理

從流讀取

javascript
const fs = require('fs');

fs.createReadStream('input.jpg')
  .pipe(sharp().resize(300, 200))
  .pipe(fs.createWriteStream('output.jpg'));

輸出到流

javascript
const fs = require('fs');

sharp('input.jpg')
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .pipe(fs.createWriteStream('output.jpg'));

Buffer 處理

從 Buffer 創建

javascript
const fs = require('fs');

const inputBuffer = fs.readFileSync('input.jpg');
const outputBuffer = await sharp(inputBuffer)
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .toBuffer();

fs.writeFileSync('output.jpg', outputBuffer);

輸出到 Buffer

javascript
const buffer = await sharp('input.jpg')
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .toBuffer();

// 可以直接使用 buffer
console.log('圖像大小:', buffer.length);

批量處理

處理目錄中的所有圖像

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

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

processImages('./input', './output');

相關鏈接

基於 Apache 2.0 許可證發布