文件上传-阿里云OSS

1. 简介

文件上传,是指将本地图片、视频、音频等文件上传到服务器,供其他用户浏览或下载的过程。

文件上传在项目中应用非常广泛,我们经常发微博、发微信朋友圈都用到了文件上传功能。

阿里云是阿里巴巴集团旗下全球领先的云计算公司,也是国内最大的云服务提供商 。

云服务指的就是通过互联网对外提供的各种各样的服务,比如像:语音服务、短信服务、邮件服务、视频直播服务、文字识别服务、对象存储服务等等。

当我们在项目开发时需要用到某个或某些服务,就不需要自己来开发了,可以直接使用阿里云提供好的这些现成服务就可以了。比如:在项目开发当中,我们要实现一个短信发送的功能,如果我们项目组自己实现,将会非常繁琐,因为你需要和各个运营商进行对接。而此时阿里云完成了和三大运营商对接,并对外提供了一个短信服务。我们项目组只需要调用阿里云提供的短信服务,就可以很方便的来发送短信了。这样就降低了我们项目的开发难度,同时也提高了项目的开发效率。(大白话:别人帮我们实现好了功能,我们只要调用即可)

阿里云对象存储OSS(Object Storage Service),是一款海量、安全、低成本、高可靠的云存储服务。使用OSS,您可以通过网络随时存储和调用包括文本、图片、音频和视频等在内的各种文件。

在我们使用了阿里云OSS对象存储服务之后,我们的项目当中如果涉及到文件上传这样的业务,在前端进行文件上传并请求到服务端时,在服务器本地磁盘当中就不需要再来存储文件了。我们直接将接收到的文件上传到oss,由 oss帮我们存储和管理,同时阿里云的oss存储服务还保障了我们所存储内容的安全可靠。

2. 思路

无论使用什么样的云服务,阿里云也好,腾讯云、华为云也罢,在使用第三方的服务时,操作的思路都是一样的。

SDK:Software Development Kit 的缩写,软件开发工具包,包括辅助软件开发的依赖(jar包)、代码示例等,都可以叫做SDK。

简单说,sdk中包含了我们使用第三方云服务时所需要的依赖,以及一些示例代码。我们可以参照sdk所提供的示例代码就可以完成入门程序。

3. 具体实现

3.1 准备工作

  1. 注册阿里云账户(注册完成后需要实名认证)

  2. 注册完账号之后,就可以登录阿里云

  3. 通过控制台找到对象存储OSS服务,如果是第一次访问,还需要开通对象存储服务OSS

  4. 开通OSS服务之后,就可以进入到阿里云对象存储的控制台

  5. 点击左侧的 "Bucket列表",创建一个Bucket

3.2 编写入门程序

参照官方所提供的sdk示例来编写入门程序。

需要打开阿里云OSS的官方文档,在官方文档中找到 SDK 的示例代码:

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 com.aliyun.oss.model.PutObjectResult;

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

public class AliOssTest {
    public static void main(String[] args) throws Exception {
        // Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。
        String endpoint = "oss-cn-shanghai.aliyuncs.com";
        
        // 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
        String accessKeyId = "LTAI5t9MZK8iq5T2Av5GLDxX";
        String accessKeySecret = "C0IrHzKZGKqU8S7YQcevcotD3Zd5Tc";
        
        // 填写Bucket名称,例如examplebucket。
        String bucketName = "web-framework01";
        // 填写Object完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。
        String objectName = "1.jpg";
        // 填写本地文件的完整路径,例如D:\\localpath\\examplefile.txt。
        // 如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件流。
        String filePath= "C:\\Users\\Administrator\\Pictures\\1.jpg";

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

        try {
            InputStream inputStream = new FileInputStream(filePath);
            // 创建PutObjectRequest对象。
            PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, inputStream);
            // 设置该属性可以返回response。如果不设置,则返回的response为空。
            putObjectRequest.setProcess("true");
            // 创建PutObject请求。
            PutObjectResult result = ossClient.putObject(putObjectRequest);
            // 如果上传成功,则返回200。
            System.out.println(result.getResponse().getStatusCode());
        } 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();
            }
        }
    }
}

在以上代码中,需要替换的内容为:

  • accessKeyId:阿里云账号AccessKey

  • accessKeySecret:阿里云账号AccessKey对应的秘钥

  • bucketName:Bucket名称

  • objectName:对象名称,在Bucket中存储的对象的名称

  • filePath:文件路径

3.3 集成使用

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

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

@Component // 表示这个类是一个 Spring 组件,可以通过依赖注入的方式使用
public class AliOSSUtils {

    // OSS的区域节点,表示我们将文件上传到上海的OSS节点
    private String endpoint = "https://oss-cn-shanghai.aliyuncs.com";
    
    // 访问 OSS 所需的 AccessKeyId,可以通过阿里云控制台获取
    private String accessKeyId = "LTAI5t9MZK8iq5T2Av5GLDxX";
    
    // 访问 OSS 所需的 AccessKeySecret,可以通过阿里云控制台获取
    private String accessKeySecret = "C0IrHzKZGKqU8S7YQcevcotD3Zd5Tc";
    
    // OSS 的存储空间(Bucket)名称,这是你在阿里云创建的存储空间
    private String bucketName = "web-framework01";

    /**
     * 实现上传图片到OSS
     * @param multipartFile 上传的文件对象(来自前端)
     * @return 返回上传到 OSS 后的文件访问路径
     * @throws IOException 抛出 IO 异常
     */
    public String upload(MultipartFile multipartFile) throws IOException {
        // 1. 获取上传的文件的输入流,用于后续将数据流上传到 OSS
        InputStream inputStream = multipartFile.getInputStream();

        // 2. 获取上传文件的原始文件名
        String originalFilename = multipartFile.getOriginalFilename();
        
        // 3. 为文件生成一个唯一的名字,避免重复文件名导致覆盖
        // UUID.randomUUID() 用于生成一个随机的唯一字符串,后面再加上文件的原始扩展名
        String fileName = UUID.randomUUID().toString() 
                          + originalFilename.substring(originalFilename.lastIndexOf(".")); 

        // 4. 创建 OSS 客户端对象,用于与阿里云 OSS 服务进行交互
        // 参数:endpoint 为 OSS 的节点,accessKeyId 和 accessKeySecret 为访问密钥
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

        // 5. 上传文件到 OSS
        // 参数:bucketName 是你存储文件的 Bucket,fileName 是存储在 OSS 中的文件名,
        //       inputStream 是文件的输入流
        ossClient.putObject(bucketName, fileName, inputStream);

        // 6. 生成文件的访问路径
        // 通过组合 endpoint 和 bucketName 来生成文件的 URL,格式如:
        // "http://bucketName.endpoint/fileName"
        String url = endpoint.split("//")[0] + "//" + bucketName + "." 
                     + endpoint.split("//")[1] + "/" + fileName;

        // 7. 关闭 OSS 客户端,释放资源
        ossClient.shutdown();

        // 8. 返回上传到 OSS 的文件访问路径,前端可以通过该路径访问该文件
        return url;
    }
}

详细注释说明:

  1. 依赖注入:使用了 @Component 注解将该类标记为一个 Spring 组件,便于在其他类中通过注入的方式使用。

  2. OSS 配置

    • endpoint:这是阿里云 OSS 服务的节点 URL,根据你的存储位置选择相应的节点,这里使用的是上海节点。
    • accessKeyIdaccessKeySecret:访问阿里云 OSS 所需的安全凭证,通过阿里云控制台生成。
    • bucketName:OSS 中用于存储文件的存储空间,提前在阿里云 OSS 管理控制台中创建。
  3. 文件上传逻辑

    • 通过 multipartFile.getInputStream() 获取前端上传文件的输入流。
    • 使用 UUID.randomUUID() 生成唯一的文件名,避免文件名冲突问题。
    • 创建一个 OSS 客户端对象,通过 putObject() 方法将文件流上传到指定的 OSS 存储空间。
  4. 文件访问路径

    • 上传完成后,生成文件的访问路径(URL),通过 OSS 可以直接访问该文件。
  5. 关闭资源:使用完 OSS 客户端后,需要调用 shutdown() 方法来关闭客户端,释放资源。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

cyt涛

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值