大家好，我是 Java陈序员。
文件上传下载，是我们在开发中经常会遇到的需求！
无论是本地存储、还是云存储，我们可以自己封装 API 来实现功能。
今天，给大家介绍一款一行代码实现多平台文件存储的工具，开箱即用！
关注微信公众号：【Java陈序员】，获取开源项目分享、AI副业分享、超200本经典计算机电子书籍等。
项目介绍x-file-storage —— 一行代码实现将文件存储到本地、FTP、SFTP、WebDAV、OSS 云存储、其它兼容 S3 协议的存储平台。
x-file-storage
支持的存储平台：
存储平台
支持的对象存储：
对象存储
快速入门配置1、引入项目依赖
<dependency> <groupId>org.dromara.x-file-storage</groupId> <artifactId>x-file-storage-spring</artifactId> <version>2.0.0</version></dependency>默认是 SpringBoot 环境，如不是 SpringBoot 环境可使用如下方式初始化。
//配置文件定义存储平台FileStorageProperties properties = new FileStorageProperties();properties.setDefaultPlatform("ftp-1");FtpConfig ftp = new FtpConfig();ftp.setPlatform("ftp-1");ftp.setHost("192.168.3.100");ftp.setPort(2121);ftp.setUser("root");ftp.setPassword("123456");ftp.setDomain("ftp://192.168.3.100:2121/");ftp.setBasePath("ftp/");ftp.setStoragePath("/");properties.setFtp(Collections.singletonList(ftp));//创建，自定义存储平台、 Client 工厂、切面等功能都有对应的添加方法FileStorageService service = FileStorageServiceBuilder.create(properties).useDefault().build();//初始化完毕，开始上传吧FileInfo fileInfo = service.of(new File("D:\\Desktop\\a.png")).upload();2、引入对应平台的依赖，如使用阿里云OSS，引入阿里云OSS的依赖，依此类推
<dependency> <groupId>com.aliyun.oss</groupId> <artifactId>aliyun-sdk-oss</artifactId> <version>3.16.1</version></dependency>3、配置文件中添加配置
dromara: x-file-storage: #文件存储配置 default-platform: huawei-obs-1 #默认使用的存储平台 thumbnail-suffix: ".min.jpg" #缩略图后缀，例如【.min.jpg】【.png】 aliyun-oss: - platform: aliyun-oss-1 # 存储平台标识 enable-storage: true # 启用存储 access-key: ?? secret-key: ?? end-point: ?? bucket-name: ?? domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.oss-cn-shanghai.aliyuncs.com/ base-path: test/ # 基础路径tips:其他云平台的配置可参考官方文档：https://x-file-storage.xuyanwu.cn/#/
编码1、在启动类上加上 @EnableFileStorage 注解
@EnableFileStorage@SpringBootApplicationpublic SpringFileStorageTestApplication { public static void main(String[] args) { SpringApplication.run(SpringFileStorageTestApplication.class,args); }}2、上传文件
// 注入实列@Autowiredprivate FileStorageService fileStorageService;/** * 上传文件 */@PostMapping("/upload")public FileInfo upload(MultipartFile file) { return fileStorageService.of(file).upload();}完整功能上传文件直接上传
fileStorageService.of(file).upload();文件流上传
fileStorageService.of(inputStream).setOriginalFilename("a.jpg").upload();上传到指定路径下
fileStorageService.of(file) .setPath("upload/") // 保存到相对路径下，为了方便管理，不需要可以不写 .upload();关联文件参数并上传
fileStorageService.of(file) .setObjectId("0") // 关联对象id，为了方便管理，不需要可以不写 .setObjectType("0") // 关联对象类型，为了方便管理，不需要可以不写 .putAttr("role","admin") //保存一些属性，可以在切面、保存上传记录、自定义存储平台等地方获取使用，不需要可以不写 .putAttr("username","007") .upload();上传到指定的存储平台
fileStorageService.of(file) .setPlatform("aliyun-oss-1") // 使用指定的存储平台 .upload();上传图片并进行处理
fileStorageService.of(file) .setThumbnailSuffix(".jpg") //指定缩略图后缀，必须是 thumbnailator 支持的图片格式，默认使用全局的 .setSaveThFilename("thabc") //指定缩略图的保存文件名，注意此文件名不含后缀，默认自动生成 .image(img -> img.size(1000,1000)) // 将图片大小调整到 1000*1000 .thumbnail(th -> th.size(200,200)) // 再生成一张 200*200 的缩略图 .upload();直接上传 HttpServletRequest
通过直接读取输入流进行上传，可以实现文件不落盘，边读取边上传，速度更快。
需要先在配置文件中开启 multipart 懒加载，不然在 Controller 中拿到输入流是已经被读取过的。
spring.servlet.multipart.resolve-lazily: true接口实现：
@RestControllerpublic FileUploadController { /** * 直接读取 HttpServletRequest 中的文件进行上传，成功返回文件信息 */ @PostMapping("/upload-request") public FileInfo uploadRequest(HttpServletRequest request) { return fileStorageService.of(request).upload(); }}监听上传进度
// 方式一fileStorageService.of(file).setProgressMonitor(progressSize -> System.out.println("已上传：" + progressSize)).upload();// 方式二fileStorageService.of(file).setProgressMonitor((progressSize,allSize) -> System.out.println("已上传 " + progressSize + " 总大小" + allSize)).upload();// 方式三fileStorageService.of(file).setProgressMonitor(new ProgressListener() { @Override public void start() { System.out.println("上传开始"); } @Override public void progress(long progressSize,long allSize) { System.out.println("已上传 " + progressSize + " 总大小" + allSize); } @Override public void finish() { System.out.println("上传结束"); }}).upload();下载获取文件信息
FileInfo fileInfo = fileStorageService.getFileInfoByUrl("https://file.abc.com/test/a.jpg");下载为字节数组
byte[] bytes = fileStorageService.download(fileInfo).bytes();下载到文件
fileStorageService.download(fileInfo).file("C:\\a.jpg");下载到 OutputStream 中
ByteArrayOutputStream out = new ByteArrayOutputStream();fileStorageService.download(fileInfo).outputStream(out);获取 InputStream 手动处理
fileStorageService.download(fileInfo).inputStream(in -> { //TODO 读取 InputStream});直接通过文件信息中的 url 下载，省去手动查询文件信息记录的过程
fileStorageService.download("https://file.abc.com/test/a.jpg").file("C:\\a.jpg");下载缩略图
fileStorageService.downloadTh(fileInfo).file("C:\\th.jpg");监听下载进度
// 方式一fileStorageService.download(fileInfo).setProgressMonitor(progressSize -> System.out.println("已下载：" + progressSize)).file("C:\\a.jpg"); // 方式二fileStorageService.download(fileInfo).setProgressMonitor((progressSize,allSize) -> System.out.println("已下载 " + progressSize + " 总大小" + allSize)).file("C:\\a.jpg");// 方式三fileStorageService.download(fileInfo).setProgressMonitor(new ProgressListener() { @Override public void start() { System.out.println("下载开始"); } @Override public void progress(long progressSize,long allSize) { System.out.println("已下载 " + progressSize + " 总大小" + allSize); } @Override public void finish() { System.out.println("下载结束"); }}).file("C:\\a.jpg");判断文件是否存在//获取文件信息FileInfo fileInfo = fileStorageService.getFileInfoByUrl("https://file.abc.com/test/a.jpg");//判断文件是否存在boolean exists = fileStorageService.exists(fileInfo);//直接通过文件信息中的 url 判断文件是否存在，省去手动查询文件信息记录的过程boolean exists2 = fileStorageService.exists("https://file.abc.com/test/a.jpg");删除文件//获取文件信息FileInfo fileInfo = fileStorageService.getFileInfoByUrl("https://file.abc.com/test/a.jpg");//直接删除fileStorageService.delete(fileInfo);//条件删除fileStorageService.delete(fileInfo,info -> { //TODO 检查是否满足删除条件 return true;});//直接通过文件信息中的 url 删除，省去手动查询文件信息记录的过程fileStorageService.delete("https://file.abc.com/test/a.jpg");最后推荐的开源项目已经收录到 GitHub 项目，欢迎 Star：
https://github.com/chenyl8848/great-open-source-project或者访问网站，进行在线浏览：
https://chencoding.top:8090/#/大家的点赞、收藏和评论都是对作者的支持，如文章对你有帮助还请点赞转发支持下，谢谢！
