目录
- 概述
- 核心 API
- Thumbnails
- Thumbnails.Builder
- 设置参数的函数
- 输出函数
- 工作流
- 实战
- 安装
- 图片缩放
- 图片旋转
- 加水印
- 批量处理图片
- 参考
概述
Thumbnailator 是一个开源的 Java 项目，它提供了非常简单的 API 来对图片进行缩放、旋转以及加水印的处理。
有多简单呢？简单到一行代码就可以完成图片处理。形式如下：
Thumbnails.of(new File("path/to/directory").listFiles())
.size(640, 480)
.outputFormat("jpg")
.toFiles(Rename.PREFIX_DOT_THUMBNAIL);当然，Thumbnailator 还有一些使用细节，下面我会一一道来。
核心 API
Thumbnails
Thumbnails 是使用 Thumbnailator 创建缩略图的主入口。
它提供了一组初始化 Thumbnails.Builder 的接口。
先看下这组接口的声明：
// 可变长度参数列表
public static Builder of(String... files) {...}
public static Builder of(File... files) {...}
public static Builder of(URL... urls) {...}
public static Builder of(InputStream... inputStreams) {...}
public static Builder of(BufferedImage... images) {...}
// 迭代器（所有实现 Iterable 接口的 Java 对象都可以，当然也包括 List、Set）
public static Builder fromFilenames(Iterable files) {...}
public static Builder fromFiles(Iterable files) {...}
public static Builder fromURLs(Iterable urls) {...}
public static Builder fromInputStreams(Iterable inputStreams) {...}
public static Builder fromImages(Iterable images) {...} 很显然，Thumbnails 允许通过传入文件名、文件、网络图的URL、图片流、图片缓存多种方式来初始化构造器。
因此，你可以根据实际需求来灵活的选择图片的输入方式。
需要注意一点：如果输入是多个对象（无论你是直接输入容器对象或使用可变参数方式传入多个对象），则输出也必须选用输出多个对象的方式，否则会报异常。
Thumbnails.Builder
Thumbnails.Builder 是 Thumbnails 的内部静态类。它用于设置生成缩略图任务的相关参数。
注：Thumbnails.Builder 的构造函数是私有函数。所以，它只允许通过 Thumbnails 的实例化函数来进行初始化。
设置参数的函数
Thumbnails.Builder 提供了一组函数链形式的接口来设置缩放图参数。
以设置大小函数为例：
public Builder size(int width, int height)
{
updateStatus(Properties.SIZE, Status.ALREADY_SET);
updateStatus(Properties.SCALE, Status.CANNOT_SET);
validateDimensions(width, height);
this.width = width;
this.height = height;
return this;
} 通过返回this指针，使得设置参数函数可以以链式调用的方式来使用，形式如下：
Thumbnails.of(new File("original.jpg"))
.size(160, 160)
.rotate(90)
.watermark(Positions.BOTTOM_RIGHT, ImageIO.read(new File("watermark.png")), 0.5f)
.outputQuality(0.8)
.toFile(new File("image-with-watermark.jpg"));好处，不言自明：那就是大大简化了代码。
输出函数
Thumbnails.Builder 提供了一组重载函数来输出生成的缩放图。
函数声明如下：
// 返回图片缓存
public List asBufferedImages() throws IOException {...}
public BufferedImage asBufferedImage() throws IOException {...}
// 返回文件列表
public List asFiles(Iterable iterable) throws IOException {...}
public List asFiles(Rename rename) throws IOException {...}
public List asFiles(File destinationDir, Rename rename) throws IOException {...}
// 创建文件
public void toFile(File outFile) throws IOException {...}
public void toFile(String outFilepath) throws IOException {...}
public void toFiles(Iterable iterable) throws IOException {...}
public void toFiles(Rename rename) throws IOException {...}
public void toFiles(File destinationDir, Rename rename) throws IOException {...}
// 创建输出流
public void toOutputStream(OutputStream os) throws IOException {...}
public void toOutputStreams(Iterable iterable) throws IOException {...} 工作流
Thumbnailator 的工作步骤十分简单，可分为三步：
-
输入：
Thumbnails根据输入初始化构造器——Thumbnails.Builder。 -
设置：
Thumbnails.Builder设置缩放图片的参数。 -
输出：
Thumbnails.Builder输出图片文件或图片流。
更多详情可以参考： Thumbnailator 官网javadoc
实战
前文介绍了 Thumbnailator 的核心 API，接下来我们就可以通过实战来看看 Thumbnailator 究竟可以做些什么。
Thumbnailator 生成什么样的图片，是根据设置参数来决定的。
安装
maven项目中引入依赖：
net.coobird
thumbnailator
[0.4, 0.5)
图片缩放
Thumbnails.Builder 的 size 函数可以设置新图片精确的宽度和高度，也可以用 scale 函数设置缩放比例。
Thumbnails.of("oldFile.png")
.size(16, 16)
.toFile("newFile_16_16.png");
Thumbnails.of("oldFile.png")
.scale(2.0)
.toFile("newFile_scale_2.0.png");
Thumbnails.of("oldFile.png")
.scale(1.0, 0.5)
.toFile("newFile_scale_1.0_0.5.png");oldFile.png
newFile_scale_1.0_0.5.png
图片旋转
Thumbnails.Builder 的 size 函数可以设置新图片的旋转角度。
Thumbnails.of("oldFile.png")
.scale(0.8)
.rotate(90)
.toFile("newFile_rotate_90.png");
Thumbnails.of("oldFile.png")
.scale(0.8)
.rotate(180)
.toFile("newFile_rotate_180.png");newFile_rotate_90.png
加水印
Thumbnails.Builder 的 watermark 函数可以为图片添加水印图片。第一个参数是水印的位置；第二个参数是水印图片的缓存数据；第三个参数是透明度。
BufferedImage watermarkImage = ImageIO.read(new File("wartermarkFile.png"));
Thumbnails.of("oldFile.png")
.scale(0.8)
.watermark(Positions.BOTTOM_LEFT, watermarkImage, 0.5f)
.toFile("newFile_watermark.png");wartermarkFile.png
newFile_watermark.png
批量处理图片
下面以批量给图片加水印来展示一下如何处理多个图片文件。
BufferedImage watermarkImage = ImageIO.read(new File("wartermarkFile.png"));
File destinationDir = new File("D:\\watermark\\");
Thumbnails.of("oldFile.png", "oldFile2.png")
.scale(0.8)
.watermark(Positions.BOTTOM_LEFT, watermarkImage, 0.5f)
.toFiles(destinationDir, Rename.PREFIX_DOT_THUMBNAIL);需要参考完整测试例代码请 点击这里
参考
Thumbnailator 官方示例文档
作者：静默虚空
欢迎任何形式的转载，但请务必注明出处。
限于本人水平，如果文章和代码有表述不当之处，还请不吝赐教。