需求分析:
在用户更换头像或者添加文章时,都需要携带一个图片的URL访问地址。当用户访问文件上传接口将图片的数据上传成功后,服务器会返回一个地址。我们后台需要提供一个文件上传的接口,用来接收前端提交的文件的数据并且返回文件的访问地址。
接口文档:
1.本地存储
文件上传,前端页面三要素
<form action="/upload" method="post" enctype="multipart/form-data">
头像:<input type="file" name="image"><br>
<input type ="submit" value="提交">
</from>
三要素:
第一:method="post"
第二:enctype="multipart/from-data"
第三:type="file"
后端:MultipartFile
@PostMapping("/upload")public Result<String> upload(MultipartFile file) throws IOException {//把文件的内容存储到本地磁盘上String originFileName = file.getOriginalFilename();file.transferTo(new File("D:\\SpringBootProjects\\files\\"+originFileName));return Result.success("url访问地址...");}
结果:
但是再次上传,文件里还是只有一张图片,发现被覆盖了。名字一样被覆盖了。这个时候用户上传的时候,名字相同会造成丢失。所以我们需要保证文件名字唯一,防止文件被覆盖。
@PostMapping("/upload")public Result<String> upload(MultipartFile file) throws IOException {//把文件的内容存储到本地磁盘上String originFileName = file.getOriginalFilename();//需要保证文件名字唯一,防止文件被覆盖String fileName = UUID.randomUUID().toString()+originFileName.substring(originFileName.lastIndexOf("."));file.transferTo(new File("D:\\SpringBootProjects\\files\\"+fileName));return Result.success("url访问地址...");}
通过将UUID与原始文件扩展名结合,可以创建一个唯一的文件名,同时保留文件的类型信息,这是一种在Web应用中常见的做法。
-
String fileName = UUID.randomUUID().toString() + originFileName.substring(originFileName.lastIndexOf("."));
: 这行代码创建一个新的文件名,以确保上传的文件不会覆盖服务器上已存在的文件。UUID.randomUUID().toString()
: 生成一个随机的UUID(Universally Unique Identifier,通用唯一识别码),并将其转换为字符串。这是为了确保新文件名的唯一性。originFileName.lastIndexOf(".")
: 调用lastIndexOf()
方法查找原始文件名中最后一个点(.
)的位置。这通常用于找到文件扩展名的起始位置。originFileName.substring(...)
: 调用substring()
方法截取原始文件名中从最后一个点的位置到字符串末尾的部分,这里也就是文件的扩展名。
结果:
上面我们并没有返回URL地址只是模拟了一下才响应给浏览器的,接下来把文件内容存储到阿里云服务器上。
2.文件上传_阿里云OSS_准备工作
刚才(1.本地存储)把上传的文件存储到本地磁盘上,但是这样存储有一些问题,比如上传的图片它无法直接访问;当图片上传的过多时磁盘满了。为了解决这些问题需要把图片上传到云端。
(有人说云是一种商业模式,也有人说云是网络上硬件和软件资源的总和;有人说云------云是互联网上一堆计算机,可以使用这些计算机完成数据运算,文件存储等等,云计算,云短信,云存储都是由互联网上的计算机来完成的。这些计算机由很多像阿里巴巴,华为,百度,网易等等提供。)
我们使用阿里云,阿里云是阿里巴巴集团下全球 领先云计算公司,也是国内最大的云服务提供商。
文件上传这一块需要使用对象存储服务(Object Storage Service)
OSS是一款海量,安全,低成本,高可靠的云存储服务。使用OSS,可以通过网络随时存储和调用包括文本,图片,音频和视频等在内的各种文件。
开通OSS服务之后就不需要把文件存储到服务器的本地磁盘上了,借助阿里云的OSS服务把图片存储到阿里云提供的计算机上就可以了。
使用第三方服务------通用思路
- 准备工作---比如需要在服务提供商的网站上去注册用户并开通对应的服务
- 参照官方SDK编写入门程序---SDK(Software Development Kit),软件开发工具包,包括辅助软件开发依赖(jar包)。代码示例等都可以叫做SDK。引入OSS提供的jar包,并且参照他提供的示例代码来编写程序
- 集成使用---参照入门程序,把该功能集成到我们的程序中,然后再使用。
1.2.
创建bucket
读写权限改为公共读,其他不用修改,点击创建
创建之后 ,点击头像,找到AccessKey管理
继续访问,点击创建AccessKey,得到ACCESS_KEY_ID和ACCESS_KEY_SECRET
回到阿里云对象存储服务,左侧边栏找到SDK下载,点击进去
点击查看文档
在跳出的帮助文档中,点击左下方的在文档中心打开
打开对象/文件.上传文件.简单上传
找到实例代码,复制粘贴到idea中,参照入门程序代码示例修改代码
修改后:(在test包中新建一个Demo.java测试一下)
package org.exampletest;import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
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.File;public class Demo {public static void main(String[] args) throws Exception {// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。String endpoint = "去bucket找到自己的endpoint改为自己的endpoint";// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。// EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();String ACCESS_KEY_ID = "填自己的.....................";String ACCESS_KEY_SECRET = "填自己..........................";// 填写Bucket名称,例如examplebucket。String bucketName = "改为自己的name";// 填写Object完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。String objectName = "fight.jpg";// 填写本地文件的完整路径,例如D:\\localpath\\examplefile.txt。// 如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件。String filePath= "D:\\SpringBootProjects\\files\\fight.jpg";// 创建OSSClient实例。OSS ossClient = new OSSClientBuilder().build(endpoint, ACCESS_KEY_ID, ACCESS_KEY_SECRET);try {// 创建PutObjectRequest对象。PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, new File(filePath));// 如果需要上传时设置存储类型和访问权限,请参考以下示例代码。// ObjectMetadata metadata = new ObjectMetadata();// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());// metadata.setObjectAcl(CannedAccessControlList.Private);// putObjectRequest.setMetadata(metadata);// 上传文件。PutObjectResult result = ossClient.putObject(putObjectRequest);} 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();}}}
}
第三步:集成如下
3.文件上传_阿里云OSS_程序集成
把入门程序的代码改造成工具类,那里需要使用就调用它就可以了
添加一个工具类AliOssUtil.java工具类
把里面不变的量提取出去改为全局静态常量
package org.exampletest.utils;import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
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.File;
import java.io.InputStream;public class AliOssUtil {// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。private static final String ENDPOINT = "自己的。。。。";// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。// EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();private static final String ACCESS_KEY_ID = "自己的。。。。。。";private static final String ACCESS_KEY_SECRET = "自己的。。。。。。";// 填写Bucket名称,例如examplebucket。private static final String BUCKET_NAME= "自己的名字。。。。。。";public static String uploadFile(String objectName, InputStream in) throws Exception {String url="";// 创建OSSClient实例。OSS ossClient = new OSSClientBuilder().build(ENDPOINT, ACCESS_KEY_ID, ACCESS_KEY_SECRET);try {// 创建PutObjectRequest对象。PutObjectRequest putObjectRequest = new PutObjectRequest(BUCKET_NAME, objectName, in);// 如果需要上传时设置存储类型和访问权限,请参考以下示例代码。// ObjectMetadata metadata = new ObjectMetadata();// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());// metadata.setObjectAcl(CannedAccessControlList.Private);// putObjectRequest.setMetadata(metadata);// 上传文件。PutObjectResult result = ossClient.putObject(putObjectRequest);//url组成:https://bucket名称.区域节点/object文件名url= "https://"+BUCKET_NAME+"."+ENDPOINT.substring(ENDPOINT.lastIndexOf("/")+1)+"/"+objectName;} 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();}}return url;}
}
在FileUploadController中修改代码
package org.exampletest.controller;import org.exampletest.pojo.Result;
import org.exampletest.utils.AliOssUtil;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;import java.io.File;
import java.io.IOError;
import java.io.IOException;
import java.util.UUID;@RestController
public class FileUploadController {@PostMapping("/upload")public Result<String> upload(MultipartFile file) throws Exception {//把文件的内容存储到本地磁盘上String originFileName = file.getOriginalFilename();//需要保证文件名字唯一,防止文件被覆盖String fileName = UUID.randomUUID().toString()+originFileName.substring(originFileName.lastIndexOf("."));//file.transferTo(new File("D:\\SpringBootProjects\\files\\"+fileName));String url = AliOssUtil.uploadFile(fileName,file.getInputStream());return Result.success(url);}
}
最后操作成功:
接口到这里就告一段落了!!!!