Alibaba Cloud Object Storage Alibaba Cloud official website click
Alibaba Cloud Object Storage OSS (Object Storage Service) is a massive, secure, low-cost, and highly reliable cloud storage service that provides 99.9999999999% (12 9s) of data durability and 99.995% of data availability. A variety of storage types are available to fully optimize storage costs. [From the official website]
First, let's look at registration and manual application for Alibaba Cloud OSS warehouse
1 Click to enter the management console
2 Console page
3 Create your own bucket
4 Create a bucket in the following way
5 Click OK. After the above process, you have successfully applied for the Alibaba Cloud OSS cloud storage warehouse
The following describes how to use the Java API to operate OSS
1 Configuration dependencies, refer to
java 8 and below, use Maven to introduce in pom.xml
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>3.10.2</version>
</dependency>
If it is Java9 and above or developed with Eclipse, please refer to the official documentation for details.
2 Java API to operate OSS
Click to enter APIs in multiple programming languages.
There are official documents for using the Java API to operate OSS . Click the Java API document . In the document, it is not difficult to find that each function is preceded by a series of Access account authentication, as shown in the figure below.
Here's how to set up an account
1 Click to enter the OSS console to enter
Select access control RAM to enter, in fact, AccessKey can also be used, but it mainly affects the security of the entire warehouse, so it is recommended to use the one pointed by the arrow
2 Click to enter to create a user
3 After the user is created, set the permissions.
4 Enter oss in the search box and add all four OSS permissions.
If the join is successful, the join will be grayed out
Access OSS using a program
1 Configure the above user information to the project's application.yml and
add the following code snippet
alioss:
endpoint: oss-cn-your location.aliyuncs.com
accessKeyId: your AccessKeyId
accessKeySecret: your AccessKeySecret
bucketName: your bucket name
where endpoint is
2 Create OSS entity class
import org.springframework.stereotype.Component;
/*
Data：set get 方法
Component: Spring 扫描
ConfigurationProperties: 与 application.yml中的属性名保持一致
*/
@ConfigurationProperties(prefix= "alioss")
@Component
@Data
public class OssEntity {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
}
3 Create Service interface
import java.io.IOException;
public interface AliOssService {
/**
* 创建存储空间
*/
void createBucket();
/**
* 上传文件
* @param file 文件对象
* @return
*/
String upload(MultipartFile file);
/**
* 下载文件
* @throws IOException
*/
void download(String fileName) throws IOException;
/**
* 列举文件
*/
void listFile();
/**
* 删除文件
*/
void deleteFile(String fileName);
}
4 ServiceImpl class
can learn from OSS Java API development documentation
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.model.*;
import com.s.system.entity.OssEntity;
import com.s.system.service.AliOssService;
import net.sf.jsqlparser.expression.DateTimeLiteralExpression;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Date;
import java.util.UUID;
//在创建AliOssServiceImpl类的时候将属性值封装
@Service
public class AliOssServiceImpl implements AliOssService, InitializingBean {
@Autowired
private OssEntity ossEntity;
//存放endpoint地址
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
@Override
public void createBucket() {
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
if (ossClient.doesBucketExist(bucketName)) {
throw new RuntimeException(bucketName + "在对象存储的Bucket列表中已经存在");
}
// 创建存储空间。
ossClient.createBucket(bucketName);
// 关闭OSSClient。
ossClient.shutdown();
}
@Override
public String upload(MultipartFile file) {
//上传地址
String uploadUrl = null;
try {
//判断oss实例是否存在：如果不存在则创建，如果存在则获取
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
if (!ossClient.doesBucketExist(bucketName)) {
//创建bucket
ossClient.createBucket(bucketName);
//设置oss实例的访问权限：公共读
ossClient.setBucketAcl(bucketName, CannedAccessControlList.PublicRead);
}
//获取上传文件流
InputStream inputStream = file.getInputStream();
//构建日期路径：avatar/2020/07/31/文件名
String datePath = new DateTimeLiteralExpression.DateTime().toString("yyyy/MM/dd");
//文件名：uuid.扩展名
//获取上传文件的全名称
String original = file.getOriginalFilename();
//去掉uuid中生成的-
String fileName = UUID.randomUUID().toString().replaceAll("-", "");
//截取掉文件获得扩展名
String fileType = original.substring(original.lastIndexOf("."));
//uuid+.jpg/.png
String newName = fileName + fileType;
// yyyy/MM/dd+/uuid+.jpg/.png
fileName = datePath + "/" + newName;
//如果想要实现图片的预览效果,一定要设置一下几个点
//1.设置文件 ACL为反正不能为私有 要么是公共读,要么是公共读写
//2.一定要设置文本类型为(image/jpg)
ObjectMetadata objectMetadata = new ObjectMetadata();
//设置公共读权限
objectMetadata.setObjectAcl(CannedAccessControlList.PublicRead);
//设置类型
objectMetadata.setContentType(getcontentType(fileName.substring(fileName.lastIndexOf("."))));
//文件上传至阿里云
ossClient.putObject(bucketName, fileName, inputStream, objectMetadata);
// 关闭OSSClient。
ossClient.shutdown();
//默认十年不过期
Date expiration = new Date(System.currentTimeMillis() + 3600L * 1000 * 24 * 365 * 10);
//bucket名称 文件名 过期时间
uploadUrl = ossClient.generatePresignedUrl(bucketName, fileName, expiration).toString();
//获取url地址
//uploadUrl = "https://" + bucketName + "." + endPoint + "/" + fileName;
} catch (IOException e) {
e.printStackTrace();
}
return uploadUrl.substring(0, uploadUrl.indexOf("?"));
//return uploadUrl;
}
@Override
public void download(String fileName) throws IOException {
// <yourObjectName>从OSS下载文件时需要指定包含文件后缀在内的完整路径，例如abc/efg/123.jpg。
String objectName = fileName;
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
// 调用ossClient.getObject返回一个OSSObject实例，该实例包含文件内容及文件元信息。
OSSObject ossObject = ossClient.getObject(bucketName, objectName);
// 调用ossObject.getObjectContent获取文件输入流，可读取此输入流获取其内容。
InputStream content = ossObject.getObjectContent();
if (content != null) {
BufferedReader reader = new BufferedReader(new InputStreamReader(content));
while (true) {
String line = reader.readLine();
if (line == null) {
break;
}
System.out.println("\n" + line);
}
// 数据读取完成后，获取的流必须关闭，否则会造成连接泄漏，导致请求无连接可用，程序无法正常工作。
content.close();
}
// 关闭OSSClient。
ossClient.shutdown();
}
@Override
public void listFile() {
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
// ossClient.listObjects返回ObjectListing实例，包含此次listObject请求的返回结果。
ObjectListing objectListing = ossClient.listObjects(bucketName);
// objectListing.getObjectSummaries获取所有文件的描述信息。
for (OSSObjectSummary objectSummary : objectListing.getObjectSummaries()) {
System.out.println(" - " + objectSummary.getKey() + " " +
"(size = " + objectSummary.getSize() + ")");
}
// 关闭OSSClient。
ossClient.shutdown();
}
@Override
public void deleteFile(String fileName) {
// <yourObjectName>从OSS下载文件时需要指定包含文件后缀在内的完整路径，例如abc/efg/123.jpg。
String objectName = fileName;
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
// 删除文件。
ossClient.deleteObject(bucketName, objectName);
// 关闭OSSClient。
ossClient.shutdown();
}
//初始化Bean之后需要进行的操作
@Override
public void afterPropertiesSet() throws Exception {
Endpoint以杭州为例，其它Region请按实际情况填写。
endpoint = ossEntity.getEndpoint();
阿里云主账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维，请登录RAM控制台创建RAM账号。
accessKeyId = ossEntity.getAccessKeyId();
accessKeySecret = ossEntity.getAccessKeySecret();
bucketName = ossEntity.getBucketName();
}
/**
* Description: 判断OSS服务文件上传时文件的contentType
*
* @param FilenameExtension 文件后缀
* @return String
*/
public static String getcontentType(String FilenameExtension) {
if (FilenameExtension.equalsIgnoreCase(".bmp")) {
return "image/bmp";
}
if (FilenameExtension.equalsIgnoreCase(".gif")) {
return "image/gif";
}
if (FilenameExtension.equalsIgnoreCase(".jpeg") ||
FilenameExtension.equalsIgnoreCase(".jpg") ||
FilenameExtension.equalsIgnoreCase(".png")) {
return "image/jpg";
}
if (FilenameExtension.equalsIgnoreCase(".html")) {
return "text/html";
}
if (FilenameExtension.equalsIgnoreCase(".txt")) {
return "text/plain";
}
if (FilenameExtension.equalsIgnoreCase(".vsd")) {
return "application/vnd.visio";
}
if (FilenameExtension.equalsIgnoreCase(".pptx") ||
FilenameExtension.equalsIgnoreCase(".ppt")) {
return "application/vnd.ms-powerpoint";
}
if (FilenameExtension.equalsIgnoreCase(".docx") ||
FilenameExtension.equalsIgnoreCase(".doc")) {
return "application/msword";
}
if (FilenameExtension.equalsIgnoreCase(".xml")) {
return "text/xml";
}
return "image/jpg";
}
}
5 test
import com.s.system.entity.OssEntity;
import com.s.system.service.AliOssService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class OssTest {
@Autowired
private OssEntity ossEntity;
@Autowired
private AliOssService aliOssService;
@Test
public void contextLoads(){
aliOssService.createBucket();
System.out.println(ossEntity.toString());
}
}
After the test is passed, it can be found that the error is mainly because the bucket already exists in aplication.yml. You can define a new name for bucketName: your bucket name in application.yml, and you can pass. This also means that the OSS Demo test has passed, and the following development can be performed.
