SpringBoot上传文件到七牛云

Z时代
2024-01-10
分类：综合

准备工作

maven

pom.xml添加七牛云的sdk依赖

        <dependency>
            <groupId>com.qiniu</groupId>
            <artifactId>qiniu-java-sdk</artifactId>
            <version>7.2.27</version>
        </dependency>

配置项

七牛云上传必要的配置有：accessKey、secretKey、bucket

其中accessKey、secretKey在该网址可查看

https://portal.qiniu.com/user/key

bucket为你的存储空间名，如下：

实现

application.yml配置

upload: qiniu: domain: 填你的域名 access-key: 你的accesskey secret-key: 你的secretKey bucket: 你的存储空间名，我这里为colablog

可以看到我的七牛云上传配置中有domain这项配置，这个配置是七牛云buket的存储域名，在内容管理下，主要用于上传文件成功后把文件访问路径返还回去。

但是这个域名是限时30天使用的，所以你最好绑定一个新的域名。

上传配置类

使用SpringBoot的@ConfigurationProperties和@Component注解实现上传的配置类UploadProperties，

因为上传配置可能会有本地上传和云上传或者其他上传的，所以该配置类我留了扩展点。因为受到了rabbitmq的配置类启发，而且上传的配置不会很多，所以用内部类来分割这种配置类。上传配置类如下：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
 * @author Johnson
 * @date 2019/12/16/ 09:35:36
 */
@Component
@ConfigurationProperties(prefix = "upload")
public class UploadProperties {
    private Local local = new Local();
    public Local getLocal() {
        return local;
    }
    /**
     * @author: Johnson
     * @Date: 2019/12/16
     * 本地上传配置
     */
    public class Local {
        ...
    }
    private Qiniu qiniu = new Qiniu();
    public Qiniu getQiniu() {
        return qiniu;
    }
    /**
     * @author: Johnson
     * @Date: 2019/12/16
     * 七牛云上传配置
     */
    public class Qiniu {
        /**
         * 域名
         */
        private String domain;
        /**
         * 从下面这个地址中获取accessKey和secretKey
         * https://portal.qiniu.com/user/key
         */
        private String accessKey;
        private String secretKey;
        /**
         * 存储空间名
         */
        private String bucket;
        public String getDomain() {
            return domain;
        }
        public void setDomain(String domain) {
            this.domain = domain;
        }
        public String getAccessKey() {
            return accessKey;
        }
        public void setAccessKey(String accessKey) {
            this.accessKey = accessKey;
        }
        public String getSecretKey() {
            return secretKey;
        }
        public void setSecretKey(String secretKey) {
            this.secretKey = secretKey;
        }
        public String getBucket() {
            return bucket;
        }
        public void setBucket(String bucket) {
            this.bucket = bucket;
        }
    }
}

七牛云上传接口和类

上传接口如下：

public interface UploadFile {
    String uploadFile(MultipartFile file);
}

上传类

import cn.colablog.blogserver.utils.properties.UploadProperties;
import com.qiniu.http.Response;
import com.qiniu.storage.Configuration;
import com.qiniu.storage.Region;
import com.qiniu.storage.UploadManager;
import com.qiniu.util.Auth;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.util.UUID;
/**
 * @author Johnson
 * @date 2019/12/14/ 17:20:16
 * 上传文件到七牛云
 */
public class UploadFileQiniu implements UploadFile {
    private UploadProperties.Qiniu properties;
    //构造一个带指定Region对象的配置类
    private Configuration cfg = new Configuration(Region.region2());
    private UploadManager uploadManager= new UploadManager(cfg);
    public UploadFileQiniu(UploadProperties.Qiniu properties) {
        this.properties = properties;
    }
    /**
    * @author: Johnson
    */
    @Override
    public String uploadFile(MultipartFile file) {
        Auth auth = Auth.create(properties.getAccessKey(), properties.getSecretKey());
        String token = auth.uploadToken(properties.getBucket());
        try {
            String originalFilename = file.getOriginalFilename();
            // 文件后缀
            String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
            String fileKey = UUID.randomUUID().toString() + suffix;
            Response response = uploadManager.put(file.getInputStream(), fileKey, token, null, null);
            return properties.getDomain() + fileKey;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "error";
    }
}

Region配置，这里代表空间的存取区域，因为我的存储空间的区域为华南。所以为Region.region2(),查看自己的存储区域可在空间概览的最下方查看到，这里就不截图了，图片占位太大。

Region对应的设置：

好了，准备工作已完成，现在就到调用了，调用类如下：

@RestController
@RequestMapping("/upload")
public class UploadFileController {
    @Autowired
    UploadProperties uploadProperties;
    @PostMapping("/img")
    public String uploadFileYun(MultipartFile file) {
        // 上传到七牛云
        UploadFile uploadFile = new UploadFileQiniu(uploadProperties.getQiniu());
        return uploadFile.uploadFile(file);
    }
}

是不是很简单呢？屁啊！简单个毛线，其实这个我是已经简化了，实际上在我的项目的结构是比这个复杂的。