模块 ngx_http_image_filter_module

示例配置
指令
     image_filter
     image_filter_buffer
     image_filter_interlace
     image_filter_jpeg_quality
     image_filter_sharpen
     image_filter_transparency
     image_filter_webp_quality

ngx_http_image_filter_module 模块 (0.7.54+) 是一个可转换 JPEG、GIF、PNG 和 WebP 格式图像的过滤器。

此模块并非默认构建,应使用 --with-http_image_filter_module 配置参数启用它。

此模块利用 libgd 库。建议使用最新版本的库。

WebP 格式支持出现在 1.11.6 版本中。要转换此格式的图像,必须使用 WebP 支持编译 libgd 库。

示例配置

location /img/ {
    proxy_pass   http://backend;
    image_filter resize 150 100;
    image_filter rotate 90;
    error_page   415 = /empty;
}

location = /empty {
    empty_gif;
}

指令

语法 image_filter off;
image_filter test;
image_filter size;
image_filter rotate 90 | 180 | 270;
image_filter resize width height;
image_filter crop width height;
默认值
image_filter off;
上下文 location

设置对图像执行的转换类型

off
关闭周围位置的模块处理。
test
确保响应是 JPEG、GIF、PNG 或 WebP 格式的图像。否则,将返回 415(不支持的媒体类型)错误。
size
以 JSON 格式输出有关图像的信息,例如
{ "img" : { "width": 100, "height": 100, "type": "gif" } }
如果发生错误,输出如下
{}
rotate 90|180|270
将图像逆时针旋转指定角度。参数值可以包含变量。此模式可以单独使用,也可以与 resizecrop 转换一起使用。
resize width height
按比例将图像缩小到指定大小。要仅按一个维度缩小,另一个维度可以指定为“-”。如果发生错误,服务器将返回代码 415(不支持的媒体类型)。参数值可以包含变量。与 rotate 参数一起使用时,旋转在缩小之后进行。
crop width height
按比例将图像缩小到较大的边尺寸,并按另一边裁剪多余的边缘。如需仅按一个维度缩小,可将另一个维度指定为“-”。如果发生错误,服务器将返回代码 415(不支持的媒体类型)。参数值可以包含变量。与 rotate 参数一起使用时,旋转发生在缩小之前

语法 image_filter_buffer size;
默认值
image_filter_buffer 1M;
上下文 httpserverlocation

设置用于读取图像的缓冲区最大尺寸。当超过尺寸时,服务器返回错误 415(不支持的媒体类型)。

语法 image_filter_interlace on | off;
默认值
image_filter_interlace off;
上下文 httpserverlocation

此指令出现在 1.3.15 版中。

如果启用,最终图像将交错显示。对于 JPEG,最终图像将采用“渐进式 JPEG”格式。

语法 image_filter_jpeg_quality quality;
默认值
image_filter_jpeg_quality 75;
上下文 httpserverlocation

设置转换后的 JPEG 图像所需的quality。可接受的值范围为 1 到 100。较低的值通常意味着较低的图像质量和较少的数据传输。建议的最大值为 95。参数值可以包含变量。

语法 image_filter_sharpen percent;
默认值
image_filter_sharpen 0;
上下文 httpserverlocation

增加最终图像的锐度。锐度百分比可以超过 100。零值禁用锐化。参数值可以包含变量。

语法 image_filter_transparency on|off;
默认值
image_filter_transparency on;
上下文 httpserverlocation

定义在转换 GIF 图像或由调色板指定颜色的 PNG 图像时是否保留透明度。透明度的丢失会导致图像质量更好。PNG 中的 Alpha 通道透明度始终保留。

语法 image_filter_webp_quality quality;
默认值
image_filter_webp_quality 80;
上下文 httpserverlocation

此指令出现在 1.11.6 版中。

设置转换后的 WebP 图像所需的quality。可接受的值范围为 1 到 100。较低的值通常意味着较低的图像质量和较少的数据传输。参数值可以包含变量。