Java图片处理工具Thumbnailator讲解

什么是Thumbnailator？

image

Thumbnailator是Google开源的优秀图片处理的第三方Java类库，比JDK自带的库要好用的多。

Maven依赖

目前最新版本是0.4.19

<dependency>
    <groupId>net.coobird</groupId>
    <artifactId>thumbnailator</artifactId>
    <version>0.4.19</version>
</dependency>

图片处理步骤

Thumbnailtor处理图片的步骤可以看我绘制的下图来说明。

image

主要分为三个步骤。

构建Thumbnails.Builder

要使用thumbnailtor，主要使用Thumbnails类，该类采用建造者模式设计，类中提供了很多返回Builder的静态方法。

image

正如上图所示，Thumbnails提供了通过字符串图片地址、File对象、URI对象等方式创建Thumbnails对象的方式。

of方法

of方法提供了多种参数，当然参数虽然不同，功能却是相同的。并且of支持多个参数，可以同时处理多个图片，不过要特别注意，处理多个图片的时候，输出方法也要使用支持输出多个图片的方法。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URL;

public class ThumbnailsOfDemo {
    public static void main(String[] args) throws IOException {
        // 参数是本地文件路径，支持多参数
        Thumbnails.of("input/logo.png")
                .scale(1D)
                .toFile("output/o1.png");

        // File类型的参数，支持多参数
        Thumbnails.of(new File("input/logo.png"))
                .scale(1D)
                .toFile("output/o2.png");

        // BufferedImage类型参数
        BufferedImage bufferedImage = ImageIO.read(new File("input/logo.png"));
        Thumbnails.of(bufferedImage)
                .scale(1D)
                .toFile("output/o3.png");

        // FileInputStream类型
        File file = new File("input/logo.png");
        FileInputStream fis = new FileInputStream(file);
        Thumbnails.of(fis)
                .scale(1D)
                .toFile("output/o4.png");

        // 网络图片
        Thumbnails.of(new URL("https://programtalk-1256529903.cos.ap-beijing.myqcloud.com/202302061502561.png"))
                .scale(1D)
                .toFile("output/o4.png");
    }
}

scale代表缩放，toFile是输出图片的方法，先不要管，后面会讲到。代码执行完毕后，会生成五个图片。

fromFilenames方法

Thumbnails.fromFilenames(Iterable<String> files)方法支持接入多个图片，也就是说能处理多个图片。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;
import net.coobird.thumbnailator.name.Rename;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;

public class ThumbnailsFromFilenamesDemo {
    /**
     * 使用FromFiles处理多个图片。
     */
    public static void main(String[] args) throws IOException {
        // 参数是本地文件路径，支持多参数
        File file = new File("input"); // input文件夹下有多个图片
        File[] files = file.listFiles();
        assert files != null;
        List<String> filenames = Arrays.stream(files).map(File::getPath).toList();
        Thumbnails.fromFilenames(filenames)
                .scale(1D)
                // 这里必须使用`toFiles`，因为处理的是多图
                .toFiles(new File("output"), Rename.SUFFIX_HYPHEN_THUMBNAIL);
    }
}

toFiles的用法后面会讲解。

fromFiles方法

Thumbnails.fromFiles方法(Iterable<File> files)方法支持接入多个图片，也就是说能处理多个图片。不同于fromFilenames的是它的参数是Iterable<File>类型。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;
import net.coobird.thumbnailator.name.Rename;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;

public class ThumbnailsFromFilesDemo {
    /**
     * 使用fromFiles处理多个图片。
     */
    public static void main(String[] args) throws IOException {
        File file = new File("input");
        File[] files = file.listFiles();
        assert files != null;
        Thumbnails.fromFiles(Arrays.asList(files))
                .scale(1D)
                // 这里必须使用`toFiles`，因为处理的是多图
                .toFiles(new File("output"), Rename.SUFFIX_HYPHEN_THUMBNAIL);
    }
}

fromURLs方法

Thumbnails.fromURLs用于批量处理网络图片。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.List;

public class ThumbnailsFromURLsDemo {
    /**
     * 使用fromURLs处理多个图片。
     */
    public static void main(String[] args) throws IOException {
        Thumbnails.fromURLs(List.of(new URL("https://programtalk-1256529903.cos.ap-beijing.myqcloud.com/202302061502561.png")
                        , new URL("https://itlab1024-1256529903.cos.ap-beijing.myqcloud.com/202301311404082.png")))
                .scale(1D)
                .toFiles(List.of(new File("output/fromURLs1.jpg"), new File("output/fromURLs2.jpg")));
    }
}

fromImages方法

Thumbnails.fromImages批量处理BufferedImage类型的图片。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import javax.imageio.ImageIO;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.List;

public class ThumbnailsFromImagesDemo {
    /**
     * 使用fromImages处理多个图片。
     */
    public static void main(String[] args) throws IOException {
        Thumbnails.fromImages(List.of(ImageIO.read(new URL("https://programtalk-1256529903.cos.ap-beijing.myqcloud.com/202302061502561.png"))
                        , ImageIO.read(new URL("https://itlab1024-1256529903.cos.ap-beijing.myqcloud.com/202301311404082.png"))))
                .scale(1D)
                .toFiles(List.of(new File("output/fromImages1.jpg"), new File("output/fromImages2.jpg")));
    }
}

fromInputStreams方法

Thumbnails.fromInputStreams批量处理InputStream类型的图片。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.List;

public class ThumbnailsFromInputStreamsDemo {
    /**
     * 使用fromInputStreams处理多个图片。
     */
    public static void main(String[] args) throws IOException {
        Thumbnails.fromInputStreams(List.of(new FileInputStream("input/logo.png")
                        , new FileInputStream("input/logo.png")))
                .scale(1D)
                .toFiles(List.of(new File("output/fromInputStreams.jpg"), new File("output/fromInputStreams.jpg")));
    }
}

图片处理

讲解图片处理前，先准备一张图片（wx.png）。图片属性信息如下：

image-20230206163350487

图片尺寸

基本说明

图片尺寸控制可以通过width、height，size， forceSize，scale方法控制。

width、height，size方法会默认保证原始图片比例（可以通过设置keepAspectRatio(false)取消，如果取消则等价于forceSize方法。），因为收到原始图片宽高比例的限制，即便设置了宽高可能也不会引起图片的尺寸（像素）变化（可能会导致图片大小变化）。

forceSize则会强制保证宽高，可能会导致图片拉伸。

scale是设置图片宽高比例，不大于1的数参数。

有以下异常情况要注意：

调用width和height方法后不能再使用size或者scale方法，否则会抛出异常。
调用size方法后不能再使用scale方法，否则会抛出异常。
调用scale方法后不能调用size、 scale或keepAspectRatio(boolean) 方法，否则会抛出异常。

代码示例

原图是宽=1710，高=624，宽高比≈2.74，那么目标的宽度是100，高度就会被计算为100 / 2.74 ≈ 36。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.IOException;

public class ThumbnailsSizeDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                .size(100, 100)
                .toFile("output/o1.png");
    }
}

处理完毕后图片信息如下：

size处理结果

可以看到确实是100X36的分辨率。

如果想不保证宽高比例，可以使用forceSize方法。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.IOException;

public class ThumbnailsSizeDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                .forceSize(100, 100)
                .toFile("output/o1.png");
    }
}

效果如下：

forceSize

通过scale，设置宽高比例来修改尺寸。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.IOException;

public class ThumbnailsSizeDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                .scale(0.8)
                .toFile("output/o1.png");
    }
}

代码中设置了scale=0.8

效果图如下：

scale

图片旋转

可以通过rotate(double angle)，来旋转图片，参数是度，比如30代表30度。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.IOException;

public class ThumbnailsRotateDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                .rotate(30) // 旋转30度
                // 此处size必须设置
                .size(100, 10)
                .toFile("output/o1.png");
    }
}

image-20230206175947372

图片水印

通过watermark设置水印，有多个多态方法。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;
import net.coobird.thumbnailator.geometry.Positions;

import javax.imageio.ImageIO;
import java.io.File;
import java.io.IOException;

public class ThumbnailsWatermarkDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                // 水印放到右下角
                .watermark(Positions.BOTTOM_RIGHT, ImageIO.read(new File("input/watermark.png")), 0.5f)
                .scale(1.74)
                .toFile("output/o1.png");
    }
}

image-20230206182020651

输出图片

输出格式

outputFormat(String format)方法用于设置输出文件格式。支持的格式可以通过ImageIO.getWriterFormatNames()获取。

我这里打印的格式列表是JPG jpg tiff bmp BMP gif GIF WBMP png PNG JPEG tif TIF TIFF jpeg wbmp。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import javax.imageio.ImageIO;
import java.io.IOException;

public class ThumbnailsOutputFormatDemo {
    public static void main(String[] args) throws IOException {
        String[] writerFormatNames = ImageIO.getWriterFormatNames();
        for (String writerFormatName : writerFormatNames) {
            System.out.print(writerFormatName + " "); // JPG jpg tiff bmp BMP gif GIF WBMP png PNG JPEG tif TIF TIFF jpeg wbmp
        }
        Thumbnails.of("input/wx.png")
                .scale(1.75)
                // 如果不设置默认跟原图片一致
                .outputFormat("JPG")
                // 设置质量
                .outputQuality(1F)
                .toFile("output/o1");
    }
}

输出结果：

outputFormat

输出质量

通过outputQuality(float quality)设置输出质量，参数介于0和1之间，支持小数，数字越小质量越差。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.IOException;

public class ThumbnailsOutputQualityDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/wx.png")
                .scale(1.75)
                // 设置质量
                .outputQuality(1F)
                .toFile("output/o1");
    }
}

输出到文件

单文件

使用toFile方法，将处理后的文件输出到指定文件，参数是文件路径，不是必须要指定文件后缀。

toFile要求文件读入的时候必须是单个源，例如如果是Thumbnails.of("input/logo.jpg","input/logo2.jpg")，使用toFile输出会抛出异常。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import javax.imageio.ImageIO;
import java.io.IOException;

public class ThumbnailsToFileDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/logo.jpg")
                .scale(1.75)
                // 默认如果文件已经存在，则不覆盖，可以设置allowOverwrite=true。
                .allowOverwrite(true)
                // 可以不指定文件后缀，默认是png
                .toFile("output/logo-new");
    }
}

默认如果文件已经存在，则不覆盖，可以设置allowOverwrite=true。

多文件

批量接入的文件处理完毕后，可以通过toFiles输出到指定目录下。

toFiles有三种多态方法

public void toFiles(File destinationDir, Rename rename) throws IOException // ①
public void toFiles(Rename rename) throws IOException // ②
public void toFiles(Iterable<File> iterable) throws IOException { // ③

①：第一个参数是文件夹路径，第二个参数是文件名处理类型。

NO_CHANGE：文件名不修改。

PREFIX_DOT_THUMBNAIL：追加 thumbnail.到文件名的开头。例如，给定 picture.jpg，结果为thumbnail.picture.jpg。

SUFFIX_DOT_THUMBNAIL：.thumbnail追加到文件扩展名之前的文件名。例如，给定 picture.jpg，结果为 picture.thumbnail.jpg

SUFFIX_HYPHEN_THUMBNAIL：-thumbnail追加到文件扩展名之前的文件名。例如，给定 picture.jpg，结果为 picture-thumbnail.jpg。

②：此方法是①的简化，等价于①中的第一个参数destinationDir为空。

③：参数是Iterable类型，也就是说可以给每个文件设置输出文件名。

代码示例如下：

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;
import net.coobird.thumbnailator.name.Rename;

import java.io.File;
import java.io.IOException;
import java.util.List;

public class ThumbnailsToFilesDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/logo.jpg", "input/logo.png")
                .scale(1.75)
                // 默认如果文件已经存在，则不覆盖，可以设置allowOverwrite=true。
                .allowOverwrite(true)
                // 可以不指定文件后缀，默认是png
                //.toFiles(new File("output"), Rename.NO_CHANGE);
                //.toFiles(Rename.NO_CHANGE);
                .toFiles(List.of(new File("output/1"), new File("output/2")));
    }
}

输出到输出流

单流

toOutputStream是将一个文件输出到输出流中。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;

public class ThumbnailsToOutputStreamDemo {
    public static void main(String[] args) throws IOException {
        OutputStream os = new FileOutputStream("output/logo.png");
        Thumbnails.of("input/logo.jpg")
                .scale(1.75)
                .toOutputStream(os);
    }
}

多流

toOutputStreams是将一个文件输出到多个输出流中。

package cn.programtalk;

import net.coobird.thumbnailator.Thumbnails;

import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;

public class ThumbnailsToOutputStreamsDemo {
    public static void main(String[] args) throws IOException {
        Thumbnails.of("input/logo.jpg", "input/logo.png")
                .scale(1.75)
                // 这里文件后缀最好指定，写入到磁盘的文件没有文件后缀。
                .toOutputStreams(List.of(new FileOutputStream("output/1.jpg"), new FileOutputStream("output/2.png")));
    }
}

github：https://github.com/ProgramTalk1024/thumbnailator-tutorial.git

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 214,951评论 6赞 497
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 91,606评论 3赞 389
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 160,601评论 0赞 350
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 57,478评论 1赞 288
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,565评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,587评论 1赞 293
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,590评论 3赞 414
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,337评论 0赞 270
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,785评论 1赞 307
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 37,096评论 2赞 330
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,273评论 1赞 344
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,935评论 5赞 339
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,578评论 3赞 322
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,199评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,440评论 1赞 268
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 47,163评论 2赞 366
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 44,133评论 2赞 352

Java图片处理工具Thumbnailator讲解

什么是Thumbnailator？

Maven依赖

图片处理步骤

构建Thumbnails.Builder

of方法

fromFilenames方法

fromFiles方法

fromURLs方法

fromImages方法

fromInputStreams方法

图片处理

图片尺寸

基本说明

代码示例

图片旋转

图片水印

输出图片

输出格式

输出质量

输出到文件

单文件

多文件

输出到输出流

单流

多流

推荐阅读更多精彩内容