tobiasw/pichasso

pichasso

https://travis-ci.org/pichasso/pichasso.svg?branch=master](https://travis-ci.org/pichasso/pichasso) https://codecov.io/github/pichasso/pichasso/coverage.svg?branch=master](https://codecov.io/github/pichasso/pichasso) https://badges.greenkeeper.io/pichasso/pichasso.svg](https://greenkeeper.io/) !https://img.shields.io/github/downloads/pichasso/pichasso/total.svg

概述

Pichasso是一款图像服务，旨在提升传输性能并减少数据传输量。通过根据给定参数调整输出图像，开发者可专注于网页创作，而由Pichasso处理图像相关工作。它提供智能裁剪功能（如人脸检测，避免裁剪人物），适配不同需求。

网站常面临图像适配难题：图像未压缩导致带宽浪费，不同设备需不同分辨率。Pichasso解决这些问题，为每个场景提供理想压缩的图像，支持WebP等现代格式，自动检测alpha通道并根据客户端支持选择格式，根据尺寸调整图像并返回最优压缩结果。

建议结合CDN使用以提升全球响应速度，可通过图片源集轻松集成：

html
<picture>
  <source media="max-width: 767px" 
          srcset="compressed_image_mobile_tablet.jpg, 
                  compressed_image_mobile_tablet_double_size.jpg 2x">
  <source media="min-width: 768px" 
          srcset="default_image.jpg, 
                  default_image_double_size.jpg 2x">
  <!-- IE回退 -->
  <img src="default_image.jpg" alt="描述">
</picture>

部署设置

智能图像裁剪与压缩服务可通过克隆后使用docker-compose运行：

1. docker-compose build
2. docker-compose up

Web服务默认运行在端口3000，调试端口为9229。

本地端口绑定

若需自定义端口映射，可在根目录创建docker-compose.override.yml文件：

yaml
version: '3'
services:
  web:
    ports:
      - 3000:3000
      # Node调试端口
      - 9229:9229

服务测试

访问路由/image/test可查看服务所有可用选项，PDF测试界面在/pdf/test。启动服务可使用部署步骤的第二步，或本地运行npm start。

测试

本地测试：npm test；Docker测试：docker-compose exec web npm test；仅运行Mocha：npm run mocha；仅 lint：npm run lint。

生产环境

若需调整配置，创建/config/production.json并覆盖所需参数。启动生产环境：npm run production（无测试环境和调试，设置NODE_ENV=production，测试页面禁用）。

清除缓存

发送GET请求到/clear/{hash}，其中{hash}需在配置文件中定义为Caching.ClearHash。有效hash会返回OK和200状态，所有缓存文件将被删除。

API

/image路由

示例URL：[***]

PDF压缩服务

/pdf路由

可输入PDF URL进行处理，示例URL：[***]

缩略图服务

/thumbnail路由

通过https://github.com/GoogleChrome/puppeteer%E6%8F%90%E4%BE%9B%E7%BD%91%E9%A1%B5%E7%BC%A9%E7%95%A5%E5%9B%BE%E7%94%9F%E6%88%90%E7%9A%84GET API，路由为/thumbnail。

上述参数用于生成指定尺寸的截图，同时支持/image路由的所有图像转换/裁剪选项，可添加以调整最终截图大小。

缩略图认证

若要防止免费使用缩略图功能，可在配置中设置Thumbnail.Verification.Enabled为true。基于file参数的URL和密钥生成的哈希需作为auth参数添加。密钥需在配置Thumbnail.Verification.Accounts路径下设置为对象列表：

json
{
    "Description": "示例描述",
    "Enabled": true,
    "Token": "示例令牌"
}            

可通过路由/thumbnail/verify/{sampletoken}/{url}（URL需编码）请求所需auth参数，响应文本可作为GET参数auth。

若需从同一站点的不同页面请求多个截图，可创建仅验证域名的auth：添加类型为hostname的账户：

json
{
    "Description": "示例域名账户",
    "Enabled": true,
    "Type": "hostname",
    "Token": "示例令牌2"
}            

使用/thumbnail/verify/sampletoken2/{url}生成的auth可用于同一域名下的所有页面。