1 概述
1.1. 什么是Spring Boot
Spring Boot是Spring项目中的一个子工程,与我们所熟知的Spring-framework 同属于spring的产品:
首页
Spring Boot
简介可以看到下面的一段介绍:
Spring Boot is designed to get you up and running as quickly as possible, with minimal upfront
confifiguration of Spring. Spring Boot takes an opinionated view of building production-ready
applications.
Spring Boot
的设计目的是让您尽可能快地启动和运行,而无需预先配置
Spring
。
Spring Boot
以一种固定的方
式来构建可用于生产级别的应用程序。
一般把Spring Boot
称为搭建程序的
脚手架
或者说
是便捷搭建 基于
Spring
的工程 脚手架。其最主要作用就是帮助开
发人员快速的构建庞大的spring
项目,并且尽可能的减少一切
xml配置,做到开箱即用,迅速上手,让开发人员关注
业务而非配置。
1.2. 为什么要学习Spring Boot
java
一直被人诟病的一点就是臃肿、麻烦。当我们还在辛苦的搭建项目时,可能
Python
程序员已经把功能写好了,
究其原因注意是两点:
- 复杂的配置:项目各种配置其实是开发时的损耗, 因为在思考 Spring 特性配置和解决业务问题之间需要进行思维切换,所以
写配置挤占了写应用程序逻辑的时间。
- 一个是混乱的依赖管理: 项目的依赖管理也是件吃力不讨好的事情。决定项目里要用哪些库就已经够让人头痛的了,你还要知道这些库
的哪个版本和其他库不会有冲突,这难题实在太棘手。并且,依赖管理也是一种损耗,添加依赖不是写应用程序代码。一旦选错了依赖的版本,随之而来的不兼容问题毫无疑问会是生产力杀手。
而
Spring Boot
让这一切成为过去!
Spring Boot
简化了基于
Spring
的应用开发,只需要
“run”
就能创建一个独立的、生产级别的
Spring
应用。
Spring Boot
为
Spring
平台及第三方库提供开箱即用的设置(提供默认设置,存放默认配置的包就是启动器
starter
),这样我们就可以简单的开始。多数
Spring Boot
应用只需要很少的
Spring
配置。
我们可以使用
Spring Boot
创建
java
应用,并使用
java –jar 命令
启动它,就能得到一个生产级别的
web
工程。
1.3. Spring Boot的特点
- 创建独立的Spring应用,为所有 Spring 的开发者提供一个非常快速的、广泛接受的入门体验
- 直接嵌入应用服务器,如tomcat、jetty、undertow等;不需要去部署war包
- 提供固定的启动器依赖去简化组件配置;实现开箱即用(启动器starter-其实就是Spring Boot提供的一个jar 包),通过自己设置参数(.properties或.yml的配置文件),即可快速使用
-
自动地配置 Spring 和其它有需要的第三方依赖
- 提供了一些大型项目中常见的非功能性特性,如内嵌服务器、安全、指标,健康检测、外部化配置等
- 绝对没有代码生成,也无需 XML 配置。
2. 快速入门
2.1. 创建工程
新建一个
maven jar
工程:
项目信息:
项目路径:
2.2.添加依赖
看到这里很多同学会有疑惑,前面说传统开发的问题之一就是依赖管理混乱,怎么这里我们还需要管理依赖呢?难道
Spring Boot
不帮我们管理吗?
别着急,现在我们的项目与
Spring Boot
还没有什么关联。
Spring Boot
提供了一个名为
spring-boot-starter-parent
的工程,里面已经对各种常用依赖(并非全部)的版本进行了管理,我们的项目需要以这个项目为父工程,这样我们
就不用操心依赖的版本问题了,需要什么依赖,直接引入坐标即可!
2.2.1. 添加父工程坐标
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
</parent>
2.2.2. 添加web启动器
为了让
Spring Boot
帮我们完成各种自动配置,我们必须引入
Spring Boot
提供的自动配置依赖,我们称为
启动器
。因为我们是web
项目,这里我们引入
web
启动器,在
pom.xml
文件中加入如下依赖:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
需要注意的是,我们并没有在这里指定版本信息。因为
Spring Boot
的父工程已经对版本进行了管理了。这个时候,我们会发现项目中多出了大量的依赖。
那些依赖都是
Spring Boot
根据
spring
-
boot
-
starter
-
web
这个依赖自动引入的,而且所有的版本都已经管理好,不会出现冲突。
2.2.3. 管理jdk版本
如果我们想要修改
Spring Boot
项目的
jdk
版本,只需要简单的添加以下属性即可,如果没有需求,则不添加。同样的在 pom.xml
文件中添加如下:
<properties>
<java.version>1.8</java.version>
</properties>
2.2.4. 完整pom文件
pom.xml
文件内容如下:
<?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.5.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>
2.3. 启动类
Spring Boot
项目通过
main
函数即可启动,我们需要创建一个启动类:
编写
heima
-
springboot\src\main\java\com\itheima\Application.java 如下:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
2.4. 编写controller
编写
heima
-
springboot\src\main\java\com\itheima\controller\HelloController.java
代码如下:
@RestController
public class HelloController {
@GetMapping("hello")
public String hello(){
return "hello, spring boot!";
}
}
2.5. 启动测试
接下来,运行
main
函数,查看控制台:
并且可以看到监听的端口信息:
1
)监听的端口是
8080
2
)
SpringMVC
的项目路径是:空
3
)
/hello
路径已经映射到了
HelloController
中的
hello()
方法
打开页面访问:
http://localhost:8080/hello
3. java配置应用
在入门案例中,我们没有任何的配置,就可以实现一个
SpringMVC
的项目了,快速、高效!
如果没有任何的
xml
,那么我们如果要配置一个
Bean
该怎么办?比如我们要配置一个数据库连接池,以前会这么配置:
<!-- 配置连接池 -->
<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. Spring配置历史
事实上,在
Spring3.0
开始,
Spring
官方就已经开始推荐使用
java
配置来代替传统的
xml
配置了,我们不妨来回顾一下 Spring的历史:
- Spring1.0时代:
在此时因为 jdk1.5 刚刚出来,注解开发并未盛行,因此一切 Spring 配置都是 xml 格式,想象一下所有的 bean 都用xml配置,细思极恐啊,心疼那个时候的程序员 2 秒。
-
Spring 引入了注解开发,但是因为并不完善,因此并未完全替代 xml ,此时的程序员往往是把 xml 与注解进行结合,貌似我们之前都是这种方式。
-
Spring3.0 及以后3.0 以后 Spring 的注解已经非常完善了,因此 Spring 推荐大家使用完全的 java 配置来代替以前的 xml ,不过似乎在国内并未推广盛行。然后当Spring Boot 来临,人们才慢慢认识到 java 配置的优雅。
有句古话说的好:拥抱变化,拥抱未来。所以我们也应该顺应时代潮流,做时尚的弄潮儿,一起来学习下
java
配置的玩法。
3.2. 尝试java配置
java
配置主要靠
java
类和一些注解,比较常用的注解有:
- @Configuration :声明一个类作为配置类,代替xml文件
- @Bean :声明在方法上,将方法的返回值加入Bean容器,代替 <bean> 标签
- @Value :属性注入
- @PropertySource :指定外部属性文件,
我们接下来用
java
配置来尝试实现连接池配置:
1.
在
pom.xml
文件中添加
Druid
连接池依赖如下
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.6</version>
</dependency>
2.
使用数据操作工具创建数据库
springboot_test
3.
然后在项目中创建
heima
-
springboot\src\main\resources\jdbc.properties
文件,内容如下
jdbc.driverClassName=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306/springboot_test
jdbc.username=root
jdbc.password=root
4.
编写
heima
-
springboot\src\main\java\com\itheima\config\JdbcConfig.java
如下
package com.itheima.config;
import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import javax.sql.DataSource;
@Configuration
@PropertySource("classpath:jdbc.properties")
public class JdbcConfig {
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.driverClassName}")
private String driverClassName;
@Value("${jdbc.username}")
private String username;
@Value("${jdbc.password}")
private String password;
@Bean
public DataSource dataSource(){
DruidDataSource dataSource = new DruidDataSource();
dataSource.setDriverClassName(driverClassName);
dataSource.setUrl(url);
dataSource.setUsername(username);
dataSource.setPassword(password);
return dataSource;
}
}
解读:
@Configuration
:声明我们
JdbcConfig
是一个配置类
@PropertySource
:指定属性文件的路径是
:
classpath:jdbc.properties
通过
@Value
为属性注入值
通过
@Bean
将
dataSource()
方法声明为一个注册
Bean
的方法,
Spring
会自动调用该方法,将方法的返回值 加入Spring
容器中。
然后我们就可以在任意位置通过
@Autowired
注入
DataSource
了!
5.
在
HelloController
中注入
DataSource
进行测试,改造代码如下:
@RestController
public class HelloController {
@Autowired
private DataSource dataSource;
@GetMapping("hello")
public String hello() {
System.out.println("dataSource = " + dataSource);
return "hello, spring boot!";
}
}
然后打断点,
Debug
运行并查看:
属性注入成功了!
3.3. Spring Boot的属性注入
属性文件的名称有变化,默认的文件名必须是:
application.properties
或
application.yml
在上面的案例中,我们实验了
java
配置方式。不过属性注入使用的是
@Value
注解。这种方式虽然可行,但是不够强大,因为它只能注入基本类型值。
在
Spring Boot
中,提供了一种新的属性注入方式,支持各种
java
基本数据类型及复杂类型的注入。
1
)新建
heima
-
springboot\src\main\java\com\itheima\config\JdbcProperties.java
,用于进行属性注入:
package com.itheima.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
private String url;
private String driverClassName;
private String username;
private String password;
// ... 略
// getters 和 setters
}
- 在类上通过@ConfifigurationProperties注解声明当前类为属性读取类
- prefix="jdbc" 读取属性文件中,前缀为jdbc的值。
- 在类上定义各个属性,名称必须与属性文件中 jdbc. 后面部分一致
- 需要注意的是,这里我们并没有指定属性文件的地址,所以我们需要把jdbc.properties名称改为application.properties,这是Spring Boot默认读取的属性文件名:
【注意】如果出现如下提示,项目也可以运行;
如果要去掉上述的提示,则可以在
pom.xml
文件中添加如下依赖:
<dependency>
<groupId> org.springframework.boot </groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<!--不传递依赖-->
<optional>true</optional>
</dependency>
2
)将
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){
// ...
}
本例中,我们采用第三种方式。
3
)测试结果;与前面的测试一样的。
大家会觉得这种方式似乎更麻烦了,事实上这种方式有更强大的功能,也是
Spring Boot
推荐的注入方式。与
@Value对比关系:
优势:
Relaxed binding
:松散绑定
不严格要求属性文件中的属性名与成员变量名一致。支持驼峰,中划线,下划线等等转换,甚至支持对象引导。比如:user.friend.name
:代表的是
user
对象中的
friend
属性中的
name
属性,显然
friend
也是对象。@value
注解就难以完成这样的注入方式。
meta-data support
:元数据支持,帮助
IDE
生成属性提示(写开源框架会用到)。
3.4. 更优雅的注入
事实上,如果一段属性只有一个
Bean
需要使用,我们无需将其注入到一个类(
JdbcProperties
,将该类上的所有注解去掉)中。而是直接在需要的地方声明即可;再次修改 JdbcConfig
类为如下代码:
@Configuration
public class JdbcConfig {
@Bean
// 声明要注入的属性前缀,Spring Boot会自动把相关属性通过set方法注入到DataSource中
@ConfigurationProperties(prefix = "jdbc")
public DataSource dataSource() {
return new DruidDataSource();
}
}
我们直接把
@ConfigurationProperties(prefix = "jdbc")
声明在需要使用的
@Bean
的方法上,然后
Spring Boot就会自动调用这个
Bean
(此处是
DataSource
)的
set
方法,然后完成注入。使用的前提是:
该类必须有对应属
性的
set
方法!
我们将
jdbc.properties
文件中的
jdbc.url
中的数据库名改成:
/heima
,再次测试:
3.5. Yaml配置文件
配置文件除了可以使用
application.properties
类型,还可以使用后缀名为:
.yml
或者
.yaml
的类型,也就是: application.yml或者
application.yaml
基本格式:
jdbc:
driverClassName: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/springboot_test
username: root
password: root
把
application.properties
修改为
application.yml
进行测试。
如果两个配置文件都有,会把两个文件的配置合并,如果有重复属性,以
properties
中的为准。
3.6. 多个Yaml配置文件
当一个项目中有多个
yml
配置文件的时候,可以以
application-**.yml
命名;在
application.yml
中配置项目使用激活这些配置文件即可。
创建
application
-prd
.yml
文件如下:
itcast:
url: http://www.itcast.cn
创建
application
-dev
.yml
文件如下:
itcast:
url: http://www.itcast.cn
在 application.yml 文件中添加如下配
#加载其它配置文件
spring:
profiles:
active: abc,def
多个文件名只需要写
application-
之后的名称,在多个文件之间使用
,
隔开。
修改代码测试:
4. 自动配置原理
使用
Spring Boot
之后,一个整合了
SpringMVC
的
WEB
工程开发,变的无比简单,那些繁杂的配置都消失不见了,这是如何做到的?
一切魔力的开始,都是从我们的
main
函数来的,所以我们再次来看下启动类:
我们发现特别的地方有两个:
注解:
@SpringBootApplication
run
方法:
SpringApplication.run()
我们分别来研究这两个部分。
4.1. 了解@SpringBootApplication
点击进入,查看源码:
这里重点的注解有
3
个:
@SpringBootConfifiguration
@EnableAutoConfifiguration
@ComponentScan
4.1.1. @SpringBootConfifiguration
我们继续点击查看源码:
通过这段我们可以看出,在这个注解上面,又有一个
@Configuration
注解。通过上面的注释阅读我们知道:这个注解的作用就是声明当前类是一个配置类,然后Spring
会自动扫描到添加了
@Configuration
的类,并且读取其中的配置信息。而@SpringBootConfiguration
是来声明当前类是
SpringBoot
应用的配置类,项目中只能有一个。所以一 般我们无需自己添加。
4.1.2. @EnableAutoConfifiguration
关于这个注解,官网上有一段说明:
The second class-level annotation is
@EnableAutoConfiguration
. This annotation tells Spring Boot to “guess” how you want to confifigure Spring, based on the jar dependencies that you have added. Since spring-
boot
-
starter
-
web
added Tomcat and Spring MVC, the auto-confifiguration assumes that you are developing a web application and sets up Spring accordingly.
简单翻译以下:
第二级的注解
@EnableAutoConfiguration
,告诉
Spring Boot
基于你所添加的依赖,去
“
猜测
”
你想要如何配置Spring
。比如我们引入了
spring
-
boot
-
starter
-
web
,而这个启动器中帮我们添加了
tomcat
、
SpringMVC的依赖。此时自动配置就知道你是要开发一个web
应用,所以就帮你完成了
web
及
SpringMVC
的默认配置了!
总结,
Spring Boot
内部对大量的第三方库或
Spring
内部库进行了默认配置,这些配置是否生效,取决于我们是否引入了对应库所需的依赖,如果有那么默认配置就会生效。
所以,我们使用
SpringBoot
构建一个项目,只需要引入所需框架的依赖,配置就可以交给
SpringBoot
处理了。除非你不希望使用SpringBoot
的默认配置,它也提供了自定义配置的入口。
4.1.3. @ComponentScan
我们跟进源码:
并没有看到什么特殊的地方。我们查看注释:
大概的意思:
配置组件扫描的指令。提供了类似与
<context:component
-
scan>
标签的作用
通过
basePackageClasses
或者
basePackages
属性来指定要扫描的包。如果没有指定这些属性,那么将从声明这个注解的类所在的包开始,扫描包及子包
而我们的
@SpringBootApplication
注解声明的类就是
main
函数所在的启动类,因此扫描的包是该类所在包及其子包。因此,一般启动类会放在一个比较前的包目录中。
4.2. 默认配置原理
4.2.1. spring.factories
在
SpringApplication
类构建的时候,有这样一段初始化代码:
跟进去:
这里发现会通过
loadFactoryNames
尝试加载一些
FactoryName
,然后利用
createSpringFactoriesInstances
将这些加载到的类名进行实例化。
继续跟进
loadFactoryNames
方法:
发现此处会利用类加载器加载某个文件:
FACTORIES_RESOURCE_LOCATION
,然后解析其内容。我们找到这个变量的声明:
可以发现,其地址是:
META
-
INF/spring.factories
,我们知道,
ClassLoader
默认是从
classpath
下读取文件,因此,SpringBoot
会在初始化的时候,加载
所有
classpath:META-INF/spring.factories
文件,包括
jar
包当中的。
而在
Spring
的一个依赖包:
spring-boot-autoconfifigure
中,就有这样的文件:
以后我们引入的任何第三方启动器,只要实现自动配置,也都会有类似文件。
4.2.1. 默认配置类
我们打开刚才的
spring.factories
文件:
可以发现以
EnableAutoConfifiguration
接口为
key
的一系列配置,
key
所对应的值,就是所有的自动配置类,可以在当前的jar
包中找到这些自动配置类:
非常多,几乎涵盖了现在主流的开源框架,例如:
redis 、
jms 、
amqp 、
jdbc 、
jackson 、
mongodb 、
jpa 、
solr 、
elasticsearch...
我们来看一个我们熟悉的,例如
SpringMVC
,查看
mvc
的自动配置类:
打开
WebMvcAutoConfifiguration
:
我们看到这个类上的
4
个注解:
- @Configuration :声明这个类是一个配置类
- @ConditionalOnWebApplication(type = Type.SERVLET)
ConditionalOn ,翻译就是在某个条件下,此处就是满足项目的类是是 Type.SERVLET 类型,也就是一个普通 web工程,显然我们就是
- @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
这里的条件是 OnClass ,也就是满足以下类存在: Servlet 、 DispatcherServlet 、 WebMvcConfifigurer ,其中Servlet只要引入了 tomcat 依赖自然会有,后两个需要引入 SpringMVC 才会有。这里就是判断你是否引入了相关依赖,引入依赖后该条件成立,当前类的配置才会生效!
- @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
这个条件与上面不同, OnMissingBean ,是说环境中没有指定的 Bean 这个才生效。其实这就是自定义配置的入口,也就是说,如果我们自己配置了一个WebMVCConfifigurationSupport 的类,那么这个默认配置就会失效!
接着,我们查看该类中定义了什么:
视图解析器:
处理器适配器(
HandlerAdapter
):
还有很多,这里就不一一截图了。
4.2.2. 默认配置属性
另外,这些默认配置的属性来自哪里呢?
我们看到,这里通过
@EnableAutoConfifiguration
注解引入了两个属性:
WebMvcProperties
和ResourceProperties。这不正是
SpringBoot
的属性注入玩法嘛。
我们查看这两个属性类:
找到了内部资源视图解析器的
prefifix
和
suffiffiffix
属性。
ResourceProperties
中主要定义了静态资源(
.js,.html,.css
等
)
的路径
如果我们要覆盖这些默认属性,只需要在
application.properties
中定义与其前缀
prefifix
和字段名一致的属性即可。
4.3. 总结
SpringBoot
为我们提供了默认配置,而默认配置生效的步骤:
- @EnableAutoConfifiguration注解会去寻找 META-INF/spring.factories 文件,读取其中以EnableAutoConfiguration 为key的所有类的名称,这些类就是提前写好的自动配置类
- 这些类都声明了 @Configuration 注解,并且通过 @Bean 注解提前配置了我们所需要的一切实例
- 但是,这些配置不一定生效,因为有 @ConditionalOn 注解,满足一定条件才会生效。比如条件之一: 是一些相关的类要存在
- 类要存在,我们只需要引入了相关依赖(启动器),依赖有了条件成立,自动配置生效。
- 如果我们自己配置了相关Bean,那么会覆盖默认的自动配置的Bean
- 我们还可以通过配置application.yml文件,来覆盖自动配置中的属性
1
)启动器
所以,我们如果不想配置,只需要引入依赖即可,而依赖版本我们也不用操心,因为只要引入了
SpringBoot
提供的stater(启动器),就会自动管理依赖及版本了。
因此,玩
SpringBoot
的第一件事情,就是找启动器,
SpringBoot
提供了大量的默认启动器
2
)全局配置
另外,
SpringBoot
的默认配置,都会读取默认属性,而这些属性可以通过自定义
application.properties
文件来进行覆盖。这样虽然使用的还是默认配置,但是配置中的值改成了我们自定义的。
因此,玩
SpringBoot
的第二件事情,就是通过
application.properties
来覆盖默认属性值,形成自定义配置。我们需要知道SpringBoot
的默认属性
key
,非常多,可以再
idea
中自动提示
属性文件支持两种格式,
application.properties
和
application.yml
yml
的语法实例:
如果
properties
和
yml
文件都存在,如果有重叠属性,默认以
Properties
优先。遇到需要修改的组件的配置项流程为:
5. Spring Boot实践
接下来,我们来看看如何用
SpringBoot
来整合
SSM
,在数据库中引入一张用户表
tb_user
和实体类
User
。
tb_user
表:
SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for tb_user
-- ----------------------------
DROP TABLE IF EXISTS `tb_user`;
CREATE TABLE `tb_user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`user_name` varchar(100) DEFAULT NULL COMMENT '用户名',
`password` varchar(100) DEFAULT NULL COMMENT '密码',
`name` varchar(100) DEFAULT NULL COMMENT '姓名',
`age` int(10) DEFAULT NULL COMMENT '年龄',
`sex` tinyint(1) DEFAULT NULL COMMENT '性别,1男性,2女性',
`birthday` date DEFAULT NULL COMMENT '出生日期',
`note` varchar(255) DEFAULT NULL COMMENT '备注',
`created` datetime DEFAULT NULL COMMENT '创建时间',
`updated` datetime DEFAULT NULL COMMENT '更新时间',
PRIMARY KEY (`id`),
UNIQUE KEY `username` (`user_name`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of tb_user
-- ----------------------------
INSERT INTO `tb_user` VALUES ('1', 'zhangsan', '123456', '张三', '30', '1', '1964-08-08', '张三同学在学Java', '2014-09-19 16:56:04', '2014-09-21 11:24:59');
INSERT INTO `tb_user` VALUES ('2', 'lisi', '123456', '李四', '21', '2', '1995-01-01', '李四同学在传智学Java', '2014-09-19 16:56:04', '2014-09-19 16:56:04');
INSERT INTO `tb_user` VALUES ('3', 'wangwu', '123456', '王五', '22', '2', '1994-01-01', '王五同学在学php', '2014-09-19 16:56:04', '2014-09-19 16:56:04');
INSERT INTO `tb_user` VALUES ('4', 'zhangliu', '123456', '张六', '20', '1', '1996-09-01', '张六同学在传智播客学Java', '2014-09-19 16:56:04', '2014-09-19 16:56:04');
INSERT INTO `tb_user` VALUES ('5', 'lina', '123456', '李娜', '28', '1', '1988-01-01', '李娜同学在传智播客学Java', '2014-09-19 16:56:04', '2014-09-19 16:56:04');
INSERT INTO `tb_user` VALUES ('6', 'lilei', '123456', '李雷', '23', '1', '1993-08-08', '李雷同学在传智播客学Java', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('7', 'hanmeimei', '123456', '韩梅梅', '24', '2', '1992-08-08', '韩梅梅同学在传智播客学php', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('8', 'itcast', '123456', '传智播客', '21', '2', '2008-07-08', '传智播客搞IT教育', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('9', 'heima', '123456', '黑马', '18', '2', '2012-08-08', '黑马是传智播客高端品牌', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('10', 'linus', '123456', '林纳斯', '45', '2', '1971-08-08', '林纳斯搞了linux又搞git', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('11', 'leijun', '123456', '雷布斯', '33', '2', '1983-08-08', '小爱同学;are you ok', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
INSERT INTO `tb_user` VALUES ('12', 'madaye', '123456', '马大爷', '46', '2', '1980-08-08', '马大爷花呗可以不还吗', '2014-09-20 11:41:15', '2014-09-20 11:41:15');
创建
heima
-
springboot\src\main\java\com\itheima\pojo\User.java
如下:
package com.itheima.pojo;
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;
// getter和setter省略
}
5.1. Lombok
我们编写
pojo
时,经常需要编写构造函数和
getter
、
setter
方法,属性多的时候,就非常浪费时间,使用
lombok
插件可以解决这个问题:
在
IDEA
中安装
lombok
插件;不安装插件在
IDEA
中使用
lombok
的注解虽然编译能通过,但是源码会报错。所以为了让IDEA
更好的辨别
lombok
注解则才安装插件。
需要在
maven
工程中的
pom.xml
文件引入依赖:
<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
插件会自动生成。
5.2. 整合SpringMVC
虽然默认配置已经可以使用
SpringMVC
了,不过我们有时候需要进行自定义配置。
可以在
application.yml
文件中配置日志级别控制:
logging:
level:
com.itheima: debug
org.springframework: info
5.2.1.
修改端口
查看
SpringBoot
的全局属性可知,端口通过以下方式配置:
修改
application.yml
配置文件,添加如下配置:
# 映射端口
server:
port: 80
重启服务后测试:
5.2.2. 访问静态资源
现在,我们的项目是一个
jar
工程,那么就没有
webapp
,我们的静态资源该放哪里呢?
回顾我们在上面看的源码,有一个叫做
ResourceProperties
的类,里面就定义了静态资源的默认查找路径:
默认的静态资源路径为:
classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/
classpath:/public
只要静态资源放在这些目录中任何一个,
SpringMVC
都会帮我们处理。
我们习惯会把静态资源放在
classpath:/static/
目录下。我们创建目录
static
,并且从
资料
文件夹中复制itcast.gif 和
test.js
如下:
重启项目后测试:
注意:如果访问图片时候没有显示;可以先将项目先
clean
再启动,或者创建
public
、
resources
文件夹,然后图片放置到public
或
resources
中。
5.2.3. 添加拦截器
拦截器也是我们经常需要使用的,在
SpringBoot
中该如何配置呢?
拦截器不是一个普通属性,而是一个类,所以就要用到
java
配置方式了。在
SpringBoot
官方文档中有这么一段说明:
If you want to keep Spring Boot MVC features and you want to add additional
MVC confifiguration
(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
配置。
1.
创建
heima
-
springboot\src\main\java\com\itheima\interceptor\MyInterceptor.java
拦截器,内容如下
package com.itheima.interceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Slf4j
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.debug("这是MyInterceptor拦截器的preHandle方法");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.debug("这是MyInterceptor拦截器的postHandle方法");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
log.debug("这是MyInterceptor拦截器的afterCompletion方法");
}
}
2.
定义配置类
heima
-
springboot\src\main\java\com\itheima\config\MvcConfig.java
,用于注册拦截器,内容如下:
package com.itheima.config;
import com.itheima.interceptor.MyInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class MvcConfig implements WebMvcConfigurer {
/*** 将拦截器注册到spring ioc容器 * @return myInterceptor */
@Bean
public MyInterceptor myInterceptor(){
return new MyInterceptor();
}
/*** 重写该方法;往拦截器链添加自定义拦截器 * @param registry 拦截器链 */
@Override public void addInterceptors(InterceptorRegistry registry) {
//通过registry添加myInterceptor拦截器,并设置拦截器路径为 /*
registry.addInterceptor(myInterceptor()).addPathPatterns("/*");
}
}
结构如下:
接下来访问
http://localhost/hello
并查看日志:
5.3. 整合jdbc和事务
spring
中的
jdbc
连接和事务是配置中的重要一环,在
SpringBoot
中该如何处理呢?
答案是不需要处理,我们只要找到
SpringBoot
提供的启动器即可,在
pom.xml
文件中添加如下依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.46</version>
</dependency>
至于事务,
SpringBoot
中通过注解来控制。就是我们熟知的
@Transactional
使用的时候设置在对应的类或方法上即可。
创建
heima
-
springboot\src\main\java\com\itheima\service\UserService.java
业务类如下:
package com.itheima.service;
import com.itheima.pojo.User;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
public class UserService {
public User queryById(Long id){
//根据id查询
return new User();
}
@Transactional
public void saveUser(User user){
System.out.println("新增用户...");
}
}
5.4. 整合连接池
其实,在刚才引入
jdbc
启动器的时候,
SpringBoot
已经自动帮我们引入了一个连接池:
HikariCP
应该是目前速度最快的连接池了,我们看看它与
c3p0
的对比:
因此,我们只需要指定连接池参数即可;打开
application.yml
添加修改配置如下
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/springboot_test
username: root
password: root
【注意】
把
JdbcConfig
类中的
druid
的配置删除或注释;
在配置完
hikari
数据库连接池后的
application.yml
文件如下:
启动项目,访问
http://localhost/hello
;查看后台输出,一样可以在
HelloController
中获取到
datasource
。
5.5. 整合mybatis
5.5.1. mybatis
1. SpringBoot
官方并没有提供
Mybatis
的启动器,不过
Mybatis
官网
自己实现了。在项目的
pom.xml
文件中加入如下依赖:
<!--mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.1</version>
</dependency>
2.
配置
application.yml
,常用配置如下:
# mybatis配置
mybatis:
# 实体类别名包路径
type-aliases-package: com.itheima.pojo
# 映射文件路径
# mapper-locations: classpath:mappers/*.xml
configuration:
# 控制台输出执行sql
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
3.
配置
Mapper
扫描
需要注意,这里没有配置
mapper
接口扫描包,因此我们需要给每一个
Mapper
接口添加
@Mapper
注解,才能被识别。
@Mapper
public interface UserMapper {
}
或者,我们也可以不加注解,而是在启动类上添加扫描包注解
(
推荐
)
:
@SpringBootApplication
@MapperScan("com.itheima.mapper")
public class Application {
public static void main(String[] args) {
// 启动代码
SpringApplication.run(Application.class, args);
}
}
以下代码示例中,我们将采用
@MapperScan
扫描方式进行。
5.5.2. 通用mapper
1.
通用
Mapper
的作者也为自己的插件编写了启动器,我们直接引入即可。在项目的
pom.xml
文件中加入如下依赖:
<!-- 通用mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
注意
:一旦引入了通用
Mapper
的启动器,会覆盖
Mybatis
官方启动器的功能,因此
需要移除对官方
Mybatis
启动器
的依赖
。
2.
编写
UserMapper
无需任何配置就可以使用了。如果有特殊需要,可以到通用
mapper
官网查看:
https://github.com/abel533/Mapper/wiki/3.confifig
编写
heima
-
springboot\src\main\java\com\itheima\mapper\UserMapper.java
如下:
package com.itheima.mapper;
import com.itheima.pojo.User;
import tk.mybatis.mapper.common.Mapper;
public interface UserMapper extends Mapper<User> {
}
3.
把启动类上的
@MapperScan
注解修改为
通用
mapper
中自带的
:
4.
在
User
实体类上加
JPA
注解
修改
heima
-
springboot\src\main\java\com\itheima\pojo\User.java
如下:
@Data @Table(name = "tb_user")
public class User{
// id
@Id
//开启主键自动回填
@KeySql(useGeneratedKeys = true)
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.
对
UserService
的代码进行简单改造
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public User queryById(Long id){
//根据id查询
return userMapper.selectByPrimaryKey(id);
}
@Transactional
public void saveUser(User user){
System.out.println("新增用户...");
userMapper.insertSelective(user);
}
}
5.6. 启动测试
将
HelloController
进行简单改造:
@RestController
public class HelloController {
@Autowired
private UserService userService;
/**
* 根据id获取用户
* @param id 用户id
* @return 用户
*/
@GetMapping("/user/{id}")
public User queryById(@PathVariable Long id){
return userService.queryById(id);
}
}
我们启动项目,查看:
5.7. Junit测试
1.
在
springboot
项目中如果要使用
Junit
进行单元测试,则需要添加如下的依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
2.
在测试包下编写测试类
在测试类上面必须要添加
@SpringBootTest
注解。
编写测试类
heima
-
springboot\src\test\java\com\itheima\service\UserServiceTest.java
package com.itheima.service;
import com.itheima.pojo.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.Date;
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {
@Autowired
private UserService userService;
@Test
public void queryById() {
User user = userService.queryById(1L);
System.out.println("user = " + user);
}
@Test
public void saveUser() {
User user = new User();
user.setName("test");
user.setPassword("123456");
user.setSex(1);
user.setAge(20);
user.setCreated(new Date());
userService.saveUser(user);
}
}
测试代码结构如:
5.8. 整合Redis
在
pom.xml
文件中添加如下依赖;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
配置
application.yml
文件;
spring:
redis:
host: localhost
port: 6379
编写
src\test\java\com\itheima\redis\RedisTest.java
测试代码;
package com.itheima.redis;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.List;
import java.util.Set;
@RunWith(SpringRunner.class)
@SpringBootTest
public class RedisTest {
@Autowired
private RedisTemplate redisTemplate;
@Test
public void test(){
//string字符串
//redisTemplate.opsForValue().set("str", "heima");
redisTemplate.boundValueOps("str").set("heima");
System.out.println("str = " + redisTemplate.opsForValue().get("str"));
//hash散列
redisTemplate.boundHashOps("h_key").put("name", "黑马");
redisTemplate.boundHashOps("h_key").put("age", 13);
//获取所有域对应的值
Set set = redisTemplate.boundHashOps("h_key").keys();
System.out.println("hash散列所有的域:" + set);
List list = redisTemplate.boundHashOps("h_key").values();
System.out.println("hash散列所有的域值:" + list);
//list列表
redisTemplate.boundListOps("l_key").leftPush("c");
redisTemplate.boundListOps("l_key").leftPush("b");
redisTemplate.boundListOps("l_key").leftPush("a");
list = redisTemplate.boundListOps("l_key").range(0, -1);
System.out.println("列表的值:" + list);
//set集合
redisTemplate.boundSetOps("set_key").add("a", "b", "c");
set = redisTemplate.boundSetOps("set_key").members();
System.out.println("集合的元素:" + set);
//sorted set有序集合
redisTemplate.boundZSetOps("z_key").add("a", 30);
redisTemplate.boundZSetOps("z_key").add("b", 20);
redisTemplate.boundZSetOps("z_key").add("c", 10);
set = redisTemplate.boundZSetOps("z_key").range(0, -1);
System.out.println("有序集合的元素:" + set);
}
}
运行上述代码测试
6. Spring Boot项目部署
6.1. 项目打包
1.
添加项目的
pom.xml
插件;在
pom.xml
要显式的加入插件
spring-boot-maven-plugin
,否则无法产生
jar
清单文件,导致打出来的 jar
无法使用命令运行;
<build>
<plugins>
<!-- 打jar包时如果不配置该插件,打出来的jar包没有清单文件 -->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
2.
使用
maven
的命令
package
打包;
之后在项目下的
target
目录中将有如下
jar
包:
【注意】在查看打出的
jar
的时候,将发现
jar
包里面包含
jar
包;这样的包称为
fatJar
(肥包)
6.2. 运行
运行打出来的包;使用命令:
java –jar
包全名
或者写一个
bat
文件,里面包含
java –jar
包全名;这样就可以双击启动应用。
如执行上述打出来的
jar
的命令为:
java -jar heima-springboot-1.0-SNAPSHOT.jar
测试则可使用浏览器访问:
http://localhost/user/8