SpringBoot使用阿里云oss实现文件上传

一、对象存储OSS

1、开通“对象存储OSS”服务

（1）申请阿里云账号

（2）实名认证

（3）开通“对象存储OSS”服务

（4）进入管理控制台

2、创建Bucket

Bucket名称：javalimb-file

地域：华北2（北京）

存储类型：标准存储

同城冗余存储：关闭

版本控制：不开通

读写权限：公共读

服务器加密方式：无

实时日志查询：不开通

定时备份：不开通

3、创建AccessKey

 

阿里云帮助文档地址

https://help.aliyun.com/?spm=a2c4g.11186623.6.538.6cb923458Rfc7f

阿里云对象存储OSS地址

https://help.aliyun.com/document_detail/31883.html?spm=a2c4g.11186623.6.595.385114a0f8JyvT

阿里云javaSDK文件上传地址

https://help.aliyun.com/document_detail/32013.html?spm=a2c4g.11186623.6.934.5ce314a0xWEkf2

文件上传参照地址

https://help.aliyun.com/document_detail/84781.html?spm=a2c4g.11186623.6.935.59df14a0eK7bAr

使用SDK需要先安装，具体可以参照阿里云官方文档。

案例1（vue+springboot图片上传）

pom文件依赖

<dependencies>
        <!-- 阿里云oss依赖 -->
        <dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
        </dependency>

        <!-- 日期工具栏依赖 -->
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
        </dependency>
    </dependencies>

yml文件

server:
  port: 9120

spring:
  profiles:
    # 环境设置
    active: dev

  application:
    # 服务名
    name: service_oss
aliyun:
  oss:
    endpoint: oss-cn-beijing.aliyuncs.com
    keyId: xxxx
    keySecret: Vxxxx
    bucketname: exxxx
#阿里云 OSS
#不同的服务器，地址不同
#  aliyun.oss.file.endpoint=oss-cn-beijing.aliyuncs.com
#  aliyun.oss.file.keyid=xxxxxxxx
#  aliyun.oss.file.keysecret=dddddddddd
#
#  # nacos服务地址
#  spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
#
#  #bucket可以在控制台创建，也可以使用java代码创建
#  aliyun.oss.file.bucketname=edu8806

读取配置文件的类

package com.stu.service.oss.utils;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/******************************
 * 用途说明:从配置文件读取变量
 * 作者姓名: Administrator
 * 创建时间: 2022-05-03 1:12
 ******************************/
@Data
@Component
@ConfigurationProperties(prefix = "aliyun.oss")
public class OssProperties {

    private String endpoint;
    private String keyId;
    private String keySecret;
    private String bucketname;
}

读取配置文件的类（另一种写法，这里下边没有用到）

package com.stu.oss.utils;

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

//项目启动，spring接口，spring加载之后，执行接口一个方法
@Component
public class ConstantPropertiesUtil implements InitializingBean {

    //读取配置文件的内容

    @Value("${aliyun.oss.file.endpoint}")
    private String endpoint;
    @Value("${aliyun.oss.file.keyid}")
    private String keyid;
    @Value("${aliyun.oss.file.keysecret}")
    private String keysecret;
    @Value("${aliyun.oss.file.bucketname}")
    private String bucketname;

    //定义一些静态常量
    public  static String END_POINT;
    public  static String KEY_ID;
    public  static String KEY_SECRET;
    public  static String BUCKET_NAME;

    //上边赋值完成后，会执行afterPropertiesSet方法，这是spring机制
    @Override
    public void afterPropertiesSet() throws Exception {
        END_POINT = endpoint;
        KEY_ID = keyid;
        KEY_SECRET = keysecret;
        BUCKET_NAME = bucketname;


    }
}

controller文件

package com.stu.service.oss.controller;

import com.stu.service.base.result.R;
import com.stu.service.oss.service.FileService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

/******************************
 * 用途说明:
 * 作者姓名: Administrator
 * 创建时间: 2022-05-03 2:22
 ******************************/
@RestController
@RequestMapping("admin/oss/file")
@Slf4j
public class FIleController {

    @Autowired
    private FileService fileService;

    @PostMapping("upload")
    public R upload(MultipartFile file) {
           String url = fileService.upload(file);
            return R.ok().data("url", url);
    }

}

service接口

package com.stu.service.oss.service;

import org.springframework.web.multipart.MultipartFile;

public interface FileService {

    /***********************************
     * 用途说明:文件上传
     * 返回值说明: java.lang.String
     ***********************************/
    String upload(MultipartFile file);
}

service实现类

endPoint,accessKeyId,accessKeySecret,bucketName的取值来源如下

 

package com.stu.service.oss.service.impl;

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.stu.service.oss.service.FileService;
import com.stu.service.oss.utils.OssProperties;
import org.joda.time.DateTime;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

/******************************
 * 用途说明:文件上传
 * 作者姓名: Administrator
 * 创建时间: 2022-05-03 1:26
 ******************************/
@Service
public class FileServiceImpl implements FileService {

    @Autowired
    private OssProperties ossProperties;

    @Override
    public String upload(MultipartFile file) {
        // Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
        String endPoint = ossProperties.getEndpoint();
        // 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
        String accessKeyId = ossProperties.getKeyId();
        String accessKeySecret = ossProperties.getKeySecret();
        // 填写Bucket名称，例如examplebucket。
        String bucketName = ossProperties.getBucketname();
        /*// 填写Object完整路径，完整路径中不能包含Bucket名称，例如exampledir/exampleobject.txt。
        //获取当前日期 joda-time
        String datePath = new DateTime().toString("yyyy/MM/dd");
        //1.文件名称添加一个唯一值
        String uuid = UUID.randomUUID().toString().replace("-", "");
        orginalFileName = uuid + orginalFileName;
        String fileExtention = orginalFileName.substring(orginalFileName.lastIndexOf("."));
        String objectName = module + "/" + datePath + orginalFileName + fileExtention;*/

        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endPoint, accessKeyId, accessKeySecret);
        String url = null;
        // 填写本地文件的完整路径。如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。
        InputStream inputStream = null;
        try {
            //获取上传文件输入流
            inputStream = file.getInputStream();
            //调用oss方法实现上传
            //第一个参数 Bucket名称
            //第二个参数，上传到oss文件路径和文件名称   A/B/图片.jpg
            //第三个参数，上传文件输入流
            //获取文件名称
            // test.png
            String fileName = file.getOriginalFilename();
            //1.文件名称添加一个唯一值
            //80b8fbf76d5140f9b33917f883533cc3
            String uuid = UUID.randomUUID().toString().replace("-", "");
            fileName = uuid + fileName;
            //2.把文件安装日期进行分类
            //2021/05/20/图片.jpg
            //获取当前日期 joda-time
            String datePath = new DateTime().toString("yyyy/MM/dd");

            //fileName 2022/05/03/80b8fbf76d5140f9b33917f883533cc3test.png
            fileName = datePath + "/" + fileName;
            ossClient.putObject(bucketName, fileName, inputStream);
            // 关闭OSSClient。
            ossClient.shutdown();
            //上传之后把文件路径返回
            //https://edu8806.oss-cn-beijing.aliyuncs.com/2022/05/03/80b8fbf76d5140f9b33917f883533cc3test.png
            url = "https://" + bucketName + "." + endPoint + "/" + fileName;

        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
        return url;
    }

}

vue页面

<template>
  <div class="app-container">
    讲师添加
    <el-form label-width="120px">
      <el-form-item label="活动名称">
        <el-input v-model="teacher.name" />
      </el-form-item>
      <el-form-item label="入驻时间">
        <el-date-picker
          type="date"
          placeholder="选择日期"
          v-model="teacher.joinDate"
          value-format="yyyy-MM-dd"
        ></el-date-picker>
      </el-form-item>

      <el-form-item label="排序">
        <el-input v-model="teacher.sort" :min="0" />
      </el-form-item>
      <el-form-item label="讲师头衔">
        <el-select v-model="teacher.level" clearable placeholder="讲师头衔">
          <el-option :value="1" label="高级讲师" />
          <el-option :value="2" label="首席讲师" />
        </el-select>
      </el-form-item>

      <el-form-item label="讲师简介">
        <el-input v-model="teacher.intro" />
      </el-form-item>

      <el-form-item label="讲师资历">
        <el-input v-model="teacher.career" />
      </el-form-item>

      <el-form-item label="讲师头像">
        <el-upload
          :action="BASE_API + '/admin/oss/file/upload'"
          :show-file-list="false"
          :on-success="handleSuccess"
          :on-error="handleError"
          :before-upload="beforeUpload"
          class="avatar-uploader"
        >
          <img v-if="teacher.avatar" :src="teacher.avatar">
          <i v-else class="el-icon-plus avatar-uploader-icon" />
        </el-upload>
      </el-form-item>
      <el-form-item>
        <el-button
          type="primary"
          :disabled="saveBtnDisabled"
          @click="saveOrUpdate()"
          >{{ saveOrUpdateText }}</el-button
        >
      </el-form-item>
    </el-form>
  </div>
</template>

<script>
import teacherApi from "@/api/teacher";
export default {
  data() {
    return {
      saveBtnDisabled: false,
      saveOrUpdateText: "保存",
      BASE_API: process.env.BASE_API,
      //讲师对象
      teacher: {
        name: "",
        intro: "", //讲师简介
        career: "", //讲师资历
        level: 1, //头衔 1高级讲师 2首席讲师
        avatar: "", //讲师头像
        sort: 0,
        joinDate: "", //入驻时间
      },
    };
  },
  created() {
    //created之执行一次

    this.init();
  },
  watch: {
    //路由每次变化都执行
    $route(to, from) {
      debugger;
      console.log("to==== " + to);
      console.log("from=== " + from);

      this.init();
    },
  },
  methods: {
    handleSuccess(res) {
      if (res.success) {
        this.$message.success(res.message);
        this.teacher.avatar = res.data.url;
        this.$forceUpdate();
      } else {
        this.$message.error(res.message);
      }
    },
    handleError(res) {
      this.$message.error(res.message);
    },
    beforeUpload(file) {
      let isJpg = file.type === "image/jpeg";
      if (!isJpg) {
        this.$message.error("上传头像图片只能是JPG格式！");
        return false;
      }
      let isLt2M = file.size / 1024 / 1024 < 2;
      if (!isLt2M) {
        this.$message.error("上传头像图片不能超过2MB！");
        return false;
      }
      return true;
    },
    init() {
      //修改就把详情查出来，否则页面是新增页面，新增页面对象数据是空
      if (this.$route.params && this.$route.params.id) {
        this.getDetail(this.$route.params.id);
        this.saveOrUpdateText = "修改";
      } else {
        this.teacher = {};
        this.saveOrUpdateText = "保存";
      }
    },
    //同一个页面，判断是新增还是修改
    saveOrUpdate() {
      if (this.teacher.id) {
        //更新
        this.update();
      } else {
        //新增
        this.save();
      }
    },
    //进入到修改页面，需要回显的数据
    getDetail(id) {
      teacherApi.getDetail(id).then((res) => {
        if (res.code === 20000 && res.data.dataInfo) {
          this.teacher = res.data.dataInfo;
          this.$message({
            type: "info",
            message: "数据初始化成功",
          });
        } else {
          this.$message({
            type: "info",
            message: "数据初始化失败",
          });
        }
      });
    },
    //新增
    save() {
      teacherApi.save(this.teacher).then((res) => {
        if (res.code === 20000 && res.data) {
          this.$message({
            type: "info",
            message: "添加成功",
          });
          this.$router.push({ path: "/teacher/list" });
        } else {
          this.$message({
            type: "info",
            message: "添加失败",
          });
        }
      });
    },
    //修改
    update() {
      teacherApi.update(this.teacher).then((res) => {
        if (res.code === 20000 && res.data) {
          this.$message({
            type: "info",
            message: "修改成功",
          });
          this.$router.push({ path: "/teacher/list" });
        } else {
          this.$message({
            type: "info",
            message: "修改失败",
          });
        }
      });
    },
  },
};
</script>

<style scoped>
.avatar-uploader .el-upload {
  border: 1px dashed #d9d9d9;
  border-radius: 6px;
  cursor: pointer;
  position: relative;
  overflow: hidden;
}

.avatar-uploader .el-upload:hover {
  border-color: #409EFF;
}

.avatar-uploader .avatar-uploader-icon {
  font-size: 28px;
  color: #8c939d;
  width: 178px;
  height: 178px;
  line-height: 178px;
  text-align: center;
}

.avatar-uploader img {
  width: 178px;
  height: 178px;
  display: block;
}
</style>

案例2

1、阿里云开通用户和权限

通过子用户

子账号

创建 

创建AccessKey

点击创建AccessKey，注意目前这个只能看一次，要么复制用户和密码然后自己保存，要么下载csv文件保存。

然后给这个子用户添加权限

2、通过SDK简单上传-上传文件流

参考文档：https://help.aliyun.com/document_detail/32009.html

2.1、添加pom依赖

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.10.2</version>
</dependency>

2.2、代码

package com.stu.gulimall.product;

import com.stu.gulimall.product.entity.BrandEntity;
import com.stu.gulimall.product.service.BrandService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringBootVersion;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.core.SpringVersion;
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.PutObjectRequest;
import java.io.ByteArrayInputStream;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

@SpringBootTest
class GulimallProductApplicationTests {

    @Autowired
    BrandService brandService;

    @Test
    void contextLoads() {
        BrandEntity b = new BrandEntity();
    b.setName("test");
        brandService.save(b);
        System.out.println("=================================");
    }
    @Test
    public void getSpringVersion() throws FileNotFoundException {
// Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
        String endpoint = "oss-cn-beijing.aliyuncs.com";
        // 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
        String accessKeyId = "xxxxxxxxxxxx";
        String accessKeySecret = "xxxxxxxxxxxxxxxxxxxx";
        // 填写Bucket名称，例如examplebucket。
        String bucketName = "edu8806";

        // 填写Object完整路径，完整路径中不能包含Bucket名称，例如exampledir/exampleobject.txt。
        String objectName = "test.png";
        // 填写本地文件的完整路径，例如D:\\localpath\\examplefile.txt。
        // 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。
        String filePath= "E:\\test.png";

        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

        try {
            InputStream inputStream = new FileInputStream(filePath);
            // 创建PutObject请求。
            ossClient.putObject(bucketName, objectName, inputStream);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
                System.out.println("============success===============");
            }
        }
    }
}

3、通过封装好的代码

参考地址：https://github.com/alibaba/spring-cloud-alibaba（这个目前可能存在版本兼容问题，可以参考下边的文章解决）

上传文件如果提示这个问题【解决Cannot resolve com.alibaba.cloud:aliyun-oss-spring-boot-starter:unknown 文件上传报错aliCloudEdasSdk解决】
可以参考这篇文章https://www.cnblogs.com/konglxblog/p/16100349.html

 

接入oss

修改pom文件，引入aliyun-oss-spring-boot-starter（注意上边的是通过SDK，这里是通过starter）

        <!--引入阿里云封装好的cloud oss-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alicloud-oss</artifactId>
            <version>2.1.0.RELEASE</version>
        </dependency>

yml文件(注意这里的key和endpoint是阿里云的子用户)

#配置数据源
spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://123.57xxx:3306/gulimall_pms?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.jdbc.Driver
  cloud:
    nacos:
      discovery:
        server-addr: xxx:8848
    alicloud:
      access-key: xxx
      secret-key: xxx
      oss:
        endpoint: xxx

测试代码

package com.stu.gulimall.product;

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSSClient;
import com.aliyun.oss.OSSException;
import com.stu.gulimall.product.entity.BrandEntity;
import com.stu.gulimall.product.service.BrandService;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

@RunWith(SpringRunner.class)
@SpringBootTest
class GulimallProductApplicationTests {

    @Autowired
    BrandService brandService;
    @Autowired
    private OSSClient ossClient;
    @Test
    void contextLoads() {
        BrandEntity b = new BrandEntity();
        b.setName("test");
        brandService.save(b);
        System.out.println("=================================");
    }
    @Test
    public void getSpringVersion() throws FileNotFoundException {
// Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
       /* String endpoint = "oss-cn-beijing.aliyuncs.com";
        // 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
        String accessKeyId = "xxxxxxxxxxxx";
        String accessKeySecret = "xxxxxxxxxxxxxxxxxxxx";
        // 填写Bucket名称，例如examplebucket。
        String bucketName = "edu8806";

        // 填写Object完整路径，完整路径中不能包含Bucket名称，例如exampledir/exampleobject.txt。
        String objectName = "test.png";
        // 填写本地文件的完整路径，例如D:\\localpath\\examplefile.txt。
        // 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。
        String filePath= "E:\\test.png";

        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);*/
        // 填写Bucket名称，例如examplebucket。
        String bucketName = "edu8806";

        // 填写Object完整路径，完整路径中不能包含Bucket名称，例如exampledir/exampleobject.txt。
        String objectName = "test.png";
        // 填写本地文件的完整路径，例如D:\\localpath\\examplefile.txt。
        // 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。
        String filePath= "E:\\test.png";
        try {
            InputStream inputStream = new FileInputStream(filePath);
            // 创建PutObject请求。
            ossClient.putObject(bucketName, objectName, inputStream);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
                System.out.println("============success===============");
            }
        }
    }
}

作者：明
出处：https://www.cnblogs.com/konglxblog//
版权：本文版权归作者和博客园共有
转载：欢迎转载，文章中请给出原文连接，此文章仅为个人知识学习分享，否则必究法律责任

免责声明：
    本文中使用的部分图片来自于网络，如有侵权,请联系博主进行删除