SpringBoot 学习笔记

SpringBoot 学习笔记

@Author: YiHua Lee @Address: Guangdong province, China

了解SpringBoot

什么是SpringBoot

SpringBoot是Spring项目中的一个子工程,与我们所熟知的Spring-framework 同属于spring的产品:

20200817102250

我们可以看到下面的一段介绍:

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配置,做到开箱即用,迅速上手,让我们关注与业务而非配置。


为什么要学习SpringBoot

java 一直被人诟病的一点就是臃肿、麻烦。当我们还在辛苦的搭建项目时,可能 Python 程序员已经把功能写好了,究其原因注意是两点:

  1. 复杂的配置:

    项目各种配置其实是开发时的损耗, 因为在思考 Spring 特性配置和解决业务问题之间需要进行思维切换,所以写配置挤占了写应用程序逻辑的时间。


  2. 混乱的依赖管理:

    项目的依赖管理也是件吃力不讨好的事情。决定项目里要用哪些库就已经够让人头痛的了,你还要知道这些库的哪个版本和其他库不会有冲突,这难题实在太棘手。并且,依赖管理也是一种损耗,添加依赖不是写应用程序代码。一旦选错了依赖的版本,随之而来的不兼容问题毫无疑问会是生产力杀手。


而SpringBoot让这一切成为过去!

Spring Boot 简化了基于Spring的应用开发,只需要“run”就能创建一个独立的、生产级别的Spring应用。Spring Boot为Spring平台及第三方库提供开箱即用的设置(提供默认设置,存放默认配置的包就是启动器),这样我们就可以简单的开始。多数Spring Boot应用只需要很少的Spring配置。

我们可以使用SpringBoot创建java应用,并使用java –jar 启动它,就能得到一个生产级别的web工程。


SpringBoot的特点

Spring Boot 主要目标是:

  • 为所有 Spring 的开发者提供一个非常快速的、广泛接受的入门体验


  • 开箱即用(启动器starter-其实就是SpringBoot提供的一个jar包),但通过自己设置参数(.properties),即可快速摆脱这种方式。


  • 提供了一些大型项目中常见的非功能性特性,如内嵌服务器、安全、指标,健康检测、外部化配置等


  • 绝对没有代码生成,也无需 XML 配置。


快速入门

创建工程

  1. 新建一个空的工程:

    20200817110153
  2. 工程名为demo:

    20200817110322
  3. 新建一个model:

    20200817110400
  4. 使用maven来构建:

    20200817110426
  5. 然后填写项目坐标:

    20200817110454
  6. 目录结构:

    20200817110531
  7. 项目结构:

    20200817110550

添加依赖

添加父工程坐标

1
2
3
4
5
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.0.RELEASE</version>
</parent>

添加web启动器

为了让SpringBoot帮我们完成各种自动配置,我们必须引入SpringBoot提供的自动配置依赖,我们称为启动器。因为我们是web项目,这里我们引入web启动器:

1
2
3
4
5
6
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>

需要注意的是,我们并没有在这里指定版本信息。因为SpringBoot的父工程已经对版本进行了管理了。

项目中多出了大量的依赖:

20200817110848

都是SpringBoot根据spring-boot-starter-web这个依赖自动引入的,而且所有的版本都已经管理好,不会出现冲突。


管理jdk版本

默认情况下,maven工程的jdk版本是1.5,而我们开发使用的是1.8,因此这里我们需要修改jdk版本,只需要简单的添加以下属性即可:

1
2
3
<properties>
<java.version>1.8</java.version>
</properties>

完整pom

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
<?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.0.0.RELEASE</version>
</parent>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>

启动类

Spring Boot项目通过main函数即可启动,我们需要创建一个启动类:

20200817111051

然后编写main函数:

1
2
3
4
5
6
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

编写controller

编写一个controller:

20200817111207

代码:

1
2
3
4
5
6
7
8
@RestController
public class HelloController {

@GetMapping("hello")
public String hello(){
return "hello, spring boot!";
}
}

启动测试

接下来,我们运行main函数,查看控制台:

20200817111336

并且可以看到监听的端口信息:

20200817111647
  • 监听的端口是8080
  • SpringMVC的映射路径是:/
  • /hello路径已经映射到了HelloController中的hello()方法

打开页面访问:http://localhost:8080/hello

20200817111742

测试成功了!


Java配置

在入门案例中,我们没有任何的配置,就可以实现一个SpringMVC的项目了,快速、高效!

如果没有任何的xml,那么我们如果要配置一个Bean该怎么办?比如我们要配置一个数据库连接池,以前会这么玩:

1
2
3
4
5
6
7
<!-- 配置连接池 -->
<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>

现在该怎么做呢?


回顾历史

  • 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配置

java配置主要靠java类和一些注解,比较常用的注解有:

  • @Configuration:声明一个类作为配置类,代替xml文件
  • @Bean:声明在方法上,将方法的返回值加入Bean容器,代替<bean>标签
  • @value:属性注入
  • @PropertySource:指定外部属性文件

接下来用java配置来尝试实现连接池配置:

首先引入Druid连接池依赖:

1
2
3
4
5
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.6</version>
</dependency>

创建一个jdbc.properties文件,编写jdbc属性:

1
2
3
4
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/leyou
jdbc.username=root
jdbc.password=123

然后编写代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@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中测试:

1
2
3
4
5
6
7
8
9
10
11
@RestController
public class HelloController {

@Autowired
private DataSource dataSource;

@GetMapping("hello")
public String hello() {
return "hello, spring boot!" + dataSource;
}
}

然后Debug运行并查看:

20200817112559

属性注入成功了!


SpringBoot的属性注入

在上面的案例中,我们实验了java配置方式。不过属性注入使用的是@Value注解。这种方式虽然可行,但是不够强大,因为它只能注入基本类型值。

在SpringBoot中,提供了一种新的属性注入方式,支持各种java基本数据类型及复杂类型的注入。


  1. 我们新建一个类,用来进行属性注入:

    1
    2
    3
    4
    5
    6
    7
    8
    @ConfigurationProperties(prefix = "jdbc")
    @Data
    public class JdbcProperties {
    private String url;
    private String driverClassName;
    private String username;
    private String password;
    }

    • 在类上通过 @ConfigurationProperties 注解声明当前类为属性读取类
    • prefix="jdbc"读取属性文件中,前缀为jdbc的值。
    • 在类上定义各个属性,名称必须与属性文件中jdbc.后面部分一致

  2. 把上例中的 jdbc.properties 名称改为 application.properties,这是SpringBoot默认读取的属性文件名:

    20200817113052
  3. 在JdbcConfig中使用这个属性:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    @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:

      1. @Autowired注入

        1
        2
        @Autowired
        private JdbcProperties prop;

      2. 构造函数注入

        1
        2
        3
        4
        private JdbcProperties prop;
        public JdbcConfig(Jdbcproperties prop){
        this.prop = prop;
        }

      3. 声明有@Bean的方法参数注入

        1
        2
        3
        4
        @Bean
        public Datasource dataSource(JdbcProperties prop){
        // ...
        }

      这里采用第三种方式进行注入。


  4. 测试结果:

    20200817113447
  5. 大家会觉得这种方式似乎更麻烦了,事实上这种方式有更强大的功能,也是SpringBoot推荐的注入方式。两者对比关系:

    20200817113616

    优势:

    • Relaxed binding:松散绑定

      不严格要求属性文件中的属性名与成员变量名一致。支持驼峰,中划线,下划线等等转换,甚至支持对象引导。比如:user.friend.name:代表的是 user 对象中的 friend 属性中的 name 属性,显然 friend 也是对象。 @value 注解就难以完成这样的注入方式。


    • meta-data support:元数据支持,帮助IDE生成属性提示(写开源框架会用到)。


更优雅的注入

事实上,如果一段属性只有一个Bean需要使用,我们无需将其注入到一个类(JdbcProperties)中。而是直接在需要的地方声明即可:

1
2
3
4
5
6
7
8
9
10
11
@Configuration
public class JdbcConfig {

@Bean
// 声明要注入的属性前缀,SpringBoot会自动把相关属性通过set方法注入到DataSource中
@ConfigurationProperties(prefix = "jdbc")
public DataSource dataSource() {
DruidDataSource dataSource = new DruidDataSource();
return dataSource;
}
}

我们直接把@ConfigurationProperties(prefix = "jdbc")声明在需要使用的@Bean的方法上,然后SpringBoot就会自动调用这个Bean(此处是DataSource)的set方法,然后完成注入。使用的前提是:该类必须有对应属性的set方法!

再次测试:

20200817113929

自动配置原理

使用SpringBoot之后,一个整合了SpringMVC的WEB工程开发,变的无比简单,那些繁杂的配置都消失不见了,这是如何做到的?

一切魔力的开始,都是从我们的main函数来的,所以我们再次来看下启动类:

1
2
3
4
5
6
@SpringBootApplication
public class BootDemoApplication {
public static void main(String[] args) {
SpringApplication.run(BootDemoApplication.class, args);
}
}

我们发现特别的地方有两个:

  • 注解:@SpringBootApplication
  • run方法:SpringApplication.run()

了解@SpringBootApplication

点击进入,查看源码:

20200817114643

这里重点的注解有3个:

  • @SpringBootConfiguration
  • @EnableAutoConfiguration
  • @ComponentScan

@SpringBootConfiguration

我们继续点击查看源码:

20200817114812

通过这段我们可以看出,在这个注解上面,又有一个@Configuration注解。通过上面的注释阅读我们知道:这个注解的作用就是声明当前类是一个配置类,然后Spring会自动扫描到添加了@Configuration的类,并且读取其中的配置信息。而@SpringBootConfiguration是来声明当前类是SpringBoot应用的配置类,项目中只能有一个。所以一般我们无需自己添加。


@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,而这个启动器中帮我们添加了tomcatSpringMVC的依赖。此时自动配置就知道你是要开发一个web应用,所以就帮你完成了web及SpringMVC的默认配置了!


总结,SpringBoot内部对大量的第三方库或Spring内部库进行了默认配置,这些配置是否生效,取决于我们是否引入了对应库所需的依赖,如果有那么默认配置就会生效。

所以,我们使用SpringBoot构建一个项目,只需要引入所需框架的依赖,配置就可以交给SpringBoot处理了。除非你不希望使用SpringBoot的默认配置,它也提供了自定义配置的入口。


@ComponentScan

源码:

20200817115439

查看这个注解的注释,大概的意思:

配置组件扫描的指令。提供了类似与<context:component-scan>标签的作用

通过basePackageClasses或者basePackages属性来指定要扫描的包。如果没有指定这些属性,那么将从声明这个注解的类所在的包开始,扫描包及子包

而我们的@SpringBootApplication注解声明的类就是main函数所在的启动类,因此扫描的包是该类所在包及其子包。因此,一般启动类会放在一个比较前的包目录中。


默认配置原理

默认配置类

通过刚才的学习,我们知道 @EnableAutoConfiguration 会开启 SpringBoot 的自动配置,并且根据你引入的依赖来生效对应的默认配置。那么问题来了:

  • 这些默认配置是在哪里定义的呢?
  • 为何依赖引入就会触发配置呢?

其实在我们的项目中,已经引入了一个依赖:spring-boot-autoconfigure,其中定义了大量自动配置类:

20200817115914


还有:

20200817115937


非常多,几乎涵盖了现在主流的开源框架,例如:redis、jms、amqp、jdbc、jackson、mongodb、jpa、solr、elasticsearch、… 等等


例如SpringMVC,查看mvc 的自动配置类:

20200817120616

打开WebMvcAutoConfiguration:

20200817121208


我们看到这个类上的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的类,那么这个默认配置就会失效!


接着,我们查看该类中定义了什么:

视图解析器:

20200817121324

处理器适配器(HandlerAdapter):

20200817121349

等等 ……


默认配置属性

另外,这些默认配置的属性来自哪里呢?

20200817122010

我们看到,这里通过@EnableAutoConfiguration注解引入了两个属性:WebMvcProperties和ResourceProperties。这不正是SpringBoot的属性注入玩法嘛。


我们查看这两个属性类:

20200817122101

找到了内部资源视图解析器的prefix和suffix属性。

20200817122738

如果我们要覆盖这些默认属性,只需要在application.properties中定义与其前缀prefix和字段名一致的属性即可。


总结

SpringBoot为我们提供了默认配置,而默认配置生效的条件一般有两个:

  • 你引入了相关依赖
  • 你自己没有配置
  1. 启动器

    如果不想配置,只需要引入依赖即可,而依赖版本我们也不用操心,因为只要引入了SpringBoot提供的stater(启动器),就会自动管理依赖及版本了。

    因此,玩SpringBoot的第一件事情,就是找启动器,SpringBoot提供了大量的默认启动器。


  2. 全局配置

    SpringBoot的默认配置,都会读取默认属性,而这些属性可以通过自定义application.properties文件来进行覆盖。这样虽然使用的还是默认配置,但是配置中的值改成了我们自定义的。

    因此,玩SpringBoot的第二件事情,就是通过application.properties来覆盖默认属性值,形成自定义配置。我们需要知道SpringBoot的默认属性key,非常多。


SpringBoot实践

整合SpringMVC

修改端口

查看SpringBoot的全局属性可知,端口通过以下方式配置:创建 SpringBoot 默认配置文件 —— application.yaml

1
2
server:
port: 80

也可以使用 application.properties 默认配置文件来配置端口:

1
2
# 映射端口
server.port=80

重启服务后测试:

20200817172853

修改映射路径

修改配置文件:application.yaml

1
2
3
4
server:
port: 80
servlet:
path: "*.abc"

修改映射路径以后,获取映射路径的方法,也要修改为对应的映射,如:

1
2
3
4
5
@GetMapping(value = "hello.abc")
@ResponseBody
public String hello() {
return "Hello, SpringBoot!";
}

重启服务后测试:

20200817193401

修改日记级别

修改配置文件:application.yaml

1
2
3
4
5
6
7
8
server:
port: 80
servlet:
path: "*.abc"
logging:
level:
pers.stringbug: debug
org.springframework: debug

重启服务后测试:控制台这个时候输出的日记信息就会很详细

输出的部分日记信息

访问静态资源

现在,我们的项目是一个jar工程,那么就没有webapp,我们的静态资源该放哪里呢?

有一个叫做 ResourceProperties 的类,里面就定义了静态资源的默认查找路径:

默认的静态资源路径为:

  • classpath:/META-INF/resources/
  • classpath:/resources/
  • classpath:/static/
  • classpath:/public

只要静态资源放在这些目录中任何一个,SpringMVC都会帮我们处理。


我们习惯会把静态资源放在classpath:/static/目录下。我们创建目录,并且添加一些静态资源:

20200817200015

在 static 中放如下动态图片:

mysql从入门到放弃

重启项目后测试:

20200817200203

添加拦截器

如果我们想要保持 SpringBoot 的一些默认 MVC 特征,同时又想自定义一些 MVC 配置(包括:拦截器、格式化器、 视图控制器、消息转换器 等等)。这个时候,我们可以通过编写一个类,让这个类实现WebMvcConfigurer 接口,并且添加@Configuration注解,来实现自定义部分SpringMvc配置(不要添加@EnableWebMvc注解。)。

如果你想要自定义HandlerMappingHandlerAdapterExceptionResolver等组件,你可以创建一个WebMvcRegistrationsAdapter实例来提供以上组件。

如果你想要完全自定义SpringMVC,不保留SpringBoot提供的一切特征,你可以自己定义类并且添加@Configuration注解和@EnableWebMvc注解

注意:如果想要保留SpringBoot提供的一切特征,那么就不要添加@EnableWebMvc注解。


定义一个拦截器:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class MyInterceptor implements HandlerInterceptor {

private Logger logger = LoggerFactory.getLogger(MyInterceptor.class);

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) {
logger.debug("preHandle method is now running!");
return true;
}

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response,
Object handler, ModelAndView modelAndView) {
logger.debug("postHandle method is now running!");
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
logger.debug("afterCompletion method is now running!");
}
}

定义配置类,注册拦截器:

1
2
3
4
5
6
7
8
@Configuration
public class MvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 添加一个拦截器,该拦截器拦截一切路径
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
}
}

applacation.yaml 配置如下:

1
2
3
4
5
6
7
8
server:
port: 80
servlet:
path: /
logging:
level:
pers.stringbug: debug
org.springframework: debug

重启项目后测试:

20200817205854

此外拦截器还可以这样写:

1
2
3
4
5
6
7
8
9
public class MyInterceptor implements HandlerInterceptor {
private Logger logger = LoggerFactory.getLogger(MyInterceptor.class);
}

// 改成

@Slf4j
public class MyInterceptor implements HandlerInterceptor {
}

@Slf4j 可以帮我们为这个类创建 Logger 对象。


整合jdbc和事务

spring中的jdbc连接和事务是配置中的重要一环,在SpringBoot中该如何处理呢?

答案是不需要处理,我们只要找到SpringBoot提供的启动器即可:

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

当然,不要忘了数据库驱动,SpringBoot并不知道我们用的什么数据库,这里我们选择MySQL:

1
2
3
4
5
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>

其中,需要在 application.yaml 中添加如下配置:

1
2
3
4
5
6
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/Test
username: root
password: 123456

至于事务,SpringBoot中通过注解来控制。就是我们熟知的@Transactional

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Service
public class UserService {

@Autowired
private UserMapper userMapper;

public User queryById(Long id){
return this.userMapper.selectByPrimaryKey(id);
}

@Transactional
public void deleteById(Long id){
this.userMapper.deleteByPrimaryKey(id);
}

}

整合连接池

其实,在刚才引入jdbc启动器的时候,SpringBoot已经自动帮我们引入了一个连接池:

20200817221307

HikariCP应该是目前速度最快的连接池了,我们看看它与c3p0的对比:

20200817221352

使用 HikariCP,只需要指定连接池参数即可:application.yaml

1
2
3
4
5
6
7
8
9
10
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/Test
username: root
password: 123456
hikari:
idle-timeout: 60000
maximum-pool-size: 30
minimum-idle: 10

application.properties 文件中可以这样配置:

1
2
3
4
5
6
7
8
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/Test
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driverClassName=com.mysql.jdbc.Driver

spring.datasource.hikari.idle-timeout=60000
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.minimum-idle=10

当然,如果你更喜欢Druid连接池,也可以使用Druid官方提供的启动器:

1
2
3
4
5
6
<!-- Druid连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.6</version>
</dependency>

而连接信息的配置与上面是类似的,只不过在连接池特有属性上,方式略有不同:

1
2
3
4
5
6
7
8
9
10
11
12
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/Test
username: root
password: 123456
druid:
initial-size: 1
min-idle: 1
max-active: 20
test-on-borrow: true
stat-view-servlet.allow: true

application.properties 文件中可以这样配置:

1
2
3
4
5
6
7
8
9
10
#初始化连接数
spring.datasource.druid.initial-size=1
#最小空闲连接
spring.datasource.druid.min-idle=1
#最大活动连接
spring.datasource.druid.max-active=20
#获取连接时测试是否可用
spring.datasource.druid.test-on-borrow=true
#监控页面启动
spring.datasource.druid.stat-view-servlet.allow=true

整合mybatis

mybatis

SpringBoot官方并没有提供Mybatis的启动器,不过Mybatis官网自己实现了:

1
2
3
4
5
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>

配置,基本没有需要配置的:application.yaml

1
2
3
4
5
mybatis:
configuration:
map-underscore-to-camel-case: true
mapper-locations: mappers/*.xml
type-aliases-package: pers.stringbug.pojo

application.properties 文件中可以这样配置:

1
2
3
4
5
mybatis.configuration.map-underscore-to-camel-case=true
# mybatis 别名扫描
mybatis.type-aliases-package=com.heima.pojo
# mapper.xml文件位置,如果没有映射文件,请注释掉
mybatis.mapper-locations=classpath:mappers/*.xml

需要注意,这里没有配置mapper接口扫描包,因此我们需要给每一个Mapper接口添加@Mapper注解,才能被识别。

1
2
3
@Mapper
public interface UserMapper {
}

通用mapper

通用Mapper 的作者也为自己的插件编写了启动器,我们直接引入即可:

1
2
3
4
5
6
<!-- 通用mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>

注意:一但引入通用 Mapper 的启动器,会覆盖 Mybatis 官方启动器的功能。因此,需要移除对官方 Mybatis 启动器的依赖。


不需要做任何配置就可以使用了。如果还有其他需要,可以查看官网:https://github.com/abel533/Mapper/wiki

1
2
3
@Mapper
public interface UserMapper extends tk.mybatis.mapper.common.Mapper<User>{
}

另外,还需要在启动类上的 @MapperScan 注解修改为 通用Mapper 中自带的:

1
2
3
4
5
6
7
8
9
10
11
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
@MapperScan("pers.stringbug.mapper")
public class BootDemoApplication {
public static void main(String[] args) {
SpringApplication.run(BootDemoApplication.class, args);
}
}

启动测试

将controller进行简单改造:

1
2
3
4
5
6
7
8
9
10
11
12
@RestController
public class HelloController {

@Autowired
private UserService userService;

@GetMapping("/hello")
public User hello() {
User user = this.userService.queryById(8L);
return user;
}
}

我们启动项目,查看:

20200818003124

参考文献

  1. 黑马 Java
评论