当前位置:首页 » 《休闲阅读》 » 正文

Java利用阿里云OSS/本地存储实现文件上传功能

29 人参与  2024年04月27日 09:43  分类 : 《休闲阅读》  评论

点击全文阅读


目录

1、简介

2、本地存储

3、阿里云OSS

3.1、准备

3.2、入门

3.3、项目实施

3.4、注意

4、图片删除


?作者介绍:双非本科大三网络工程专业在读,阿里云专家博主,专注于Java领域学习,擅长web应用开发、数据结构和算法,初步涉猎Python人工智能开发和前端开发。
?主页:@逐梦苍穹

✈ 所属专栏:Java Web

?您的一键三连,是我创作的最大动力?

1、简介

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

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

想要完成文件上传这个功能需要涉及到两个部分:

前端程序服务端程序

本文着重介绍服务端程序。这里通过黑马程序员苍穹外卖项目中的"修改套餐"业务来举例说明,例子分别为本地存储和阿里云OSS存储。

2、本地存储

首先看一下页面效果:

9028130d577745138340aac5b770e517.png

这个地方需要上传图片。

下面实现一个controller来接收图片:

加上所必须的注解(@RestController、@RequestMapping)等,然后编写upload方法。

首先是要获取到用户上传的这张图片的名称(完整名称,包括后缀),然后重新为文件起一个新的名称(这个名称的要求是需要唯一,避免机缘巧合的情况下跟本地其他图片重复),这里采用的是UUID:

f66860e3293d4fe8afe80eaf1a11598a.png

然后是构造存储路径,把文件存入本地:aa63f85794874fdeb4c5907a864813ec.png

最后需要返回给前端图片的路径,注意:这里的路径并不是本地存储路径,而是访问路径!

构造访问路径,需要在配置类中配置映射:

83d2db85a59547f8a9baa41d620414a0.png

这个配置类中配置映射的代码,意思是把localhost:8080/images/下面的任何资源,都对应的映射到本地的路径下面。所以返回的访问路径就应该是:

980ce5512d2b49a98f33c346a5970447.png

这里的127.0.0.1就是本地地址,等同于localhost

本地存储的完整代码如下:

package com.sky.controller.upload;import com.sky.constant.MessageConstant;import com.sky.exception.FireNameIsNullException;import com.sky.result.Result;import com.sky.utils.AliOssUtil;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;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;import java.io.File;import java.io.IOException;import java.util.UUID;/** * @author 逐梦苍穹 * @date 2023/10/11 8:35 */@RestController@RequestMapping("/admin/common")@Api(tags = "文件上传(无阿里云)controller接口")@Slf4jpublic class UploadNoAliOssController {    @Autowired    private AliOssUtil aliOssUtil;    /**     * 文件上传接口     *     * @param file     * @return     */    @PostMapping("/upload")    @ApiOperation("文件上传")    public Result<String> upload(MultipartFile file) {        log.info("文件上传:{}", file);        String originalFilename = file.getOriginalFilename();        try {            if (originalFilename != null) {                // 利用UUID构造新的文件名称                String objectName = UUID.randomUUID().toString() + originalFilename;                // 文件的请求路径                String filePath = "E:\\javaSTUDY\\sky-take-out-imageFile\\" + objectName;                String returnImagePate = "http://127.0.0.1:8080/images/" + objectName;                file.transferTo(new File(filePath));                return Result.success(returnImagePate);            } else {                throw new FireNameIsNullException(MessageConstant.FILE_NAME_IS_NULL);            }        } catch (IOException e) {            e.printStackTrace();            log.error("文件上传失败:{}", e);        }        return Result.error(MessageConstant.UPLOAD_FAILED);    }}

到时此,我们文件上传的本地存储方式已完成了。但是这种本地存储方式还存在一问题:

b413a814ac8a4eb5a12bb1a746881561.png

如果直接存储在服务器的磁盘目录中,存在以下缺点:

不安全:磁盘如果损坏,所有的文件就会丢失容量有限:如果存储大量的图片,磁盘空间有限(磁盘不可能无限制扩容)无法直接访问

为了解决上述问题呢,通常有两种解决方案:

自己搭建存储服务器,如:fastDFS 、MinIO使用现成的云服务,如:阿里云,腾讯云,华为云

下面介绍阿里云OSS。

3、阿里云OSS

3.1、准备

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

4d385ae5f39d4c03aa9964adab52a6ab.png

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

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

云服务提供商给我们提供的软件服务通常是需要收取一部分费用的。

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

31fe4e2f39cd4a1abb6756e8b5f167fd.png

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

1999e069217444268f823d02e0a45290.png

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

7a24acf861d249a58aaf102edfb013ed.png

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

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

接下来介绍一下当前要使用的阿里云oss对象存储服务具体的使用步骤。

3416f16a638f4f828e22e3bdd534db39.png

Bucket:存储空间是用户用于存储对象(Object,就是文件)的容器,所有的对象都必须隶属于某个存储空间。

下面根据之前介绍的使用步骤,完成准备工作:

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

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

89db4892a1664e4b96d0496bf6776c49.png

③通过控制台找到对象存储OSS服务

b7a853a5aab540918b98945c83db6f33.png

如果是第一次访问,还需要开通对象存储服务OSS

0901a149356142f587366efe5f4355c9.png

3c6c2c41a62447bbb9404a9e45faafa8.png

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

b036ca743d094b4eb6b97743603794b0.png

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

67a125541f5c4eb8b111470755d9ab62.png

1fff614292fd4a25abb66fcaa70ee5cb.png

3.2、入门

阿里云oss 对象存储服务的准备工作已经完成了,接下来参照官方所提供的sdk示例来编写入门程序。

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

bda9fa1daea34b75ae54440d532dcf71.png

fcbe62b1b7b44cc8baa997ee563e8f0e.png

c21d488d1b8a4bffa790a9b3e61c5d80.png

参照官方提供的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 = "";        String accessKeySecret = "";                // 填写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:文件路径

AccessKey :

35f6374b81fe4cb8bf73eee8845cade1.png

运行以上程序后,会把本地的文件上传到阿里云OSS服务器上:

0acc564e06b1438b884c43f7f338492d.png

3.3、项目实施

在黑马苍穹外卖项目中,配置阿里云OSS实现图片上传的步骤如下:

①编写阿里云OSS配置属性类:

a2f57ca7d99e4bc7a6affb8772459fc1.png

②在application-dev.yml文件中定义各配置项的值:

26f232aaeccc4cb9b9d655fdf5cef15f.png

③在application.yml中配置:

c1719ab6355e42b28a7a3f1d074933a6.png

④编写工具类,工具类的核心如下:

51b2620c0313498eb1fa682b937e254a.png

代码:

package com.sky.utils;import com.aliyun.oss.ClientException;import com.aliyun.oss.OSS;import com.aliyun.oss.OSSClientBuilder;import com.aliyun.oss.OSSException;import lombok.AllArgsConstructor;import lombok.Data;import lombok.extern.slf4j.Slf4j;import java.io.ByteArrayInputStream;/** * 阿里云OSS对象存储服务工具类 * @author 逐梦苍穹 */@Data@AllArgsConstructor@Slf4jpublic class AliOssUtil {    private String endpoint;    private String accessKeyId;    private String accessKeySecret;    private String bucketName;    /**     * 文件上传     *     * @param bytes     * @param objectName     * @return     */    public String upload(byte[] bytes, String objectName) {        // 创建OSSClient实例。        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);        try {            // 创建PutObject请求。            ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(bytes));        } 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();            }        }        //文件访问路径规则 https://BucketName.Endpoint/ObjectName        StringBuilder stringBuilder = new StringBuilder("https://");        stringBuilder                .append(bucketName)                .append(".")                .append(endpoint)                .append("/")                .append(objectName);        log.info("文件上传到:{}", stringBuilder.toString());        return stringBuilder.toString();    }}

⑤编写OSS配置类:

package com.sky.config;import com.sky.properties.AliOssProperties;import com.sky.utils.AliOssUtil;import lombok.extern.slf4j.Slf4j;import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;/** * @author 逐梦苍穹 * @date 2023/10/11 9:44 */@Configuration@Slf4jpublic class OssConfiguration {    /**     * 开始创建阿里云文件上传工具类对象     * @param aliOssProperties     * @ConditionalOnMissingBean 确保容器里面只有一个工具对象     * @return     */    @Bean    @ConditionalOnMissingBean    public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){        log.info("开始创建阿里云文件上传工具类对象:{}",aliOssProperties);        return new AliOssUtil(aliOssProperties.getEndpoint(),aliOssProperties.getAccessKeyId(),aliOssProperties.getAccessKeySecret(),aliOssProperties.getBucketName());    }}

3.4、注意

这里有一个注意事项,就是在编写OSS配置类的时候,记得在方法上面加上@ConditionalOnMissingBean注解,这是保证项目运行过程中只会创建一次工具类对象。

@ConditionalOnMissingBean 是 Spring Boot 中的一个条件注解,它的作用是在特定的 bean 不存在时才会生效。这个注解通常用于配置类或者自动配置类中,用来根据条件来决定是否创建一个特定的 bean。

当一个 bean 被 @ConditionalOnMissingBean 注解标记时,Spring 容器会首先检查是否已经存在该类型的 bean。如果不存在,则会创建该 bean;如果已经存在,则不会创建该 bean。这样可以确保当某个特定的 bean 还未被用户自定义配置时,自动配置类会创建这个 bean。

这个注解允许您在自定义 bean 的同时,保留自动配置类提供的默认实现。这在需要覆盖默认实现时非常有用,可以确保只有在用户没有提供自定义实现时才使用默认实现。

总之,@ConditionalOnMissingBean 注解允许您根据 bean 是否存在来控制自动配置的行为。

4、图片删除

上面所实现的功能中,还有一个至关重要的功能,那就是:重新上传图片的时候,需要删除原图片!

实现思路:利用redis缓存。

在数据回显的时候,把当前的访问路径存入redis缓存,

在修改完成点击保存的时候,先解析缓存中的访问路径,然后根据需要进行匹配删除

(如果是阿里云OSS存储的,直接根据这个路径删除即可;本地存储还需要先解析本地路径)

下面是具体流程步骤:

在项目当中,点击"修改"按钮,服务端后台作出数据回显:

176b352e07814441af099c8af6b64441.png

acdb478d12254673aaebf13bb8adb945.png

这个方法实现的是把当前套餐的数据从数据库当中取出,并回显到前端页面。

此时利用RedisTemplate对图片路径进行缓存:

96e9ed398f30462697190a380cd752e9.png

数据回显之后,点击保存的时候,调用的是服务端的"update"方法:

70c7c29470a9492a9027af0a63102bc7.png

这部分代码不细说了。

重点是在代码开始的部分,检查图片是否被修改,如果被修改则需要删除原图片:

6276bdb16d834faa92ad3233f5ac66f2.png

删除部分的代码如下(以本地文件举例):

//在这里删除原图片String deleteImage = (String) redisTemplate.opsForValue().get(KEY);if (deleteImage != null){    if (!deleteImage.equals(setmealDTO.getImage())){        //查询套餐和菜品表单的image表单项数据        List<String> lists = deleteImageMapper.selectSetmealAndDishImage();        for (String list : lists) {            if (deleteImage.equals(list)){                //正则表达式匹配文件名                String regex = "http://127.0.0.1:8080/images/(.*)";                Pattern pattern = Pattern.compile(regex);                Matcher matcher = pattern.matcher(list);                if (matcher.find()){                    String deleteFileName = matcher.group(1);                    //删除图片                    if (new File("E:/javaSTUDY/sky-take-out-imageFile/"+deleteFileName).delete()){                        break;                    }else{                        log.error("删除原图片失败");                    }                }            }        }    }}redisTemplate.delete(KEY);


点击全文阅读


本文链接:http://zhangshiyu.com/post/100894.html

<< 上一篇 下一篇 >>

  • 评论(0)
  • 赞助本站

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

关于我们 | 我要投稿 | 免责申明

Copyright © 2020-2022 ZhangShiYu.com Rights Reserved.豫ICP备2022013469号-1