inventid/iaas

Live Image Resize

![Code Climate]([] ![Dependency Status]([]

镜像概述和主要用途

随着网络上用户生成内容展示需求的增长，不同客户端（移动应用、网页客户端）可能需要不同分辨率的图片。每次单独转换图片既耗时又低效。为此，inventid与Magne***联合开发了iaas（Imaging-As-A-Service，图像即服务），旨在提供高效的图片实时处理解决方案。

核心功能和特性

工作原理

请求图片

客户端可直接请求图片，并指定最大高度、宽度和格式（例如/sfsdf_1040_1040.png）。为支持Apple视网膜屏，可添加 upscale 参数后缀，如/sfsdf_1040_1040_2x.png（未来也支持_13x）。系统会先检查该分辨率的图片是否已缓存：

• 若已缓存，返回指向缓存位置（当前为AWS S3）的重定向
• 若未缓存，实时调整图片大小并直接返回给客户端，同时将新缓存版本上传至AWS S3

调整过程会保持宽高比，图片将缩放到请求中指定边界框的最大尺寸。

上传图片

图片上传同样简单。客户端需附带令牌（token）进行POST请求。令牌可通过向/token端点发送POST请求获取（该端点应通过防火墙限制特定IP访问）。令牌仅单次有效，客户端可直接上传文件，无需经过应用服务器（可能仅需传递标识符）。

日志采用JSON Logstash兼容格式，便于集成到Logstash和Kibana进行日志分析。

HTTP状态码

功能选项

请求或上传图片时可指定额外选项，所有请求选项可组合使用：

使用场景和适用范围

适用于需要处理和展示用户生成内容的网站或应用，尤其是多客户端（移动应用、网页）需要不同分辨率图片的场景。可高效解决图片格式转换、实时调整、缓存管理等问题，减少服务器负载并提升用户体验。

使用方法

请求图片

通过简单的GET请求获取图片，例如：

bash
curl http://localhost:1337/example_100_100.png

该请求会触发服务器搜索ID为example的图片，并以PNG格式、100x100分辨率返回。根据历史请求，图片可能来自CDN（触发重定向）或实时转码后返回（随后上传至缓存）。

对于视网膜（HiDpi）显示屏，添加_2x后缀可适配调整尺寸，例如/example_100_100_2x.png。可通过查询参数添加额外选项，如?fit=crop裁剪至边界框。

上传图片

上传图片需先获取令牌：

1. 向/token端点发送POST请求（需在请求体中提供id）：

   bash
   curl -XPOST http://localhost:1337/token -d '{"id": "test"}' -H "Content-Type: application/json"
   

   该端点通常需通过防火墙或负载均衡器限制访问，返回的令牌有效期为15分钟。

2. 使用令牌上传图片（通过X-Token请求头传递令牌）：

   bash
   curl -XPOST http://localhost:1337/test.jpg -H "X-Token:  earlier-return-value" -F "image=@/home/user1/Desktop/test.jpg"
   

   令牌仅对单次上传尝试和指定ID有效，使用后自动失效。

配置说明

设置

需将config目录下的default.json.example复制为default.json，并修改为自定义值。生产环境中启动脚本时需指定环境变量：

bash
NODE_ENV=production node index.js

此时会额外加载production.json配置文件。支持的配置项如下：

数据库

系统使用PostgreSQL数据库存储缓存链接，通过https://github.com/rogierslag/pg-migration%E8%87%AA%E5%8A%A8%E5%88%9B%E5%BB%BA%E8%A1%A8%E5%B9%B6%E7%BB%B4%E6%8A%A4 schema。需手动创建数据库及凭据，示例psql命令：

bash
sudo -u postgres psql -c "CREATE USER imageresizer WITH PASSWORD 'rogierisgaaf';"
sudo -u postgres createdb -E UTF8 -T template0 --locale=en_US.utf8 imageresizer
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE imageresizer to imageresizer;"

创建后编辑default.json配置数据库连接信息。

原始图片存储

原始图片保存在images子目录（从AWS S3检查图片是否存在速度较慢），需确保数据备份。可通过配置项指定其他目录，确保服务用户有写入权限。

清除AWS缓存

如需清除缓存（如修复bug后重新生成图片），可通过逐步删除数据库中的缓存链接实现，示例psql命令：

bash
sudo -u postgres psql imageresizer -c "DELETE FROM images WHERE ctid IN (SELECT ctid FROM images where rendered_at < '2016-09-01 00:00:00' LIMIT 100);"

每次限制删除100条记录，避免服务突然负载过高。可结合screen和watch命令自动化缓存清理。

开发和贡献

开发环境设置

推荐使用Docker开发，步骤如下：

1. 创建Docker机器：docker-machine create inventid --driver=virtualbox
2. 配置环境变量：eval $(docker-machine env inventid)
3. 准备PostgreSQL数据库（见数据库部分）
4. 构建并运行容器：

   bash
   mkdir -p /tmp/images && docker build --tag=test . && docker run -p 1337:1337 -v /tmp/images:/opt/images -v `pwd`/config:/opt/iaas/config test
   

5. 开发时修改代码后，停止容器并重新执行上述命令（重建容器速度较快）。

快速上传图片示例（需安装jq）：

bash
IMAGE=test1234567
PORT=1337
RES=`curl -XPOST http://localhost:$PORT/token -d "{\"id\": \"${IMAGE}\"}" -H "Content-Type: application/json"`
TOKEN=`echo $RES | jq -r .token`
curl -XPOST http://localhost:$PORT/${IMAGE} -H "X-Token: ${TOKEN}" -F "image=@/Users/Rogier/Downloads/IMG_7419.PNG"

贡献方式

可使用Dockerfile本地测试。代码贡献请https://github.com/inventid/iaas/fork%E5%B9%B6%E6%8F%90%E4%BA%A4Pull Request。

!https://github.com/inventid/iaas/blob/develop/images/example?raw=true