Java圖片處理工具Thumbnailator講解

什么是Thumbnailator？

image

Thumbnailator是Google開源的優(yōu)秀圖片處理的第三方Java類庫，比JDK自帶的庫要好用的多。

官網(wǎng)Github地址

Maven依賴

目前最新版本是0.4.19

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

圖片處理步驟

Thumbnailtor處理圖片的步驟可以看我繪制的下圖來說明。

image

主要分為三個步驟。

構(gòu)建Thumbnails.Builder

要使用thumbnailtor，主要使用Thumbnails類，該類采用建造者模式設(shè)計，類中提供了很多返回Builder的靜態(tài)方法。

image

正如上圖所示，Thumbnails提供了通過字符串圖片地址、File對象、URI對象等方式創(chuàng)建Thumbnails對象的方式。

of方法

of方法提供了多種參數(shù)，當然參數(shù)雖然不同，功能卻是相同的。并且of支持多個參數(shù)，可以同時處理多個圖片，不過要特別注意，處理多個圖片的時候，輸出方法也要使用支持輸出多個圖片的方法。

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 {
        // 參數(shù)是本地文件路徑，支持多參數(shù)
        Thumbnails.of("input/logo.png")
                .scale(1D)
                .toFile("output/o1.png");

        // File類型的參數(shù)，支持多參數(shù)
        Thumbnails.of(new File("input/logo.png"))
                .scale(1D)
                .toFile("output/o2.png");

        // BufferedImage類型參數(shù)
        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");

        // 網(wǎng)絡(luò)圖片
        Thumbnails.of(new URL("https://programtalk-1256529903.cos.ap-beijing.myqcloud.com/202302061502561.png"))
                .scale(1D)
                .toFile("output/o4.png");
    }
}

scale代表縮放，toFile是輸出圖片的方法，先不要管，后面會講到。代碼執(zhí)行完畢后，會生成五個圖片。

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 {
        // 參數(shù)是本地文件路徑，支持多參數(shù)
        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的是它的參數(shù)是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用于批量處理網(wǎng)絡(luò)圖片。

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方法會默認保證原始圖片比例（可以通過設(shè)置keepAspectRatio(false)取消，如果取消則等價于forceSize方法。），因為收到原始圖片寬高比例的限制，即便設(shè)置了寬高可能也不會引起圖片的尺寸（像素）變化（可能會導(dǎo)致圖片大小變化）。

forceSize則會強制保證寬高，可能會導(dǎo)致圖片拉伸。

scale是設(shè)置圖片寬高比例，不大于1的數(shù)參數(shù)。

有以下異常情況要注意：

  • 調(diào)用width和height方法后不能再使用size或者scale方法，否則會拋出異常。
  • 調(diào)用size方法后不能再使用scale方法，否則會拋出異常。
  • 調(diào)用scale方法后不能調(diào)用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處理結(jié)果

可以看到確實是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，設(shè)置寬高比例來修改尺寸。

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");
    }
}

代碼中設(shè)置了scale=0.8

效果圖如下：

scale

圖片旋轉(zhuǎn)

可以通過rotate(double angle)，來旋轉(zhuǎn)圖片，參數(shù)是度，比如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) // 旋轉(zhuǎn)30度
                // 此處size必須設(shè)置
                .size(100, 10)
                .toFile("output/o1.png");
    }
}
image-20230206175947372

圖片水印

通過watermark設(shè)置水印，有多個多態(tài)方法。

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)方法用于設(shè)置輸出文件格式。支持的格式可以通過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)
                // 如果不設(shè)置默認跟原圖片一致
                .outputFormat("JPG")
                // 設(shè)置質(zhì)量
                .outputQuality(1F)
                .toFile("output/o1");
    }
}

輸出結(jié)果：

outputFormat

輸出質(zhì)量

通過outputQuality(float quality)設(shè)置輸出質(zhì)量，參數(shù)介于0和1之間，支持小數(shù)，數(shù)字越小質(zhì)量越差。

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)
                // 設(shè)置質(zhì)量
                .outputQuality(1F)
                .toFile("output/o1");
    }
}

輸出到文件

單文件

使用toFile方法，將處理后的文件輸出到指定文件，參數(shù)是文件路徑，不是必須要指定文件后綴。

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)
                // 默認如果文件已經(jīng)存在，則不覆蓋，可以設(shè)置allowOverwrite=true。
                .allowOverwrite(true)
                // 可以不指定文件后綴，默認是png
                .toFile("output/logo-new");
    }
}

默認如果文件已經(jīng)存在，則不覆蓋，可以設(shè)置allowOverwrite=true。

多文件

批量接入的文件處理完畢后，可以通過toFiles輸出到指定目錄下。

toFiles有三種多態(tài)方法

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

①：第一個參數(shù)是文件夾路徑，第二個參數(shù)是文件名處理類型。

NO_CHANGE：文件名不修改。

PREFIX_DOT_THUMBNAIL：追加 thumbnail.到文件名的開頭。例如，給定 picture.jpg，結(jié)果為thumbnail.picture.jpg。

SUFFIX_DOT_THUMBNAIL：.thumbnail追加到文件擴展名之前的文件名。例如，給定 picture.jpg，結(jié)果為 picture.thumbnail.jpg

SUFFIX_HYPHEN_THUMBNAIL：-thumbnail追加到文件擴展名之前的文件名。例如，給定 picture.jpg，結(jié)果為 picture-thumbnail.jpg。

②：此方法是①的簡化，等價于①中的第一個參數(shù)destinationDir為空。

③：參數(shù)是Iterable類型，也就是說可以給每個文件設(shè)置輸出文件名。

代碼示例如下：

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)
                // 默認如果文件已經(jīng)存在，則不覆蓋，可以設(shè)置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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容