-
SpringBootWeb案例——Tlias智能学习辅助系统(2)
前一节已经实现了员工信息的条件分页查询以及删除操作。
这一节继续完成新增员工、文件上传、修改员工、配置文件的功能。新增员工
在新增用户时，我们需要保存用户的基本信息，并且还需要上传的员工的图片，目前我们先完成第一步操作，保存用户的基本信息。
- 基本信息
请求路径：/emps 请求方式：POST 接口描述：该接口用于添加员工的信息- 1
- 2
- 3
请求参数样例：
{ "image": "https://web-framework.oss-cnhangzhou. aliyuncs.com/2022-09-03-07-37-38222.jpg", "username": "linpingzhi", "name": "林平之", "gender": 1, "job": 1, "entrydate": "2022-09-18", "deptId": 1 } 其中username name gender 为必须参数 其他可缺省- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
怎么在controller中接收json格式的请求参数：@RequestBody //把前端传递的json数据填充到实体类中
忘记了就回顾一下SpringBoot Web请求响应
EmpController
//新增员工 @PostMapping public Result save(@RequestBody Emp emp){ //记录日志 log.info("新增员工, emp:{}",emp); //调用业务层新增功能 empService.save(emp); //响应 return Result.success(); }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
EmpServiceImpl
@Override public void save(Emp emp) { //补全数据 emp.setCreateTime(LocalDateTime.now()); emp.setUpdateTime(LocalDateTime.now()); //调用添加方法 empMapper.insert(emp); }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
EmpMapper
//新增员工 @Insert("insert into emp (username, name, gender, image, job, entrydate, dept_id, create_time, update_time) " + "values (#{username}, #{name}, #{gender}, #{image}, #{job}, #{entrydate}, #{deptId}, #{createTime}, #{updateTime});") void insert(Emp emp);- 1
- 2
- 3
- 4
文件上传
简介
在我们完成的新增员工功能中，还存在一个问题：没有头像(图片缺失)
首先我们先对文件上传做一个整体的介绍，接着再学习文件上传的本地存储方式，最后学习云存储方式。想要完成文件上传这个功能需要涉及到两个部分：
- 前端程序
- 服务端程序
我们先来看看在前端程序中要完成哪些代码：
<form action="/upload" method="post" enctype="multipart/form-data"> 姓名: <input type="text" name="username"><br> 年龄: <input type="text" name="age"><br> 头像: <input type="file" name="image"><br> <input type="submit" value="提交"> form>- 1
- 2
- 3
- 4
- 5
- 6
上传文件的原始form表单，要求表单必须具备以下三点（上传文件页面三要素）：
-
表单必须有file域，用于选择要上传的文件
<input type="file" name="image"/>- 1
-
表单提交方式必须为POST
通常上传的文件会比较大，所以需要使用 POST 提交方式
-
表单的编码类型enctype必须要设置为：multipart/form-data
普通默认的编码格式是不适合传输大型的二进制数据的，所以在文件上传时，表单的编码格式必须设置为multipart/form-data
写一个前端页面来验证一下：
DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>上传文件title> head> <body> <form action="/upload" method="post" enctype="multipart/form-data"> 姓名: <input type="text" name="username"><br> 年龄: <input type="text" name="age"><br> 头像: <input type="file" name="image"><br> <input type="submit" value="提交"> form> body> html>- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
删除form表单中enctype属性值，会是什么情况？
点击"提交"按钮，进入到开发者模式观察
再来验证：设置form表单中enctype属性值为multipart/form-data，会是什么情况？
那我们的后端程序又是如何实现的呢？
-
首先在服务端定义这么一个controller，用来进行文件上传，然后在controller当中定义一个方法来处理/upload 请求(请求路径随便定义, 前后端统一即可)
-
在定义的方法中接收提交过来的数据 （方法中的形参名和请求参数的名字保持一致）
- 用户名：String name
- 年龄： Integer age
- 文件： MultipartFile image
Spring中提供了一个API：MultipartFile，使用这个API就可以来接收到上传的文件
问题：如果表单项的名字和方法中形参名不一致，该怎么办？
解决：使用@RequestParam注解进行参数绑定-
public Result upload(String username, Integer age, @RequestParam("image") MultipartFile file)- 1
- 2
- 3
UploadController
@Slf4j @RestController public class UploadController { @PostMapping("/upload") public Result upload(String username, Integer age, MultipartFile image) { log.info("文件上传：{},{},{}",username,age,image); return Result.success(); } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
后端程序编写完成之后，打个断点，以debug方式启动SpringBoot项目
打开浏览器输入：http://localhost:8080/upload.html ， 录入数据并提交
通过后端程序控制台可以看到，上传的文件是存放在一个临时目录
打开临时目录可以看到以下内容：
表单提交的三项数据(姓名、年龄、文件)，分别存储在不同的临时文件中：
当我们程序运行完毕之后，这个临时文件会自动删除。
所以，我们如果想要实现文件上传，需要将这个临时文件，要转存到我们的磁盘目录中。
本地存储
下面呢，我们就需要完成将上传的文件保存在服务器的本地磁盘上。
代码实现：
- 在服务器本地磁盘上创建images目录，用来存储上传的文件（例：E盘创建images目录）
- 使用MultipartFile类提供的API方法，把临时文件转存到本地磁盘目录下
MultipartFile 常见方法：
- String getOriginalFilename(); //获取原始文件名
- void transferTo(File dest); //将接收的文件转存到磁盘文件中
- long getSize(); //获取文件的大小，单位：字节
- byte[] getBytes(); //获取文件内容的字节数组
- InputStream getInputStream(); //获取接收到的文件内容的输入流
UploadController
@Slf4j @RestController public class UploadController { @PostMapping("/upload") public Result upload(String username, Integer age, MultipartFile image) throws IOException { log.info("文件上传：{},{},{}",username,age,image); //获取原始文件名 String originalFilename = image.getOriginalFilename(); //将文件存储在服务器的磁盘目录 image.transferTo(new File("E:/images/"+originalFilename)); return Result.success(); } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
利用postman测试，注意：请求参数名和controller方法形参名保持一致
通过postman测试，我们发现文件上传是没有问题的。但是由于我们是使用原始文件名作为所上传文件
的存储名字，当我们再次上传一个名为1.jpg文件时，发现会把之前已经上传成功的文件覆盖掉。解决方案：保证每次上传文件时文件名都唯一的（使用UUID获取随机文件名）
@Slf4j @RestController public class UploadController { @PostMapping("/upload") public Result upload(String username, Integer age, MultipartFile image) throws IOException { log.info("文件上传：{},{},{}",username,age,image); //获取原始文件名 String originalFilename = image.getOriginalFilename(); //构建新的文件名 String extname = originalFilename.substring(originalFilename.lastIndexOf("."));//文件扩展名 String newFileName = UUID.randomUUID().toString()+extname;//随机名+文件扩展名 //将文件存储在服务器的磁盘目录 image.transferTo(new File("E:/images/"+newFileName)); return Result.success(); } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
在解决了文件名唯一性的问题后，我们再次上传一个较大的文件(超出1M)时发现，后端程序报错：
因为：在SpringBoot中，文件上传时默认单个文件最大大小为1M
那么如果需要上传大文件，可以在application.properties进行如下配置：#配置单个文件最大上传大小 spring.servlet.multipart.max-file-size=10MB #配置单个请求最大上传大小(一次请求可以上传多个文件) spring.servlet.multipart.max-request-size=100MB- 1
- 2
- 3
- 4
- 5
到此，我们文件上传的本地存储方式已完成了。但是这种本地存储方式还存在问题：
如果直接存储在服务器的磁盘目录中，存在以下缺点：
- 不安全：磁盘如果损坏，所有的文件就会丢失
- 容量有限：如果存储大量的图片，磁盘空间有限(磁盘不可能无限制扩容)
- 无法直接访问
为了解决上述问题呢，通常有两种解决方案：
- 自己搭建存储服务器，如：fastDFS 、MinIO
- 使用现成的云服务，如：阿里云，腾讯云，华为云
阿里云OSS介绍与入门
阿里云是国内最大的云服务提供商。当我们在项目开发时需要用到某个或某些服务，就不需要自己来开发了，可以直接使用阿里云提供好的这些现成服务就可以了,如阿里云提供的短信服务。这样就降低了我们项目的开发难度，同时也提高了项目的开发效率。
阿里云对象存储OSS（Object Storage Service），是一款海量、安全、低成本、高可靠的云存储服务。使用OSS，您可以通过网络随时存储和调用包括文本、图片、音频和视频等在内的各种文件。
在我们使用了阿里云OSS对象存储服务之后，我们的项目当中如果涉及到文件上传这样的业务，在前端进行文件上传并请求到服务端时，在服务器本地磁盘当中就不需要再来存储文件了。我们直接将接收到的文件上传到oss，由 oss帮我们存储和管理，同时阿里云的oss存储服务还保障了我们所存储内容的安全可靠。
我们主要学习的是如何在项目当中来使用云服务完成具体的业务功能。无论使用什么样的云服务阿里云也好，腾讯云、华为云也罢操作的思路都是一样的：
SDK：Software Development Kit 的缩写，软件开发工具包，包括辅助软件开发的依赖（jar包）、代码示例等，都可以叫做SDK。
简单说，sdk中包含了我们使用第三方云服务时所需要的依赖，以及一些示例代码。我们可以参照sdk所提供的示例代码就可以完成入门程序。
介绍一下我们当前要使用的阿里云oss对象存储服务具体的使用步骤。
Bucket：用户用于存储对象（Object，就是文件）的容器，所有的对象都必须隶属于某个存储空间。
注册阿里云账户（注册完成后需要实名认证）后就可以登录阿里云
如果是第一次访问，还需要开通对象存储服务OSS。开通OSS服务之后，就可以进入到阿里云对象存储的控制台。
点击左侧的 “Bucket列表”，创建一个Bucket
阿里云oss 对象存储服务的准备工作我们已经完成了，接下来我们就来完成第二步操作：参照官方所提供的sdk示例来编写入门程序。在官方文档中找到 SDK 的示例代码：
如果是在实际开发当中，我们是需要从前往后仔细的去阅读这一份文档的。
参照官方提供的SDK，改造一下，即可实现文件上传功能，上传前要按照Java配置访问凭证的流程，获取AccessKey，配置一下环境变量。
AccessKey ：
public class Demo { public static void main(String[] args) throws Exception { // Endpoint以华北2（北京）为例，其它Region请按实际情况填写。 String endpoint = "https://oss-cn-beijing.aliyuncs.com"; // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); // 填写Bucket名称，例如examplebucket。 String bucketName = "web-tx-36"; // 填写Object完整路径，例如exampledir/exampleobject.txt，代表目标文件传输到buceket时的保存路径。Object完整路径中不能包含Bucket名称。 String objectName = "exampledir/中国梦.txt"; // 填写本地文件的完整路径，例如D:\\localpath\\examplefile.txt。 // 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件流。 String filePath= "E:\\images\\中国梦.txt"; // 创建OSSClient实例。 OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider); try { InputStream inputStream = new FileInputStream(filePath); // 创建PutObjectRequest对象。 PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, inputStream); // 设置该属性可以返回response。如果不设置，则返回的response为空。 putObjectRequest.setProcess("true"); // 创建PutObject请求。 PutObjectResult result = ossClient.putObject(putObjectRequest); // 如果上传成功，则返回200。 System.out.println(result.getResponse().getStatusCode()); } 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(); } } } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
运行以上程序后，会把本地的文件上传到阿里云OSS服务器上：
项目集成阿里云(难点)
接下来我们就需要在案例当中集成oss对象存储服务，来存储和管理案例中上传的图片。
OSS中的每一个文件都会分配一个访问的url，通过这个url就可以访问到存储在阿里云上的图片。所以需要把url返回给前端，这样前端就可以通过url获取到图像，然后前端再调用新增员工api的时候存储的图片就是存储url。
- 基本信息
请求路径：/upload 请求方式：POST 接口描述：上传图片接口- 1
- 2
- 3
请求参数格式：multipart/form-data- 1
响应数据样例：
{ "code": 1, "msg": "success", "data": "https://web-framework.oss-cnhangzhou.aliyuncs.com/2022-09-02-00-27-0400.jpg" }- 1
- 2
- 3
- 4
- 5
引入阿里云OSS上传文件工具类AliOSSUtils（由官方的示例代码改造而来）
@Component public class AliOSSUtils { // Endpoint以华北2（北京）为例，其它Region请按实际情况填写。 String endpoint = "https://oss-cn-beijing.aliyuncs.com"; // 填写Bucket名称，例如examplebucket。 String bucketName = "web-tx-36"; public String upload(MultipartFile multipartFile) throws Exception { // 获取上传的文件的输入流 InputStream inputStream = multipartFile.getInputStream(); // 避免文件覆盖 String originalFilename = multipartFile.getOriginalFilename(); String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf(".")); //上传文件到 OSS // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider(); // 创建OSSClient实例。 OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider); ossClient.putObject(bucketName, fileName, inputStream); //文件访问路径 String url = endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName; // 关闭ossClient ossClient.shutdown(); return url;// 把上传到oss的路径返回 } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
修改UploadController代码：
@Slf4j @RestController public class UploadController { @Autowired private AliOSSUtils aliOSSUtils; @PostMapping("/upload") public Result upload(String username, Integer age, MultipartFile image) throws Exception { //调用阿里云OSS工具类，将上传上来的文件存入阿里云 String url = aliOSSUtils.upload(image); //将图片上传完成后的url返回，用于浏览器回显展示 return Result.success(url); } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
使用postman测试：
前端测试：
新增员工，添加头像后，后端可以给前端返回图片url并显示在前端页面。
修改员工
在进行修改员工信息的时候，我们首先先要根据员工的ID查询员工的信息用于页面回显展示，然后用户
修改员工数据之后，点击保存按钮，就可以将修改的数据提交到服务端，保存到数据库。 具体操作
为：- 根据ID查询员工信息
- 保存修改的员工信息
查询回显
- 基本信息
请求路径：/emps/{id} 请求方式：GET 接口描述：该接口用于根据主键ID查询员工的信息- 1
- 2
- 3
请求参数样例：
/emps/1- 1
响应数据样例：
{ "code": 1, "msg": "success", "data": { "id": 2, "username": "zhangwuji", "password": "123456", "name": "张无忌", "gender": 1, "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg", "job": 2, "entrydate": "2015-01-01", "deptId": 2, "createTime": "2022-09-01T23:06:30", "updateTime": "2022-09-02T00:29:04" } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
EmpController
//根据id查询员工 @GetMapping("/{id}") public Result getById(@PathVariable Integer id){ Emp emp = empService.getById(id); return Result.success(emp); }- 1
- 2
- 3
- 4
- 5
- 6
EmpServiceImpl
@Override public Emp getById(Integer id) { return empMapper.findById(id); }- 1
- 2
- 3
- 4
EmpMapper
//根据ID查询员工信息 @Select("select * from emp where id = #{id}") Emp findById(Integer id);- 1
- 2
- 3
postman测试:
前端编辑界面可以返回员工数据：
修改员工
当用户修改完数据之后，点击保存按钮，就需要将数据提交到服务端，然后服务端需要将修改后的数据更新到数据库中。
由于可能只修改部分字段，所以需要使用xml来写动态sql- 基本信息
请求路径：/emps 请求方式：PUT 接口描述：该接口用于修改员工的数据信息- 1
- 2
- 3
请求参数样例：
{ "id": 1, "image": "https://web-framework.oss-cnhangzhou.aliyuncs.com/2022-09-03-07-37-38222.jpg", "username": "linpingzhi", "name": "林平之", "gender": 1, "job": 1, "entrydate": "2022-09-18", "deptId": 1 }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
EmpController
//修改员工 @PutMapping public Result update(@RequestBody Emp emp){ empService.update(emp); return Result.success(); }- 1
- 2
- 3
- 4
- 5
- 6
EmpServiceImpl
@Override public void update(Emp emp) { emp.setUpdateTime(LocalDateTime.now()); //更新修改时间为当前时间 empMapper.update(emp); }- 1
- 2
- 3
- 4
- 5
EmpMapper
//修改员工信息 public void update(Emp emp);- 1
- 2
EmpMapper.xml
<update id="update"> update emp <set> <if test="username != null and username != ''"> username = #{username}, if> <if test="password != null and password != ''"> password = #{password}, if> <if test="name != null and name != ''"> name = #{name}, if> <if test="gender != null"> gender = #{gender}, if> <if test="image != null and image != ''"> image = #{image}, if> <if test="job != null"> job = #{job}, if> <if test="entrydate != null"> entrydate = #{entrydate}, if> <if test="deptId != null"> dept_id = #{deptId}, if> <if test="updateTime != null"> update_time = #{updateTime} if> set> where id = #{id} update>- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
postman测试:
前端测试：
配置文件
员工管理的增删改查功能我们已开发完成，但在我们所开发的程序中还一些小问题。
参数配置化(@Value)
在我们之前编写的程序中进行文件上传时，需要调用AliOSSUtils工具类，将文件上传到阿里云OSS对象存储服务当中。而在调用工具类进行文件上传时，需要一些参数：
endpoint //阿里云OSS域名
bucketName //存储空间的名字
…关于以上的这些阿里云相关配置信息，我们是直接写死在java代码中了(硬编码)，如果这些参数发生变化了，就必须在源程序代码中改动这些参数，并且将这些参数分散的定义在各个Java类当中，我们要修改一个参数值，我们就需要在众多的Java代码当中来定位到对应的位置。
为了解决以上分析的问题，我们可以将参数配置在配置文件中。如下：
#自定义的阿里云OSS配置信息 aliyun.oss.endpoint=https://oss-cn-hangzhou.aliyuncs.com aliyun.oss.bucketName=web-tlias ...- 1
- 2
- 3
- 4
springboot程序在启动时会默认读取application.properties配置文件，而我们可以使用一个现成的注解：@Value，获取配置文件中的数据。具体用法为：
@Value("${配置文件中的key}")- 1
@Component public class AliOSSUtils { @Value("${aliyun.oss.endpoint}") private String endpoint; @Value("${aliyun.oss.bucketName}") private String bucketName; //省略其他代码... }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
使用postman测试：
yml配置文件
除了支持properties配置文件以外，springboot还
支持另外一种类型的配置文件——yml格式的配置文件。yml 格式的配置文件，后缀名有两种：yml （推荐）、yaml，格式都一样。
yml配置文件的基本语法：
- 大小写敏感
- 数值前边必须有空格，作为分隔符
- 使用缩进表示层级关系，缩进时，不允许使用Tab键，只能用空格（idea中会自动将Tab转换为空格）
- 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
#表示注释，从这个字符一直到行尾，都会被解析器忽略
yml文件中最为常见的两类数据格式：
对象/Map集合
user: name: zhangsan age: 18 password: 123456- 1
- 2
- 3
- 4
数组/List/Set集合
hobby: - java - game - sport- 1
- 2
- 3
- 4
熟悉完了yml文件的基本语法后，我们修改下之前案例中使用的配置文件，变更为application.yml配置方式：
- 修改application.properties名字为：
_application.properties（名字随便更换，只要加载不到即可） - 创建新的配置文件：
application.yml
原有application.properties文件：
新建的application.yml文件：
spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/tlias username: root password: 1234 servlet: multipart: max-file-size: 10MB max-request-size: 100MB mybatis: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl map-underscore-to-camel-case: true aliyun: oss: endpoint: https://oss-cn-hangzhou.aliyuncs.com accessKeyId: LTAI4GCH1vX6DKqJWxd6nEuW accessKeySecret: yBshYweHOpqDuhCArrVHwIiBKpyqSL bucketName: web-397- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
@ConfigurationProperties
先来看一个场景，分析下代码当中可能存在的问题：
我们在application.properties或者application.yml中配置了阿里云OSS的四项参数之后，如果java程序中需要这四项参数数据，我们直接通过@Value注解来进行注入。这种方式本身没有什么问题问题，但是如果说需要注入的属性较多(例：需要20多个参数数据)，我们写起来就会比较繁琐。
Spring提供的简化方式套路：
-
创建一个实现类，且实体类中的属性名和配置文件当中key的名字一致
比如：配置文件当中叫endpoints，实体类当中的属性也得叫endpoints，另外实体类当中的属性还需要提供 getter / setter方法
-
需要将实体类交给Spring的IOC容器管理，成为IOC容器当中的bean对象
-
在实体类上添加
@ConfigurationProperties注解，并通过prefix属性来指定配置参数项的前缀
实体类：AliOSSProperties
import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; /*阿里云OSS相关配置*/ @Data @Component @ConfigurationProperties(prefix = "aliyun.oss") public class AliOSSProperties { //区域 private String endpoint; //身份ID private String accessKeyId ; //身份密钥 private String accessKeySecret ; //存储空间 private String bucketName; }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
完成上述操作后，修改AliOSSUtils工具类，注入配置参数实体类对象，并将原来使用其属性值的地方改成由参数实体类对象获取属性值(getter函数)。
AliOSSUtils工具类：
@Component //当前类对象由Spring创建和管理 public class AliOSSUtils { //注入配置参数实体类对象 @Autowired private AliOSSProperties aliOSSProperties; /** * 实现上传图片到OSS */ public String upload(MultipartFile multipartFile) throws IOException { // 获取上传的文件的输入流 InputStream inputStream = multipartFile.getInputStream(); // 避免文件覆盖 String originalFilename = multipartFile.getOriginalFilename(); String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf(".")); //上传文件到 OSS OSS ossClient = new OSSClientBuilder().build(aliOSSProperties.getEndpoint(), aliOSSProperties.getAccessKeyId(), aliOSSProperties.getAccessKeySecret()); ossClient.putObject(aliOSSProperties.getBucketName(), fileName, inputStream); //文件访问路径 String url =aliOSSProperties.getEndpoint().split("//")[0] + "//" + aliOSSProperties.getBucketName() + "." + aliOSSProperties.getEndpoint().split("//")[1] + "/" + fileName; // 关闭ossClient ossClient.shutdown(); return url;// 把上传到oss的路径返回 } } }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
在我们添加上注解后，idea窗口弹出红色警告：
是告知我们未配置Spring Boot配置注解处理器，还需要引入一个依赖：
<dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-configuration-processorartifactId> dependency>- 1
- 2
- 3
- 4
在pom.xml中配置了这项依赖之后，重新启动服务，就会看到在properties或者是yml配置文件当中，就会提示阿里云 OSS 相关的配置项。所以这项依赖它的作用就是会自动的识别被
@ConfigurationProperties注解标识的bean对象。刚才的红色警告，已经变成了一个灰色的提示，提示我们需要重新运行springboot服务
区分一下@ConfigurationProperties注解以及我们前面所介绍的另外一个@Value注解：
相同点：都是用来注入外部配置的属性的。
不同点：
-
@Value注解只能一个一个的进行外部属性的注入。
-
@ConfigurationProperties可以批量的将外部的属性配置注入到bean对象的属性中。
如果要注入的属性非常的多，并且还想做到复用，就可以定义这么一个bean对象。通过 configuration properties 批量的将外部的属性配置直接注入到 bean 对象的属性当中。在其他的类当中，我要想获取到注入进来的属性，我直接注入 bean 对象，然后调用 get 方法，就可以获取到对应的属性值了
在后期学习微服务使用nacos配置热更新时，可以知道，@ConfigurationProperties可以使得在修改nacos中的配置后，微服务中无需重启即可让配置生效。
-
相关阅读:
MySQL进阶（B）
使用AssertJ让单元测试和TDD更加简单
Spring Boot 3 整合 xxl-job 实现分布式定时任务调度，结合 Docker 容器化部署（图文指南）
什么是final修饰 使用final修饰类、方法、变量的区别？
linux写文件如何保证落盘？
核范数，schatten p范数比较
PyTorch之张量的相关操作大全 -＞（个人学习记录笔记）
3线硬件SPI+DMA驱动 HX8347 TFT屏-快速显示文字
市场人员被 CEO、销售要求去证明“数量指标”作用的现象越来越常见
一起学数据结构（5）——栈和队列
- 原文地址：https://blog.csdn.net/weixin_43739821/article/details/134167594
