引言

接下来,我们开始学习Spring BootWeb开发,从这一章往后,就属于我们实战部分的内容了。

其实Spring Boot的东西用起来非常简单,因为Spring Boot最大的特点就是自动装配。

使用Spring Boot的步骤:

1、创建一个Spring Boot应用,选择我们需要的模块,Spring Boot就会默认将我们的需要的模块自动配置好

2、手动在配置文件中配置部分配置项目就可以运行起来了。

3、专注编写业务代码,不需要考虑以前那样一大堆的配置了。

要熟悉掌握开发,之前学习的自动配置原理一定要搞明白!

比如:Spring Boot到底帮我们配置了什么?我们能不能修改?我们能修改哪些配置?我们能不能扩展?

  • **自动配置类( xxxAutoconfiguration):**向容器中自动配置组件(Bean)。
  • 属性配置类xxxProperties):封装(propertiesyaml)配置文件的内容,供自动配置类使用。

没事就找找类,看看自动装配原理!

我们之后来进行一个单体项目的小项目测试,让大家能够快速上手开发!

附:搭建Spring Boot开发环境

参见《第一个Spring Boot应用程序

(1)在IDEA中新建一个项目名称为:springboot-02-webSpring Initializr项目。项目信息如下图所示:

项目信息

(2)选择初始化的组件(勾选Spring Web即可)和Spring Boot的版本(我们这里选择2.7.7版)。

版本信息

(3)填写项目路径,等待项目构建成功。

(4)先删除IDEA自动生成的.mvn文件夹、.gitignoreHELP.mdmvnwmvnw.cmd文件。

(5)然后,在Settings中手动配置Maven的安装目录、配置文件和本地仓库。

**注:**若Maven未识别到该子项目,则右键为其添加Maven支持。

(6)在程序的主启动类(Springboot02WebApplication)的同级目录下:

  • 新建一个controller包,用于存放控制器代码;
  • 新建一个service包,用于存放业务层代码;
  • 新建一个dao包,用于存放持久层代码(映射器接口及其对应的映射器配置文件);
  • 新建一个pojo包,用于存放实体类;
  • 新建一个utils包,用于存放我们封装的各种工具;
  • 新建一个config包,用于存放自定义配置文件。

**注:**程序的主启动类一定要与controllerservicedaopojoutilsconfig包在同级目录下,否则识别不到【约定大于配置】。

(7)在controller包下新建一个HelloController类。

HelloController.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

//控制器
@Controller
public class HelloController {
@RequestMapping("/hello")
@ResponseBody
public String sayHello(){
return "Hello Spring Boot!";
}
}

(8)启动主启动类中的main函数,在浏览器中输入http://localhost:8080/hello,页面访问成功。访问结果如下图所示:

环境测试成功

11、静态资源处理

11.1、传统web项目访问静态资源

在传统的web项目开发中,我们都是将所有的前端页面放在项目的webapp(或web)目录下。如下图所示:

传统Web项目静态资源目录

注:

  • 放在WEB-INF目录下的资源是受保护的,在浏览器上不能够通过路径直接访问。所以像HTMLCSSJSimage等静态资源一定要放到WEB-INF目录之外。
  • 传统Web项目发布后,都会被放到Web服务器(Tomcat)中指定的web应用文件夹下(webapps目录)。(详见《Tomcat详解》)

11.2、Spring Boot项目访问静态资源

SpringBoot项目中对静态资源的存放位置,是有规定的!

Spring Boot中,Spring MVCweb配置都在WebMvcAutoConfiguration这个自动配置类中。

(1)全局搜索WebMvcAutoConfiguration,可以发现:该类内部有一个WebMvcAutoConfigurationAdapter静态类。

(2)点击进入WebMvcAutoConfigurationAdapter类,可以发现其中有一个addResourceHandlers( 添加资源处理器)方法。

WebMvcAutoConfiguration.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Override
// 添加资源处理器
public void addResourceHandlers(ResourceHandlerRegistry registry) {
//判断是否使用默认的资源处理器?若不使用默认的资源处理器,则直接返回。(方式三)
if (!this.resourceProperties.isAddMappings()) {
logger.debug("Default resource handling disabled");
return;
}
//第一种静态资源映射规则:通过Webjars将"classpath:/META-INF/resources/webjars/"目录下的静态资源以jar包的方式导入。
addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
//第二种静态资源映射规则:直接访问本地默认路径下的静态资源。
addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
registration.addResourceLocations(this.resourceProperties.getStaticLocations());
if (this.servletContext != null) {
ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
registration.addResourceLocations(resource);
}
});
}

分析上述函数可以发现:Spring Boot默认会通过以下三种方式访问静态资源。

11.2.1、方式一:直接访问Webjars包特定目录下的静态资源(了解)

11.2.1.1、什么是webjars

WebJars就是将客户端Web库(如jQueryechartslayuiBootstrap等)打包后生成的一个个 jarJava Archive)包。

Spring Boot源码在addResourceHandlers函数中将URL访问路径"/webjars/**"映射到了项目的"classpath:/META-INF/resources/webjars/"目录下。

这样,我们便可以通过URL访问到Webjars"classpath:/META-INF/resources/webjars/"目录下的静态资源文件了。

因此,我们可以将静态资源存放在项目的"classpath:/META-INF/resources/webjars/"目录下。

注:我们一般不使用该方式访问我们自己编写的静态资源(如:HTMLCSSJSimage等)。

11.2.1.2、访问示例

如:我们要访问并使用jQuery库,我们只需要:

(1)去WebJars官网查找jQuery库的Maven依赖,并将该依赖添加到Spring Boot项目的pom.xml文件中。

pom.xml文件:

1
2
3
4
5
6
<!-- jQuery的WebJars依赖 -->
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>3.4.1</version>
</dependency>

(2)导入完毕后,查看webjars目录结构。如下图所示:

webjars目录结构

此时,我们便可以通过URLhttp://localhost:8080/webjars/**)访问到Webjars"classpath:/META-INF/resources/webjars/"目录下的静态资源了。

(3)启动主启动类中的main函数,在浏览器中输入http://localhost:8080/webjars/jquery/3.4.1/jquery.js,便可以成功访问jquery.js文件。访问结果如下图所示:

成功访问jQuery

11.2.2、方式二:直接访问本地默认路径下的静态资源

11.2.2.1、源码分析

继续分析addResourceHandlers( 添加资源处理器)方法中的第二种静态资源映射规则,可以发现:其中调用了getStaticPathPattern方法用于获取静态资源的URL访问路径;调用了getStaticLocations方法用于获取静态资源的本地存放目录。

(1)点击进入getStaticPathPattern方法,可以发现静态资源的URL访问路径为:"/**"

WebMvcProperties.java文件:

1
2
3
4
5
6
//静态资源访问路径
private String staticPathPattern = "/**";

public String getStaticPathPattern() {
return this.staticPathPattern;
}

(2)点击进入getStaticLocations方法,可以发现静态资源默认的本地存放目录为:"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"

WebProperties.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
//静态资源默认的本地存放目录
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = {
"classpath:/META-INF/resources/",
"classpath:/resources/",
"classpath:/static/",
"classpath:/public/" };
//静态资源默认的本地存放目录
private String[] staticLocations = CLASSPATH_RESOURCE_LOCATIONS;

public String[] getStaticLocations() {
return this.staticLocations;
}

即:Spring Boot源码在addResourceHandlers函数中将URL访问路径"/**"默认映射到了项目的"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"目录下。

这样,我们便可以通过URL访问项目默认目录下的静态资源文件了。

11.2.2.2、结论

  • 我们可以将静态资源存放在项目的以下目录下:
1
2
3
4
"classpath:/META-INF/resources/"
"classpath:/resources/"
"classpath:/static/"
"classpath:/public/"
  • 访问上述四个目录的优先级为:"classpath:/META-INF/resources/" > "classpath:/resources/" > "classpath:/static/" > "classpath:/public/"

我们在项目的resources根目录下新建对应的文件夹,都可以存放我们的静态文件。如:我们访问 http://localhost:8080/test.png , Spring Boot就会去默认的这些文件夹中寻找对应的静态资源test.png文件。

注:我们一般使用这种方式访问我们自己编写的静态资源(如:HTMLCSSJSimage等)。

11.2.3、方式三:自定义静态资源存放路径(了解)

我们也可以在(propertiesyaml)配置文件中自定义静态资源的URL访问路径和本地存放目录。如:

application.properties文件:

1
2
3
4
#自定义静态资源的URL访问路径
spring.mvc.static-path-pattern=/atang/**
#自定义静态资源的本地存放目录
spring.web.resources.static-locations=classpath:/MyStaticResource/

注:

  • 一旦自己定义了静态资源的访问路径或本地存放目录,Spring Boot默认配置的访问路径或本地存放目录就会失效了!
  • 我们一般不自定义静态资源的访问路径和本地存放目录,而是使用默认的配置。

11.3、欢迎页定制

11.3.1、源码分析

Spring Boot的欢迎页同样是在WebMvcAutoConfiguration自动配置类中进行处理的。

(1)全局搜索WebMvcAutoConfiguration,可以发现:该类内部有一个EnableWebMvcConfiguration静态类。

(2)点击进入EnableWebMvcConfiguration类,可以发现其中有一个welcomePageHandlerMapping(欢迎页处理器映射)方法。

WebMvcAutoConfiguration.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
@Bean
//欢迎页处理器映射
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
//getWelcomePage()方法:获取欢迎页面
WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
this.mvcProperties.getStaticPathPattern());
welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
return welcomePageHandlerMapping;
}

分析welcomePageHandlerMapping(欢迎页处理器映射)方法,可以发现:其中调用了getWelcomePage方法用于获取欢迎页面。

(3)点击进入getWelcomePage方法。

WebMvcAutoConfiguration.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
//获取欢迎页面
private Resource getWelcomePage() {
//遍历默认的静态资源存放目录:"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"
for (String location : this.resourceProperties.getStaticLocations()) {
//获取默认静态资源存放目录下的欢迎页面
Resource indexHtml = getIndexHtml(location);
//若找到,则返回index.html页面
if (indexHtml != null) {
return indexHtml;
}
}
ServletContext servletContext = getServletContext();
if (servletContext != null) {
return getIndexHtml(new ServletContextResource(servletContext, SERVLET_LOCATION));
}
return null;
}

//获取默认静态资源存放目录下的欢迎页面
private Resource getIndexHtml(String location) {
//获取默认静态资源存放目录下的index.html页面
return getIndexHtml(this.resourceLoader.getResource(location));
}

//获取默认静态资源存放目录下的index.html页面
private Resource getIndexHtml(Resource location) {
try {
Resource resource = location.createRelative("index.html");
if (resource.exists() && (resource.getURL() != null)) {
return resource;
}
}
catch (Exception ex) {
}
return null;
}

可以发现:Spring Boot启动时默认会从默认的静态资源存放目录下搜索index.html页面作为欢迎页面。

11.3.2、具体实现

(1)在静态资源的任一默认存放目录下,新建一个index.html文件。

index.html文件:

1
<h1>Welcome to Spring Boot!</h1>

(2)启动主启动类中的main函数,在浏览器中输入http://localhost:8080/,欢迎页面访问成功。访问结果如下图所示:

欢迎页面

12、Thymeleaf模板引擎

12.1、模板引擎及其工作原理

前端交给我们的是html页面。在以前的项目开发中,我们需要把它们转成jsp页面,jsp的好处就是我们可以把查出一些数据转发到jsp页面,我们可以用jsp轻松实现数据的显示和交互等。

jsp的功能非常强大,包括能写Java代码等。但是由于SpringBoot项目是以jar包的方式进行打包(不是war包),且默认使用的是嵌入式的Tomcat,所以:SpringBoot默认是不支持jsp

既然SpringBoot不支持jsp,如果我们直接用纯静态页面的方式,那么会给我们的开发会带来很大的麻烦,那怎么办呢?

SpringBoot推荐我们使用模板引擎。

**注:**其实jsp就是一个模板引擎。

模板引擎有非常多,如:SpringBoot给我们推荐的Thymeleaf,还有用的比较多的freemarker等。但再多的模板引擎,它们的思想都是一样的,其工作原理如下图所示:

模板引擎原理

模板引擎的工作原理就是:将后端封装好的数据填充到前端写好的页面模板的表达式中,最终生成一个我们想要的前端页面。

  • 不管是jsp,还是其他模板引擎,都是这个思想。
  • 不同的模板引擎之间,只是在语法上有所不同。

12.2、Thymeleaf简介

Thymeleaf是一个面向web和非web环境的现代服务器端Java模板引擎。它是一个开源的Java库,能够处理htmlxmltextjavascriptcssraw等模型。

Thymeleaf提供了一个用于整合Spring MVC的可选模块,在项目开发中,我们可以使用Thymeleaf来完全代替jsp,或其他模板引擎,如VelocityFreeMarker等。

12.3、Thymeleaf自动配置规则

12.3.1、源码分析

根据Spring Boot的自动配置原理,我们可以:

  • 在自动配置的核心文件中找到Thymeleaf的自动配置类(org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration)。

  • 全局搜索ThymeleafAutoConfiguration自动配置类。

    ThymeleafAutoConfiguration.java文件:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    //表示这是一个自动配置类,和以前Spring中编写的xml配置文件一样,也可以向IOC容器中添加组件
    @AutoConfiguration(after = { WebMvcAutoConfiguration.class, WebFluxAutoConfiguration.class })
    //启动指定类的属性配置功能(参数:xxxProperties类为属性配置类)
    @EnableConfigurationProperties(ThymeleafProperties.class)
    //自动配置类生效的条件
    @ConditionalOnClass({ TemplateMode.class, SpringTemplateEngine.class })
    @Import({ TemplateEngineConfigurations.ReactiveTemplateEngineConfiguration.class,
    TemplateEngineConfigurations.DefaultTemplateEngineConfiguration.class })
    public class ThymeleafAutoConfiguration {
    ……
    }
  • 点击进入Thymeleaf属性配置类(ThymeleafProperties,我们可以在其中查看Spring BootThymeleaf默认的自动配置规则。

    ThymeleafProperties.java文件:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    @ConfigurationProperties(prefix = "spring.thymeleaf")
    public class ThymeleafProperties {
    private static final Charset DEFAULT_ENCODING = StandardCharsets.UTF_8;
    //默认前缀
    public static final String DEFAULT_PREFIX = "classpath:/templates/";
    //默认后缀
    public static final String DEFAULT_SUFFIX = ".html";
    private boolean checkTemplate = true;
    private boolean checkTemplateLocation = true;
    private String prefix = DEFAULT_PREFIX;
    private String suffix = DEFAULT_SUFFIX;
    private String mode = "HTML";
    private Charset encoding = DEFAULT_ENCODING;
    ……
    }

12.3.1、结论

通过分析上述源码,我们可以在发现Spring BootThymeleaf默认的前缀为:"classpath:/templates/",默认的后缀为:".html"

因此,**使用Thymeleaf我们什么都不需要配置,只需要把我们的html页面存放在类路径下的templates目录下即可。**这样,Thymeleaf就可以帮助我们自动渲染前端页面了。

12.4、Thymeleaf的使用步骤

(1)添加Thymeleaf启动器依赖

Spring官方文档中:找到Thymeleaf启动器,并将其依赖添加到项目的pom.xml文件中。

pom.xml文件:

1
2
3
4
5
<!--thymeleaf依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

此时,Maven会自动下载相应的jar包,如下图所示:

Thymeleaf依赖包

(2)新建html页面并导入约束

在项目的templates目录下新建一个test.html测试页面。

test.html文件:

1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>阿汤笔迹</title>
</head>
<body>
<h1>测试页面</h1>
<!--th:text就是将div中的内容设置为它指定的值-->
<div th:text="${msg}"></div>
</body>
</html>

注:

  • templates目录下的所有页面,只能通过Controller来跳转!

  • 我们要使用Thymeleaf,需要在html文件中导入命名空间的约束,方便提示。

    1
    xmlns:th="http://www.thymeleaf.org"
  • 如果html页面中的表达式变量名爆红,那么我们可以在设置中取消Thymeleaf的表达式变量验证。

    取消表达式变量校验

(3)编写控制器

在项目的Controller目录下新建一个TestController类。

TestController.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package com.atangbiji.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/thymeleaf")
public class TestController {
@RequestMapping("/t1")
public String test(Model model){
//存入数据
model.addAttribute("msg","Hello,Thymeleaf");
//返回classpath:/templates/test.html页面
return "test";
}
}

(4)启动测试

启动主启动类中的main函数,在浏览器中输入http://localhost:8080/thymeleaf/t1,页面访问成功。访问结果如下图所示:

thymeleaf测试结果

12.5、Thymeleaf语法

12.5.1、属性优先级

我们可以使用任意的th:xxx来替换html中原生属性的值。Thymeleaf中可以使用的(全部)属性及优先级如下表所示:

thymeleaf属性

12.5.2、表达式语法

(1)简单表达式

表达式名字 语法格式 用途
变量表达式(Variable Expressions ${…} 获取变量的值
选择变量表达式(Selection Variable Expressions *{…} 获取上下文变量的值,与${}功能类似
消息表达式(Message Expressions #{…} 获取国际化信息
链接表达式(Link URL Expressions @{…} 定义URL
代码块表达式(Fragment Expressions ~{…} 引用公共页面代码块

(2)字面常量

  • 文本值(单引号):'one text''Another one!'、…
  • 数字:0343.012.3、…
  • 布尔值:true, false
  • 空值:null
  • 变量:onesometextmain、…

(3)文本操作

  • 字符串拼接:+
  • 文本替换:|The name is ${name}|

(4)数学运算

+-*/%

(5)布尔运算

andor!not

(6)比较运算

><>=<===!=

(7)条件运算

  • If-then: (if) ? (then)

  • If-then-else: (if) ? (then) : (else)

  • Default: (value) ?: (defaultvalue)

(8)无操作_

注:

  • 上述表达式中的所有功能都可以进行组合和嵌套。
  • Thymeleaf中有很多样式,实际项目中需要使用什么,能够根据官方文档来查询才是最重要的,要熟练使用官方文档!

13、Spring MVC自动配置原理

13.1、Spring Boot MVC的默认配置

Spring BootSpring MVC提供了自动配置,它可以很好地与大多数应用程序一起工作。Spring Boot中自动配置的Spring MVC主要是在Spring默认设置的基础上添加了以下功能:(详见Spring Boot官方文档

(1)包含视图解析器( ContentNegotiatingViewResolverBeanNameViewResolver )。

  • 我们之前学习SpringMVC时需要手动配置视图解析器,而Spring Boot为我们自动配置了自动配置了视图解析器(ContentNegotiatingViewResolverBeanNameViewResolver)。

  • ContentNegotiatingViewResolver (内容协商视图解析器)主要用来组合所有的视图解析器,它能够根据Web请求帮我们从候选视图解析器中选择最佳的视图解析器。

  • 视图解析器根据方法的返回值取得视图对象(View),然后由视图对象决定如何渲染(转发、重定向)。

(2)支持静态资源处理,以及webjars(详见第11节《静态资源处理》)

(3)自动注册了很多转换器(Converter)、通用转换器(GenericConverter)和格式化器(Formatter)。

  • 转换器(Converter):主要用于把前端提交的数据自动转换成后台封装的对象。如:

    • "1"字符串自动转换为int类型;
    • 把前端提交的用户信息(字段)转换为User实体类。
  • 格式化器(Formatter):可以对日期格式的数据进行格式化,并封装成Date对象。

**(4)支持 HttpMessageConverters。**即支持Http请求和响应的转换,如:把一个User对象转换为JSON字符串。

(5)自动注册了错误消息解析器(MessageCodesResolver)。

(6)支持自定义首页(index.html)。

(7)自动使用初始化数据绑定器(ConfigurableWebBindingInitializer。帮助我们把请求数据绑定到JavaBean

注:Spring Boot中这么多的自动配置,原理都是一样的,我们要不断提升自己通过分析源码得出结论的能力。

13.2、增强Spring Boot MVC的默认配置

如果我们要在上述Spring Boot MVC默认功能的基础上增加其它MVC配置(拦截器、格式化程序、视图控制器以及其它功能),那么我们可以自定义一个类型为WebMvcConfigurer的配置类(即WebMvcConfigurer接口实现类),然后在该类上添加@configuration注解,并且不能再该类上添加@EnableWebMvc注解。

13.2.1、实现步骤

在上述项目的基础上:

(1)在程序的主启动类的同级目录下,新建一个config包,用于存放自定义配置文件。

(2)在config包下新建一个名称为MyMvcConfigWebMvcConfigurer接口实现类,并为它添加@configuration注解,将其定义成一个配置类。并在其中重写addInterceptors方法以实现视图跳转功能。

MyMvcConfig.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.atangbiji.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

//自定义的MVC配置类
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
//视图跳转
@Override
public void addViewControllers(ViewControllerRegistry registry) {
//当浏览器发送/atang请求时,将视图跳转到test页面
registry.addViewController("/atang").setViewName("test");
}
}

(3)运行主启动类中的main函数,在浏览器中输入http://localhost:8080/test,页面跳转成功。访问结果如下图所示:

视图跳转测试

13.2.2、源码分析

WebMvcAutoConfigurationSpringMVC的自动配置类。

(1)全局搜索WebMvcAutoConfiguration自动配置类。可以发现其内部有一个WebMvcAutoConfigurationAdapter静态内部类,该类在做其它自动配置时会导入通过@Import注解导入EnableWebMvcConfiguration类。

WebMvcAutoConfiguration.java文件:

1
2
3
4
5
6
7
@Configuration(proxyBeanMethods = false)
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class, WebProperties.class })
@Order(0)
public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer, ServletContextAware {
……
}

(2)点击进入EnableWebMvcConfiguration类,可以发现它继承了一个DelegatingWebMvcConfiguration父类。

(3)点击进入DelegatingWebMvcConfiguration类,可以发现它会从容器中获取所有的webMvcConfigurer

DelegatingWebMvcConfiguration.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {

private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();

//从容器中获取所有的webMvcConfigurer
@Autowired(required = false)
public void setConfigurers(List<WebMvcConfigurer> configurers) {
if (!CollectionUtils.isEmpty(configurers)) {
this.configurers.addWebMvcConfigurers(configurers);
}
}
……
}

(4)我们可以在该类中去寻找一个我们刚才设置的viewController作为参考,发现它调用了一个addViewControllers方法。

DelegatingWebMvcConfiguration.java文件:

1
2
3
4
@Override
protected void addViewControllers(ViewControllerRegistry registry) {
this.configurers.addViewControllers(registry);
}

(5)点击进入addViewControllers方法。可以发现:它将所有与WebMvcConfigurer相关的配置一起调用!包括我们自己配置的和Spring给我们配置的。

WebMvcConfigurerComposite.java文件:

1
2
3
4
5
6
7
@Override
public void addViewControllers(ViewControllerRegistry registry) {
//将所有与WebMvcConfigurer相关的配置一起调用!包括我们自己配置的和Spring给我们配置的。
for (WebMvcConfigurer delegate : this.delegates) {
delegate.addViewControllers(registry);
}
}

因此,我们可以得出**结论:**所有的WebMvcConfiguration都会被作用,不止Spring自己的配置类,我们自定义的配置类也会被调用。

注:

  • Spring Boot中会有非常多的增强配置类,我们应该多留心注意。

  • 如果我们希望在Spring Boot MVC默认功能的基础上使用自定义的RequestMappingHandlerMappingRequestMappingHandlerAdapterExceptionHandlerExceptionResolver的组件,那么我们可以声明一个WebMvcRegistrationAdapter实例来提供这些组件的自定义实例。

13.3、全面接管Spring MVC(了解)

如果我们要全面接管Spring MVC,那么只需在上述自定义的MVC配置类中添加一个@EnableWebMvc注解即可。

此时,Spring Boot中所有的Spring MVC自动配置都会失效!因此,实际开发中,我们不推荐全面接管SpringMVC

13.3.1、对比测试

在上述项目的基础上:

(1)不加@EnableWebMvc注解之前

运行主启动类中的main函数,在浏览器中输入http://localhost:8080/,访问首页成功。访问结果如下图所示:

全面接管前

(2)添加@EnableWebMvc注解之后

MyMvcConfig.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.atangbiji.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

//自定义的MVC配置类
@Configuration
//全面接管SpringMVC
@EnableWebMvc
public class MyMvcConfig implements WebMvcConfigurer {
//视图跳转
@Override
public void addViewControllers(ViewControllerRegistry registry) {
//当浏览器发送/atang请求时,将视图跳转到test页面
registry.addViewController("/atang").setViewName("test");
}
}

重新运行主启动类中的main函数,在浏览器中输入http://localhost:8080/,访问首页失败。因为,自定义的WebMvcConfigurer配置类全面接管Spring MVC后,SpringBoot默认给我们配置的静态资源映射会全部无效。访问结果如下图所示:

全面接管后

13.3.2、源码分析

(1)点击进入@EnableWebMvc注解,可以发现:它通过@Import注解导入了一个DelegatingWebMvcConfiguration类。

EnableWebMvc.java文件:

1
2
3
4
5
6
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}

(2)点击进入DelegatingWebMvcConfiguration类,发现它继承了一个WebMvcConfigurationSupport父类。

DelegatingWebMvcConfiguration.java文件:

1
2
3
4
@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
……
}

(3)查看WebMvcAutoConfiguration自动配置类。可以发现:当容器中没有WebMvcConfigurationSupport这个组件(Bean)时,这个自动配置类才生效。

WebMvcAutoConfiguration.java文件:

1
2
3
4
5
6
7
8
9
10
@AutoConfiguration(after = { DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
ValidationAutoConfiguration.class })
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
//当容器中没有WebMvcConfigurationSupport这个组件时,这个自动配置类才生效
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
public class WebMvcAutoConfiguration {
……
}

因此,当我们在上述自定义的MVC配置类中添加了@EnableWebMvc注解后,Spring Boot中所有的Spring MVC自动配置都会失效!

14、使用JDBC操作数据库

14.1、Spring Data简介

Spring Data也是Spring中与Spring BootSpring Cloud等齐名的知名项目。对于数据访问层,无论是SQL(关系型数据库)还是NOSQL(非关系型数据库),Spring Boot底层都是采用Spring Data的方式进行统一处理。

14.2、搭建测试环境

(1)新建一个项目名称为:springboot-03-dataSpring Initializr项目。参见《使用IDEA创建项目

data测试项目信息

(2)选择初始化的组件(此处勾选JDBC APIMySQL Driver即可)和Spring Boot的版本(我们这里选择2.7.8版)。

data项目初始化

(3)填写项目路径,等待项目构建成功。项目构建成功后,它会默认为我们导入JDBC启动器和MySQL驱动相关的依赖。

pom.xml文件:

1
2
3
4
5
6
7
8
9
10
11
<!-- JDBC启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- MySQL驱动依赖 -->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>

(4)先删除IDEA自动生成的.mvn文件夹、.gitignoreHELP.mdmvnwmvnw.cmd文件。

(5)然后,在Settings中手动配置Maven的安装目录、配置文件和本地仓库。

**注:**若Maven未识别到该子项目,则右键为其添加Maven支持。

(6)在程序的主启动类(Springboot03DataApplication)的同级目录下:

  • 新建一个controller包,用于存放控制器代码;
  • 新建一个service包,用于存放业务层代码;
  • 新建一个dao包,用于存放持久层代码(映射器接口及其对应的映射器配置文件);
  • 新建一个pojo包,用于存放实体类;
  • 新建一个utils包,用于存放我们封装的各种工具;
  • 新建一个config包,用于存放自定义配置文件。

**注:**程序的主启动类一定要与controllerservicedaopojoutilsconfig包在同级目录下,否则识别不到【约定大于配置】。

(7)在resources目录下,新建一个application.yaml配置文件,并在其中配置数据库连接信息。

application.yaml文件:

1
2
3
4
5
6
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver

**注:**我们这里连接的是在学习MyBatis时创建的mybatis数据库。其中的user表如下图所示:

user表

14.3、查看Spring Boot默认配置的数据源

按上述步骤完成测试环境搭建后,Spring Boot默认会帮我们完成JDBC相关的自动配置,我们直接去使用即可。

接下来,我们在测试类中对使用的数据源进行测试。

(1)编写测试函数。

Springboot03DataApplicationTests.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package com.atangbiji;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@SpringBootTest
@EnableAutoConfiguration
class Springboot03DataApplicationTests {

//DI注入数据源
@Autowired(required=false)
DataSource dataSource;
@Test
void contextLoads() throws SQLException {
//查看Spring Boot默认的数据源(Hikari)
System.out.println("默认的数据源:" + dataSource.getClass());

//获得数据库连接
Connection connection = dataSource.getConnection();
//使用原生的JDBC语句进行数据库操作(此处省略)
System.out.println("数据库连接:" + connection);
//关闭连接
connection.close();
}
}

(2)启动测试类(Springboot03DataApplicationTests),输出结果如下图所示:

jdbc数据源

结论:Spring Boot默认给我们配置的数据源为 : Hikari数据源class com.zaxxer.hikari.HikariDataSource)。

注:

  • HikariDataSource号称是Java WEB当前速度最快的数据源,相比于传统的C3P0DBCPTomcat jdbc等连接池更加优秀。
  • Spring Boot 2.0以上版本默认使用的是Hikari数据源。
  • 而以前版本(如Spring Boot 1.5)默认使用org.apache.tomcat.jdbc.pool.DataSource作为数据源。
  • 我们可以通过配置spring.datasource.type属性的值来指定其它的数据源,该属性的值为将要使用的数据源(数据库连接池)的完全限定名。

附:源码分析

Spring Boot中,JDBC数据源的自动配置是在org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration这个自动配置类中完成的,与之对应的属性配置类DataSourceProperties。具体分析过程参见《Spring Boot自动配置原理

14.4、JDBCTemplate模板类

  • 有了数据源(com.zaxxer.hikari.HikariDataSource),然后我们就可以拿到数据库连接(java.sql.Connection);有了数据库连接,然后我们就可以使用原生的JDBC语句来操作数据库(CRUD)了。

  • 即使不使用第三方第数据库操作框架(如:MyBatis等),Spring本身也对原生的JDBC做了轻量级的封装,即JdbcTemplate类。

**注:**在Spring Boot中有很多的XxxTemplate类。XxxTemplate类是Spring Boot已经为我们封装好的模板类(Bean),我们只需要拿来使用即可。

  • JDBC操作数据库的所有CRUD方法都被封装在JdbcTemplate这一模板类中。

  • Spring Boot默认已经将配置好的JdbcTemplate放在了容器中,我们只需自己注入即可使用。

  • JdbcTemplate的自动配置是依赖org.springframework.boot.autoconfigure.jdbc包下的JdbcTemplateConfiguration这一自动配置类完成的。

JdbcTemplate类主要提供以下几类方法:

  • execute方法:可以用于执行任何SQL语句,一般用于执行DDL语句。
  • update方法及batchUpdate方法:
    • update方法:用于执行新增、修改、删除等语句。
    • batchUpdate方法:用于执行批处理相关语句。
  • query方法及queryForXXX方法:用于执行查询相关语句。
  • call方法:用于执行存储过程、函数相关语句。

附:源码分析

Spring Boot中,JdbcTemplate的自动配置是在org.springframework.boot.autoconfigure.jdbc包下的JdbcTemplateAutoConfiguration这一自动配置类完成的,与之对应的属性配置类JdbcProperties。具体分析过程参见《Spring Boot自动配置原理

(1)全局搜索JdbcTemplateAutoConfiguration类。

JdbcTemplateAutoConfiguration.java文件:

1
2
3
4
5
6
7
8
9
@AutoConfiguration(after = DataSourceAutoConfiguration.class)
@ConditionalOnClass({ DataSource.class, JdbcTemplate.class })
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(JdbcProperties.class)
@Import({ DatabaseInitializationDependencyConfigurer.class, JdbcTemplateConfiguration.class,
NamedParameterJdbcTemplateConfiguration.class })
public class JdbcTemplateAutoConfiguration {

}

(2)点击进入JdbcTemplateConfiguration类,可以发现:在其中配置了JdbcTemplate类。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingBean(JdbcOperations.class)
class JdbcTemplateConfiguration {
//注册JdbcTemplate类(Bean)
@Bean
@Primary
JdbcTemplate jdbcTemplate(DataSource dataSource, JdbcProperties properties) {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
JdbcProperties.Template template = properties.getTemplate();
jdbcTemplate.setFetchSize(template.getFetchSize());
jdbcTemplate.setMaxRows(template.getMaxRows());
if (template.getQueryTimeout() != null) {
jdbcTemplate.setQueryTimeout((int) template.getQueryTimeout().getSeconds());
}
return jdbcTemplate;
}
}

14.5、CRUD测试

(1)在pom.xml文件中导入web场景启动器。

pom.xml文件:

1
2
3
4
5
<!-- web场景启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

(2)在controller包下,新建一个JdbcController类,用于测试使用JDBC操作数据库。

JdbcController文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package com.atangbiji.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;
import java.util.Map;

//JDBC控制器
@RestController
@RequestMapping("/jdbc")
public class JdbcController {
/**
* Spring Boot 默认提供了数据源(HikariDataSource)和JdbcTemplate
* JdbcTemplate中会自己注入数据源,用于简化 JDBC操作
* 使用它还能避免一些常见的错误,也不用自己来关闭数据库连接了
*/
@Autowired(required=false)
JdbcTemplate jdbcTemplate;

/**
* 查询user表中所有数据
* List中的1个Map对应数据库的1行数据
* Map中的key对应数据库的字段名,value对应数据库的字段值
*/
@GetMapping("/list")
public List<Map<String,Object>> userList(){
String sql = "select * from user";
List<Map<String, Object>> list_maps = jdbcTemplate.queryForList(sql);
return list_maps;
}

/******** 新增一个用户 ********/
@GetMapping("/add")
public String addUser(){
//插入语句(默认自动提交事务)
String sql = "insert into user(id, name, pwd) values (4, '小明','123456')";
jdbcTemplate.update(sql);
//返回
return "add Ok!";
}

/******** 修改一个用户(Restful风格) ********/
@GetMapping("/update/{id}")
public String updateUser(@PathVariable("id") int id){
//修改语句(默认自动提交事务)
String sql = "update user set name = ?, pwd = ? where id =" + id;
//封装数据
Object[] objects = new Object[2];
objects[0] = "小明2";
objects[1] = "222333";
jdbcTemplate.update(sql,objects);
//返回
return "update Ok!";
}

/******** 删除一个用户(Restful风格) ********/
@GetMapping("/delete/{id}")
public String deleteUser(@PathVariable("id") int id){
//删除语句(默认自动提交事务)
String sql = "delete from user where id = ?";
jdbcTemplate.update(sql,id);
//返回
return "delete Ok!";
}
}

(3)启动主启动类(Springboot03DataApplication)中的main函数。

  • 在浏览器中输入http://localhost:8080/jdbc/list,数据库查询成功。访问结果如下图所示:
JDBC查询
  • 在浏览器中输入http://localhost:8080/jdbc/add,数据增加成功。此时,数据库中的user表如下图所示:
JDBC增加
  • 在浏览器中输入http://localhost:8080/jdbc/update/4,数据修改成功。此时,数据库中的user表如下图所示:
jdbc修改
  • 在浏览器中输入http://localhost:8080/jdbc/delete/4,数据删除成功。此时,数据库中的user表如下图所示:
jdbc删除

至此,在Spring Boot中使用JDBC就搞定了数据库的CRUD

15、整合Druid数据源

15.1、Druid简介

为了提高Java程序操作数据库时候的性能,我们不得不使用数据库连接池。

Druid是阿里巴巴开源平台上的一个数据库连接池实现。它结合了C3P0DBCPDB连接池的优点,同时加入了日志监控。

Druid可以很好的监控DB池连接和SQL的执行情况,它天生就是针对监控而生的DB连接池。

Druid已经在阿里巴巴部署了超过600个应用,经过一年多生产环境大规模部署的严苛考验。

Spring Boot 2.0以上版本默认使用的是Hikari数据源。可以说HikariDriud都是当前Java Web开发中最优秀的数据源。我们这里重点介绍Spring Boot如何集成Druid数据源,如何实现数据库监控。

15.2、DruidDataSource基本配置参数

com.alibaba.druid.pool.DruidDataSource可以设置的基本配置参数如下:

Druid配置参数1

15.3、配置DruidDataSource

在上述项目的基础上:

(1)在项目的pom.xml文件中添加上Druid数据源的依赖。

pom.xml文件:

1
2
3
4
5
6
<!-- Druid数据源依赖 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.21</version>
</dependency>

(2)在配置文件中切换数据源。Spring Boot 2.0以上版本默认使用com.zaxxer.hikari.HikariDataSource数据源,如果我们不想使用默认的数据源,想切换数据源,那么只需要通过配置spring.datasource.type属性的值来指定其它的数据源即可。

application.yaml文件:

1
2
3
4
5
6
7
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.alibaba.druid.pool.DruidDataSource #切换为Druid数据源

(3)数据源切换之后,在测试类中注入DataSource,然后获取到它。输出当前使用的数据源便知是否成功切换。

Springboot03DataApplicationTests.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package com.atangbiji;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@SpringBootTest
@EnableAutoConfiguration
class Springboot03DataApplicationTests {

//DI注入数据源
@Autowired(required=false)
DataSource dataSource;
@Test
void contextLoads() throws SQLException {
//查看当前使用的数据源
System.out.println("当前使用的数据源:" + dataSource.getClass());

//获得数据库连接
Connection connection = dataSource.getConnection();
//进行数据库操作(此处省略)
System.out.println("数据库连接:" + connection);
//关闭连接
connection.close();
}
}

(4)启动测试类(Springboot03DataApplicationTests),发现当前使用的数据源已经切换成DruidDataSource。输出结果如下图所示:

切换数据源

(5)数据源切换成功后,就可以设置druid数据源的专有属性了。如:数据源连接初始化大小、最大连接数、等待时间、最小连接数等。

application.yaml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.alibaba.druid.pool.DruidDataSource #切换为Druid数据源

#Spring Boot默认是不会注入这些属性值的,要我们自己绑定
#druid数据源专有属性
initialSize: 5
minIdle: 5
maxActive: 20
maxWait: 60000
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
validationQuery: SELECT 1 FROM DUAL
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true

#配置监控统计拦截的filters:(1)stat:监控统计;(2)log4j:日志记录;(3)wall:防御sql注入
#若允许时报错: java.lang.ClassNotFoundException: org.apache.log4j.Priority
#则导入 log4j 的依赖即可,Maven 地址:https://mvnrepository.com/artifact/log4j/log4j
filters: stat,wall,log4j
maxPoolPreparedStatementPerConnectionSize: 20
useGlobalDataSourceStat: true
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

(6)导入Log4j的依赖。

pom.xml文件:

1
2
3
4
5
6
<!-- log4j依赖 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>

(7)在程序的主启动类(Springboot03DataApplication)的同级目录下,新建一个config包,用于存放自定义配置文件。

(8)在config包下新建一个DruidConfig配置类,用于配置Druid数据源。并在其中将自定义的Druid数据源添加到容器中,不再使用Spring Boot自动创建的数据源,即:将全局配置文件(application.yaml)中的Druid数据源属性与com.alibaba.druid.pool.DruidDataSource绑定,进而让全局配置文件中的Druid数据源属性生效。

DruidConfig.java文件:

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
package com.atangbiji.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

//自定义的Druid数据源配置类
@Configuration
public class DruidConfig {
/**
* 将自定义的Druid数据源添加到容器中,不再使用Spring Boot自动创建的数据源。
* 将全局配置文件(application.yaml)中的Druid数据源属性与com.alibaba.druid.pool.DruidDataSource绑定,
* 进而让全局配置文件中的Druid数据源属性生效。
* 其中:
* @ConfigurationProperties(prefix = "spring.datasource")的作用就是:
* 将全局配置文件中前缀为spring.datasource的属性值注入到com.alibaba.druid.pool.DruidDataSource的同名参数中去。
*/
@ConfigurationProperties(prefix = "spring.datasource")
@Bean
public DataSource druidDataSource() {
return new DruidDataSource();
}
}

其中:@ConfigurationProperties(prefix = "spring.datasource")的作用就是:将全局配置文件中前缀为spring.datasource的属性值注入到com.alibaba.druid.pool.DruidDataSource的同名参数中去。

(9)在测试类中测试Druid数据源的属性是否设置成功。

Springboot03DataApplicationTests.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package com.atangbiji;

import com.alibaba.druid.pool.DruidDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@SpringBootTest
@EnableAutoConfiguration
class Springboot03DataApplicationTests {

//DI注入数据源
@Autowired(required=false)
DataSource dataSource;
@Test
void contextLoads() throws SQLException {
//查看当前使用的数据源
System.out.println("当前使用的数据源:" + dataSource.getClass());

//获得数据库连接
Connection connection = dataSource.getConnection();
System.out.println(connection);
//进行数据库操作(此处省略)
DruidDataSource druidDataSource = (DruidDataSource) dataSource;
System.out.println("druidDataSource 数据源最大连接数:" + druidDataSource.getMaxActive());
System.out.println("druidDataSource 数据源初始化连接数:" + druidDataSource.getInitialSize());
//关闭连接
connection.close();
}
}

(10)启动测试类(Springboot03DataApplicationTests),可见发现配置参数已经生效!输出结果如下图所示:

Druid数据源属性设置成功

15.4、配置Druid数据源监控

Druid数据源具有监控的功能,并提供了一个web界面方便用户查看。类似安装路由器时,厂家提供了一个默认的web页面。具体使用步骤如下:

(1)在Druid数据源的配置类中设置Druid的后台管理页面,如:登录账号、密码等。

DruidConfig.java文件:

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
/**
* 配置Druid监控管理后台的Servlet(固定写法)
* 因为内置Servlet容器时没有web.xml文件,所以我们使用Spring Boot的方式注册Servlet.
*/
@Bean
public ServletRegistrationBean statViewServlet() {

ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

//这些参数可以在com.alibaba.druid.support.http.StatViewServlet
//的父类 com.alibaba.druid.support.http.ResourceServlet中找到。
Map<String, String> initParams = new HashMap<>();
initParams.put("loginUsername", "admin"); //后台管理界面的登录账号
initParams.put("loginPassword", "123456"); //后台管理界面的登录密码

//后台允许谁可以访问
//initParams.put("allow", "localhost"):表示只有本机可以访问
//initParams.put("allow", ""):为空或者为null时,表示允许所有访问
initParams.put("allow", "");
//后台拒绝谁访问
//initParams.put("deny", "192.168.1.20"):表示禁止此ip访问

//设置初始化参数
bean.setInitParameters(initParams);
return bean;
}

(2)配置完毕后,重新启动主启动类(Springboot03DataApplication)中的main函数。在浏览器中输入http://localhost:8080/druid/,系统会自动跳转到登录页面。如下图所示:

Druid后台监控登录

(3)在Druid数据源监控登录界面输入自定义的用户名和密码,即可成功登录Druid监控管理后台。访问结果如下图所示:

Druid后台监控首页

15.5、配置Druid web监控过滤器

我们还可以在Druid数据源的配置类中配置web监控的过滤器(filter)。具体实现方法如下:

DruidConfig.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/**
* 配置Druid web监控的filter
*/
@Bean
public FilterRegistrationBean webStatFilter() {

FilterRegistrationBean bean = new FilterRegistrationBean();
//WebStatFilter:用于配置Web和Druid数据源之间的管理关联监控统计
bean.setFilter(new WebStatFilter());

//exclusions:设置哪些请求进行过滤排除掉,从而不进行统计
Map<String, String> initParams = new HashMap<>();
initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
bean.setInitParameters(initParams);

//"/*" 表示过滤所有请求
bean.setUrlPatterns(Arrays.asList("/*"));
return bean;
}

在工作中,我们按需求进行配置即可!

16、整合MyBatis框架

16.1、mybatis-spring-boot-starter

16.2、搭建测试环境

(1)新建一个项目名称为:springboot-04-mybatisSpring Initializr项目。参见《使用IDEA创建项目

(2)选择初始化的组件(此处勾选Spring WebJDBC APIMySQL Driver即可)和Spring Boot的版本(我们这里选择2.7.8版)。

(3)填写项目路径,等待项目构建成功。项目构建成功后,它会默认为我们导入web启动器、JDBC启动器和MySQL驱动相关的依赖。

pom.xml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!-- web启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- JDBC启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- MySQL驱动依赖 -->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>

(4)先删除IDEA自动生成的.mvn文件夹、.gitignoreHELP.mdmvnwmvnw.cmd文件。

(5)然后,在Settings中手动配置Maven的安装目录、配置文件和本地仓库。

**注:**若Maven未识别到该子项目,则右键为其添加Maven支持。

(6)在程序的主启动类(Springboot03DataApplication)的同级目录下:

  • 新建一个controller包,用于存放控制器代码;
  • 新建一个service包,用于存放业务层代码;
  • 新建一个dao包,用于存放持久层代码(映射器接口及其对应的映射器配置文件);
  • 新建一个pojo包,用于存放实体类;
  • 新建一个utils包,用于存放我们封装的各种工具;
  • 新建一个config包,用于存放自定义配置文件。

**注:**程序的主启动类一定要与controllerservicedaopojoutilsconfig包在同级目录下,否则识别不到【约定大于配置】。

16.3、整合步骤

16.3.1、导入MyBatis启动器

(1)在项目的pom.xml文件中导入MyBatis启动器。

pom.xml文件:

1
2
3
4
5
6
<!-- mybatis启动器 -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>

16.3.2、配置数据源

(2)在resources目录下,新建一个application.yaml配置文件,并在其中配置数据库连接信息。

application.yaml文件:

1
2
3
4
5
6
7
#配置数据源
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver

注:

  • 我们这里使用的是Spring Boot默认的Hikari数据源。

  • 我们这里连接的是在学习MyBatis时创建的mybatis数据库。其中的user表如下图所示:

    user表

(3)在测试类中测试数据库是否连接成功。

Springboot04MybatisApplicationTests.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
package com.atangbiji;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@SpringBootTest
class Springboot04MybatisApplicationTests {
//DI注入数据源
@Autowired(required=false)
DataSource dataSource;
@Test
void contextLoads() throws SQLException {
//查看Spring Boot默认的数据源(Hikari)
System.out.println("默认的数据源:" + dataSource.getClass());

//获得数据库连接
Connection connection = dataSource.getConnection();
//使用原生的JDBC语句进行数据库操作(此处省略)
System.out.println("数据库连接:" + connection);
//关闭连接
connection.close();
}
}

(4)启动测试类(Springboot04MybatisApplicationTests),数据库连接成功。输出结果如下图所示:

数据库连接成功

16.3.3、创建实体类

(5)在项目的pom.xml文件中导入Lombok依赖。

pom.xml文件:

1
2
3
4
5
6
<!--lombok依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>

(6)在项目的pojo包下新建一个User类,用于实现关系型数据库和业务实体间的映射。

User.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.atangbiji.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//实体类
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private int id;
private String name;
private String pwd;
}

16.3.4、创建映射器接口

(7)在项目的dao包下新建一个UserMapper映射器接口类,然后再向其中添加映射器接口函数。

UserMapper.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package com.atangbiji.dao;

import com.atangbiji.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

//映射器接口
@Mapper
@Repository
public interface UserMapper {
//查询全部用户
List<User> queryUserList();
//根据id查询用户
User queryUserById(int id);
//添加一个用户
int addUser(User user);
//修改一个用户
int updateUser(User user);
//根据id删除一个用户
int deleteUser(int id);
}

注:

  • 映射器接口中的接口函数用于映射XML映射器配置文件中对应标签中的SQL语句
  • @Mapper注解表示该类是一个MyBatis的映射器接口类。
  • @Repository注解是@Component注解的衍生注解,用于将dao层的实体类对应的bean对象装配到Spring IOC容器中,交由Spring管理。

16.3.5、创建XML映射器配置文件

(8)在项目的resources目录下新建一个mybatis.mapper目录,用于存放XML映射器配置文件。然后,在该目录下新建一个映射器配置文件UserMapper.xml,并在其中使用标签实现SQL语句与映射器接口函数的映射

UserMapper.xml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间(绑定对应的映射器接口)-->
<mapper namespace="com.atangbiji.dao.UserMapper">
<!--查询全部用户-->
<select id="queryUserList" resultType="User">
select * from mybatis.user
</select>

<!--根据id查询用户-->
<select id="queryUserById" parameterType="int" resultType="User">
select * from mybatis.user where id = #{id}
</select>

<!--添加一个用户-->
<insert id="addUser" parameterType="User">
insert into mybatis.user (id,name,pwd) values (#{id},#{name},#{pwd})
</insert>

<!--修改一个用户-->
<update id="updateUser" parameterType="User">
update mybatis.user set name = #{name}, pwd = #{pwd} where id = #{id}
</update>

<!--根据id删除一个用户-->
<delete id="deleteUser" parameterType="int">
delete from mybatis.user where id = #{id}
</delete>
</mapper>

16.3.6、配置MyBatis(重点)

(9)在全局配置文件(application.propertiesapplication.yaml)中配置MyBatis的属性。(重点)

application.yaml文件:

1
2
3
4
#整合MyBatis
mybatis:
type-aliases-package: com.atangbiji.pojo #指定包下的类型别名
mapper-locations: classpath:mybatis/mapper/*.xml #注册所有的映射器

注:Spring Boot中导入MyBatis启动器后,MyBatis的相应配置会在自动配置类MybatisAutoConfiguration)中自动配置,其对应的属性配置类MybatisProperties类。因此,Spring Boot中我们一般不再使用MyBatis核心配置文件,而是将以前MyBatis核心配置文件中的所有配置改在Spring Boot的全局配置文件(application.propertiesapplication.yaml)中配置了。

16.3.7、CRUD测试

(10)在controller包下新建一个UserController类,用于测试Spring Boot整合MyBatis后的增删改查功能测试。

UserController.java文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.atangbiji.controller;

import com.atangbiji.dao.UserMapper;
import com.atangbiji.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

//控制器
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserMapper userMapper;

@GetMapping("/queryAll")
public List<User> queryUserList(){
return userMapper.queryUserList();
}

@GetMapping("/queryById/{id}")
public User queryUserById(@PathVariable("id") int id){
return userMapper.queryUserById(id);
}

@GetMapping("/add")
public String addUser(){
userMapper.addUser(new User(4,"葫芦娃","888888"));
return "add Ok!";
}

@GetMapping("/update")
public String updateUser(){
userMapper.updateUser(new User(4,"孙悟空","123456"));
return "update Ok!";
}

@GetMapping("/delete/{id}")
public String deleteUser(@PathVariable("id") int id){
userMapper.deleteUser(id);
return "delete Ok!";
}
}

**注:**实际项目中建议在Service层调用Dao层。

(11)启动主启动类(Springboot04MybatisApplication)中的main函数。

  • 在浏览器中输入http://localhost:8080/user/queryAll,数据库查询成功。访问结果如下图所示:
MyBatis查询全部
  • 在浏览器中输入http://localhost:8080/user/queryById/1,数据库查询成功。访问结果如下图所示:
MyBatis查询
  • 在浏览器中输入http://localhost:8080/user/add,数据增加成功。此时,数据库中的user表如下图所示:
MyBatis增加
  • 在浏览器中输入http://localhost:8080/user/update,数据修改成功。此时,数据库中的user表如下图所示:
MyBatis修改
  • 在浏览器中输入http://localhost:8080/user/delete/4,数据删除成功。此时,数据库中的user表如下图所示:
MyBatis删除

17、项目实战

学完上述知识点后,我们就可以使用Spring Boot进行基本的Web项目开发了!这里不再赘述,多练习才是王道!

(持续更新中…… )

阿汤笔迹微信公众平台

关注**“阿汤笔迹”** 微信公众号,获取更多学习笔记。
原文地址:http://www.atangbiji.com/2023/02/12/SpringBootInDetail02WebDev
博主最新文章在个人博客 http://www.atangbiji.com/ 发布。