SpringBoot整合OSS对象存储

已于 2022-05-25 15:12:28 修改
阅读量2.8k 收藏 8
点赞数 4
分类专栏： Spring 中间件 文章标签： 阿里云
于 2021-06-05 16:09:09 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Monsterof/article/details/117595844
版权

阿里云存储OSS

介绍

对象存储服务（Object Storage Service，OSS）是一种海量、安全、低成本、高可靠的云存储服务，适合存放任意类型的文件。容量和处理能力弹性扩展，多种存储类型供选择，全面优化存储成本。

参考文档

阿里云官方API文档

准备工作

首先登录阿里云账号

到控制台里选择对象存储OSS，开通oss，注意此服务会根据流量收取费用
在这里插入图片描述

安装

进行OSS各类操作前，您需要先安装Java SDK。本文提供了Java SDK的多种安装方式，请结合实际使用场景选用。

前提条件

使用Java 1.7及以上版本。

您可以通过命令java -version查看Java版本。

安装SDK

您可以通过以下三种方式安装SDK。

  • 方式一：在Maven项目中加入依赖项（推荐方式）
    在Maven工程中使用OSS Java SDK，只需在pom.xml中加入相应依赖即可。以3.10.2版本为例，在中加入如下内容：
<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.10.2</version>
</dependency>

如果使用的是Java 9及以上的版本，则需要添加jaxb相关依赖。添加jaxb相关依赖示例代码如下：

<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>javax.activation</groupId>
    <artifactId>activation</artifactId>
    <version>1.1.1</version>
</dependency>
<!-- no more than 2.3.3-->
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.3</version>
</dependency>
  • 方式二：在Eclipse项目中导入JAR包
    以3.10.2版本为例，步骤如下：
  1. 下载Java SDK 开发包。
  2. 解压该开发包。
  3. 将解压后文件夹中的文件aliyun-sdk-oss-3.10.2.jar以及lib文件夹下的所有文件拷贝到您的项目中。
  4. 在Eclipse中选择您的工程，右键选择Properties > Java Build Path > Add JARs。
  5. 选中拷贝的所有JAR文件，导入到Libraries中。
  • 方式三：在Intellij IDEA项目中导入JAR包
    以3.10.2版本为例，步骤如下：
  1. 下载Java SDK 开发包。
  2. 解压该开发包。
  3. 将解压后文件夹中的文件aliyun-sdk-oss-3.10.2.jar以及lib文件夹下的所有JAR文件拷贝到您的项目中。
  4. 在Intellij IDEA中选择您的工程，右键选择File > Project Structure > Modules > Dependencies > + > JARs or directories 。
  5. 选中拷贝的所有JAR文件，导入到External Libraries中。

初始化

OSSClient是OSS的Java客户端，用于管理存储空间和文件等OSS资源。使用Java SDK发起OSS请求，您需要初始化一个OSSClient实例，并根据需要修改ClientConfiguration的默认配置项。

新建OSSClient

@Data
@ConfigurationProperties(prefix = "quanmingyanxuan.aliyun-oss")
public class OSSClientConstants {

    //阿里云API的外网域名
    private String endPoint;
    //阿里云API的密钥Access Key ID
    private String accessKeyId;
    //阿里云API的密钥Access Key Secret
    private String accessKeySecret;
    //阿里云OSS文件夹
    private String backetName;
    // 文件名
    private String folder;
    
}

您的工程中可以有一个或多个OSSClient。OSSClient可以并发使用。

实现

配置数据

这里需要指定Endpoint。有关Endpoint的更多信息，按照你开通oss服务的配置就行了

oss:
   endpoint: oss-cn-xxxxx.aliyuncs.com
   keyid: LTAI4GAeifxxxxxxxxAE8KpV
   keysecret: wRpsOkDEwKzmxxxxxxxxEP8qUJji
   bucketname: xxx-test # bucket名称
   filehost: xxx-test
   domainname: http://xxx.com.cn

配置文件（公共配置）

@Configuration
@Data
public class CommonConfig {

	@Value("${file.dir}")
	private String fileDir;

	@Value("${message.push-url}")
	private String messagePushUrl;

	@Value("${jpush.app-key:6ba985e9c1b1a614d917341b}")
	private String jPushAppKey;

	@Value("${jpush.master-secret:c1d5b6cb445650ed56b5194a}")
	private String jPushMasterSecret;

实现类（工具类）

/**
 * 阿里云OSS工具类
 */
@Service
@Slf4j
@AllArgsConstructor
public class AliyunOSSUtil {

	private final ConstantProperties constantProperties;

	private final BladeLogger bladeLogger;

	private static final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");

	private final CommonConfig commonConfig;

	/**
	 * 上传
	 *
	 * @param file file
	 * @param path 文件路径，不包含后缀
	 * @return 文件访问URL
	 */
	public String upload(File file, String path) {
		if (null == file) {
			return null;
		}
		log.info("=========>OSS文件上传开始：" + file.getName());
		String endpoint = constantProperties.getEndpoint();
		String accessKeyId = constantProperties.getKeyid();
		String accessKeySecret = constantProperties.getKeysecret();
		String bucketName = constantProperties.getBucketname();
		String fileHost = constantProperties.getFilehost();
		String domainName = constantProperties.getDomainname();
		log.info(endpoint + "endpoint");
		if (StrUtil.isBlank(path)) {
			SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
			path = format.format(new Date());
		}
		OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
		try {
			//容器不存在，就创建
			if (!ossClient.doesBucketExist(bucketName)) {
				ossClient.createBucket(bucketName);
				CreateBucketRequest createBucketRequest = new CreateBucketRequest(bucketName);
				createBucketRequest.setCannedACL(CannedAccessControlList.PublicRead);
				ossClient.createBucket(createBucketRequest);
			}
			//创建文件路径
			String fileUrl =
				fileHost + CommonConstant.SEPARATOR_LINUX + (path + CommonConstant.SEPARATOR_LINUX + file.getName());
			fileUrl = StrUtil.replace(fileUrl, "//", "/");
			//上传文件
			PutObjectResult result = ossClient.putObject(new PutObjectRequest(bucketName, fileUrl, file));
			//设置权限 这里是公开读
			ossClient.setBucketAcl(bucketName, CannedAccessControlList.PublicRead);
			if (null != result) {
				log.info("==========>OSS文件上传成功,OSS地址：" + fileUrl);
//                return bucketName+"."+endpoint+"/"+fileUrl;
				return domainName + CommonConstant.SEPARATOR_LINUX + fileUrl;
			}
		} catch (OSSException oe) {
			log.error(oe.getMessage());
		} catch (ClientException ce) {
			log.error(ce.getMessage());
		} finally {
			//关闭
			ossClient.shutdown();
		}
		return null;
	}


	/**
	 * 删除
	 *
	 * @param fileKey
	 * @return
	 */
	public String deleteBlog(String fileKey) {
		log.info("=========>OSS文件删除开始");
		String endpoint = constantProperties.getEndpoint();
		String accessKeyId = constantProperties.getKeyid();
		String accessKeySecret = constantProperties.getKeysecret();
		String bucketName = constantProperties.getBucketname();
		try {
			@SuppressWarnings("deprecation")
			OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);

			if (!ossClient.doesBucketExist(bucketName)) {
				log.info("==============>您的Bucket不存在");
				return "您的Bucket不存在";
			} else {
				log.info("==============>开始删除Object");
				ossClient.deleteObject(bucketName, fileKey);
				log.info("==============>Object删除成功：" + fileKey);
				return "==============>Object删除成功：" + fileKey;
			}
		} catch (Exception ex) {
			log.info("删除Object失败", ex);
			return "删除Object失败";
		}
	}

	/**
	 * 查询文件名列表
	 *
	 * @param bucketName
	 * @return
	 */
	public List<String> getObjectList(String bucketName) {
		List<String> listRe = new ArrayList<>();
		String endpoint = constantProperties.getEndpoint();
		String accessKeyId = constantProperties.getKeyid();
		String accessKeySecret = constantProperties.getKeysecret();
		try {
			log.info("【阿里云OSS】查询文件名列表");
			@SuppressWarnings("deprecation")
			OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
			ListObjectsRequest listObjectsRequest = new ListObjectsRequest(bucketName);
			//列出11111目录下今天所有文件
			listObjectsRequest.setPrefix("11111/" + format.format(new Date()) + CommonConstant.SEPARATOR_LINUX);
			ObjectListing list = ossClient.listObjects(listObjectsRequest);
			for (OSSObjectSummary objectSummary : list.getObjectSummaries()) {
				log.info(objectSummary.getKey());
				listRe.add(objectSummary.getKey());
			}
			return listRe;
		} catch (Exception ex) {
			log.info("【阿里云OSS】查询列表失败", ex);
			return new ArrayList<>();
		}
	}

	/**
	 * 下载文件
	 *
	 * @param objectName oss对象存储完整文件名
	 */
	public void download(String objectName) {
		OSS oss = null;
		try {
			String absolutePath = StrUtil.concat(false, commonConfig.getFileDir(),
				StrUtil.removePrefix(objectName, constantProperties.getFilehost()));
			if (!CommonConstant.SYS_SEPARATOR.equals(CommonConstant.SEPARATOR_LINUX)) {
				absolutePath = StrUtil.replace(absolutePath, CommonConstant.SEPARATOR_LINUX, CommonConstant.SYS_SEPARATOR);
			}
			absolutePath = PathUtil.removeRepeatSeparator(absolutePath);
			String endpoint = constantProperties.getEndpoint();
			String accessKeyId = constantProperties.getKeyid();
			String accessKeySecret = constantProperties.getKeysecret();
			String bucketName = constantProperties.getBucketname();
			objectName = PathUtil.removeRepeatSeparator(objectName);
			oss = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
			FileUtil.mkParentDirs(absolutePath);
			oss.getObject(new GetObjectRequest(bucketName, objectName), FileUtil.newFile(absolutePath));
		} catch (Exception e) {
			bladeLogger.error(CommonConstant.LOG_ID_COMMON, "下载OSS文件失败." + e.getMessage());
			throw new ServiceException(BladeResultCode.DOWNLOAD_OSS_FILE_FAIL, e);
		} finally {
			oss.shutdown();
		}
	}

	/**
	 * 判断文件是否存在
	 *
	 * @param objectName
	 * @return
	 */
	public boolean checkExist(String objectName) {
		OSS oss = null;
		try {
			String endpoint = constantProperties.getEndpoint();
			String accessKeyId = constantProperties.getKeyid();
			String accessKeySecret = constantProperties.getKeysecret();
			String bucketName = constantProperties.getBucketname();
			objectName = PathUtil.removeRepeatSeparator(objectName);
			oss = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
			return oss.doesObjectExist(new GenericRequest(bucketName, objectName));
		} catch (Exception e) {
			bladeLogger.error(CommonConstant.LOG_ID_COMMON, "检查OSS文件是否存在失败." + e.getMessage());
			throw new ServiceException(BladeResultCode.DOWNLOAD_OSS_FILE_FAIL, e);
		} finally {
			oss.shutdown();
		}
	}

}

以上代码全是可复制粘贴即可使用的

Monster_起飞
关注
  • 4
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
专栏目录
阿里云OSS对象存储完全开发手册（一篇学会阿里云OSS所有知识点）
hao_kkkkk的专栏
03-25 293
阿里云对象存储OSS（Object Storage Service）是一款海量、安全、低成本、高可靠的云存储服务，可提供99.9999999999%（12个9）的数据持久性，99.995%的数据可用性。多种存储类型供选择，全面优化存储成本， 可以使用阿里云提供的 API、SDK 接口或者 OSS 迁移工具轻松地将海量数据移入或移出阿里云 OSS。RAM用户是RAM的一种实体身份类型，有确定的身份ID和身份凭证，它通常与某个确定的人或应用程序一一对应。RAM用户具备以下特点。
SpringBoot整合阿里云OSS对象存储服务的实现
08-18
主要介绍了SpringBoot整合阿里云OSS对象存储服务的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
blade-log:刀片服务器默认日志显示
05-08
blade-log 这是一个简单的日志实现，可能是一个简易版的 logback。 特性 格式化日志输出 彩色日志打印 输出日志到文件 多种日志级别 不依赖第三方库 按文件大小切割 使用 加入依赖 <dependency> <groupId>com.bladejava</groupId> <artifactId>blade-log</artifactId> <version>0.1.6</version> </dependency> 配置 com.blade.logger.rootLevel=INFO com.blade.logger.dir=./logs com.blade.logger.name=app
springboot整合京东云OSS对象储存
05-29
springboot整合京东云OSS对象储存.实现文件/图片存储,下载,删除操作.有完整的demo.
日志打印（bladex）
最新发布
chengchong_cc的博客
12-06 485
log.info("通用短信发送接口：" + response.getMsg());
Maven之阿里云镜像仓库配置
weixin_30725467的博客
08-22 2905
方式一：全局配置 可以添加阿里云的镜像到maven的setting.xml配置中，这样就不需要每次在pom中，添加镜像仓库的配置，在mirrors节点下面添加子节点： <mirror> <id>nexus-aliyun</id> <mirrorOf>central</mirrorOf> &l...
springboot整合阿里云OSS存储（对象存储）图文详解-———入门操作指南。
weixin_53472653的博客
03-24 4676
oss
SpringBoot使用阿里云OSS对象存储
m0_43584016的博客
11-14 638
阿里云上传文件
SpringBoot集成阿里云对象存储OSS(上传/下载数据)
mo_sss的博客
03-30 1223
阿里云对象存储oss
SpringBoot整合OSS存储
小凯的博客
06-29 3532
OSS存储与COS存储对比，springboot整合OSS存储笔记
SpringBoot整合——阿里云对象存储（OSS）
weixin_45565886的博客
10-22 1807
SpringBoot整合——阿里云对象存储（OSS）
springboot整合easypoi实现文件导入导出OSS文件上传和下载。OSS图片导出
01-07
代码简单容懂。下载就可以运行。该列子包过了easypoi注解导出exel表格同时导出oss中的图片到exel表格中。
SpringBoot + minio实现文件切片极速上传技术源码（敢说全网整合完整度前三）
06-02
Minio是一款开源的对象存储服务器，它可以运行在多种操作系统上，包括Linux、Windows和MacOS等。它提供了一种简单、可扩展、高可用的对象存储解决方案，支持多种数据格式，包括对象、块和文件等。 以下是Minio的...
源码 SpringBoot 文件管理(支持FastDFS/FTP/阿里/华为OBS/天翼云/联通云/移动云)源代码
04-13
可支持FastDFS存储、FTP存储、天翼云存储、华为云存储（OBS）、阿里云存储（OSS）、移动云。可通过配置自动切换存储类型。本微服务支持临时文件24小时自动删除、文件下载。本资源也包含了Github更新地址
Java集成第三方推送（极光推送）——开发篇
Monsterof的博客
07-15 3398
Java快速集成极光开发相关文档一级目录二级目录 相关文档 Java集成第三方推送（极光推送）——文档篇 一级目录 二级目录
三分钟实现 Spring Boot 集成 RabbitMQ，实现消息队列服务
Monsterof的博客
10-16 3136
Spring Boot提供了spring-bootstarter-amqp组件对消息队列进行支持，使用非常简单，仅需要非常少的配置即可实现完整的消息队列服务。 消息中间件在互联网公司使用的越来越多，主要用于在分布式系统中存储转发消息，在易用性、扩展性、高可用性等方面表现不俗。消息队列实现系统之间的双向解耦，生产者往消息队列中发送消息，消费者从队列中拿取消息并处理，生产者不用关心是谁来消费，消费者不用关心谁在生产消息，从而达到系统解耦的目的，也大大提高了系统的高可用性和高并发能力。 接下来介绍Spring
Springboot框架防止前台重复提交（锁）
Monsterof的博客
08-12 1940
Springboot–解决防重复提交 防止重复提交，主要是使用锁的形式来处理，如果是单机部署，可以使用本地缓存锁（Guava）即可。 一、本地锁（Guava） 1、导入依赖 <!--本地 缓存锁 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </d
SpringBoot框架实现热部署配置方法
Monsterof的博客
08-24 1393
SpringBoot项目实现热部署方法 最近在小编在开发中用到了热部署，在这里做如下记录： 一、什么是热部署？ 所谓热部署，就是在应用正在运行的时候升级软件，却不需要重新启动应用。 二、什么是SpringBoot热部署？ 通俗的说，就是当你在修改SpringBoot项目中的静态资源的时候，不需要每一次都要去重启项目才能达到预期效果。 三、怎么使用SpringBoot热部署？ 1.pom文件中导入spring-boot-devtools依赖： <dependencies> <
springboot整合阿里云oss对象存储
09-05
SpringBoot可以通过整合阿里云OSS对象存储服务来实现文件上传和管理功能。具体实现可以参考以下步骤： 1. 在service层定义FileService接口，该接口包含上传文件到阿里云OSS的方法。例如，可以使用MultipartFile作为参数，返回上传成功后的文件URL。 2. 在controller层编写FileApiController类，该类使用@RestController注解标识为控制器，并使用@RequestMapping注解指定请求路径。在该类中，通过@Autowired注入FileService，并在文件上传的接口方法中调用FileService的上传文件方法并返回上传成功后的文件URL。 3. 在配置文件中配置阿里云OSS的相关信息，包括accessKey、secretKey、bucketName等。可以使用SpringBoot提供的@ConfigurationProperties注解来读取配置文件中的信息。 4. 在pom.xml文件中添加阿里云OSS SDK的依赖。 5. 编写上传文件的前端界面，可以使用HTML或者前端框架如Vue.js、React等。 通过以上步骤的实现，SpringBoot就可以整合阿里云OSS对象存储服务，实现文件上传和管理功能。这样可以将文件存储在阿里云OSS中，提高文件的安全性和可靠性。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [SpringBoot整合阿里云OSS对象存储服务的实现](https://download.csdn.net/download/weixin_38649091/12721580)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [全网最详细SpringBoot、SpringCloud整合阿里云OSS对象存储服务](https://blog.csdn.net/weixin_55076626/article/details/127924003)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

Monster_起飞

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

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

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

打赏作者

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

抵扣说明：

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

余额充值