org.dromara.x.file.storage.core

类 UploadPretreatment

java.lang.Object

org.dromara.x.file.storage.core.UploadPretreatment

public class UploadPretreatment
extends Object

文件上传预处理对象

构造器概要

构造器

构造器和说明
UploadPretreatment()

方法概要

限定符和类型	方法和说明
UploadPretreatment	clearThumbnail() 清空缩略图
UploadPretreatment	clearThumbnail(boolean flag) 清空缩略图
cn.hutool.core.lang.Dict	getAttr() 获取附加属性字典
String	getContentType() 获取文件的 MIME 类型
Map<String,String>	getMetadata() 获取文件元数据
String	getName() 获取文件名
String	getOriginalFilename() 获取原始文件名
Map<String,String>	getThMetadata() 获取缩略图元数据
Map<String,String>	getThUserMetadata() 获取缩略图用户元数据
Map<String,String>	getUserMetadata() 获取文件用户元数据
UploadPretreatment	image() 缩放到 200*200 大小
UploadPretreatment	image(boolean flag) 缩放到 200*200 大小
UploadPretreatment	image(boolean flag, java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 进行图片处理，可以进行裁剪、旋转、缩放、水印等操作
UploadPretreatment	image(boolean flag, int width, int height) 缩放到指定大小
UploadPretreatment	image(java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 进行图片处理，可以进行裁剪、旋转、缩放、水印等操作
UploadPretreatment	image(int width, int height) 缩放到指定大小
UploadPretreatment	putAttr(boolean flag, String key, Object value) 设置附加属性
UploadPretreatment	putAttr(String key, Object value) 设置附加属性
UploadPretreatment	putAttrAll(boolean flag, Map<String,Object> attr) 设置附加属性
UploadPretreatment	putAttrAll(Map<String,Object> attr) 设置附加属性
UploadPretreatment	putMetadata(boolean flag, String key, String value) 设置文件元数据
UploadPretreatment	putMetadata(String key, String value) 设置文件元数据
UploadPretreatment	putMetadataAll(boolean flag, Map<String,String> metadata) 设置文件元数据
UploadPretreatment	putMetadataAll(Map<String,String> metadata) 设置文件元数据
UploadPretreatment	putThMetadata(boolean flag, String key, String value) 设置缩略图元数据
UploadPretreatment	putThMetadata(String key, String value) 设置缩略图元数据
UploadPretreatment	putThMetadataAll(boolean flag, Map<String,String> metadata) 设置缩略图元数据
UploadPretreatment	putThMetadataAll(Map<String,String> metadata) 设置缩略图元数据
UploadPretreatment	putThUserMetadata(boolean flag, String key, String value) 设置缩略图用户元数据
UploadPretreatment	putThUserMetadata(String key, String value) 设置缩略图用户元数据
UploadPretreatment	putThUserMetadataAll(boolean flag, Map<String,String> metadata) 设置缩略图用户元数据
UploadPretreatment	putThUserMetadataAll(Map<String,String> metadata) 设置缩略图用户元数据
UploadPretreatment	putUserMetadata(boolean flag, String key, String value) 设置文件用户元数据
UploadPretreatment	putUserMetadata(String key, String value) 设置文件用户元数据
UploadPretreatment	putUserMetadataAll(boolean flag, Map<String,String> metadata) 设置文件用户元数据
UploadPretreatment	putUserMetadataAll(Map<String,String> metadata) 设置文件用户元数据
UploadPretreatment	setAcl(boolean flag, Object acl) 同时设置 fileAcl 和 thFileAcl 两个属性 详情见FileInfo#setFileAcl
UploadPretreatment	setAcl(Object acl) 同时设置 fileAcl 和 thFileAcl 两个属性 详情见FileInfo#setFileAcl
UploadPretreatment	setContentType(boolean flag, String contentType) 设置文件的 MIME 类型
UploadPretreatment	setContentType(String contentType) 设置文件的 MIME 类型
UploadPretreatment	setFileWrapper(boolean flag, FileWrapper fileWrapper) 设置要上传的文件包装类
UploadPretreatment	setName(boolean flag, String name) 设置文件名
UploadPretreatment	setName(String name) 设置文件名
UploadPretreatment	setObjectId(boolean flag, Object objectId) 设置文件所属对象id
UploadPretreatment	setObjectId(Object objectId) 设置文件所属对象id
UploadPretreatment	setObjectType(boolean flag, String objectType) 设置文件所属对象类型
UploadPretreatment	setOriginalFilename(boolean flag, String originalFilename) 设置原始文件名
UploadPretreatment	setOriginalFilename(String originalFilename) 设置原始文件名
UploadPretreatment	setPath(boolean flag, String path) 设置文文件存储路径
UploadPretreatment	setPlatform(boolean flag, String platform) 设置要上传到的平台
UploadPretreatment	setProgressMonitor(java.util.function.BiConsumer<Long,Long> progressListener) 设置上传进度监听器
UploadPretreatment	setProgressMonitor(boolean flag, java.util.function.BiConsumer<Long,Long> progressListener) 设置上传进度监听器
UploadPretreatment	setProgressMonitor(boolean flag, java.util.function.Consumer<Long> progressListener) 设置上传进度监听器
UploadPretreatment	setProgressMonitor(boolean flag, ProgressListener progressListener) 设置上传进度监听器
UploadPretreatment	setProgressMonitor(java.util.function.Consumer<Long> progressListener) 设置上传进度监听器
UploadPretreatment	setProgressMonitor(ProgressListener progressListener) 设置上传进度监听器
UploadPretreatment	setSaveFilename(boolean flag, String saveFilename) 设置保存文件名，如果不设置则自动生成
UploadPretreatment	setSaveThFilename(boolean flag, String saveThFilename) 设置缩略图的保存文件名，注意此文件名不含后缀，后缀用 thumbnailSuffix 属性控制
UploadPretreatment	setThContentType(boolean flag, String thContentType) 缩略图 MIME 类型，如果不设置则在上传文件根据缩略图文件名自动识别
UploadPretreatment	setThumbnailBytes(boolean flag, byte[] thumbnailBytes) 设置要上传文件的缩略图
UploadPretreatment	setThumbnailSuffix(boolean flag, String thumbnailSuffix) 设置缩略图后缀，不是扩展名但包含扩展名，例如【.min.jpg】【.png】。
UploadPretreatment	thumbnail() 生成缩略图并缩放到 200*200 大小，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnail(boolean flag) 生成缩略图并缩放到 200*200 大小，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnail(boolean flag, java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 生成缩略图并进行图片处理，如果缩略图已存在则使用已有的缩略图进行处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnail(boolean flag, int width, int height) 生成缩略图并缩放到指定大小，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnail(java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 生成缩略图并进行图片处理，如果缩略图已存在则使用已有的缩略图进行处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnail(int width, int height) 生成缩略图并缩放到指定大小，默认输出图片格式通过 thumbnailSuffix 获取
UploadPretreatment	thumbnailOf(boolean flag, Object file) 通过指定 file 生成缩略图， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭
UploadPretreatment	thumbnailOf(boolean flag, Object file, java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 通过指定 file 生成缩略图并进行图片处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭
UploadPretreatment	thumbnailOf(Object file) 通过指定 file 生成缩略图， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭
UploadPretreatment	thumbnailOf(Object file, java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer) 通过指定 file 生成缩略图并进行图片处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭
FileInfo	upload() 上传文件，成功返回文件信息，失败返回null

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

UploadPretreatment

public UploadPretreatment()

方法详细资料

setPlatform

public UploadPretreatment setPlatform(boolean flag,
                                      String platform)

设置要上传到的平台

setFileWrapper

public UploadPretreatment setFileWrapper(boolean flag,
                                         FileWrapper fileWrapper)

设置要上传的文件包装类

setThumbnailBytes

public UploadPretreatment setThumbnailBytes(boolean flag,
                                            byte[] thumbnailBytes)

设置要上传文件的缩略图

setThumbnailSuffix

public UploadPretreatment setThumbnailSuffix(boolean flag,
                                             String thumbnailSuffix)

设置缩略图后缀，不是扩展名但包含扩展名，例如【.min.jpg】【.png】。 只能在缩略图生成前进行修改后缀中的扩展名部分。 例如当前是【.min.jpg】那么扩展名就是【jpg】，当缩略图未生成的情况下可以随意修改（扩展名必须是 thumbnailator 支持的图片格式）， 一旦缩略图生成后，扩展名之外的部分可以随意改变 ，扩展名部分不能改变，除非你在 thumbnail(boolean, java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends java.io.InputStream>>) 方法中修改了输出格式。

setObjectId

public UploadPretreatment setObjectId(boolean flag,
                                      Object objectId)

设置文件所属对象id

参数:

objectId - 如果不是 String 类型会自动调用 toString() 方法

setObjectId

public UploadPretreatment setObjectId(Object objectId)

设置文件所属对象id

参数:

objectId - 如果不是 String 类型会自动调用 toString() 方法

setObjectType

public UploadPretreatment setObjectType(boolean flag,
                                        String objectType)

设置文件所属对象类型

setPath

public UploadPretreatment setPath(boolean flag,
                                  String path)

设置文文件存储路径

setSaveFilename

public UploadPretreatment setSaveFilename(boolean flag,
                                          String saveFilename)

设置保存文件名，如果不设置则自动生成

setSaveThFilename

public UploadPretreatment setSaveThFilename(boolean flag,
                                            String saveThFilename)

设置缩略图的保存文件名，注意此文件名不含后缀，后缀用 thumbnailSuffix 属性控制

setThContentType

public UploadPretreatment setThContentType(boolean flag,
                                           String thContentType)

缩略图 MIME 类型，如果不设置则在上传文件根据缩略图文件名自动识别

getName

public String getName()

获取文件名

setName

public UploadPretreatment setName(boolean flag,
                                  String name)

设置文件名

setName

public UploadPretreatment setName(String name)

设置文件名

getContentType

public String getContentType()

获取文件的 MIME 类型

setContentType

public UploadPretreatment setContentType(boolean flag,
                                         String contentType)

设置文件的 MIME 类型

setContentType

public UploadPretreatment setContentType(String contentType)

设置文件的 MIME 类型

getOriginalFilename

public String getOriginalFilename()

获取原始文件名

setOriginalFilename

public UploadPretreatment setOriginalFilename(boolean flag,
                                              String originalFilename)

设置原始文件名

setOriginalFilename

public UploadPretreatment setOriginalFilename(String originalFilename)

设置原始文件名

getMetadata

public Map<String,String> getMetadata()

获取文件元数据

putMetadata

public UploadPretreatment putMetadata(boolean flag,
                                      String key,
                                      String value)

设置文件元数据

putMetadata

public UploadPretreatment putMetadata(String key,
                                      String value)

设置文件元数据

putMetadataAll

public UploadPretreatment putMetadataAll(boolean flag,
                                         Map<String,String> metadata)

设置文件元数据

putMetadataAll

public UploadPretreatment putMetadataAll(Map<String,String> metadata)

设置文件元数据

getUserMetadata

public Map<String,String> getUserMetadata()

获取文件用户元数据

putUserMetadata

public UploadPretreatment putUserMetadata(boolean flag,
                                          String key,
                                          String value)

设置文件用户元数据

putUserMetadata

public UploadPretreatment putUserMetadata(String key,
                                          String value)

设置文件用户元数据

putUserMetadataAll

public UploadPretreatment putUserMetadataAll(boolean flag,
                                             Map<String,String> metadata)

设置文件用户元数据

putUserMetadataAll

public UploadPretreatment putUserMetadataAll(Map<String,String> metadata)

设置文件用户元数据

getThMetadata

public Map<String,String> getThMetadata()

获取缩略图元数据

putThMetadata

public UploadPretreatment putThMetadata(boolean flag,
                                        String key,
                                        String value)

设置缩略图元数据

putThMetadata

public UploadPretreatment putThMetadata(String key,
                                        String value)

设置缩略图元数据

putThMetadataAll

public UploadPretreatment putThMetadataAll(boolean flag,
                                           Map<String,String> metadata)

设置缩略图元数据

putThMetadataAll

public UploadPretreatment putThMetadataAll(Map<String,String> metadata)

设置缩略图元数据

getThUserMetadata

public Map<String,String> getThUserMetadata()

获取缩略图用户元数据

putThUserMetadata

public UploadPretreatment putThUserMetadata(boolean flag,
                                            String key,
                                            String value)

设置缩略图用户元数据

putThUserMetadata

public UploadPretreatment putThUserMetadata(String key,
                                            String value)

设置缩略图用户元数据

putThUserMetadataAll

public UploadPretreatment putThUserMetadataAll(boolean flag,
                                               Map<String,String> metadata)

设置缩略图用户元数据

putThUserMetadataAll

public UploadPretreatment putThUserMetadataAll(Map<String,String> metadata)

设置缩略图用户元数据

getAttr

public cn.hutool.core.lang.Dict getAttr()

获取附加属性字典

putAttr

public UploadPretreatment putAttr(boolean flag,
                                  String key,
                                  Object value)

设置附加属性

putAttr

public UploadPretreatment putAttr(String key,
                                  Object value)

设置附加属性

putAttrAll

public UploadPretreatment putAttrAll(boolean flag,
                                     Map<String,Object> attr)

设置附加属性

putAttrAll

public UploadPretreatment putAttrAll(Map<String,Object> attr)

设置附加属性

image

public UploadPretreatment image(boolean flag,
                                java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

进行图片处理，可以进行裁剪、旋转、缩放、水印等操作

image

public UploadPretreatment image(java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

进行图片处理，可以进行裁剪、旋转、缩放、水印等操作

image

public UploadPretreatment image(boolean flag,
                                int width,
                                int height)

缩放到指定大小

image

public UploadPretreatment image(int width,
                                int height)

缩放到指定大小

image

public UploadPretreatment image(boolean flag)

缩放到 200*200 大小

image

public UploadPretreatment image()

缩放到 200*200 大小

clearThumbnail

public UploadPretreatment clearThumbnail(boolean flag)

清空缩略图

clearThumbnail

public UploadPretreatment clearThumbnail()

清空缩略图

thumbnailOf

public UploadPretreatment thumbnailOf(boolean flag,
                                      Object file)

通过指定 file 生成缩略图， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭

thumbnailOf

public UploadPretreatment thumbnailOf(Object file)

通过指定 file 生成缩略图， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭

thumbnailOf

public UploadPretreatment thumbnailOf(boolean flag,
                                      Object file,
                                      java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

通过指定 file 生成缩略图并进行图片处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭

thumbnailOf

public UploadPretreatment thumbnailOf(Object file,
                                      java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

通过指定 file 生成缩略图并进行图片处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取， 如果 file 是 InputStream、FileWrapper 等可以自动关闭的对象，操作完成后会自动关闭

thumbnail

public UploadPretreatment thumbnail(boolean flag,
                                    java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

生成缩略图并进行图片处理，如果缩略图已存在则使用已有的缩略图进行处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取

thumbnail

public UploadPretreatment thumbnail(java.util.function.Consumer<net.coobird.thumbnailator.Thumbnails.Builder<? extends InputStream>> consumer)

生成缩略图并进行图片处理，如果缩略图已存在则使用已有的缩略图进行处理， 可以进行裁剪、旋转、缩放、水印等操作，默认输出图片格式通过 thumbnailSuffix 获取

thumbnail

public UploadPretreatment thumbnail(boolean flag,
                                    int width,
                                    int height)

生成缩略图并缩放到指定大小，默认输出图片格式通过 thumbnailSuffix 获取

thumbnail

public UploadPretreatment thumbnail(int width,
                                    int height)

生成缩略图并缩放到指定大小，默认输出图片格式通过 thumbnailSuffix 获取

thumbnail

public UploadPretreatment thumbnail(boolean flag)

生成缩略图并缩放到 200*200 大小，默认输出图片格式通过 thumbnailSuffix 获取

thumbnail

public UploadPretreatment thumbnail()

生成缩略图并缩放到 200*200 大小，默认输出图片格式通过 thumbnailSuffix 获取

setProgressMonitor

public UploadPretreatment setProgressMonitor(boolean flag,
                                             java.util.function.Consumer<Long> progressListener)

设置上传进度监听器

参数:

progressListener - 提供一个参数，表示已传输字节数

setProgressMonitor

public UploadPretreatment setProgressMonitor(java.util.function.Consumer<Long> progressListener)

设置上传进度监听器

参数:

progressListener - 提供一个参数，表示已传输字节数

setProgressMonitor

public UploadPretreatment setProgressMonitor(boolean flag,
                                             java.util.function.BiConsumer<Long,Long> progressListener)

设置上传进度监听器

参数:

progressListener - 提供两个参数，第一个是 progressSize已传输字节数，第二个是 allSize总字节数

setProgressMonitor

public UploadPretreatment setProgressMonitor(java.util.function.BiConsumer<Long,Long> progressListener)

设置上传进度监听器

参数:

progressListener - 提供两个参数，第一个是 progressSize已传输字节数，第二个是 allSize总字节数

setProgressMonitor

public UploadPretreatment setProgressMonitor(boolean flag,
                                             ProgressListener progressListener)

设置上传进度监听器

setProgressMonitor

public UploadPretreatment setProgressMonitor(ProgressListener progressListener)

设置上传进度监听器

setAcl

public UploadPretreatment setAcl(boolean flag,
                                 Object acl)

同时设置 fileAcl 和 thFileAcl 两个属性 详情见FileInfo#setFileAcl

setAcl

public UploadPretreatment setAcl(Object acl)

同时设置 fileAcl 和 thFileAcl 两个属性 详情见FileInfo#setFileAcl

upload

public FileInfo upload()

上传文件，成功返回文件信息，失败返回null