集成Java
项目集成
- 在Maven项目中引入aliyunOSS 以来坐标
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>3.15.1</version>
</dependency>
- 从阿里文档中复制示例代码作为工具类
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;
/**
* AliOssUtil类是一个包含 文件上传 功能的工具类。
*/
@Data
@AllArgsConstructor
@Slf4j
public class AliOssUtil {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
/**
* 文件上传 upload file
* @param bytes
* @param objectName
* @return
*/
public String upload(byte[] bytes, String objectName) {
// 创建OSSClient实例。
/*在upload方法中，首先创建了一个OSSClient实例，用于与OSS服务进行交互。*/
OSS ossClient = new OSSClientBuilder()
.build(endpoint, accessKeyId, accessKeySecret);
try {
// 创建PutObject请求。
/*然后，通过调用ossClient.putObject方法将文件上传到指定的存储桶中。*/
ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(bytes));
/*在上传过程中，通过捕获OSSException和ClientException来处理可能出现的异常情况，并输出相应的错误信息。*/
} 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();
}
}
- aliyun OSS 相关配置
application.yaml
sky:
alioss:
#endpoint: oss-cn-beijing.aliyuncs.com
#access-key-id: LTAI5tPeFLzSPPT8gG3LPw64
#access-key-secret: U6k1broZ8gaOIXv3nxbulGTUzy6Pd7
#bucket-name: sky-itcast
properties 配置实体类
package com.sky.properties;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* 阿里云 配置 实体类
*/
@Component
/**
* 请注意，为了使用@ConfigurationProperties注解，你需要在Spring Boot应用程序中启用配置绑定功能。
* 你可以通过在主应用程序类上添加@EnableConfigurationProperties注解来实现。
*/
@ConfigurationProperties(prefix = "sky.alioss")
@Data
public class AliOssProperties {
/**
* 表示OSS服务的访问域名。
*/
private String endpoint;
/**
* 表示访问OSS服务所需的Access Key ID。
*/
private String accessKeyId;
/**
* 表示访问OSS服务所需的Access Key Secret。
*/
private String accessKeySecret;
/**
* 表示要操作的存储桶名称。
*/
private String bucketName;
}
- 配置类 生成 oss工具类对象
先有工具类 。
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;
/**
* AliOssUtil类是一个包含 文件上传 功能的工具类。
*/
@Data
@AllArgsConstructor
@Slf4j
public class AliOssUtil {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
/**
* 文件上传 upload file
* @param bytes
* @param objectName
* @return
*/
public String upload(byte[] bytes, String objectName) {
// 创建OSSClient实例。
/*在upload方法中，首先创建了一个OSSClient实例，用于与OSS服务进行交互。*/
OSS ossClient = new OSSClientBuilder()
.build(endpoint, accessKeyId, accessKeySecret);
try {
// 创建PutObject请求。
/*然后，通过调用ossClient.putObject方法将文件上传到指定的存储桶中。*/
ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(bytes));
/*在上传过程中，通过捕获OSSException和ClientException来处理可能出现的异常情况，并输出相应的错误信息。*/
} 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();
}
}
生成工具类对象（实例化）
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;
/**
*
* 配置类，用于创建 AliOssUtil
* Created by ZSC.
* User: lenovo
*
* @PackageName:com.sky.config
* @projectName: sky-take-out
* @ClassName: OssConfiguration
* @Description: TODO
* @Author ZSC
* @Date 2024/3/18 09:49
* @Version 1.0
*/
@Configuration
@Slf4j
public class OssConfiguration {
/**
* ConditionalOnMissingBean 条件创建 当没有这个类的时候进行创建
* @ConditionalOnMissingBean注解表示当不存在名为aliOssUtil的bean时，才会创建该bean。
* 这意味着如果已经有其他地方定义了名为aliOssUtil的bean，那么这个方法将不会执行。
*
* 在这个配置类中，定义了一个名为aliOssUtil的@Bean方法，用于创建一个AliOssUtil对象。
*
* 在方法体中，通过依赖注入的方式获取AliOssProperties对象，并使用它的属性值来创建AliOssUtil对象。
* @param aliOssProperties
* @return
*/
@Bean
@ConditionalOnMissingBean
public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){
log.info("开始创建阿里云OSS文件上传工具类对象：{}", aliOssProperties);
return new AliOssUtil(aliOssProperties.getEndpoint(),
aliOssProperties.getAccessKeyId(),
aliOssProperties.getAccessKeySecret(),
aliOssProperties.getBucketName());
}
}
- 文件上传
控制转发层进行文件上传
将原始照片文件名进行uuid重命名存储，防止名字冲突
package com.sky.controller.admin;
import com.sky.constant.MessageConstant;
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.stereotype.Controller;
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.IOException;
import java.util.UUID;
/**
* 通用接口
* Created by ZSC.
* User: lenovo
*
* @PackageName:com.sky.controller.admin
* @projectName: sky-take-out
* @ClassName: CommonController
* @Description: TODO
* @Author ZSC
* @Date 2024/3/18 09:12
* @Version 1.0
*/
@RestController
@RequestMapping("/admin/common")
@Api(tags = "通用接口")
@Slf4j
/*CommonController是一个使用AliOssUtil进行文件上传的控制器类。*/
public class CommonController {
@Autowired
private AliOssUtil aliOssUtil;
/**
* 菜品管理 --- 文件上传 上传 菜品图片
* <p>
* Multipart 多元件的
* MultipartFile是SpringMVC提供简化上传操作的工具类。
*
* @param multipartFile
* @return
*/
@PostMapping("/upload")
@ApiOperation("菜品上传图片-阿里云文件上传")
public Result<String> upload(MultipartFile multipartFile) {
log.info("阿里云文件-菜品图片文件上传: {} ", multipartFile.getOriginalFilename());
// objectName 名称 使用uuid 防止名称冲突
try {
//原始文件名
// 获取原始文件名称
/*首先通过file.getOriginalFilename()获取原始文件名*/
String originalFilename = multipartFile.getOriginalFilename();
// 截取 文件名称的后缀 截取原始文件名的后缀 dfdfdf.png
// ****.jpg
/*然后通过originalFilename.lastIndexOf(".")获取文件名的后缀。*/
String extension = originalFilename.substring(originalFilename.lastIndexOf("."));
//构造新文件名称
/*使用UUID.randomUUID().toString()生成一个随机的文件名，并将后缀拼接在文件名后面，构造出新的文件名。*/
// 使用 uuid
String uuidToString = UUID.randomUUID().toString();
String objectName = uuidToString + extension;
//文件的请求路径
/*然后，调用aliOssUtil.upload方法将文件上传到OSS，并获取 文件的请求路径。*/
String filePath = aliOssUtil.upload(multipartFile.getBytes(), objectName);
log.info("文件上传完成...文件访问路径:{}", filePath);
/*最后，返回一个Result对象，其中包含上传文件的请求路径。*/
return Result.success(filePath);
} catch (IOException e) {
e.printStackTrace();
log.info("文件上传失败：{}", e);
}
return Result.error(MessageConstant.UPLOAD_FAILED);
}
}
- 至此通过接口方法就能上传文件啦！ 成功的话返回给前端是访问该图片的路径，使用HTML语言的
image即可在页面中回显。
2493
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
