X File Storage 技术文档

X File Storage 技术文档1. 安装指南环境要求JDK 8Maven 3.0Spring Boot 2.x可选Solon可选Maven 依赖配置在项目的pom.xml文件中添加以下依赖!-- 核心依赖 -- dependency groupIdorg.dromara.x-file-storage/groupId artifactIdx-file-storage-spring/artifactId version2.3.0/version /dependency !-- 存储平台SDK以阿里云OSS为例 -- dependency groupIdcom.aliyun.oss/groupId artifactIdaliyun-sdk-oss/artifactId version3.16.1/version /dependency2. 项目使用说明基础配置在application.yml中配置存储平台信息dromara: x-file-storage: default-platform: aliyun-oss-1 aliyun-oss: - platform: aliyun-oss-1 enable-storage: true access-key: your-access-key secret-key: your-secret-key end-point: your-endpoint bucket-name: your-bucket domain: https://your-domain.com/ base-path: test/启用服务在Spring Boot启动类上添加注解EnableFileStorage SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }3. API使用文档文件上传RestController public class FileController { Autowired private FileStorageService fileStorageService; // 基础上传 PostMapping(/upload) public FileInfo upload(MultipartFile file) { return fileStorageService.of(file).upload(); } // 带参数上传 PostMapping(/upload2) public String upload2(MultipartFile file) { FileInfo fileInfo fileStorageService.of(file) .setPath(upload/) .setSaveFilename(custom.jpg) .setObjectId(123) .setObjectType(user) .putAttr(role,admin) .upload(); return fileInfo.getUrl(); } }图片处理// 图片缩放缩略图 PostMapping(/upload-image) public FileInfo uploadImage(MultipartFile file) { return fileStorageService.of(file) .image(img - img.size(1000,1000)) .thumbnail(th - th.size(200,200)) .upload(); }文件操作// 文件存在检查 boolean exists fileStorageService.exists(fileInfo); // 文件下载 byte[] bytes fileStorageService.download(fileInfo).bytes(); // 文件删除 fileStorageService.delete(fileInfo); // 通过URL操作 fileStorageService.delete(https://example.com/file.jpg);4. 项目安装方式Spring Boot项目添加Maven依赖配置application.yml添加EnableFileStorage注解注入FileStorageService使用Solon项目参考官方文档中的在Solon中使用章节非Spring环境参考官方文档中的脱离SpringBoot单独使用章节多平台支持项目支持30存储平台包括本地存储FTP/SFTP主流云存储(阿里云OSS、腾讯云COS等)WebDAVMinIOMongoDB GridFSFastDFS等各平台配置方式类似只需引入对应SDK并在配置文件中添加平台配置即可。创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考