利用Thumbnailator轻松实现图片缩放、旋转与加水印

程序员文章站 2024-03-08 18:27:05

概述 thumbnailator 是一个开源的 java 项目，它提供了非常简单的 api 来对图片进行缩放、旋转以及加水印的处理。有多简单呢？简单到一行代码就可以完...

概述

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<file> of(string... files) {...}
public static builder<file> of(file... files) {...}
public static builder<url> of(url... urls) {...}
public static builder<? extends inputstream> of(inputstream... inputstreams) {...}
public static builder<bufferedimage> of(bufferedimage... images) {...}
// 迭代器（所有实现 iterable 接口的 java 对象都可以，当然也包括 list、set）
public static builder<file> fromfilenames(iterable<string> files) {...}
public static builder<file> fromfiles(iterable<file> files) {...}
public static builder<url> fromurls(iterable<url> urls) {...}
public static builder<inputstream> frominputstreams(iterable<? extends inputstream> inputstreams) {...}
public static builder<bufferedimage> fromimages(iterable<bufferedimage> images) {...}

很显然，thumbnails 允许通过传入文件名、文件、网络图的url、图片流、图片缓存多种方式来初始化构造器。

因此，你可以根据实际需求来灵活的选择图片的输入方式。

需要注意一点：如果输入是多个对象（无论你是直接输入容器对象或使用可变参数方式传入多个对象），则输出也必须选用输出多个对象的方式，否则会报异常。

thumbnails.builder

thumbnails.builder 是 thumbnails 的内部静态类。它用于设置生成缩略图任务的相关参数。

注：thumbnails.builder 的构造函数是私有函数。所以，它只允许通过 thumbnails 的实例化函数来进行初始化。

设置参数的函数

thumbnails.builder 提供了一组函数链形式的接口来设置缩放图参数。

以设置大小函数为例：

public builder<t> 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<bufferedimage> asbufferedimages() throws ioexception {...}
public bufferedimage asbufferedimage() throws ioexception {...}
// 返回文件列表
public list<file> asfiles(iterable<file> iterable) throws ioexception {...}
public list<file> asfiles(rename rename) throws ioexception {...}
public list<file> 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<file> 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<? extends outputstream> iterable) throws ioexception {...}

工作流

thumbnailator 的工作步骤十分简单，可分为三步：

输入：thumbnails 根据输入初始化构造器—— thumbnails.builder 。
设置：thumbnails.builder 设置缩放图片的参数。
输出：thumbnails.builder 输出图片文件或图片流。

更多详情可以参考： thumbnailator 官网javadoc

实战

前文介绍了 thumbnailator 的核心 api，接下来我们就可以通过实战来看看 thumbnailator 究竟可以做些什么。

thumbnailator 生成什么样的图片，是根据设置参数来决定的。

安装

maven项目中引入依赖：

<dependency>
 <groupid>net.coobird</groupid>
 <artifactid>thumbnailator</artifactid>
 <version>[0.4, 0.5)</version>
</dependency>

图片缩放

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