# 1\. 了解SpringBoot
在这一部分,我们主要了解以下3个问题:
* 什么是SpringBoot
* 为什么要学习SpringBoot
* SpringBoot的特点
## 1.1.什么是SpringBoot
SpringBoot是Spring项目中的一个子工程,与我们所熟知的Spring-framework 同属于spring的产品:
我们可以看到下面的一段介绍:
> Takes an opinionated view of building production-ready Spring applications. Spring Boot favors convention over configuration and is designed to get you up and running as quickly as possible.
翻译一下:
> 用一些固定的方式来构建生产级别的spring应用。Spring Boot 推崇约定大于配置的方式以便于你能够尽可能快速的启动并运行程序。
其实人们把Spring Boot 称为搭建程序的`脚手架`。其最主要作用就是帮我们快速的构建庞大的spring项目,并且尽可能的减少一切xml配置,做到开箱即用,迅速上手,让我们关注与业务而非配置。
## 1.2.为什么要学习SpringBoot
java一直被人诟病的一点就是臃肿、麻烦。当我们还在辛苦的搭建项目时,可能Python程序员已经把功能写好了,究其原因注意是两点:
* 复杂的配置
项目各种配置其实是开发时的损耗, 因为在思考 Spring 特性配置和解决业务问题之间需要进行思维切换,所以写配置挤占了写应用程序逻辑的时间。
* 一个是混乱的依赖管理
项目的依赖管理也是件吃力不讨好的事情。决定项目里要用哪些库就已经够让人头痛的了,你还要知道这些库的哪个版本和其他库不会有冲突,这难题实在太棘手。并且,依赖管理也是一种损耗,添加依赖不是写应用程序代码。一旦选错了依赖的版本,随之而来的不兼容问题毫无疑问会是生产力杀手。
而SpringBoot让这一切成为过去!
> Spring Boot 简化了基于Spring的应用开发,只需要“run”就能创建一个独立的、生产级别的Spring应用。Spring Boot为Spring平台及第三方库提供开箱即用的设置(提供默认设置,存放默认配置的包就是启动器starter),这样我们就可以简单的开始。多数Spring Boot应用只需要很少的Spring配置。
我们可以使用SpringBoot创建java应用,并使用java –jar 启动它,就能得到一个生产级别的web工程。
## 1.3.SpringBoot的特点
Spring Boot 主要目标是:
* 为所有 Spring 的开发者提供一个非常快速的、广泛接受的入门体验
* 开箱即用(启动器starter-其实就是SpringBoot提供的一个jar包),但通过自己设置参数(.properties),即可快速摆脱这种方式。
* 提供了一些大型项目中常见的非功能性特性,如内嵌服务器、安全、指标,健康检测、外部化配置等
* 绝对没有代码生成,也无需 XML 配置。
更多细节,大家可以到[官网](http://projects.spring.io/spring-boot/)查看。
# 2.快速入门
接下来,我们就来利用SpringBoot搭建一个web工程,体会一下SpringBoot的魅力所在!
## 2.1.创建工程
我们先新建一个空的工程:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1531270595638.png?lastModify=1649173481)
项目信息:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1531283966656.png?lastModify=1649173481)
地址:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1531283988110.png?lastModify=1649173481)
## 2.2.添加依赖
看到这里很多同学会有疑惑,前面说传统开发的问题之一就是依赖管理混乱,怎么这里我们还需要管理依赖呢?难道SpringBoot不帮我们管理吗?
别着急,现在我们的项目与SpringBoot还没有什么关联。SpringBoot提供了一个名为spring-boot-starter-parent的工程,里面已经对各种常用依赖(并非全部)的版本进行了管理,我们的项目需要以这个项目为父工程,这样我们就不用操心依赖的版本问题了,需要什么依赖,直接引入坐标即可!
### 2.2.1.添加父工程坐标
~~~
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
</parent>
~~~
### 2.2.2.添加web启动器
为了让SpringBoot帮我们完成各种自动配置,我们必须引入SpringBoot提供的自动配置依赖,我们称为`启动器`。因为我们是web项目,这里我们引入web启动器:
~~~
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
~~~
需要注意的是,我们并没有在这里指定版本信息。因为SpringBoot的父工程已经对版本进行了管理了。
这个时候,我们会发现项目中多出了大量的依赖:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525486980765.png?lastModify=1649173481)
这些都是SpringBoot根据spring-boot-starter-web这个依赖自动引入的,而且所有的版本都已经管理好,不会出现冲突。
### 2.2.3.管理jdk版本
如果我们想要修改SpringBoot项目的jdk版本,只需要简单的添加以下属性即可,如果没有需求,则不添加。
~~~
<properties>
<java.version>1.8</java.version>
</properties>
~~~
### 2.2.4.完整pom
~~~
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.leyou.demo</groupId>
<artifactId>springboot-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<java.version>1.8</java.version>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>
~~~
## 2.3.启动类
Spring Boot项目通过main函数即可启动,我们需要创建一个启动类:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525487293907.png?lastModify=1649173481)
然后编写main函数:
~~~
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
~~~
## 2.4.编写controller
接下来,我们就可以像以前那样开发SpringMVC的项目了!
我们编写一个controller:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525487465325.png?lastModify=1649173481)
代码:
~~~
@RestController
public class HelloController {
@GetMapping("hello")
public String hello(){
return "hello, spring boot!";
}
}
~~~
## 2.5.启动测试
接下来,我们运行main函数,查看控制台:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525487613365.png?lastModify=1649173481)
并且可以看到监听的端口信息:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525487705460.png?lastModify=1649173481)
* 1)监听的端口是8080
* 2)SpringMVC的映射路径是:/
* 3)`/hello`路径已经映射到了`HelloController`中的`hello()`方法
打开页面访问:[http://localhost:8080/hello](http://localhost:8080/hello)
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525487820824.png?lastModify=1649173481)
测试成功了!
## 2.6. SpringBoot的项目模板
自己搭建SpringBoot项目需要编写启动类、pom、测试类等内容,虽然已经很简洁,但是也会消耗时间。所以Spring提供了一套快速搭建项目的脚手架,非常方便:
1)创建新工程,选择spring方式:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877758683.png?lastModify=1649173481)
2)编写项目信息
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877779795.png?lastModify=1649173481)
3)勾选所需依赖
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877832623.png?lastModify=1649173481)
4)填写项目路径:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877864914.png?lastModify=1649173481)
这样就可以得到完整项目,并且依赖、配置、启动类、测试类等都已经自动完成:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877914333.png?lastModify=1649173481)
pom文件:
~~~
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.itcast.demo</groupId>
<artifactId>boot-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>boot-demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-solr</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
~~~
# 3.Java配置
在入门案例中,我们没有任何的配置,就可以实现一个SpringMVC的项目了,快速、高效!
但是有同学会有疑问,如果没有任何的xml,那么我们如果要配置一个Bean该怎么办?比如我们要配置一个数据库连接池,以前会这么玩: SpEL ${}
~~~
<!-- 配置连接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
init-method="init" destroy-method="close">
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</bean>
~~~
现在该怎么做呢?
## 3.1.回顾历史
事实上,在Spring3.0开始,Spring官方就已经开始推荐使用java配置来代替传统的xml配置了,我们不妨来回顾一下Spring的历史:
* Spring1.0时代
在此时因为jdk1.5刚刚出来,注解开发并未盛行,因此一切Spring配置都是xml格式,想象一下所有的bean都用xml配置,细思极恐啊,心疼那个时候的程序员2秒
* Spring2.0时代
Spring引入了注解开发,但是因为并不完善,因此并未完全替代xml,此时的程序员往往是把xml与注解进行结合,貌似我们之前都是这种方式。
* Spring3.0及以后
3.0以后Spring的注解已经非常完善了,因此Spring推荐大家使用完全的java配置来代替以前的xml,不过似乎在国内并未推广盛行。然后当SpringBoot来临,人们才慢慢认识到java配置的优雅。
有句古话说的好:拥抱变化,拥抱未来。所以我们也应该顺应时代潮流,做时尚的弄潮儿,一起来学习下java配置的玩法。
## 3.2.尝试java配置
java配置主要靠java类和一些注解,比较常用的注解有:
* `@Configuration`:声明一个类作为配置类,代替xml文件
* `@Bean`:声明在方法上,将方法的返回值加入Bean容器,代替`<bean>`标签
* `@Value`:属性注入
* `@PropertySource`:指定外部属性文件,
我们接下来用java配置来尝试实现连接池配置:
首先引入Druid连接池依赖:
~~~
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.6</version>
</dependency>
~~~
创建一个jdbc.properties文件,编写jdbc属性:
~~~
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/leyou
jdbc.username=root
jdbc.password=123
~~~
然后编写代码:
~~~
@Configuration
@PropertySource("classpath:jdbc.properties")
public class JdbcConfig {
@Value("${jdbc.url}")
String url;
@Value("${jdbc.driverClassName}")
String driverClassName;
@Value("${jdbc.username}")
String username;
@Value("${jdbc.password}")
String password;
@Bean
public DataSource dataSource() {
DruidDataSource dataSource = new DruidDataSource();
dataSource.setUrl(url);
dataSource.setDriverClassName(driverClassName);
dataSource.setUsername(username);
dataSource.setPassword(password);
return dataSource;
}
}
~~~
解读:
* `@Configuration`:声明我们`JdbcConfig`是一个配置类
* `@PropertySource`:指定属性文件的路径是:`classpath:jdbc.properties`
* 通过`@Value`为属性注入值
* 通过@Bean将 `dataSource()`方法声明为一个注册Bean的方法,Spring会自动调用该方法,将方法的返回值加入Spring容器中。
然后我们就可以在任意位置通过`@Autowired`注入DataSource了!
我们在`HelloController`中测试:
~~~
@RestController
public class HelloController {
@Autowired
private DataSource dataSource;
@GetMapping("hello")
public String hello() {
System.out.println("dataSource: " + dataSource);
return "hello, spring boot!";
}
}
~~~
然后打断点,Debug运行并查看:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525492528558.png?lastModify=1649173481)
属性注入成功了!
## 3.3.SpringBoot的属性注入
SpringBoot强调的是约定大于配置,因此遵循约定,我们就能节省很多配置:
* 首先,属性文件的名称有变化,文件名必须是:application.properties
* 其次,要注入的属性的变量名要和配置文件中的属性名的最后一部分保持一致
* 最后,要在类上声明这些属性在属性文件中的共同的前缀,并提供getter和setter方法
### 3.3.1.修改属性文件名称
属性文件的名称有变化,文件名必须是:application.properties,SpringBoot会自动加载这个文件,无需我们指定加载的文件的名称。
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1555551244910.png?lastModify=1649173481)
### 3.3.2.定义属性注入类
我们新建一个类,用来做属性注入:
~~~
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
private String url;
private String driverClassName;
private String username;
private String password;
// ... 略
// getters 和 setters
}
~~~
* 在类上通过@ConfigurationProperties注解声明当前类为属性读取类
* `prefix="jdbc"`读取属性文件中,前缀为jdbc的值。
* 在类上定义各个属性,名称必须与属性文件中`jdbc.`后面部分一致
### 3.3.3.使用属性类
默认情况下,属性读取类JdbcProperties是 不会被加入Spring的容器的,需要下面两种方式来激活:
* 方式一:在JdbcProperties中添加@Component注解
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1555554270542.png?lastModify=1649173481)
* 方式二:在配置类上使用@EnableConfigurationProperties(JdbcProperties.class)
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1555554307530.png?lastModify=1649173481)
以上两种方式都可以,**任选其一**即可。
例如,在JdbcConfig中使用这个属性:
~~~
@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfig {
@Bean
public DataSource dataSource(JdbcProperties jdbc) {
DruidDataSource dataSource = new DruidDataSource();
dataSource.setUrl(jdbc.getUrl());
dataSource.setDriverClassName(jdbc.getDriverClassName());
dataSource.setUsername(jdbc.getUsername());
dataSource.setPassword(jdbc.getPassword());
return dataSource;
}
}
~~~
* 通过`@EnableConfigurationProperties(JdbcProperties.class)`来声明要使用`JdbcProperties`这个类的对象
* 然后你可以通过以下方式注入JdbcProperties:
* @Autowired注入
~~~
@Autowired
private JdbcProperties prop;
~~~
* 构造函数注入
~~~
private JdbcProperties prop;
public JdbcConfig(Jdbcproperties prop){
this.prop = prop;
}
~~~
* 声明有@Bean的方法参数注入
~~~
@Bean
public Datasource dataSource(JdbcProperties prop){
// ...
}
~~~
本例中,我们采用第三种方式。
测试结果:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525492528558.png?lastModify=1649173481)
## 3.4.更优雅的注入
事实上,@ConfigurationProperties(prefix = "jdbc")的作用机制就是遵循约定:
* 注解的前缀,加上 类中的变量名,刚好于属性文件中的属性一致:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1555554600504.png?lastModify=1649173481)
因此,只要一个Bean符合这样的约定,然后加上@ConfigurationProperties(prefix = "jdbc"),Spring就会帮我们注入属性了。
DataSource中刚好也有jdbc相关的四大参数,符合这个约定,此时,我们只需要把注解加到声明DataSource的方法上,Spring也会帮我们注入属性,无需手动注入:
~~~
@Configuration
public class JdbcConfig {
@Bean
// 声明要注入的属性前缀,SpringBoot会自动把相关属性通过set方法注入到DataSource中
@ConfigurationProperties(prefix = "jdbc")
public DataSource dataSource() {
return new DruidDataSource();
}
}
~~~
我们直接把`@ConfigurationProperties(prefix = "jdbc")`声明在需要使用的`@Bean`的方法上,然后SpringBoot就会自动调用这个Bean(此处是DataSource)的set方法,然后完成注入。使用的前提是:**该类必须有对应属性的set方法!**
我们将jdbc的url改成:/heima,再次测试:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525497513206.png?lastModify=1649173481)
## 3.5.Yaml配置文件
### 3.5.1.基本用法
配置文件除了可以使用application.properties类型,还可以使用后缀名为:.yml或者.yaml的类型,也就是:application.yml或者application.yaml
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1531284020457.png?lastModify=1649173481)
基本格式:
~~~
jdbc:
driverClassName: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/heima
username: root
password: 123
~~~
如果两个配置文件都有,会把两个文件的配置合并,如果有重复属性,以Properties中的为准。
### 3.5.2 高级用法
SpringBoot注入不仅支持基本数据类型的属性注入,而且支持各种java类型的注入,如List、Map、Set、Object等。
例如我们这样配置一些属性:
~~~
cn:
itcast:
name: jack
age: 21
user:
name: jack
age: 21
girls:
- Rose
- 柳岩
- 刘亦菲
- 范冰冰
~~~
如果我们以cn.itcast为前缀,那么有下列属性需要注入:
* name和age是基本类型属性
* user是对象类型属性,可以用Map或者类来接收,又包含下面的子属性:
* name和age:基本类型
* girls:数组或集合类型
我们用来接收的java类:
~~~
@Data
@Component
@ConfigurationProperties("cn.itcast")
public class ItcastProperties {
private String name;
private int age;
private User user = new User();// 用对象介绍cn.itcast.user
@Data
class User{ // 对应cn.itcast.user类型,包含name、age、girls子属性
private String name;
private int age;
private List<String> girls;// 是一个字符串集合
}
}
~~~
最后的结果:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1545877544739.png?lastModify=1649173481)
# 4.自动配置原理
使用SpringBoot之后,一个整合了SpringMVC的WEB工程开发,变的无比简单,那些繁杂的配置都消失不见了,这是如何做到的?
一切魔力的开始,都是从我们的main函数来的,所以我们再次来看下启动类:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525488044650.png?lastModify=1649173481)
我们发现特别的地方有两个:
* 注解:@SpringBootApplication
* run方法:SpringApplication.run()
我们分别来研究这两个部分。
## 4.1.了解@SpringBootApplication
点击进入,查看源码:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525488226710.png?lastModify=1649173481)
这里重点的注解有3个:
* @SpringBootConfiguration
* @EnableAutoConfiguration
* @ComponentScan
### 4.1.1.@SpringBootConfiguration
我们继续点击查看源码:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525488518514.png?lastModify=1649173481)
通过这段我们可以看出,在这个注解上面,又有一个`@Configuration`注解。通过上面的注释阅读我们知道:这个注解的作用就是声明当前类是一个配置类,然后Spring会自动扫描到添加了`@Configuration`的类,并且读取其中的配置信息。而`@SpringBootConfiguration`是来声明当前类是SpringBoot应用的配置类,项目中只能有一个。所以一般我们无需自己添加。
### 4.1.2.@EnableAutoConfiguration
关于这个注解,官网上有一段说明:
> The second class-level annotation is `@EnableAutoConfiguration`. This annotation tells Spring Boot to “guess” how you want to configure Spring, based on the jar dependencies that you have added. Since `spring-boot-starter-web` added Tomcat and Spring MVC, the auto-configuration assumes that you are developing a web application and sets up Spring accordingly.
简单翻译以下:
> 第二级的注解`@EnableAutoConfiguration`,告诉SpringBoot基于你所添加的依赖,去“猜测”你想要如何配置Spring。比如我们引入了`spring-boot-starter-web`,而这个启动器中帮我们添加了`tomcat`、`SpringMVC`的依赖。此时自动配置就知道你是要开发一个web应用,所以就帮你完成了web及SpringMVC的默认配置了!
总结,SpringBoot内部对大量的第三方库或Spring内部库进行了默认配置,这些配置是否生效,取决于我们是否引入了对应库所需的依赖,如果有那么默认配置就会生效。
所以,我们使用SpringBoot构建一个项目,只需要引入所需框架的依赖,配置就可以交给SpringBoot处理了。除非你不希望使用SpringBoot的默认配置,它也提供了自定义配置的入口。
### 4.1.3.@ComponentScan
我们跟进源码:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525498265579.png?lastModify=1649173481)
并没有看到什么特殊的地方。我们查看注释:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525498351385.png?lastModify=1649173481)
大概的意思:
> 配置组件扫描的指令。提供了类似与`<context:component-scan>`标签的作用
>
> 通过basePackageClasses或者basePackages属性来指定要扫描的包。如果没有指定这些属性,那么将从声明这个注解的类所在的包开始,扫描包及子包
而我们的@SpringBootApplication注解声明的类就是main函数所在的启动类,因此扫描的包是该类所在包及其子包。因此,**一般启动类会放在一个比较前的包目录中。**
## 4.2.默认配置原理
### 4.2.1.spring.factories
在SpringApplication类构建的时候,有这样一段初始化代码:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684134317.png?lastModify=1649173481)
跟进去:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684245960.png?lastModify=1649173481)
这里发现会通过loadFactoryNames尝试加载一些FactoryName,然后利用createSpringFactoriesInstances将这些加载到的类名进行实例化。
继续跟进loadFactoryNames方法:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684398745.png?lastModify=1649173481)
发现此处会利用类加载器加载某个文件:`FACTORIES_RESOURCE_LOCATION`,然后解析其内容。我们找到这个变量的声明:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684452698.png?lastModify=1649173481)
可以发现,其地址是:`META-INF/spring.factories`,我们知道,ClassLoader默认是从classpath下读取文件,因此,SpringBoot会在初始化的时候,加载**所有**classpath:META-INF/spring.factories文件,包括jar包当中的。
而在Spring的一个依赖包:spring-boot-autoconfigure中,就有这样的文件:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684761902.png?lastModify=1649173481)
以后我们引入的任何第三方启动器,只要实现自动配置,也都会有类似文件。
### 4.2.1默认配置类
我们打开刚才的spring.factories文件:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533684789998.png?lastModify=1649173481)
可以发现以EnableAutoConfiguration接口为key的一系列配置,key所对应的值,就是所有的自动配置类,可以在当前的jar包中找到这些自动配置类:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525499397690.png?lastModify=1649173481)
还有:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525499426598.png?lastModify=1649173481)
非常多,几乎涵盖了现在主流的开源框架,例如:
* redis
* jms
* amqp
* jdbc
* jackson
* mongodb
* jpa
* solr
* elasticsearch
... 等等
我们来看一个我们熟悉的,例如SpringMVC,查看mvc 的自动配置类:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525499859426.png?lastModify=1649173481)
打开WebMvcAutoConfiguration:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500000816.png?lastModify=1649173481)
我们看到这个类上的4个注解:
* `@Configuration`:声明这个类是一个配置类
* `@ConditionalOnWebApplication(type = Type.SERVLET)`
ConditionalOn,翻译就是在某个条件下,此处就是满足项目的类是是Type.SERVLET类型,也就是一个普通web工程,显然我们就是
* `@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })`
这里的条件是OnClass,也就是满足以下类存在:Servlet、DispatcherServlet、WebMvcConfigurer,其中Servlet只要引入了tomcat依赖自然会有,后两个需要引入SpringMVC才会有。这里就是判断你是否引入了相关依赖,引入依赖后该条件成立,当前类的配置才会生效!
* `@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)`
这个条件与上面不同,OnMissingBean,是说环境中没有指定的Bean这个才生效。其实这就是自定义配置的入口,也就是说,如果我们自己配置了一个WebMVCConfigurationSupport的类,那么这个默认配置就会失效!
接着,我们查看该类中定义了什么:
视图解析器:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500405278.png?lastModify=1649173481)
处理器适配器(HandlerAdapter):
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500452517.png?lastModify=1649173481)
还有很多,这里就不一一截图了。
### 4.2.2.默认配置属性
另外,这些默认配置的属性来自哪里呢?
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500697391.png?lastModify=1649173481)
我们看到,这里通过@EnableAutoConfiguration注解引入了两个属性:WebMvcProperties和ResourceProperties。这不正是SpringBoot的属性注入玩法嘛。
我们查看这两个属性类:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500810914.png?lastModify=1649173481)
找到了内部资源视图解析器的prefix和suffix属性。
ResourceProperties中主要定义了静态资源(.js,.html,.css等)的路径:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500921773.png?lastModify=1649173481)
如果我们要覆盖这些默认属性,只需要在application.properties中定义与其前缀prefix和字段名一致的属性即可。
## 4.3.总结
SpringBoot为我们提供了默认配置,而默认配置生效的步骤:
* @EnableAutoConfiguration注解会去寻找`META-INF/spring.factories`文件,读取其中以`EnableAutoConfiguration`为key的所有类的名称,这些类就是提前写好的自动配置类
* 这些类都声明了`@Configuration`注解,并且通过`@Bean`注解提前配置了我们所需要的一切实例。完成自动配置
* 但是,这些配置不一定生效,因为有`@ConditionalOn`注解,满足一定条件才会生效。比如条件之一:是一些相关的类要存在
* 类要存在,我们只需要引入了相关依赖(启动器),依赖有了条件成立,自动配置生效。
* 如果我们自己配置了相关Bean,那么会覆盖默认的自动配置的Bean
* 我们还可以通过配置application.properties文件,来覆盖自动配置中的属性
1)启动器
所以,我们如果不想配置,只需要引入依赖即可,而依赖版本我们也不用操心,因为只要引入了SpringBoot提供的stater(启动器),就会自动管理依赖及版本了。
因此,玩SpringBoot的第一件事情,就是找启动器,SpringBoot提供了大量的默认启动器
2)全局配置
另外,SpringBoot的默认配置,都会读取默认属性,而这些属性可以通过自定义`application.properties`文件来进行覆盖。这样虽然使用的还是默认配置,但是配置中的值改成了我们自定义的。
因此,玩SpringBoot的第二件事情,就是通过`application.properties`来覆盖默认属性值,形成自定义配置。我们需要知道SpringBoot的默认属性key,非常多,可以再idea中自动提示
# 5.SpringBoot实践
接下来,我们来看看如何用SpringBoot来玩转以前的SSM,我们会在数据库引入一张用户表tb\_user和实体类User
tb\_user:
详见课前笔记中:《tb\_user.sql》文件。
user实体类:
~~~
public class User{
// id
private Long id;
// 用户名
private String userName;
// 密码
private String password;
// 姓名
private String name;
// 年龄
private Integer age;
// 性别,1男性,2女性
private Integer sex;
// 出生日期
private Date birthday;
// 创建时间
private Date created;
// 更新时间
private Date updated;
// 备注
private String note;
}
~~~
## 5.0.Lombok
我们编写pojo时,经常需要编写构造函数和gettersetter方法,属性多的时候,就非常浪费时间,使用lombok插件可以解决这个问题:
在idea中安装lombok插件:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533700386138.png?lastModify=1649173481)
需要在maven中引入依赖:
~~~
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
~~~
然后可以在Bean上使用:
@Data :自动提供getter和setter、hashCode、equals、toString等方法
@Getter:自动提供getter方法
@Setter:自动提供setter方法
@Slf4j:自动在bean中提供log变量,其实用的是slf4j的日志功能。
例如,我们在javabean上加@Data,那么就可以getter和setter等方法的编写,lombok插件会帮我们自动生成:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1533778469361.png?lastModify=1649173481)
## 5.1.整合SpringMVC
虽然默认配置已经可以使用SpringMVC了,不过我们有时候需要进行自定义配置。
### 5.1.0.日志控制
日志级别控制:
~~~
logging:
level:
cn.itcast: debug
org.springframework: debug
~~~
其中:
* logging.level:是固定写法,说明下面是日志级别配置,日志相关其它配置也可以使用。
* cn.itcast和org.springframework是指定包名,后面的配置仅对这个包有效。
* debug:日志的级别
### 5.1.1.修改端口
查看SpringBoot的全局属性可知,端口通过以下方式配置:
~~~
# 映射端口
server.port=80
~~~
重启服务后测试:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525511878440.png?lastModify=1649173481)
### 5.1.2.访问静态资源
现在,我们的项目是一个jar工程,那么就没有webapp,我们的静态资源该放哪里呢?
回顾我们上面看的源码,有一个叫做ResourceProperties的类,里面就定义了静态资源的默认查找路径:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525500921773.png?lastModify=1649173481)
默认的静态资源路径为:
* classpath:/META-INF/resources/
* classpath:/resources/
* classpath:/static/
* classpath:/public
只要静态资源放在这些目录中任何一个,SpringMVC都会帮我们处理。
我们习惯会把静态资源放在`classpath:/static/`目录下。我们创建目录,并且添加一些静态资源:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525512196866.png?lastModify=1649173481)
重启项目后测试:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525512253682.png?lastModify=1649173481)
### 5.1.3.添加拦截器
拦截器也是我们经常需要使用的,在SpringBoot中该如何配置呢?
拦截器不是一个普通属性,而是一个类,所以就要用到java配置方式了。在SpringBoot官方文档中有这么一段说明:
> If you want to keep Spring Boot MVC features and you want to add additional [MVC configuration](https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/web.html#mvc) (interceptors, formatters, view controllers, and other features), you can add your own `@Configuration` class of type `WebMvcConfigurer` but **without** `@EnableWebMvc`. If you wish to provide custom instances of `RequestMappingHandlerMapping`, `RequestMappingHandlerAdapter`, or `ExceptionHandlerExceptionResolver`, you can declare a `WebMvcRegistrationsAdapter` instance to provide such components.
>
> If you want to take complete control of Spring MVC, you can add your own `@Configuration` annotated with `@EnableWebMvc`.
翻译:
> 如果你想要保持Spring Boot 的一些默认MVC特征,同时又想自定义一些MVC配置(包括:拦截器,格式化器, 视图控制器、消息转换器 等等),你应该让一个类实现`WebMvcConfigurer`,并且添加`@Configuration`注解,但是**千万不要**加`@EnableWebMvc`注解。如果你想要自定义`HandlerMapping`、`HandlerAdapter`、`ExceptionResolver`等组件,你可以创建一个`WebMvcRegistrationsAdapter`实例 来提供以上组件。
>
> 如果你想要完全自定义SpringMVC,不保留SpringBoot提供的一切特征,你可以自己定义类并且添加`@Configuration`注解和`@EnableWebMvc`注解
总结:通过实现`WebMvcConfigurer`并添加`@Configuration`注解来实现自定义部分SpringMvc配置。
首先我们定义一个拦截器:
~~~
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
log.debug("preHandle method is now running!");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
log.debug("postHandle method is now running!");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
log.debug("afterCompletion method is now running!");
}
}
~~~
然后,我们定义配置类,注册拦截器:
~~~
@Configuration
public class MvcConfig implements WebMvcConfigurer{
/**
* 重写接口中的addInterceptors方法,添加自定义拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 通过registry来注册拦截器,通过addPathPatterns来添加拦截路径
registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**");
}
}
~~~
结构如下:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525513555179.png?lastModify=1649173481)
接下来运行并查看日志:
你会发现日志中什么都没有,因为我们记录的log级别是debug,默认是显示info以上,我们需要进行配置。
SpringBoot通过`logging.level.*=debug`来配置日志级别,\*填写包名
~~~
# 设置com.leyou包的日志级别为debug
logging:
level:
com.leyou=debug
~~~
再次运行查看:
~~~
2018-05-05 17:50:01.811 DEBUG 4548 --- [p-nio-80-exec-1] com.leyou.interceptor.LoginInterceptor : preHandle method is now running!
2018-05-05 17:50:01.854 DEBUG 4548 --- [p-nio-80-exec-1] com.leyou.interceptor.LoginInterceptor : postHandle method is now running!
2018-05-05 17:50:01.854 DEBUG 4548 --- [p-nio-80-exec-1] com.leyou.interceptor.LoginInterceptor : afterCompletion method is now running!
~~~
## 5.2.整合jdbc和事务
spring中的jdbc连接和事务是配置中的重要一环,在SpringBoot中该如何处理呢?
答案是不需要处理,我们只要找到SpringBoot提供的启动器即可:
~~~
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
~~~
当然,不要忘了数据库驱动,SpringBoot并不知道我们用的什么数据库,这里我们选择MySQL:
~~~
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
~~~
至于事务,SpringBoot中通过注解来控制。就是我们熟知的`@Transactional`
~~~
@Service
public class UserService {
public User queryById(Long id){
// 开始查询
return new User();
}
@Transactional
public void deleteById(Long id){
// 开始删除
System.out.println("删除了: " + id);
}
}
~~~
## 5.3.整合连接池
其实,在刚才引入jdbc启动器的时候,SpringBoot已经自动帮我们引入了一个连接池:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525514424562.png?lastModify=1649173481)
HikariCP应该是目前速度最快的连接池了,我们看看它与c3p0的对比:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1525516441005.png?lastModify=1649173481)
因此,我们只需要指定连接池参数即可:
~~~
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/mydb01
username: root
password: 123
~~~
## 5.4.整合mybatis
### 5.4.1.mybatis
SpringBoot官方并没有提供Mybatis的启动器,不过Mybatis[官网](https://github.com/mybatis/spring-boot-starter)自己实现了:
~~~
<!--mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.1</version>
</dependency>
~~~
配置,一些文件位置相关的,mybatis知道,需要我们来指定:
~~~
mybatis:
# mybatis 别名扫描
type-aliases-package=cn.itcast.pojo
# mapper.xml文件位置,如果没有映射文件,请注释掉
mapper-locations=classpath:mappers/*.xml
~~~
另外,Mapper接口的位置在application.yml中并不能配置,Mapper接口的扫描有两种实现方式:
> 方式一
我们需要给每一个Mapper接口添加`@Mapper`注解,由Spring来扫描这些注解,完成Mapper的动态代理。
~~~
@Mapper
public interface UserMapper {
}
~~~
> 方式二
在启动类上添加扫描包注解(**推荐**):
~~~
@SpringBootApplication
@MapperScan("cn.itcast.mapper")
public class Application {
public static void main(String[] args) {
// 启动代码
SpringApplication.run(Application.class, args);
}
}
~~~
这种方式的好处是,不用给每一个Mapper都添加注解。
以下代码示例中,我们将采用@MapperScan扫描方式进行。
### 5.4.2.通用mapper
通用Mapper的作者也为自己的插件编写了启动器,我们直接引入即可:
~~~
<!-- 通用mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
~~~
**注意**:一旦引入了通用Mapper的启动器,会覆盖Mybatis官方启动器的功能,因此需要移除对官方Mybatis启动器的依赖。
无需任何配置就可以使用了。如果有特殊需要,可以到通用mapper官网查看:[https://github.com/abel533/Mapper/wiki/3.config](https://github.com/abel533/Mapper/wiki/3.config)
另外,我们需要把启动类上的@MapperScan注解修改为通用mapper中自带的:
![](file://G:/BaiduNetdiskDownload/2020java/13.SpringBoot/day01_springboot/%E8%AE%B2%E4%B9%89/assets/1531284085887.png?lastModify=1649173481)
接下来就是通用mapper的使用步骤了:
1)继承Mapper接口
~~~
public interface UserMapper extends Mapper<User>{
}
~~~
2)在实体类上加JPA注解:
~~~
@Data
@Table(name = "tb_user")
public class User{
@Id
@KeySql(useGeneratedKeys = true) // 开启自增主键回显功能
private Long id;
private String userName;
private String password;
private String name;
private Integer age;
private Integer sex;
private Date birthday;
private Date created;
private Date updated;
private String note;
}
~~~
此时,对UserService的代码进行简单改造:
~~~
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public User queryById(Long id){
// 查询
return userMapper.selectByPrimaryKey(id);
}
@Transactional
public Integer saveUser(User user){
// 新增
return userMapper.insertSelective(user);
}
}
~~~
## 5.5.启动测试
将controller进行简单改造:
~~~
@RestController
public class HelloController {
@Autowired
private UserService userService;
@GetMapping("/user/{id}")
public User hello(@PathVariable("id") Long id) {
User user = this.userService.queryById(id);
return user;
}
}
~~~
我们启动项目,查看: