文章目录
1、OSS介绍及开通
1.1、阿里云OSS简介
阿里云对象存储服务（Object Storage Service，简称OSS）为您提供基于网络的数据存取服务。使用OSS，您可以通过网络随时存储和调用包括文本、图片、音频和视频等在内的各种非结构化数据文件。
阿里云OSS将数据文件以对象（object）的形式上传到存储空间（bucket）中。
可以进行以下操作
- 创建一个或者多个存储空间，向每个存储空间中添加一个或多个文件。
- 通过获取已上传文件的地址进行文件的分享和下载。
- 通过修改存储空间或文件的属性或元信息来设置相应的访问权限。
- 在阿里云管理控制台执行基本和高级OSS任务。
- 使用阿里云开发工具包或直接在应用程序中进行RESTful API调用执行基本和高级OSS任务
1.2、开通OSS
登录阿里云官网。 点击右上角的控制台。
将鼠标移至产品，找到并单击对象存储OSS，打开OSS产品详情页面。在OSS产品详情页中的单击立即开通。
可以选择按量付费
开通服务后，在OSS产品详情页面单击管理控制台直接进入OSS管理控制台界面。您也可以单击位于官网首页右上方菜单栏的控制台，进入阿里云管理控制台首页，然后单击左侧的对象存储OSS菜单进入OSS管理控制台界面。
2、创建存储空间bucket及密钥获取
2.1、创建存储空间
- 点击【创建bucket】按钮
填写
- bucket名字、
- 地域、
- 将读写权限设置为 【公共读】
- 点击确定
创建成功后，展示 bucket的基本信息和 当前存储空间的访问域名信息
2.2、获取密钥
在界面用户右上角下拉框中，点击accessKey管理
第一次进入时需要创建新的accessKey
创建accessKey完成后会获得两个信息，保存好这两个信息（不要泄露），这两个信息是访问阿里云服务的合法身份凭证
- AccessKey ID
- AccessKey Secret
且AccessKey Secret只会在创建时提供查询，需要自己保存好
3、OSS快速入门案例
（1）创建测试工程，引入依赖
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>3.15.1</version>
</dependency>
（2）新建类和main方法
在下面的案例中，访问oss需要准备以下信息
- endpoint：地域节点，在bucket的概览中可以看到，华东1（杭州）为https://oss-cn-hangzhou.aliyuncs.com
- accessKeyId： 在2.2节中创建密钥获取
- accessKeySecret：在2.2节中创建密钥获取
- bucketName：Bucket名称，2.1节创建存储空间的名称
- objectName：文件在 云存储空间bucket中的名称
- filePath： 文件的本地路径
调用ossClient.putObject(bucketName, objectName, inputStream);这条语句后完成文件上传
上传完成后文件的访问路径为 https:// [BucketName].[Endpoint] / [ObjectName]
import org.junit.jupiter.api.Test;
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import java.io.FileInputStream;
import java.io.InputStream;
public class AliOssTest {
@Test
public void testOss(){
// Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
String accessKeyId = "---------------------";
String accessKeySecret = "-----------------------";
// 填写Bucket名称，例如examplebucket。
String bucketName = "-----------";
// 填写Object完整路径，完整路径中不能包含Bucket名称，例如exampledir/exampleobject.txt。
String objectName = "0001.jpg";
// 填写本地文件的完整路径，例如D:\\localpath\\examplefile.txt。
// 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。
String filePath= "C:\\Users\\Administrator\\Pictures\\Saved Pictures\\10.jpg";
// 创建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 (Exception 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();
}
}
}
}
4、在springboot项目中整合
4.1、将oss配置放到yml文件中
- endpoint
- access-key-id
- access-key-secret
- bucket-name
4.2、创建Oss属性类，接收yml文件中的属性
@ConfigurationProperties(prefix = “sky.alioss”) 注解直接读取yml文件中配置赋值给属性成员
@Component注解 将AliOssProperties类 注入ioc容器（springboot会自动扫描包）
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
//阿里云oss属性配置类
@Component
@ConfigurationProperties(prefix = "sky.alioss")
@Data
public class AliOssProperties {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
}
4.3、封装文件上传功能到AliOssUtil类
将AliOss文件上传方法封装到 AliOssUtil 类中
其中 upload()方法 用于文件上传，返回String类型 的 文件上传后的访问路径
其中 类中的几个属性为yml配置的属性（后续为AliOssUtil属性成员赋值）
@Data
@AllArgsConstructor
@Slf4j
public class AliOssUtil {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
/**
* 文件上传
*
* @param bytes 文件的字节数组
* @param objectName 文件名uuid
* @return 返回文件的 阿里云url 路径
*/
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();
}
}
4.4、通过配置类将AliOssUtil注入
通过配置类将 AliOssUtil 注入IOC容器，并为AliOssUtil 中的属性赋值
@Configuration 表示这是一个配置类
传入参数 aliOssProperties 为 4.2节中 注入的属性类，4.2中 AliOssProperties类加了@Component注解，所以aliOssProperties已经在IOC容器中，可以将IOC容器中的Bean作为实参传入。
//配置类，创建AliOssUtils对象
@Configuration
@Slf4j
public class OSSConfiguration {
//注入bean AliOssUtil
//AliOssProperties是已经注入的bean，作为aliOssUtil的参数
@Bean
@ConditionalOnMissingBean
public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){
log.info("开始注入阿里云oss文件上传工具类对象：{}",aliOssProperties);
return new AliOssUtil(aliOssProperties.getEndpoint(),aliOssProperties.getAccessKeyId(),
aliOssProperties.getAccessKeySecret(),aliOssProperties.getBucketName() );
}
}
4.5、在具体Controller中使用AliOssUtil完成文件上传
在具体Controller中装配并使用AliOssUtil
只需要调用 aliOssUtil.upload(file.getBytes(), objectName) 即可完成文件上传
前端需要调用的rest接口为 http://【ip】:【port】/admin/common/upload 并携带文件作为参数进行上传
@RestController
@RequestMapping("/admin/common")
@Slf4j
public class CommonController {
// 自动装配阿里云oss工具类
@Autowired
private AliOssUtil aliOssUtil;
@PostMapping("/upload")
@ApiOperation("文件上传")
public Result<String> upload(MultipartFile file){
log.info("文件上传：{}",file);
try {
//原始文件名
String originalFilename = file.getOriginalFilename();
//截取文件名后缀 xxx.png
String extension = originalFilename.substring(originalFilename.lastIndexOf("."));
//构造新文件名称
String objectName = UUID.randomUUID().toString() + extension;
//返回文件请求路径
String filePath = aliOssUtil.upload(file.getBytes(), objectName);
return Result.success(filePath);
} catch (IOException e) {
log.error("文件上传失败");
e.printStackTrace();
}
return Result.error("文件上传失败");
}
}
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
