SpringBootWeb案例

YangeIT大约 42 分钟SpringBootPageHelper前后端协议SpringBootJSON·@ConfigurationProperties

SpringBootWeb案例

今日目标

  • 员工管理
    • 新增员工 ✏️
      • 文件上传(本地上传和oss上传) ✏️
    • 修改员工 ✏️
  • 其他
    • 配置文件
      • yml格式 ✏️
      • @ConfigurationProperties 🍐✏️

知识准备

  1. 能理解controller,service,mapper三个包的含义以及调用顺序
  2. 能完成新增,修改,删除,查询基本操作
  3. 能理解前后端交互是用过JSON格式传递数据的
  4. 能说出HTTP协议的特点,特别是请求和响应的组成部分

api文档

1. 新增员工 🚩

新增员工

image-20221216160009145
image-20221216160009145

在新增用户时,我们需要保存用户的基本信息,并且还需要上传的员工的图片,目前我们先完成第一步操作,保存用户的基本信息。

代码操作

新增员工的具体的流程:

image-20221216170946166
image-20221216170946166

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {

    @Autowired
    private EmpService empService;

    //新增
    @PostMapping
    public Result save(@RequestBody Emp emp){
        //记录日志
        log.info("新增员工, emp:{}",emp);
        //调用业务层新增功能
        empService.save(emp);
        //响应
        return Result.success();
    }

    //省略...
}

课堂作业

  1. mapper接口中的方法,可以重载吗?
  2. 🚩 独自完成新增员工的逻辑,并进行PostMan/APIfox测试,最后在进行前后联调

2. 文件上传 🚩 ✏️ 🍐

文件上传

  1. 新增员工功能中,还存在一个问题:没有头像(图片缺失),怎么解决?
image-20221216200653717
image-20221216200653717

使用文件上传,将图片存储到本地或者阿里云服务器中

需求1:下面我们来验证:删除form表单中enctype属性值,会是什么情况?

  1. 在IDEA中直接使用浏览器打开upload.html页面
image-20221216210643628
image-20221216210643628

接下来,创建后端ploadController,接收前端传过来的图片

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();
    }

}





 






本地存储方式的不足

image-20220904200320964
image-20220904200320964

如果直接存储在服务器的磁盘目录中,存在以下缺点:

  • 不安全:磁盘如果损坏,所有的文件就会丢失
  • 容量有限:如果存储大量的图片,磁盘空间有限(磁盘不可能无限制扩容)
  • 无法直接访问

通常有两种解决方案:

  • 自己搭建存储服务器,如:fastDFS 、MinIO 实用
  • 使用现成的云服务,如:阿里云,腾讯云,华为云简单

总结

课堂作业

  1. 前端上传文件必须满足哪3个要素
  2. 为什么要使用UUID算法给图片重新取名字?🎤
  3. 本地存储的缺点有哪些?🎤
  4. 结合UUID练习一下本地存储

3️⃣2.3 阿里云OSS

阿里云OSS

阿里云是阿里巴巴集团旗下全球领先的云计算公司,也是国内最大的云服务提供商 。

image-20221229093412464
image-20221229093412464

云服务指的就是通过互联网对外提供的各种各样的服务,比如像:语音服务、短信服务、邮件服务、视频直播服务、文字识别服务、对象存储服务等等。

当我们在项目开发时需要用到某个或某些服务,就不需要自己来开发了,可以直接使用阿里云提供好的这些现成服务就可以了。比如:在项目开发当中,我们要实现一个短信发送的功能,如果我们项目组自己实现,将会非常繁琐,因为你需要和各个运营商进行对接。而此时阿里云完成了和三大运营商对接,并对外提供了一个短信服务。我们项目组只需要调用阿里云提供的短信服务,就可以很方便的来发送短信了。这样就降低了我们项目的开发难度,同时也提高了项目的开发效率。(大白话:别人帮我们实现好了功能,我们只要调用即可)

云服务提供商给我们提供的软件服务通常是需要收取一部分费用的。、

阿里云oss对象存储使用步骤

第三方服务使用的通用思路,我们做一个简单介绍之后,接下来我们就来介绍一下我们当前要使用的阿里云oss对象存储服务具体的使用步骤。

image-20221229112451120
image-20221229112451120

Bucket:存储空间是用户用于存储对象(Object,就是文件)的容器,所有的对象都必须隶属于某个存储空间。

下面我们根据之前介绍的使用步骤,完成准备工作:

  1. 注册阿里云账户(注册完成后需要实名认证)
  2. 注册完账号之后,就可以登录阿里云
image-20220904201839857
image-20220904201839857
  1. 通过控制台找到对象存储OSS服务
image-20220904201932884
image-20220904201932884

如果是第一次访问,还需要开通对象存储服务OSS

image-20220904202537579
image-20220904202537579
image-20220904202618423
image-20220904202618423
  1. 开通OSS服务之后,就可以进入到阿里云对象存储的控制台
image-20220904201810832
image-20220904201810832
  1. 点击左侧的 "Bucket列表",创建一个Bucket
image-20220904202235180
image-20220904202235180

大家可以参照"资料\04. 阿里云oss"中提供的文档,开通阿里云OSS服务。点击查看阿里云文档

总结

课堂作业

  1. 阿里云对象存储OSS是什么?有什么用途?🎤
  2. Bucket是什么意思?有什么作用?🎤
  3. 开通阿里云账号,然后创建一个Bucket存储文件。✏️

2.3.2 OSS入门和集成

OSS入门和集成

需求1:创建Bucket后,传入一张本地图片至OSS,然后通过返回的链接,直接访问图片

需求2:集成OSS到项目中

需求1:测试阿里云API

核心步骤

  1. 创建测试工程,引入依赖
  2. 准备测试类
  3. 获取AccessKeyId以及配置工具类AliOSSUtils

参考文档官方open in new window

(1)创建测试工程,引入依赖

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.15.1</version>
</dependency>

需求2:集成OSS到项目中

阿里云oss对象存储服务的准备工作以及入门程序我们都已经完成了,接下来我们就需要在案例当中集成oss对象存储服务,来存储和管理案例中上传的图片。

image-20221229170235632
image-20221229170235632

在新增员工的时候,上传员工的图像,而之所以需要上传员工的图像,是因为将来我们需要在系统页面当中访问并展示员工的图像。而要想完成这个操作,需要做两件事:

  1. 需要上传员工的图像,并把图像保存起来(存储到阿里云OSS)
  2. 访问员工图像(通过图像在阿里云OSS的存储地址访问图像)
    • OSS中的每一个文件都会分配一个访问的url,通过这个url就可以访问到存储在阿里云上的图片。所以需要把url返回给前端,这样前端就可以通过url获取到图像。

集成OSS到项目中代码实现:

引入阿里云OSS上传文件工具类(由官方的示例代码改造而来) 👇 👇

com.xx.utils 工具包

@Component // 表明当前类需要被spring进行实例化,放到ioc容器中
public class AliOSSUtils {
    private String endpoint = "https://oss-cn-shanghai.aliyuncs.com";
    private String accessKeyId = "LTAI5t9MZK8iq5T2Av5GLDxX";
    private String accessKeySecret = "C0IrHzKZGKqU8S7YQcevcotD3Zd5Tc";
    private String bucketName = "web-framework01";

    /**
     * 实现上传图片到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(endpoint, accessKeyId, accessKeySecret);
        ossClient.putObject(bucketName, fileName, inputStream);

        //文件访问路径
        String url = endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName;

        // 关闭ossClient
        ossClient.shutdown();
        return url;// 把上传到oss的路径返回
    }
}

总结

课堂作业

  1. 🚩 注册阿里云账号,开通Oss服务,完成上述服务,并且能够使用清晰的描述出集成oss流程。(可以使用流程图工具进行绘制)

3. 修改员工 🚩

需求

  1. 修改员工信息
image-20220904220001994
image-20220904220001994
image-20220904220001994
image-20220904220001994

步骤:

  1. 根据ID查询员工信息---> 3.1 查询回显
  2. 保存修改的员工信息---> 3.2 修改提交

1️⃣3.1 查询回显 ✏️

查询回显

需求:根据ID查询员工信息

代码操作

  • EmpController
@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {

    @Autowired
    private EmpService empService;

    //根据id查询
    @GetMapping("/{id}")
    public Result getById(@PathVariable Integer id){
        Emp emp = empService.getById(id);
        return Result.success(emp);
    }
    
    //省略...
}

总结

课堂作业

  1. 为什么要回显数据?🎤
  2. 回显数据的传参方式是怎样的?需要配置什么注解?🎤

2️⃣ 3.2 修改员工

修改员工

api文档 👈 可点击查看接口文档

当用户修改完数据之后,点击保存按钮,就需要将数据提交到服务端,然后服务端需要将修改后的数据更新到数据库中。

代码操作

image-20221230171342318
image-20221230171342318
  • EmpController
@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {

    @Autowired
    private EmpService empService;

    //修改员工
    @PutMapping
    public Result update(@RequestBody Emp emp){
        empService.update(emp);
        return Result.success();
    }
    
    //省略...
}

总结

课堂作业

  1. 修改数据需求中,sql的关键字是什么?需不需要条件?🎤
  2. 修改需求和新增需求,在实现上有什么不同?🎤

4. 配置文件 🍐

4.1 优化-参数配置化

优化-参数配置化

image-20221231085558457
  • endpoint //阿里云OSS域名
  • accessKeyID //用户身份ID
  • accessKeySecret //用户密钥
  • bucketName //存储空间的名字

上述写法存在两个问题:

  1. 如果这些参数发生变化了,就必须在源程序代码中改动这些参数,然后需要重新进行代码的编译,将Java代码编译成class字节码文件再重新运行程序。(比较繁琐
  2. 如果我们开发的是一个真实的企业级项目, Java类可能会有很多,如果将这些参数分散的定义在各个Java类当中,我们要修改一个参数值,我们就需要在众多的Java代码当中来定位到对应的位置,再来修改参数,修改完毕之后再重新编译再运行。(参数配置过于分散,是不方便集中的管理和维护

解决方案:将配置信息,放到单独的配置文件中。。

代码操作

1️⃣ 可以将参数配置在配置文件

application.properties文件

#自定义的阿里云OSS配置信息
aliyun.oss.endpoint=https://oss-cn-hangzhou.aliyuncs.com
aliyun.oss.accessKeyId=LTAI4GCH1vX6DKqJWxd6nEuW
aliyun.oss.accessKeySecret=yBshYweHOpqDuhCArrVHwIiBKpyqSL
aliyun.oss.bucketName=web-tlias

4.2 优化-yml配置文件 🍐 ❤️

优化-yml配置文件

前面我们一直使用springboot项目创建完毕后自带的application.properties进行属性的配置,那其实呢,在springboot项目当中是支持多种配置方式的,除了支持properties配置文件以外,还支持另外一种类型的配置文件,就是我们接下来要讲解的yml格式的配置文件。

image-20230102181215809
image-20230102181215809

常见配置文件格式

  • application.properties

    server.port=8080
    server.address=127.0.0.1
    
  • application.yml

    server:
      port: 8080
      address: 127.0.0.1
    
  • application.yaml

    server:
      port: 8080
      address: 127.0.0.1
    

熟悉完了yml文件的基本语法后,我们修改下之前案例中使用的配置文件,变更为application.yml配置方式

代码操作👇

  1. 修改application.properties名字为:_application.properties(名字随便更换,只要加载不到即可)
  2. 创建新的配置文件: application.yml

原有application.properties文件:

image-20230103202630793
image-20230103202630793

新建的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. yml格式的配置文件有哪些优点?🎤
  2. yml格式有哪些注意事项?🎤

4.3 @ConfigurationProperties 🍐

ConfigurationProperties

问题:单独使用@Value的不足之处

image-20230103202919756
image-20230103202919756

我们在application.properties或者application.yml中配置了阿里云OSS的四项参数之后,如果java程序中需要这四项参数数据,我们直接通过@Value注解来进行注入。这种方式本身没有什么问题问题,但是如果说需要注入的属性较多(例:需要20多个参数数据),我们写起来就会比较繁琐。 ⚠️

代码操作

1️⃣ 定义实体类AliOSSProperties

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/*阿里云OSS相关配置*/
@Data
@Component //实例化该类--->IOC容器
@ConfigurationProperties(prefix = "aliyun.oss") //加载配置文件中的配置复赋值
public class AliOSSProperties {
    //区域
    private String endpoint;
    //身份ID
    private String accessKeyId ;
    //身份密钥
    private String accessKeySecret ;
    //存储空间
    private String bucketName;
}







 










在我们添加上注解后,会发现idea窗口上面出现一个红色警告:不影响开发,了解一下

点击查看代码
image-20230103212042823
image-20230103212042823

这个警告提示是告知我们还需要引入一个依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

当我们在pom.xml文件当中配置了这项依赖之后,我们重新启动服务,大家就会看到在properties或者是yml配置文件当中,就会提示阿里云 OSS 相关的配置项。所以这项依赖它的作用就是会自动的识别被@Configuration Properties注解标识的bean对象。

刚才的红色警告,已经变成了一个灰色的提示,提示我们需要重新运行springboot服务

总结

@ConfigurationProperties和@Value的区别

  • 相同点:都是用来注入外部配置的属性的。
  • 不同点
    • @Value注解只能一个一个的进行外部属性的注入。
    • @ConfigurationProperties可以批量的将外部的属性配置注入到bean对象的属性中。

如果要注入的属性非常的多,并且还想做到复用,就可以定义这么一个bean对象 👍👍

通过 configuration properties 批量的将外部的属性配置直接注入到 bin 对象的属性当中。在其他的类当中,我要想获取到注入进来的属性,我直接注入 bin 对象,然后调用 get 方法,就可以获取到对应的属性值了

课堂作业

  1. @ConfigurationProperties和@Value的区别有哪些?🎤
  2. 定义配置实体类的属性名有什么注意事项?

4️⃣4.4 三种配置文件的优先级 原理,了解一下

三种配置文件的优先级

在SpringBoot项目当中,常见的属性配置方式有5种(3配+2外)---优先级(从低到高)

  • application.yaml(忽略)
  • application.yml 企业实用
  • application.properties
  • java系统属性(-Dxxx=xxx)
  • 命令行参数(--xxx=xxx)测试人员实用
  • application.properties
server.port=8081
  • application.yml
server:
   port: 8082
  • application.yaml
server:
   port: 8082

我们启动SpringBoot程序,测试下三个配置文件中哪个Tomcat端口号生效:

  • properties、yaml、yml三种配置文件同时存在
image-20230113144757856
image-20230113144757856

properties、yaml、yml三种配置文件,优先级最高的是properties

  • yaml、yml两种配置文件同时存在
image-20230113145158771
image-20230113145158771

点击查看idea当中运行程序时,如何来指定Java系统属性和命令行参数

那在idea当中运行程序时,如何来指定Java系统属性和命令行参数呢?了解一下

  • 编辑启动程序的配置信息
image-20230113162746634
image-20230113162746634
image-20230113162639630
image-20230113162639630

重启服务,同时配置Tomcat端口(三种配置文件、系统属性、命令行参数),测试哪个Tomcat端口号生效:

image-20230113165006550
image-20230113165006550

删除命令行参数配置,重启SpringBoot服务:

image-20230113170841253
image-20230113170841253

优先级: 命令行参数 > 系统属性参数 > properties参数 > yml参数 > yaml参数

5️⃣4.5 Bean管理 原理,了解一下 🍐

Bean管理

主要学习IOC容器中Bean的其他使用细节,主要学习以下三方面:

  1. 如何从IOC容器手动的获取到bean对象
  2. bean的作用域配置
  3. 管理第三方的bean对象

已经学过的Spring注解

  • 控制反转(IOC)
    • @Component
      • @Controller
      • @Service
      • @Repository
  • 依赖注入(DI)
    • @Autowired

代码演示 👇 👇

  1. 想获取到IOC容器,直接将IOC容器对象ApplicationContext注入进来,
  2. 而在Spring容器中提供了一些方法,可以主动从IOC容器(ApplicationContext)中获取到bean对象,
  3. 下面介绍3种常用方式:
    • 根据name获取bean --Object getBean(String name)
    • 根据类型获取bean --<T> T getBean(Class<T> requiredType)
    • 根据name获取bean(带类型转换)--<T> T getBean(String name, Class<T> requiredType)

测试类:

@SpringBootTest
class SpringbootWebConfig2ApplicationTests {

    @Autowired
    private ApplicationContext applicationContext; //IOC容器对象

    //获取bean对象
    @Test
    public void testGetBean(){
        //根据bean的名称获取
        DeptController bean1 = (DeptController) applicationContext.getBean("deptController");
        System.out.println(bean1);

        //根据bean的类型获取
        DeptController bean2 = applicationContext.getBean(DeptController.class);
        System.out.println(bean2);

        //根据bean的名称 及 类型获取
        DeptController bean3 = applicationContext.getBean("deptController", DeptController.class);
        System.out.println(bean3);
    }
}










 



 



 



程序运行后控制台日志:

image-20230113211619818
image-20230113211619818

问题:输出的bean对象地址值是一样的,说明IOC容器当中的bean对象有几个?

答案:只有一个。 (默认情况下,IOC中的bean对象是单例)

那么能不能将bean对象设置为非单例的(每次获取的bean都是一个新对象)?

可以,在下一个知识点(bean作用域)中讲解。

注意事项:

  • 上述所说的 【Spring项目启动时,会把其中的bean都创建好】还会受到作用域及延迟初始化影响,这里主要针对于默认的单例非延迟加载的bean而言。

总结

  1. 想获取到IOC容器,直接将IOC容器对象ApplicationContext注入进来
  2. 默认bean对象是单例模式(只有一个实例对象)。
  3. 在方法上加上一个@Bean注解,Spring 容器在启动的时候,它会自动的调用这个方法,并将方法的返回值声明为Spring容器当中的Bean对象
  4. 如果不指定bean的名字,默认bean的名称就是方法名。

课堂作业

  1. @Bean的作用是什么,使用原则是什么?🎤

课后作业

🚩 1. 重点完成上述的课堂作业

  1. 晚自习第一节课的前30分钟,总结完毕之后,每个同学先必须梳理今日知识点 (记得写不知道的,以及感恩三件事);整理好的笔记可以发给组长,组长交给班长,意在培养大家总结的能力)

  2. 晚自习第一节课的后30分钟开始练习(记住:程序员是代码堆起来的):

    • 先要把今天的所有案例或者课堂练习,如果没练完的,练完他
    • 独立书写今日作业 Day11作业👈
  3. 剩余的时间:预习第二天的知识,预习的时候一定要注意:

  • 预习不是学习,不要死看第二天的视频(很容易出现看了白看,为了看视频而看视频)
  • 预习看第二天的笔记,把笔记中标注重要的知识,可以找到预习视频,先看一遍,如果不懂的 ,记住做好标注。