ImagesUtil (tool-core 1.3.15 API)

java.lang.Object
- cn.novelweb.tool.img.ImagesUtil

```
public class ImagesUtil
extends Object
```
图片处理工具类

2020-03-31 11:07

作者:

Dai Yuanchuan

字段概要

字段
限定符和类型字段和说明

static String[] IMAGES_TYPE
支持的图片类型数组其他格式不保证效果

字段
限定符和类型	字段和说明
`static String[]`	`IMAGES_TYPE` 支持的图片类型数组其他格式不保证效果

构造器概要

构造器
构造器和说明

ImagesUtil()

构造器
构造器和说明
`ImagesUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`areColorsWithinTolerance(Color color1, Color color2, Color tolerance)` 判断颜色是否在容差范围内对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值
`static boolean`	`areColorsWithinTolerance(Color color1, Color color2, int tolerance)` 判断颜色是否在容差范围内对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值
`static BufferedImage`	`backgroundRemoval(BufferedImage bufferedImage, Color override, int tolerance)` 背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
`static BufferedImage`	`backgroundRemoval(ByteArrayOutputStream outputStream, Color override, int tolerance)` 背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
`static boolean`	`backgroundRemoval(File input, File output, Color override, int tolerance)` 背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
`static boolean`	`backgroundRemoval(File input, File output, int tolerance)` 背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
`static boolean`	`backgroundRemoval(String inputPath, String outputPath, int tolerance)` 背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
`static byte[]`	`compressionSizeOutByte(InputStream imgFile, String suffix, double compressionRatio, double scaling)` 压缩图片大小图片尺寸保持不变
`static ByteArrayOutputStream`	`compressionSizeOutStream(InputStream imgFile, String suffix, double compressionRatio, double scaling)` 压缩图片大小图片尺寸保持不变
`static byte[]`	`compressNetworkPicturesOutByte(String url, Integer width, Integer height)` 压缩指定网络图片大小(例如：横500高500)，保持图片不变形，多余部分裁剪掉
`static ByteArrayOutputStream`	`compressNetworkPicturesOutStream(String url, Integer width, Integer height)` 压缩指定网络图片大小(例如：横500高500)，保持图片不变形，多余部分裁剪掉
`static byte[]`	`compressPicturesOutByte(InputStream input, String suffix, Integer width, Integer height)` 压缩至指定图片尺寸(例如：横500高500)，保持图片不变形，多余部分裁剪掉
`static ByteArrayOutputStream`	`compressPicturesOutStream(InputStream input, String suffix, Integer width, Integer height)` 压缩至指定图片尺寸(例如：横500高500)，保持图片不变形，多余部分裁剪掉
`static byte[]`	`cutPictureOutByte(File input, Integer x, Integer y, Integer width, Integer height)` 图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
`static boolean`	`cutPictureOutFile(File input, File output, Integer x, Integer y, Integer width, Integer height)` 图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
`static BufferedImage`	`cutPictureOutStream(File input, Integer x, Integer y, Integer width, Integer height)` 图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
`static String`	`getMainColor(BufferedImage bufferedImage)` 获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
`static String`	`getMainColor(File input)` 获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
`static String`	`getMainColor(String input)` 获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
`static Color`	`hexToRgb(String hex)` 十六进制颜色码转RGB颜色值
`static byte[]`	`mergeOutByte(File[] files, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接
`static byte[]`	`mergeOutByte(String[] files, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接
`static boolean`	`mergeOutFile(File[] files, File output, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接
`static boolean`	`mergeOutFile(String[] files, String output, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接
`static BufferedImage`	`mergeOutStream(File[] files, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接根据需求图像的宽高需要保持一致注意:横向合并时高度必须要保持一致纵向合并时宽度必须要保持一致
`static BufferedImage`	`mergeOutStream(String[] files, boolean horizontalOrVertical)` 图片拼接多张图片进行横向或纵向拼接
`static String`	`rgbToHex(int r, int g, int b)` RGB颜色值转换成十六进制颜色码
`static byte[]`	`scaleToScaleOutByte(InputStream imgFile, String suffix, double scaling)` 按照比例进行缩放...图片尺寸不变
`static byte[]`	`scaleToScaleOutByte(InputStream imgFile, String suffix, Integer width, Integer height, boolean isScaling)` 不按照比例，指定大小进行缩放
`static ByteArrayOutputStream`	`scaleToScaleOutStream(InputStream imgFile, String suffix, double scaling)` 按照比例进行缩放...图片尺寸不变
`static ByteArrayOutputStream`	`scaleToScaleOutStream(InputStream imgFile, String suffix, Integer width, Integer height, boolean isScaling)` 不按照比例，指定大小进行缩放

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - IMAGES_TYPE
```
public static String[] IMAGES_TYPE
```
    支持的图片类型数组其他格式不保证效果
- 构造器详细资料
  - ImagesUtil
```
public ImagesUtil()
```
- 方法详细资料
  - compressPicturesOutByte
```
public static byte[] compressPicturesOutByte(InputStream input,
                                             String suffix,
                                             Integer width,
                                             Integer height)
```
    压缩至指定图片尺寸(例如：横500高500)，保持图片不变形，多余部分裁剪掉
    
    参数:
    
    input - 图片流
    
    suffix - 文件后缀 jpg、png等等
    
    width - 压缩至:宽度(最小为1)
    
    height - 压缩至:高度(最小为1)
    
    返回:
    
    返回图片的byte类型数组
  - compressPicturesOutStream
```
public static ByteArrayOutputStream compressPicturesOutStream(InputStream input,
                                                              String suffix,
                                                              Integer width,
                                                              Integer height)
```
    压缩至指定图片尺寸(例如：横500高500)，保持图片不变形，多余部分裁剪掉
    
    参数:
    
    input - 图片流
    
    suffix - 文件后缀 jpg、png等等
    
    width - 压缩至:宽度(最小为1)
    
    height - 压缩至:高度(最小为1)
    
    返回:
    
    返回图片的字节数组输出流
  - compressNetworkPicturesOutByte
```
public static byte[] compressNetworkPicturesOutByte(String url,
                                                    Integer width,
                                                    Integer height)
```
    压缩指定网络图片大小(例如：横500高500)，保持图片不变形，多余部分裁剪掉
    
    参数:
    
    url - 网络图片URL
    
    width - 压缩至:宽度(最小为10)
    
    height - 压缩至:高度(最小为10)
    
    返回:
    
    返回图片的byte类型数组
  - compressNetworkPicturesOutStream
```
public static ByteArrayOutputStream compressNetworkPicturesOutStream(String url,
                                                                     Integer width,
                                                                     Integer height)
```
    压缩指定网络图片大小(例如：横500高500)，保持图片不变形，多余部分裁剪掉
    
    参数:
    
    url - 网络图片URL
    
    width - 压缩至:宽度(最小为10)
    
    height - 压缩至:高度(最小为10)
    
    返回:
    
    返回图片的字节数组输出流
  - scaleToScaleOutByte
```
public static byte[] scaleToScaleOutByte(InputStream imgFile,
                                         String suffix,
                                         double scaling)
```
    按照比例进行缩放...图片尺寸不变
    
    参数:
    
    imgFile - 文件流
    
    suffix - 文件后缀 jpg、png等等
    
    scaling - 缩放比例(1为最高质量,大于1就是变大,小于1就是缩小)
    
    返回:
    
    返回图片的byte类型数组
  - scaleToScaleOutStream
```
public static ByteArrayOutputStream scaleToScaleOutStream(InputStream imgFile,
                                                          String suffix,
                                                          double scaling)
```
    按照比例进行缩放...图片尺寸不变
    
    参数:
    
    imgFile - 文件流
    
    suffix - 文件后缀 jpg、png等等
    
    scaling - 缩放比例(1为最高质量,大于1就是变大,小于1就是缩小)
    
    返回:
    
    返回图片的字节数组输出流
  - scaleToScaleOutByte
```
public static byte[] scaleToScaleOutByte(InputStream imgFile,
                                         String suffix,
                                         Integer width,
                                         Integer height,
                                         boolean isScaling)
```
    不按照比例，指定大小进行缩放
    
    参数:
    
    imgFile - 文件流
    
    suffix - 文件后缀 jpg、png等等
    
    width - 压缩至:宽
    
    height - 压缩至:高
    
    isScaling - 是否按照比例缩放(true按照比例缩放 : false不按照比例缩放)
    
    返回:
    
    返回图片的byte类型数组
  - scaleToScaleOutStream
```
public static ByteArrayOutputStream scaleToScaleOutStream(InputStream imgFile,
                                                          String suffix,
                                                          Integer width,
                                                          Integer height,
                                                          boolean isScaling)
```
    不按照比例，指定大小进行缩放
    
    参数:
    
    imgFile - 文件流
    
    suffix - 文件后缀 jpg、png等等
    
    width - 压缩至:宽
    
    height - 压缩至:高
    
    isScaling - 是否按照比例缩放(true按照比例缩放 : false不按照比例缩放)
    
    返回:
    
    返回图片的字节数组输出流
  - compressionSizeOutByte
```
public static byte[] compressionSizeOutByte(InputStream imgFile,
                                            String suffix,
                                            double compressionRatio,
                                            double scaling)
```
    压缩图片大小图片尺寸保持不变
    
    参数:
    
    imgFile - 文件流
    
    compressionRatio - 压缩比例[设置缩略图的缩放因子,值大于0.0]
    
    scaling - 缩放比例[取值范围 0.0 ~ 1.0 之间]
    
    返回:
    
    返回图片的byte类型数组
  - compressionSizeOutStream
```
public static ByteArrayOutputStream compressionSizeOutStream(InputStream imgFile,
                                                             String suffix,
                                                             double compressionRatio,
                                                             double scaling)
```
    压缩图片大小图片尺寸保持不变
    
    参数:
    
    imgFile - 文件流
    
    compressionRatio - 压缩比例[设置缩略图的缩放因子,值大于0.0]
    
    scaling - 缩放比例[取值范围 0.0 ~ 1.0 之间]
    
    返回:
    
    返回图片的字节数组输出流
  - backgroundRemoval
```
public static boolean backgroundRemoval(String inputPath,
                                        String outputPath,
                                        int tolerance)
```
    背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
    
    参数:
    
    inputPath - 要处理图片的路径
    
    outputPath - 输出图片的路径
    
    tolerance - 容差值[根据图片的主题色,加入容差值,值的范围在0~255之间]
    
    返回:
    
    返回处理结果 true:图片处理完成 false:图片处理失败
  - backgroundRemoval
```
public static boolean backgroundRemoval(File input,
                                        File output,
                                        int tolerance)
```
    背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
    
    参数:
    
    input - 需要进行操作的图片
    
    output - 最后输出的文件
    
    tolerance - 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间]
    
    返回:
    
    返回处理结果 true:图片处理完成 false:图片处理失败
  - backgroundRemoval
```
public static boolean backgroundRemoval(File input,
                                        File output,
                                        Color override,
                                        int tolerance)
```
    背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
    
    参数:
    
    input - 需要进行操作的图片
    
    output - 最后输出的文件
    
    override - 指定替换成的背景颜色为null时背景为透明
    
    tolerance - 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间]
    
    返回:
    
    返回处理结果 true:图片处理完成 false:图片处理失败
  - backgroundRemoval
```
public static BufferedImage backgroundRemoval(BufferedImage bufferedImage,
                                              Color override,
                                              int tolerance)
```
    背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
    
    参数:
    
    bufferedImage - 需要进行处理的图片流
    
    override - 指定替换成的背景颜色为null时背景为透明
    
    tolerance - 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间]
    
    返回:
    
    返回处理好的图片流
  - backgroundRemoval
```
public static BufferedImage backgroundRemoval(ByteArrayOutputStream outputStream,
                                              Color override,
                                              int tolerance)
```
    背景移除图片去底工具将 "纯色背景的图片" 还原成 "透明背景的图片" 将纯色背景的图片转成矢量图取图片边缘的像素点和获取到的图片主题色作为要替换的背景色再加入一定的容差值,然后将所有像素点与该颜色进行比较发现相同则将颜色不透明度设置为0,使颜色完全透明.
    
    参数:
    
    outputStream - 需要进行处理的图片字节数组流
    
    override - 指定替换成的背景颜色为null时背景为透明
    
    tolerance - 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间]
    
    返回:
    
    返回处理好的图片流
  - rgbToHex
```
public static String rgbToHex(int r,
                              int g,
                              int b)
```
    RGB颜色值转换成十六进制颜色码
    
    参数:
    
    r - 红(R)
    
    g - 绿(G)
    
    b - 蓝(B)
    
    返回:
    
    返回字符串形式的十六进制颜色码如
  - hexToRgb
```
public static Color hexToRgb(String hex)
```
    十六进制颜色码转RGB颜色值
    
    参数:
    
    hex - 十六进制颜色码
    
    返回:
    
    返回 RGB颜色值
  - areColorsWithinTolerance
```
public static boolean areColorsWithinTolerance(Color color1,
                                               Color color2,
                                               int tolerance)
```
    判断颜色是否在容差范围内对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值
    
    参数:
    
    color1 - 颜色1
    
    color2 - 颜色2
    
    tolerance - 容差值
    
    返回:
    
    返回true:两个颜色在容差值之内 false: 不在
  - areColorsWithinTolerance
```
public static boolean areColorsWithinTolerance(Color color1,
                                               Color color2,
                                               Color tolerance)
```
    判断颜色是否在容差范围内对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值
    
    参数:
    
    color1 - 颜色1
    
    color2 - 颜色2
    
    tolerance - 容差色值
    
    返回:
    
    返回true:两个颜色在容差值之内 false: 不在
  - getMainColor
```
public static String getMainColor(String input)
```
    获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
    
    参数:
    
    input - 图片文件路径
    
    返回:
    
    返回一个图片的大概的色值一个16进制的颜色码
  - getMainColor
```
public static String getMainColor(File input)
```
    获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
    
    参数:
    
    input - 图片文件
    
    返回:
    
    返回一个图片的大概的色值一个16进制的颜色码
  - getMainColor
```
public static String getMainColor(BufferedImage bufferedImage)
```
    获取图片大概的主题色循环所有的像素点,取出出现次数最多的一个像素点的RGB值
    
    参数:
    
    bufferedImage - 图片流
    
    返回:
    
    返回一个图片的大概的色值一个16进制的颜色码
  - cutPictureOutStream
```
public static BufferedImage cutPictureOutStream(File input,
                                                Integer x,
                                                Integer y,
                                                Integer width,
                                                Integer height)
```
    图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
    
    参数:
    
    input - 指定需要进行操作的图片文件
    
    x - x轴图片从指定 x轴开始切割
    
    y - y轴图片从指定 y轴开始切割
    
    width - 图片需要切割的宽度
    
    height - 图片需要切割的高度
    
    返回:
    
    返回切割后的图片流 java.awt.image.BufferedImage
  - cutPictureOutByte
```
public static byte[] cutPictureOutByte(File input,
                                       Integer x,
                                       Integer y,
                                       Integer width,
                                       Integer height)
```
    图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
    
    参数:
    
    input - 指定需要进行操作的图片文件
    
    x - x轴图片从指定 x轴开始切割
    
    y - y轴图片从指定 y轴开始切割
    
    width - 图片需要切割的宽度
    
    height - 图片需要切割的高度
    
    返回:
    
    返回切割后的图片字节数组
  - cutPictureOutFile
```
public static boolean cutPictureOutFile(File input,
                                        File output,
                                        Integer x,
                                        Integer y,
                                        Integer width,
                                        Integer height)
```
    图片指定 X轴，Y轴裁剪、切割给定 X轴、Y轴、裁剪后的宽、高进行指定位置的裁剪
    
    参数:
    
    input - 指定需要进行操作的图片文件
    
    output - 指定切割后需要输出的文件
    
    x - x轴图片从指定 x轴开始切割
    
    y - y轴图片从指定 y轴开始切割
    
    width - 图片需要切割的宽度
    
    height - 图片需要切割的高度
    
    返回:
    
    返回布尔值文件是否写入成功标识 true:文件成功写入 false:文件写入失败
  - mergeOutStream
```
public static BufferedImage mergeOutStream(File[] files,
                                           boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接根据需求图像的宽高需要保持一致注意:横向合并时高度必须要保持一致纵向合并时宽度必须要保持一致
    
    参数:
    
    files - 需要进行拼接的文件数组
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回拼接后的图片流 java.awt.image.BufferedImage
  - mergeOutStream
```
public static BufferedImage mergeOutStream(String[] files,
                                           boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接
    
    参数:
    
    files - 需要进行拼接的文件路径数组
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回拼接后的图片流 java.awt.image.BufferedImage
  - mergeOutByte
```
public static byte[] mergeOutByte(File[] files,
                                  boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接
    
    参数:
    
    files - 需要进行拼接的文件数组
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回切割后的图片字节数组
  - mergeOutByte
```
public static byte[] mergeOutByte(String[] files,
                                  boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接
    
    参数:
    
    files - 需要进行拼接的文件路径数组
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回切割后的图片字节数组
  - mergeOutFile
```
public static boolean mergeOutFile(File[] files,
                                   File output,
                                   boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接
    
    参数:
    
    files - 需要进行拼接的文件数组
    
    output - 指定图片拼接后需要输出的文件
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回布尔值文件是否写入成功标识 true:文件成功写入 false:文件写入失败
  - mergeOutFile
```
public static boolean mergeOutFile(String[] files,
                                   String output,
                                   boolean horizontalOrVertical)
```
    图片拼接多张图片进行横向或纵向拼接
    
    参数:
    
    files - 需要进行拼接的文件路径数组
    
    output - 指定图片拼接后需要输出的文件
    
    horizontalOrVertical - 布尔值 true:进行横向拼接 false:进行纵向拼接
    
    返回:
    
    返回布尔值文件是否写入成功标识 true:文件成功写入 false:文件写入失败

类 ImagesUtil

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

IMAGES_TYPE

构造器详细资料

ImagesUtil

方法详细资料

compressPicturesOutByte

compressPicturesOutStream

compressNetworkPicturesOutByte

compressNetworkPicturesOutStream

scaleToScaleOutByte

scaleToScaleOutStream

scaleToScaleOutByte

scaleToScaleOutStream

compressionSizeOutByte

compressionSizeOutStream

backgroundRemoval

backgroundRemoval

backgroundRemoval

backgroundRemoval

backgroundRemoval

rgbToHex

hexToRgb

areColorsWithinTolerance

areColorsWithinTolerance

getMainColor

getMainColor

getMainColor

cutPictureOutStream

cutPictureOutByte

cutPictureOutFile

mergeOutStream

mergeOutStream

mergeOutByte

mergeOutByte

mergeOutFile

mergeOutFile