Springboot整合阿里云OSS,实现图片上传、查看、删除功能

3,104 阅读3分钟

使用Springboot框架做网站的时候,经常会上传一些文件如图片等。第一种方法是可以将图片转成base64编码,存入数据库当中,字段采用longtext等类型即可存储。第二种方法是采用OSS服务器进行存储,直接去阿里云OSS购买(如果不想花钱,可以转去七牛云OSS)。

阿里云OSS官网给出的简介:阿里云对象存储服务(Object Storage Service,简称OSS),是阿里云对外提供的海量、安全、低成本、高可靠的云存储服务。您可以通过本文档提供的简单的REST接口,在任何时间、任何地点、任何互联网设备上进行上传和下载数据。基于OSS,您可以搭建出各种多媒体分享网站、网盘、个人和企业数据备份等基于大规模数据的服务。

一、导入依赖

<!--   阿里云OSS    -->
<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.5.0</version>
</dependency>

二、创建配置文件

在application.properties文件同级目录下,创建aliyun.properties,给出5个字段。

这5个字段在OSS服务器中直接就能拿到。

aliyun.access-id=
aliyun.access-key=
aliyun.bucket=
aliyun.endpoint=
aliyun.dir=

三、创建properties文件信息读取类

使用这样的一个类,读取properties文件里的数据,感觉用起来很方便,如果大家不愿意这么做的话,可以直接变成static变量,省略了这两部。

import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Component
@PropertySource("classpath:/aliyun.properties")
public class OSSProperties implements InitializingBean {

    @Value("${aliyun.endpoint}")
    private String aliyun_endpoint;

    @Value("${aliyun.access-id}")
    private String aliyun_access_id;

    @Value("${aliyun.access-key}")
    private String aliyun_access_key;

    @Value("${aliyun.bucket}")
    private String aliyun_bucket;

    @Value("${aliyun.dir}")
    private String aliyun_dir;

    // 声明静态变量
    public static String ALIYUN_ENDPOINT;

    public static String ALIYUN_ACCESS_ID;

    public static String ALIYUN_ACCESS_KEY;

    public static String ALIYUN_BUCKET;

    public static String ALIYUN_DIR;

    @Override
    public void afterPropertiesSet() {
        ALIYUN_ENDPOINT = aliyun_endpoint;
        ALIYUN_ACCESS_ID = aliyun_access_id;
        ALIYUN_ACCESS_KEY = aliyun_access_key;
        ALIYUN_BUCKET = aliyun_bucket;
        ALIYUN_DIR = aliyun_dir;
    }

}

四、OSSUtil工具类

可以实现图片的删除、上传、查看url链接等。

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.model.ObjectMetadata;
import com.aliyun.oss.model.PutObjectResult;
import org.mybatis.logging.Logger;
import org.mybatis.logging.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;

import java.io.*;
import java.net.URL;
import java.util.Date;

public class OSSUtil {

    /**
     * log日志
     */
    public static final Logger logger = LoggerFactory.getLogger(OSSUtil.class);

    private final String endpoint = OSSProperties.ALIYUN_ENDPOINT;

    private final String accessKeyId = OSSProperties.ALIYUN_ACCESS_ID;

    private final String accessKeySecret = OSSProperties.ALIYUN_ACCESS_KEY;

    private final String bucketName = OSSProperties.ALIYUN_BUCKET;

    private final String FOLDER = OSSProperties.ALIYUN_DIR;

    /**
     * 删除单个图片
     *
     * @param url
     */
    public void deleteImg(String url) {
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
        url = FOLDER + url;
        ossClient.deleteObject(bucketName, url);
        System.out.println("删除 " + url + " 成功");
        ossClient.shutdown();
    }

    /**
     * 上传图片
     *
     * @param file
     * @param fileName
     * @return
     * @throws IOException
     */
    public String uploadImg2Oss(MultipartFile file, String fileName) throws IOException {
        try {
            InputStream inputStream = file.getInputStream();
            this.uploadFile2OSS(inputStream, fileName);
            String url = "https://" + bucketName + "." + endpoint + "/" + FOLDER + fileName;
            return url;
        } catch (Exception e) {
            throw new IOException("图片上传失败");
        }
    }

    /**
     * 上传到OSS服务器 如果同名文件会覆盖服务器上的
     *
     * @param instream 文件流
     * @param fileName 文件名称 包括后缀名
     * @return 出错返回"" ,唯一MD5数字签名
     */
    public String uploadFile2OSS(InputStream instream, String fileName) {

        String ret = "";
        try {
            OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
            // 创建上传Object的Metadata
            ObjectMetadata objectMetadata = new ObjectMetadata();
            objectMetadata.setContentLength(instream.available());
            objectMetadata.setCacheControl("no-cache");
            objectMetadata.setHeader("Pragma", "no-cache");
            objectMetadata.setContentType(getcontentType(fileName.substring(fileName.lastIndexOf("."))));
            objectMetadata.setContentDisposition("inline;filename=" + fileName);
            // 上传文件
            PutObjectResult putResult = ossClient.putObject(bucketName, FOLDER + fileName, instream, objectMetadata);
            ret = putResult.getETag();
        } catch (IOException e) {
//            logger.error(e.getMessage(), e);
            System.out.println(e.getMessage());
        } finally {
            try {
                if (instream != null) {
                    instream.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return ret;
    }

    /**
     * Description: 判断OSS服务文件上传时文件的contentType
     */
    public static String getcontentType(String filenameExtension) {
        if (filenameExtension.equalsIgnoreCase("bmp")) {
            return "image/bmp";
        }
        if (filenameExtension.equalsIgnoreCase("gif")) {
            return "image/gif";
        }
        if (filenameExtension.equalsIgnoreCase("jpeg") || filenameExtension.equalsIgnoreCase("jpg")
                || filenameExtension.equalsIgnoreCase("png")) {
            return "image/jpeg";
        }
        if (filenameExtension.equalsIgnoreCase("html")) {
            return "text/html";
        }
        if (filenameExtension.equalsIgnoreCase("txt")) {
            return "text/plain";
        }
        if (filenameExtension.equalsIgnoreCase("vsd")) {
            return "application/vnd.visio";
        }
        if (filenameExtension.equalsIgnoreCase("pptx") || filenameExtension.equalsIgnoreCase("ppt")) {
            return "application/vnd.ms-powerpoint";
        }
        if (filenameExtension.equalsIgnoreCase("docx") || filenameExtension.equalsIgnoreCase("doc")) {
            return "application/msword";
        }
        if (filenameExtension.equalsIgnoreCase("xml")) {
            return "text/xml";
        }
        return "image/jpeg";
    }

    /**
     * 获得url链接
     *
     * @param key
     * @return
     */
    public String getUrl(String key) {
        // 设置URL过期时间为10年 3600l* 1000*24*365*10
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
        Date expiration = new Date(System.currentTimeMillis() + 3600L * 1000 * 24 * 365 * 10);
        // 生成URL
        URL url = ossClient.generatePresignedUrl(bucketName, key, expiration);
        // url = "https://" + bucketName + ".oss-cn-beijing.aliyuncs.com/" + bucketName+"/"+ key;
        if (url != null) {
            String host = "https://" + url.getHost() + url.getPath();
            return host;
        }
        return "";
    }

}

五、调用

这里采用UUID的方法,保证文件名不会重复。

@PostMapping
public Result upload(@RequestParam("image") MultipartFile file) throws IOException {
    // 原始文件名称,如a.png
    String originalFilename = file.getOriginalFilename();
    // 唯一的文件名称
    String fileName = UUID.randomUUID().toString() + "." + StringUtils.substringAfterLast(originalFilename, ".");
    // 上传地址
    OSSUtil ossUtil = new OSSUtil();
    String url = ossUtil.uploadImg2Oss(file, fileName);
    if (url != null) {
        return Result.success(url);
    }
    return Result.fail(20001, "上传失败");
}