Spring Boot

1.概述

SpringBoot是对Spring框架的缺点进行的改善和优化,基于约定优于配置的思想,可以让开发人员不必在配置与逻辑业务之间进行思维的切换,全身心的投入到逻辑业务的代码编写中,从而大大提高了开发的效率,一定程度上缩短了项目周期。

1.1 SpringBoot的特点

  • 为基于Spring的开发提供更快的入门体验
  • 开箱即用,没有代码生成,也无需XML配置。只需要少量配置即可构建一个JAVA EE项目
  • 提供了一些大型项目中常见的非功能性特性,如嵌入式服务器、安全、指标,健康检测、外部配置等
  • 内置Web服务器,可以快速部署
  • SpringBoot不是对Spring功能上的增强,而是提供了一种快速使用Spring构建JavaEE项目的方式

2. 快速入门

利用IDEA工具通过Spring Initializr快速构建一个SpringBoot项目

2.1 Spring Initializr新建项目

点击下一步

配置好项目名称和jdk后点击下一步

勾选上Web里面的Spring Web依赖然后点击下一步

  1. 项目创建完成后的maven依赖如下
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <parent>
  6. <groupId>org.springframework.boot</groupId>
  7. <artifactId>spring-boot-starter-parent</artifactId>
  8. <version>2.4.0</version>
  9. <relativePath/> <!-- lookup parent from repository -->
  10. </parent>
  11. <groupId>com.example</groupId>
  12. <artifactId>demo</artifactId>
  13. <version>0.0.1-SNAPSHOT</version>
  14. <name>demo</name>
  15. <properties>
  16. <java.version>1.8</java.version>
  17. </properties>
  18. <dependencies>
  19. <dependency>
  20. <groupId>org.springframework.boot</groupId>
  21. <artifactId>spring-boot-starter-web</artifactId>
  22. </dependency>
  23. <dependency>
  24. <groupId>org.springframework.boot</groupId>
  25. <artifactId>spring-boot-starter-test</artifactId>
  26. <scope>test</scope>
  27. </dependency>
  28. </dependencies>
  29. <build>
  30. <plugins>
  31. <plugin>
  32. <groupId>org.springframework.boot</groupId>
  33. <artifactId>spring-boot-maven-plugin</artifactId>
  34. </plugin>
  35. </plugins>
  36. </build>
  37. </project>
  1. 其中spring-boot-starter-parent是一个特殊的Starter,提供了一些maven的默认配置,同时还提供了dependency-management统一依赖管理,可以让开发者在引入其它依赖时不用输入版本号,方便依赖的管理,SpringBoot提供的starter很多,这些starter主要为第三方库提供的自动配置,例如spring-web依赖就是开发一个web项目必备的依赖。

2.2 编写启动类

  1. @EnableAutoConfiguration
  2. public class SpringBootDemoApplication {
  3. public static void main(String[] args) {
  4. System.out.println("http://localhost:3399");
  5. }
  6. }
  • @EnableAutoConfiguration注解表示开启自动配置,因为添加了springweb依赖,所以使用此注解可以对spring和springmvc之间进行自动配置。在传统xml配置里需要配置大量的标签。
  • 在main方法中通过SpringApplication中的run方法启动项目,参数一传入该类的.class,告诉spring主要的组件,参数二是运行时输入的其他参数。

2.3 编写控制器

  1. 在控制器指定一个/index接口,并在主启动类配置包扫描将控制器注册到spring容器中。
  1. @RestController
  2. public class IndexController {
  3. @GetMapping("/index")
  4. public String index() {
  5. return "This is a SpringBoot Application";
  6. }
  7. }

启动类

  1. @EnableAutoConfiguration
  2. @ComponentScan //扫描所有的包到spring容器
  3. public class SpringBootDemoApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(SpringBootDemoApplication.class);
  6. System.out.println("http://localhost:3399");
  7. }
  8. }

上面的@EnableAutoConfiguration和@ComponentScan注解可以用一个组合注解代替,@SpringBootApplication,此注解默认覆盖了这两个注解的功能。

  1. @SpringBootApplication
  2. public class SpringBootDemoApplication {
  3. public static void main(String[] args) {
  4. SpringApplication.run(SpringBootDemoApplication.class);
  5. System.out.println("http://localhost:3399");
  6. }
  7. }
  1. 启动项目访问`http://localhost:3399/index`

3. SpringBoot基本配置

3.1 @SpringBootApplication

  1. 上面用到的@SpringBootApplication注解是一个组合注解,是Spring Boot应用标注在某个类上说明这个类是SpringBoot的主配置类,项目启动应该运行这个类的main方法来启动SpringBoot应用,源码如下
  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. @SpringBootConfiguration
  6. @EnableAutoConfiguration
  7. @ComponentScan(excludeFilters = {
  8. @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
  9. @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
  10. public @interface SpringBootApplication {
  • @SpringBootConfiguration:Spring Boot的配置类,表示这是一个Spring Boot的配置类;
  • @Configuration:配置类上来标注这个注解
  • @Component:表示这是一个配置类,是容器中的一个组件;
  • @EnableAutoConfiguration:开启自动配置功能;

    1. 以前需要xml中配置的信息,Spring Boot可以自动配置;@**EnableAutoConfiguration**告诉SpringBoot开启自动配置功能,这样自动配置才能生效。

3.2 自定义banner

  1. SpringBoot项目在启动时会打印一个信息图标,如下图所示

上面这个图标可以通过自定义其它的内容显示,做法是在resources目录下创建一个banner.txt文件,在这个文件中写入文本,内容将会在项目启动时被打印出来,如果想替换各种艺术字则有以下几个网站可以定制。

  1. 如果想要关闭显示banner图标则可以在启动类设置。
  1. SpringApplicationBuilder builder = new SpringApplicationBuilder(SpringBootDemoApplication.class);
  2. builder.bannerMode(Banner.Mode.OFF).run(args);

3.3 Web容器配置

  1. SpringBoot项目中可以内置TomcatJettyUndertowNetty等容器,当添加了springweb依赖时默认会使用tomcat作为Web服务器,可以在resources下的application.properties文件中进行其它配置。

3.3.1 常规配置

  1. server.port=39 #配置项目访问端口号
  2. server.error.path=/error #项目出错时跳转到error命名的页面
  3. server.servlet.session.timeout=30m #设置session失效时间,30m为三十分钟
  4. server.servlet.context-path=/hello #配置访问路径,默认为/
  5. server.tomcat.uri-encoding=utf-8 #设置Tomcat请求编码
  6. server.tomcat.basedir=/src/log #设置存放Tomcat运行日志和临时文件的目录

3.32 Jetty配置

  1. 将默认的Tomcat服务器切换为Jetty服务器,配置如下
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <groupId>org.springframework.boot</groupId>
  7. <artifactId>spring-boot-starter-tomcat</artifactId>
  8. </exclusion>
  9. </exclusions>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-jetty</artifactId>
  14. </dependency>
  1. 首先排除Tomcatstarter依赖,然后再添加Jetty的依赖。启动项目查看控制台结果

3.4 properties配置

  1. SpringBoot中采用大量的自动化配置,替换了繁杂的XML配置,但也需要少量的配置来满足项目的开发需求,这些配置通常写入到resources目录下的application.properties文件,或者application.yaml文件,这两种配置文件有着格式上的区别。

SpringBoot项目中的application.properties配置文件可以放置到以下四个路径位置

  1. 项目根目录下的config文件夹中
  2. 项目根目录下
  3. classpath下的config文件夹中
  4. classpath路径下

    如果这四个位置都有properties文件则加载的时候按照优先级高低,上面从高到低分别为:1-2-3-4

3.5 类型安全配置属性

  1. SpringBoot提供了@Value注解来将类中的属性通过配置注入数据,这样即使在数据量大的情况下,也可以方便的将配置文件中设置的数据注入到Bean中。

在properties中添加一段配置

  1. user.name=admin
  2. user.password=system
  3. user.age=30;

新建一个类,将配置数据注入到Bean中

  1. @Component
  2. @ConfigurationProperties(prefix = "user")
  3. public class User {
  4. private String username;
  5. private String password;
  6. private Integer age;
  7. //省略get&set方法
  8. }

@ConfigurationProperties中的prefix属性表示要加载的配置类中指定的前缀,通过此前缀在配置文件中调用成员变量属性。

最后创建一个Controller测试

  1. @Autowired
  2. private User user; //注入user类
  3. @GetMapping("/user")
  4. public String user() {
  5. return user.toString();
  6. }

最后测试访问http://localhost:3399/user地址

3.6 yaml配置

yaml是json的超集,是一种专门用来编写配置文件的语言,功能和properties文件一样,yaml采用缩进来表示层级的关系,并且大小写敏感,使用yaml文件只需要在resources目录下创建一个application.yaml文件。

3.6.1 语法示例

新建两个User实体类

  1. @Data
  2. @Component //注入到容器当中
  3. @ConfigurationProperties(prefix = "user") //指定配置文件中对象的前缀
  4. public class User implements Serializable {
  5. private String username; //字符串类型
  6. private Boolean showStatus; //布尔类型
  7. private Date birthday; //日期类型
  8. private Integer age; //数值类型
  9. private Pet pet; //对象类型
  10. private String[] hobby; //字符串数组
  11. private List<String> pets; //List集合类型
  12. private Map<String, Object> money; //Map集合类型
  13. private Set<String> salaries; //Set集合类型
  14. private Map<String, List<Pet>> allPets; //复杂Map集合类型
  15. }
  16. @Data
  17. public class Pet {
  18. private String name;
  19. private Integer age;
  20. }
  • yaml语法配置
  1. # 指定的suer前缀
  2. user:
  3. username: Ted #普通字符串类型
  4. showStatus: true #布尔类型
  5. birthday: 2020/12/30 22:22:22 #日期类型
  6. age: 20 #数值类型
  7. #对象类型配置
  8. pet:
  9. name: Bear
  10. age: 3
  11. #数组类型配置
  12. hobby: [学习,睡觉]
  13. #List集合类型配置
  14. pets:
  15. - Cat
  16. - Dog
  17. #Map集合类型
  18. money:
  19. ted:
  20. bear: 20
  21. dog: 30
  22. cat: 40
  23. #行内写法
  24. admin: [1,2,3]
  25. arthur: [deer: 30, horse: 40]
  26. #Set集合类型
  27. salaries: [2000,3000,4000]
  28. #复杂Map集合类型
  29. allPets:
  30. big:
  31. - {name: Bear}
  32. - {name: elephant}
  33. small: [{name: cat,age: 3}]
  • 测试
  1. @Autowired
  2. User user; //注入user对象
  3. @GetMapping("/user")
  4. public User findAll() {
  5. return user; //返回user对象
  6. }

3.7 profile

  1. 为了替换不同开发环境的配置文件,springboot提供了profile表示配置环境,根据后缀配置不同的开发环境。

使用如下:

  1. 在resources目录下创建两个配置文件:application-dev.properties、application-prod.properties
    • application-dev.properties
  1. server.port=8080
  • application-dev.properties
  1. server.port=80
  1. 区分两个配置文件的端口号
  • 接下来在application.properties文件指定开发的环境
  1. spring.profiles.active=dev
  1. 上面这段内容表示指定并使用application-dev.properties配置文件中的内容,如果替换为prod,则是用application-prod.properties中的内容
  • 在启动器中指定开发环境
  1. SpringApplicationBuilder builder = new SpringApplicationBuilder(SpringBootDemoApplication.class);
  2. builder.application().setAdditionalProfiles("dev");
  3. builder.run(args);

4. Spring Boot整合视图层技术

  1. 分别整合Thymeleaf-FreeMarker两种视图层的技术

4.1 整合thymeleaf

  1. 添加thymeleaf依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-thymeleaf</artifactId>
  4. </dependency>
  1. 配置thymeleaf信息
  1. #是否开启缓存,默认为true
  2. spring.thymeleaf.cache=true
  3. #文件编码
  4. spring.thymeleaf.encoding=UTF-8
  5. #模板文件位置
  6. spring.thymeleaf.prefix=classpath:/templates/
  7. #Content-Type配置
  8. spring.thymeleaf.servlet.content-type=text/html
  9. #模板文件后缀
  10. spring.thymeleaf.suffix=.html
  1. 编写Controller测试
  1. @GetMapping("/datas")
  2. public String da(Model model) {
  3. List<String> list = new ArrayList<>();
  4. list.add("Hello");
  5. list.add("World");
  6. model.addAttribute("result",list);
  7. return "data";
  8. }
  1. 在templates目录下创建一个data.html视图
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Title</title>
  6. </head>
  7. <body>
  8. <div th:text="${result[0]}"></div>
  9. <div th:text="${result[1]}"></div>
  10. </body>
  11. </html>
  1. 视图层根据索引取两个添加的值,运行项目即可看到添加的内容

4.2 整合FreeMarker

  1. 添加依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-freemarker</artifactId>
  4. </dependency>
  1. 编写FreeMarker配置
  1. #是否开启缓存
  2. spring.freemarker.cache=false
  3. #文件编码
  4. spring.freemarker.charset=UTF-8
  5. #文件后缀
  6. spring.freemarker.suffix=.ftl
  7. #模板文件位置
  8. spring.freemarker.template-loader-path=classpath:/templates/
  1. 编写Controller代码
  1. @GetMapping("/datas")
  2. public String da(Model model) {
  3. List<String> list = new ArrayList<>();
  4. list.add("Hello");
  5. list.add("World");
  6. model.addAttribute("result",list);
  7. return "data";
  8. }
  1. 创建一个.ftl后缀的视图文件
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Title</title>
  6. </head>
  7. <body>
  8. <div>${result[0]}</div>
  9. <div>${result[1]}</div>
  10. </body>
  11. </html>

5. SpringBoot整合Web开发

5.1 返回JSON数据

  1. Json是目前主流的前后端数据传输方式,SpringMVC中使用的消息转换器HttpMessageConverter接口,对JSON的转换提供了支持。在SpringBoot中更进一步的对相关配置进行了简化。
  • 在项目中测试返回json数据

    • 添加web依赖

        1. <dependency>
        2. <groupId>org.springframework.boot</groupId>
        3. <artifactId>spring-boot-starter-web</artifactId>
        4. </dependency>
          1. 这个依赖默认加入了jackson-databind作为JSON的处理器,此时不需要额外添加JSON的处理器就能返回一段JSON数据了。
  • 创建User实体类
      1. @Data
      2. public class User {
      3. private String username;
      4. private String password;
      5. private Double height;
      6. @JsonFormat(pattern = "yyyy-MM-dd")
      7. private Date birthday;
      8. private Integer age;
      9. /*
      10. 省略get&set
      11. */
      12. }
  • 创建UserController测试

      1. @RestController
      2. public class UserController {
      3. @GetMapping("/user")
      4. public User user() {
      5. User user = new User();
      6. user.setUsername("Ted");
      7. user.setPassword("123");
      8. user.setHeight(180.5d);
      9. user.setAge(20);
      10. user.setBirthday(new Date());
      11. return user;
      12. }
      13. }
        1. @RestController@ResponseBody@Controller注解的组合,用于响应json数据到网页中
  • 测试
      1. 启动项目访问http://localhost:8080/user
  1. 上面这种是采用SpringBoot默认的处理Json的方式,可以对字段忽略,日期格式化等需求可以通过注解实现。

5.2 自定义JSON转换器

  1. 常见的JSON处理器除了jackson-databind之外,还有Gsonfastjson,这里采用常用的方法演示。

使用Gson转换器。

  1. GsonGoogle的一个开源JSON解析框架,使用Gson需要先去除SpringBoot默认的jackson-databind,然后加入Gson依赖
  1. 添加Gson依赖

    1. <dependency>
    2. <groupId>com.google.code.gson</groupId>
    3. <artifactId>gson</artifactId>
    4. </dependency>
    5. <dependency>
    6. <groupId>org.springframework.boot</groupId>
    7. <artifactId>spring-boot-starter-web</artifactId>
    8. <exclusions>
    9. <exclusion>
    10. <groupId>com.fasterxml.jackson.core</groupId>
    11. <artifactId>jackson-databind</artifactId>
    12. </exclusion>
    13. </exclusions>
    14. </dependency>
    1. SpringBoot中也默认提供了Gson的自动转换类`GsonHttpMessageConvertersConfiguration`,因此Gson的依赖添加成功后,就可以和默认的jackson-databind一样直接使用Gson
    1. 自定义格式化处理类
  1. 处理对日期数据进行格式化的自定义转换代码
  1. @Configuration
  2. public class GsonConfigure {
  3. @Bean //注册一个格式转换对象实例
  4. public GsonHttpMessageConverter gsonHttpMessageConverter() {
  5. GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
  6. GsonBuilder builder = new GsonBuilder();
  7. builder.setDateFormat("yyyy-MM-dd"); //设置日期格式化
  8. Gson gson = builder.create(); //创建Gsno对象放入
  9. converter.setGson(gson);
  10. return converter;
  11. }
  12. }
  1. Controller层
  1. @GetMapping("/user")
  2. public User user() {
  3. User user = new User();
  4. user.setUsername("Ted");
  5. user.setPassword("123");
  6. user.setHeight(180.5d);
  7. user.setAge(20);
  8. user.setBirthday(new Date());
  9. return user;
  10. }
  1. 测试
  1. 启动项目访问http://localhost:8080/user

5.3 文件上传

  1. SpringBoot中对文件上传做了更进一步的简化,使得文件上传更方便。

Java中文件上传一共涉及两个组件,一个是CommonsMultipartResolver,另一个是StandardServletMultipartResolver,其中CommonsMultipartResolver是使用commons-fileupload来处理multipart请求,而StandardServletMultipartResolver则是基于Servlet 3.0来处理multipart请求。

5.3.1 文件上传功能实现

  1. 创建springboot项目添加web依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  1. 在resource目录下创建upload.html文件
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>upload</title>
  6. </head>
  7. <body>
  8. <form action="/upload" method="post" enctype="multipart/form-data">
  9. <input type="file" name="uploadFile" value="请选择文件">
  10. <input type="submit" value="上传文件">
  11. </form>
  12. </body>
  13. </html>
  1. 编写Controller层处理文件上传
  1. package com.bear.springboot.controller;
  2. import org.springframework.web.bind.annotation.PostMapping;
  3. import org.springframework.web.bind.annotation.RestController;
  4. import org.springframework.web.multipart.MultipartFile;
  5. import javax.servlet.http.HttpServletRequest;
  6. import java.io.File;
  7. import java.io.IOException;
  8. import java.text.SimpleDateFormat;
  9. import java.util.Date;
  10. import java.util.UUID;
  11. @RestController
  12. public class FileUploadController {
  13. SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd/");
  14. @PostMapping("/upload")
  15. public String upload(MultipartFile uploadFile, HttpServletRequest request) {
  16. //指定文件上传路径为当前项目运行目录
  17. String realPath = request.getSession().getServletContext().getRealPath("/uploadFile/");
  18. //格式化日期
  19. String format = sdf.format(new Date());
  20. //判断是否是目录,不是就创建
  21. File folder = new File(realPath + format);
  22. if (!folder.isDirectory()) {
  23. folder.mkdirs();
  24. }
  25. //获取原始文件名
  26. String oldName = uploadFile.getOriginalFilename();
  27. //使用随机数生成文件不同的名称。
  28. String newName = UUID.randomUUID().toString()+oldName.substring(oldName.lastIndexOf("."),oldName.length());
  29. try {
  30. //调用transferTo方法进行文件上传操作
  31. uploadFile.transferTo(new File(folder,newName));
  32. //生成上传文件访问路径,并渲染到网页中。
  33. return request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+"/uploadFile/"+format+newName;
  34. } catch (IOException e) {
  35. e.printStackTrace();
  36. }
  37. return "上传失败";
  38. }
  39. }
  1. 测试
    1. 访问`http://localhost:8080/upload.html` 上传文件,然后根据生成路径访问图片。
  • 指定上传文件的配置
  1. spring.servlet.multipart.enabled=true #是否开启上传文件的支持,默认为true
  2. spring.servlet.multipart.file-size-threshold=0 #文件写入磁盘的阈值,默认为0
  3. spring.servlet.multipart.location=D:\\file #文件临时保存的位置
  4. spring.servlet.multipart.max-file-size=1MB #上传单个文件的最大大小。默认为1MB
  5. spring.servlet.multipart.max-request-size=10MB #上传多文件的总大小,默认为10MB
  6. spring.servlet.multipart.resolve-lazily=false #是否延迟解析,默认为false

5.4 全局异常处理

  1. 使用`@ControllerAdvice`注解进行全局的异常处理
  • ControllerAdvice此注解通常用于处理项目的全局异常,全局异常就是只要项目中的任何一个类任何一行代码触发了全局异常配置类中的代码,则会报出定义的错误信息。
  • 此注解用于处理页面之间的跳转异常。

5.4.1 根据转发视图处理

  • 下面定义一个全局处理算术的异常演示
    1.引入所需的依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>org.springframework.boot</groupId>
  7. <artifactId>spring-boot-starter-thymeleaf</artifactId>
  8. </dependency>
  1. 定义全局异常类
  1. @ControllerAdvice
  2. public class CustomException {
  3. @ExceptionHandler(value = ArithmeticException.class)
  4. public ModelAndView modelAndView(Exception e) {
  5. ModelAndView mv = new ModelAndView();
  6. mv.addObject("message", "执行了算术异常");
  7. mv.setViewName("error"); //设置跳转的视图
  8. return mv;
  9. }
  10. }
  1. [@ExceptionHandler ](/ExceptionHandler ) 注解为指定要抛出的异常,如果抛出所有异常则调用父类Exception.class,这里演示算术异常
  1. error页面
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Title</title>
  6. </head>
  7. <body>
  8. <span th:text="${message}"></span>
  9. </body>
  1. templates目录下建立一个error.html文件,并输出message信息。
  1. 编写控制器,定义一个错误代码
  1. @Controller
  2. public class ExceptionController {
  3. @GetMapping("/index")
  4. public void index() {
  5. int a = 10/0;
  6. }
  7. }
  1. Controller中设定一个100的错误,以演示全局异常功能。
  1. 测试
    1. 访问http://localhost:8080/index 则会看到网页中抛出的自定义异常信息

5.4.2 根据返回字符串处理

  1. 直接在浏览器返回字符串,使用`@RestControllerAdvice`注解。
  1. 修改自定义异常类
  1. @RestControllerAdvice
  2. public class CustomException {
  3. @ExceptionHandler(value = ArithmeticException.class)
  4. public String error(Exception e) {
  5. return "触发了算术异常" + e.getMessage();
  6. }
  7. }
  1. 直接定义一个String方法,并返回指定的异常信息。
  1. Controller
  1. @Controller
  2. public class ExceptionController {
  3. @GetMapping("/index")
  4. public void index() {
  5. int a = 10/0;
  6. }
  7. }

5.5 注册拦截器

  1. SpringMVC中的拦截器可以做到对项目运行之前、运行时、运行之后进行预处理。在SpringBoot中使用拦截器更加方便,只需要两个配置类即可对项目进行额外的处理。
  • 在项目中配置拦截器
    1.首先引入web依赖

    1. <dependency>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-web</artifactId>
    4. <dependency/>
    1. 编写自定义拦截器,并实现HandlerInterceptor接口
  1. public class MyInterceptor implements HandlerInterceptor {
  2. @Override
  3. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  4. System.out.println("preHandle==>:执行了");
  5. return true;
  6. }
  7. @Override
  8. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  9. System.out.println("postHandle==>:执行了");
  10. }
  11. @Override
  12. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  13. System.out.println("afterCompletion==>:执行了");
  14. }
  15. }
  1. HandlerInterceptor接口中一共有三个方法,这三个方法会按照preHandle-Controller-postHandle-afterCompletion顺序执行,只有当第一个方法preHandle方法返回true时后面的方法才会执行,而postHandle方法则是当拦截器链内所有的拦截器返回成功后才会调用,afterCompletion则是只有preHandle方法返回true时才会调用。


3.配置拦截器拦截的资源。

  1. @Configuration
  2. public class WebMvcConfiguration implements WebMvcConfigurer {
  3. @Override
  4. public void addInterceptors(InterceptorRegistry registry) {
  5. registry.addInterceptor(new MyInterceptor())
  6. .addPathPatterns("/**")
  7. .addPathPatterns("/hello")
  8. .excludePathPatterns("/user");
  9. }
  10. }
  1. 这个配置类对应拦截器所配置的拦截资源,比如拦截路径、静态资源。
  2. addInterceptors中的方法表示添加拦截的路径,excludePathPatterns表示排除的路径。
  1. 配置两个Controller接口
  1. @RestController
  2. public class Interceptor {
  3. @GetMapping("/hello")
  4. public String hello() {
  5. return "hello";
  6. }
  7. @GetMapping("/user")
  8. public String getUser() {
  9. return "admin user";
  10. }
  11. }
  1. 提供一个hellouser路径的接口,由于在拦截器中配置了拦截/hello接口和排除了/user接口,所以当测试的时候访问/hello接口会触发拦截器中的方法,而访问/user接口则不会。

5.6 启动系统任务

  1. 有一些特殊的任务需要在启动器启动的时候执行,例如加载配置文件、数据库初始化等操作,springboot提供了两种方案,实现`ApplicationRunner``CommandLineRunner`接口,这两个接口基本一致,差别体现在参数上面。

5.6.1 CommandLineRunner

  1. SpringBoot项目在启动时会遍历所有此接口的实现类,并调用其中的run方法,达到在项目启动时就执行的效果,如果配置了多个类继承CommandLineRunner接口则使用@Order注解指定任务执行的顺序
  1. 在项目中分别添加两个类继承CommandLineRunner接口

MyCommandLineRunner1

  1. @Component
  2. @Order(1)
  3. public class MyCommandLineRunner1 implements CommandLineRunner {
  4. @Override
  5. public void run(String... args) throws Exception {
  6. System.out.println("MyCommandLineRunner1任务执行");
  7. }
  8. }

MyCommandLineRunner2

  1. @Component
  2. @Order(2)
  3. public class MyCommandLineRunner2 implements CommandLineRunner {
  4. @Override
  5. public void run(String... args) throws Exception {
  6. System.out.println("MyCommandLineRunner2任务执行");
  7. }
  8. }
  1. 上面分别创建了两个类实现了CommandLineRunner接口,并使用@Component将类注入到spring容器中重写run方法打印一段信息,这些信息会在项目启动时在控制台打印。@Order注解是指定优先级顺序,数字越小优先级就越高,越先执行。

5.6.2 ApplicationRunner

5.7 整合Servlet、Filter、Listener

  1. 对传统web开发中的Servlet网页交互技术、filter过滤器、listener监听器整合到springboot项目当中
  1. 分别创建三个对应的类
  • servlet
  1. @WebServlet("/servlet")
  2. public class MyServlet extends HttpServlet {
  3. @Override
  4. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  5. doPost(req,resp);
  6. }
  7. @Override
  8. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  9. System.out.println(req.getParameter("name"));
  10. }
  11. }
  • Filter
  1. @WebFilter("/*")
  2. public class MyFilter implements Filter {
  3. @Override
  4. public void init(FilterConfig filterConfig) throws ServletException {
  5. System.out.println("init方法执行");
  6. }
  7. @Override
  8. public void destroy() {
  9. System.out.println("destroy方法执行");
  10. }
  11. @Override
  12. public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
  13. System.out.println("doFilter方法执行");
  14. filterChain.doFilter(request, response);
  15. }
  16. }
  • Listener
  1. @WebListener
  2. public class MyListener implements ServletRequestListener {
  3. @Override
  4. public void requestDestroyed(ServletRequestEvent sre) {
  5. System.out.println("requestDestroyed方法执行");
  6. }
  7. @Override
  8. public void requestInitialized(ServletRequestEvent sre) {
  9. System.out.println("requestInitialized方法执行");
  10. }
  11. }
  1. 上面分别定义了对应三个组件,分别使用@WebServlet表示Servlet应用,@WebFilter表示过滤器应用,@Listener表示监听器应用进行表示。
  1. 在启动类中标上注解扫描Servlet 的应用
  1. @SpringBootApplication
  2. @ServletComponentScan //扫描servlet应用
  3. public class SpringBootDemoApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(SpringBootDemoApplication.class);
  6. }
  7. }
  • 测试
    1. 启动项目访问http://localhost:8080/servlet?name=ted 路径即可看到结果。

5.8 整合AOP功能

  1. AOP是(Aspect Oriented Programming)的缩写,翻译为面向切面编程,AOP是通过预编译方式和运行期间基于动态代理实现程序功能的一种技术。AOPOOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑 的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时可提高开发的效率。
  • AOP基本概念
    • Joinpoint(连接点):类里面被增强的方法就成为连接点,比如修改哪个方法哪个方法即为连接点。
    • Pointcut(切入点):对Joinpoint进行拦截的定义即为切入点,例如对某个方法进行拦截,这个定义即为切入点。
    • Advice(通知):使对方法配置进行输出的方式,通知分为前置、后置、异常、最终、环绕通知
    • Aspect(切面):Pointcut和Advice的结合
    • Target(目标对象):增强的类称为Target
      1. SpringBoot在原生Spring配置上做了简化的开发,省去了繁琐的XML配置。但需要导入额外的依赖


1.引入AOPstarter

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-aop</artifactId>
  4. </dependency>
  1. 创建一个service供演示操作
  1. package com.bear.springboot.service;
  2. import org.springframework.stereotype.Service;
  3. @Service //标识这是一个Service层的类,并注入到spring容器当中
  4. public class UserService {
  5. //模拟根据id获取用户
  6. public String findUserById(int id) {
  7. System.out.println(id);
  8. return "获取" + id + "号用户";
  9. }
  10. //模拟删除用户
  11. public void removeUserById(int id) {
  12. System.out.println("删除了" + id + "号用户");
  13. }
  14. }
  1. 创建切面类,分别配置前置、后置、后置返回、后置异常、环绕通知方法。
  1. package com.bear.springboot.log;
  2. import org.aspectj.lang.JoinPoint;
  3. import org.aspectj.lang.ProceedingJoinPoint;
  4. import org.aspectj.lang.annotation.*;
  5. import org.springframework.stereotype.Component;
  6. @Aspect
  7. @Component
  8. public class LogAspect {
  9. //配置方法的切入点,为service包下的所有类。
  10. @Pointcut("execution(* com.bear.springboot.service.*.*(..))")
  11. public void log() {}
  12. /**
  13. * 配置前置通知
  14. * @param joinPoint
  15. */
  16. @Before(value = "log()") //value值为方法的切入点。
  17. public void beforeAdvice(JoinPoint joinPoint) {
  18. String name = joinPoint.getSignature().getName();
  19. System.out.println(name + "方法执行结束");
  20. }
  21. /**
  22. * 配置后置通知
  23. * @param joinPoint
  24. */
  25. @After(value = "log()")
  26. public void afterAdvice(JoinPoint joinPoint) {
  27. String name = joinPoint.getSignature().getName();
  28. System.out.println(name + "方法执行结束");
  29. }
  30. /**
  31. * 配置后置返回通知
  32. * @param joinPoint
  33. * @param result
  34. */
  35. @AfterReturning(value = "log()",returning = "result")
  36. public void afterReturning(JoinPoint joinPoint,Object result) {
  37. String name = joinPoint.getSignature().getName();
  38. System.out.println(name + "方法的返回值为:" + result);
  39. }
  40. /**
  41. * 配置后置异常通知
  42. * @param joinPoint
  43. * @param exception
  44. */
  45. @AfterThrowing(value = "log()",throwing = "exception")
  46. public void afterThrowing(JoinPoint joinPoint,Exception exception) {
  47. String name = joinPoint.getSignature().getName();
  48. System.out.println(name + "方法抛出异常,异常为:" + exception);
  49. }
  50. /**
  51. * 配置环绕通知
  52. * @param joinPoint
  53. * @return
  54. * @throws Throwable
  55. */
  56. @Around("log()")
  57. public Object aroudAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
  58. return joinPoint.proceed();
  59. }
  60. }
  1. LogAspect类中一共定义了五种通知类型,首先类上的@Aspect注解表示这是一个AOP的切面类,然后在类中定义了一个log()方法,这个方法是用来指定类切入点用的,使用`execution`表达式去指定要影响的包名或类名,第一个_表示方法的任意返回值类型,第二个 _表示service包下的任意类都配置。
  • @Before注解
      1. 这个注解表示前置通知,使用了该注解的方法会在方法执行前执行,通过`JoinPoint` 可以获取目标方法的方法名,修饰符等信息。
  • @After
      1. 此注解和@Before注解相反,它表示后置通知,在方法执行后执行。
  • @AfterReturning
      1. 此注解表示返回通知,在该方法执行后获取该方法的返回值,returning参数是指定返回值的变量名称,也就是对应的Object方法参数,在参数里定义了一个Object类型的变量,表示目标返回值可以是任意类型,如果参数类型为Long,则表示只能处理Long返回值的参数。
  • @AfterThrowing
      1. 表示是一个后置异常类的通知,如果目标方法发生异常时则会触发该通知,形参类型指定为Exception,表示所有异常都会进入该方法中执行,如果指定其它子类异常类,则只会默认抛出指定的异常。
  • @Around
      1. 此注解表示环绕型通知,环绕通知是所有通知功能里最强的功能,可以实现前置、后置通知、异常通知以及返回通知的功能。目标方法进入环绕通知后,通过调用ProceedingJoinPoint对象的proceed方法使目标方法继续执行,也可以修改目标方法的执行参数,返回值等。

5.9 自定义favicon

  1. favicon.ico是浏览器左上角的显示图标,可以放在静态资源路径下或者类路径下,静态资源路径优先级要高于类路径下的favicon.ico

6. SpringBoot整合持久层技术

  1. 持久层技术是Java EE中对数据库进行访问操作的一种技术,SpringBoot对其持久层框架提供了自动化配置,例如JdbcTemplateJPA等,MyBatis自动化配置则是Mybatis官方提供的。

6.1 整合JdbcTemplate

  1. JdbcTemplateSpring官方提供的一套jdbc模板框架,利用了AOP技术解决了原生jdbc大量重复代码的问题。
  • 创建数据库和表
  1. create database study;
  2. use study;
  3. create table user
  4. (
  5. id varchar(20) not null
  6. primary key,
  7. name varchar(20) null,
  8. age varchar(20) null,
  9. address varchar(20) null,
  10. birth datetime null
  11. );
  12. insert into user value(1,'ted',"19","China",now())
  • 创建SpringBoot项目添加以下依赖
  1. <dependencies>
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. </dependency>
  6. <dependency>
  7. <groupId>mysql</groupId>
  8. <artifactId>mysql-connector-java</artifactId>
  9. <scope>runtime</scope>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-jdbc</artifactId>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.projectlombok</groupId>
  17. <artifactId>lombok</artifactId>
  18. <optional>true</optional>
  19. </dependency>
  20. </dependencies>
  • 配置数据库连接信息
  1. spring:
  2. datasource:
  3. driver-class-name: com.mysql.cj.jdbc.Driver
  4. url: jdbc:mysql://localhost:3306/study?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT
  5. username: root
  6. password: system56
  • 创建实体类
  1. package com.bear.springboot.entities;
  2. import com.fasterxml.jackson.annotation.JsonFormat;
  3. import lombok.Data;
  4. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. import org.springframework.stereotype.Component;
  6. import java.util.Date;
  7. @Data
  8. public class User {
  9. private String id;
  10. private String name;
  11. private String age;
  12. private String address;
  13. private Date birth;
  14. }
  1. 由于添加了lombok依赖,可以使用@Data代替get&set方法
  • 编写dao层
  1. package com.bear.springboot.repository;
  2. import com.bear.springboot.entities.User;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.jdbc.core.BeanPropertyRowMapper;
  5. import org.springframework.jdbc.core.JdbcTemplate;
  6. import org.springframework.stereotype.Repository;
  7. import java.util.ArrayList;
  8. import java.util.List;
  9. @Repository
  10. public class UserDao {
  11. @Autowired
  12. private JdbcTemplate jdbcTemplate;
  13. public int saveUser(User user) {
  14. return jdbcTemplate.update("insert into user(id,name,age,address,birth) values(?,?,?,?,?)"
  15. ,user.getId(),user.getName(),user.getAge(),user.getAddress(),user.getBirth());
  16. }
  17. public int deleteUser(int id) {
  18. return jdbcTemplate.update("delete from user where id = ?",id);
  19. }
  20. public int updateUser(User user) {
  21. return jdbcTemplate.update("update user set name =?,age =?,address=?,birth=? where id =?"
  22. ,user.getName(),user.getAge(),user.getAddress(),user.getBirth(),user.getId());
  23. }
  24. public List<User> findAllByUser() {
  25. return jdbcTemplate.query("select * from user",new BeanPropertyRowMapper<>(User.class));
  26. }
  27. }
  1. 注入使用JdbcTemplate类即可进行对数据库的操作,此类会被自动注册到Spring容器当中,以上dao层分别调用了updatequery方法,update则对应增删改三种方式,而query则对应查询数据。在执行查询操作时,如果数据库字段和属性名称对应则直接使用BeanPropertyRowMapper对象,如果不对应则需要实现RowMapper接口将列字段和实体类字段一一对应。
  • 创建Controller层调用dao层
  1. package com.bear.springboot.controller;
  2. import com.bear.springboot.entities.User;
  3. import com.bear.springboot.repository.UserDao;
  4. import com.bear.springboot.service.UserService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.PathVariable;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import java.util.Date;
  10. import java.util.List;
  11. @RestController
  12. public class UserController {
  13. @Autowired
  14. private UserDao userDao;
  15. @GetMapping("/crud")
  16. public void saveUser() {
  17. User user = new User();
  18. user.setId("4");
  19. user.setName("tony");
  20. user.setAge("38");
  21. user.setAddress("China");
  22. user.setBirth(new Date());
  23. System.out.println("添加数据==>"+userDao.saveUser(user));
  24. User user2 = new User();
  25. user2.setId("3");
  26. user2.setName("teddy");
  27. user2.setAge("20");
  28. user2.setAddress("japan");
  29. user2.setBirth(new Date());
  30. System.out.println("修改数据==>"+userDao.updateUser(user2));
  31. int result = userDao.deleteUser(4);
  32. System.out.println("删除==>"+result);
  33. List<User> userList = userDao.findAllByUser();
  34. userList.forEach((item -> {
  35. String value = item.toString();
  36. System.out.println("查询所有数据==>"+value);
  37. }));
  38. }
  39. }
  • 测试
      1. 启动项目在浏览器地址栏输入http://localhost:8080/crud 即可看到控制台打印的内容

6.2 整合MyBatis

  1. Mybatis是一款持久层框架,原名叫做iBatisMybatis支持定制化SQL,存储过程以及高级映射。不用像jdbc那样手动设置参数以及获取结果集,但需要配置大量的xml文件编写sql语句。在SpringBoot中由Mybatis官方提供了一套自动化配置方案。
  • 创建springboot项目,添加以下依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>mysql</groupId>
  7. <artifactId>mysql-connector-java</artifactId>
  8. <scope>runtime</scope>
  9. </dependency>
  10. <dependency>
  11. <groupId>org.projectlombok</groupId>
  12. <artifactId>lombok</artifactId>
  13. <optional>true</optional>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.mybatis.spring.boot</groupId>
  17. <artifactId>mybatis-spring-boot-starter</artifactId>
  18. <version>2.1.3</version>
  19. </dependency>
  • 创建数据表
  1. create database study;
  2. use study;
  3. create table user
  4. (
  5. id varchar(20) not null
  6. primary key,
  7. name varchar(20) null,
  8. age varchar(20) null,
  9. address varchar(20) null,
  10. birth datetime null
  11. );
  12. insert into user value(1,'Bear',"19","China",now())
  • 创建实体类
  1. package com.bear.springboot.entities;
  2. import com.fasterxml.jackson.annotation.JsonFormat;
  3. import lombok.Data;
  4. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. import org.springframework.stereotype.Component;
  6. import java.util.Date;
  7. @Data
  8. public class User {
  9. private String id;
  10. private String name;
  11. private String age;
  12. private String address;
  13. private Date birth;
  14. }
  • 配置yaml的mysql连接
  1. spring:
  2. datasource:
  3. driver-class-name: com.mysql.cj.jdbc.Driver
  4. url: jdbc:mysql://localhost:3306/study?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT
  5. username: root
  6. password: system56
  • 创建Mapper接口,映射增删改查方法
  1. package com.bear.springboot.repository;
  2. import com.bear.springboot.entities.User;
  3. import org.apache.ibatis.annotations.Mapper;
  4. import java.util.List;
  5. @Mapper
  6. public interface UserMapper {
  7. int saveUser(User user);
  8. int updateUser(User user);
  9. int deleteUser(int id);
  10. List<User> findAllByUser();
  11. }
  1. @Mapper注解表示该接口是MyBatis中的Mapper。使用@Respository注解也可达到同样效果
  • 编写sql映射的xml文件
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper
  3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.bear.springboot.repository.UserMapper">
  6. <insert id="saveUser" parameterType="com.bear.springboot.entities.User">
  7. insert into user(id,name,age,address,birth) values (#{id},#{name},#{age},#{address},#{birth});
  8. </insert>
  9. <update id="updateUser" parameterType="com.bear.springboot.entities.User">
  10. update user set name=#{name},age=#{age}, address=#{address}, birth=#{birth} where id=#{id};
  11. </update>
  12. <delete id="deleteUser" parameterType="int">
  13. delete from user where id=#{id};
  14. </delete>
  15. <select id="findAllByUser" resultType="com.bear.springboot.entities.User">
  16. select * from user ;
  17. </select>
  18. </mapper>
  1. xml文件中的每个标签对应着增删改查的操作,标签体内则对应着对数据库进行操作的sql语句,#{}为占位符,用来获取实体类属性名对应数据库字段。
  • 编写Controller
  1. @GetMapping("/crud")
  2. public void mybatisCrud() {
  3. User user = new User();
  4. user.setId("4");
  5. user.setName("tony");
  6. user.setAge("38");
  7. user.setAddress("China");
  8. user.setBirth(new Date());
  9. System.out.println("添加数据==>"+userMapper.saveUser(user));
  10. User user2 = new User();
  11. user2.setId("3");
  12. user2.setName("Bear");
  13. user2.setAge("20");
  14. user2.setAddress("China");
  15. user2.setBirth(new Date());
  16. System.out.println("修改数据==>"+userMapper.updateUser(user2));
  17. int result = userMapper.deleteUser(4);
  18. System.out.println("删除==>"+result);
  19. List<User> userList = userMapper.findAllByUser();
  20. userList.forEach((item -> {
  21. String value = item.toString();
  22. System.out.println("查询所有数据==>"+value);
  23. }));
  24. }
  • 测试
    1. 访问http://localhost:8080/crud 地址查看控制台打印效果

6.3 整合Spring Data JPA

  1. Spring Data JPA Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架,可使开发只用极简的代码即可实现对数据库的访问和操作。
  1. 创建数据库
  1. create database `test` default character set utf8;
  • JPA可以通过对象实体类进行对数据库的字段映射,这里只需创建一张空库即可
  1. 创建SpringBoot项目,导入相关依赖
  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>mysql</groupId>
  7. <artifactId>mysql-connector-java</artifactId>
  8. <scope>runtime</scope>
  9. </dependency>
  10. <dependency>
  11. <groupId>org.projectlombok</groupId>
  12. <artifactId>lombok</artifactId>
  13. <optional>true</optional>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.springframework.boot</groupId>
  17. <artifactId>spring-boot-starter-data-jpa</artifactId>
  18. </dependency>
  1. 配置yaml数据库信息
  1. spring:
  2. datasource:
  3. driver-class-name: com.mysql.cj.jdbc.Driver
  4. url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT
  5. username: root
  6. password: system56
  7. jpa:
  8. hibernate:
  9. ddl-auto: update #update表示根据实体类的变化更新数据库中的数据
  1. 新建一个实体类
  1. package com.example.entity.relationship.ManyToOne;
  2. import lombok.AllArgsConstructor;
  3. import lombok.Builder;
  4. import lombok.Data;
  5. import lombok.NoArgsConstructor;
  6. import javax.persistence.*;
  7. import java.io.Serializable;
  8. import java.util.List;
  9. @Entity
  10. @Data
  11. @AllArgsConstructor
  12. @NoArgsConstructor
  13. public class Person implements Serializable {
  14. @Id
  15. @GeneratedValue(strategy= GenerationType.IDENTITY)
  16. private Long id;
  17. private String name;
  18. private Integer age;
  19. private String email;
  20. private String sex;
  21. }

@Entity是javax.persistence包下的,表示该类是一个映射数据库的实体类,在项目启动时会根据该实体类自动生成一张数据表。

@Id注解表示id字段为数据表中的主键,@GeneratedValue注解表示主键自动生成,strategy则表示主键的生成策略

  1. 创建持久层接口,
  1. package com.example.repository.OneToOne;
  2. import com.example.entity.relationship.ManyToOne.Person;
  3. import org.springframework.data.jpa.repository.JpaRepository;
  4. import org.springframework.data.jpa.repository.Query;
  5. import org.springframework.data.repository.query.Param;
  6. import java.util.List;
  7. public interface PersonRepository extends JpaRepository<Person,Long> {
  8. //查询person表中以指定名字开头的数据
  9. List<Person> findPersonByNameStartingWith(String name);
  10. //查询年龄大于参数age的值
  11. List<Person> getPersonByAgeGreaterThan(Integer age);
  12. //查询年龄最大的人
  13. @Query("select p from Person as p where p.age = (select max(age) from Person)")
  14. Person findMaxAgePerson();
  15. //查询id大于指定数值,并且name等于指定数值,
  16. @Query("select p from Person as p where p.id>:id and p.name=:name")
  17. List<Person> findPersonByIdAndName(@Param("id") Long id,@Param("name") String name);
  18. //查询id小于指定数值,并且对name字段进行模糊查询
  19. @Query("select p from Person as p where p.id <?1 and p.name like %?2%")
  20. List<Person> findPersonsByIdAndName(Long id,String name);
  21. }
  1. 数据层接口继承于JpaRepository接口,该接口内提供了一些基本的增删改查、分页查询、排序查询等方法。@Param注解则为id>:id为参数之间的绑定
  1. 创建service层接口
  1. package com.example.service;
  2. import com.example.entity.relationship.ManyToOne.Person;
  3. import org.springframework.data.domain.Page;
  4. import org.springframework.data.domain.Pageable;
  5. import org.springframework.data.jpa.repository.Query;
  6. import org.springframework.data.repository.query.Param;
  7. import java.util.List;
  8. public interface PersonService {
  9. //插入数据
  10. void insertPerson(Person person);
  11. //根据id删除
  12. void deletePerson(Long id);
  13. //更新数据
  14. void updatePerson(Person person);
  15. //分页查询所有
  16. Page<Person> findPersonByPage(Pageable pageable);
  17. //查询person表中以指定名字开头的数据
  18. List<Person> findPersonByNameStartingWith(String name);
  19. //查询年龄大于参数age的值
  20. List<Person> findPersonByAgeGreaterThan(Integer age);
  21. //查询年龄最大的人
  22. Person findMaxAgePerson();
  23. //查询id大于指定数值,并且name等于指定数值
  24. List<Person> findPersonByIdAndName(Long id,String name);
  25. //查询id小于指定数值,并且对name字段进行模糊查询
  26. List<Person> findPersonsByIdAndName(Long id,String name);
  27. }
  28. //实现类
  29. package com.example.service;
  30. import com.example.entity.relationship.ManyToOne.Person;
  31. import com.example.repository.OneToOne.PersonRepository;
  32. import org.springframework.beans.factory.annotation.Autowired;
  33. import org.springframework.data.domain.Page;
  34. import org.springframework.data.domain.Pageable;
  35. import org.springframework.stereotype.Service;
  36. import java.util.List;
  37. @Service
  38. public class PersonServiceImpl implements PersonService{
  39. @Autowired
  40. private PersonRepository personRepository;
  41. @Override
  42. public void insertPerson(Person person) {
  43. personRepository.save(person);
  44. }
  45. @Override
  46. public void deletePerson(Long id) {
  47. personRepository.deleteById(id);
  48. }
  49. @Override
  50. public void updatePerson(Person person) {
  51. personRepository.save(person);
  52. }
  53. @Override
  54. public Page<Person> findPersonByPage(Pageable pageable) {
  55. return personRepository.findAll(pageable);
  56. }
  57. @Override
  58. public List<Person> findPersonByNameStartingWith(String name) {
  59. return personRepository.findPersonByNameStartingWith(name);
  60. }
  61. @Override
  62. public List<Person> findPersonByAgeGreaterThan(Integer age) {
  63. return personRepository.getPersonByAgeGreaterThan(age);
  64. }
  65. @Override
  66. public Person findMaxAgePerson() {
  67. return personRepository.findMaxAgePerson();
  68. }
  69. @Override
  70. public List<Person> findPersonByIdAndName(Long id, String name) {
  71. return personRepository.findPersonByIdAndName(id,name);
  72. }
  73. @Override
  74. public List<Person> findPersonsByIdAndName(Long id, String name) {
  75. return personRepository.findPersonsByIdAndName(id,name);
  76. }
  77. }
  1. service层又提供了增删改查和一个分页的方法,默认只需要调用数据层接口继承的JpaRepository接口中的方法即可实现效果。
  1. Controller层
  1. package com.example.controller;
  2. import com.example.entity.relationship.ManyToOne.Person;
  3. import com.example.service.PersonService;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.data.domain.Page;
  6. import org.springframework.data.domain.PageRequest;
  7. import org.springframework.web.bind.annotation.GetMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import java.util.List;
  10. @RestController
  11. public class PersonController {
  12. @Autowired
  13. private PersonService personService;
  14. @GetMapping("/crud")
  15. public String data() {
  16. personService.insertPerson(new Person(1L,"ted",20,"123@qq.com","男"));
  17. personService.updatePerson(new Person(1L,"Bear",19,"12345@qq.com","男"));
  18. Page<Person> page = personService.findPersonByPage(PageRequest.of(2, 3));
  19. System.out.println("总页数:==>"+ page.getTotalPages());
  20. System.out.println("总记录数:==>"+ page.getTotalElements());
  21. System.out.println("查询结果:==>"+ page.getContent());
  22. System.out.println("当前页数:==>"+ page.getNumber() + 1);
  23. System.out.println("当前页记录数:==>"+ page.getNumberOfElements());
  24. System.out.println("每页记录数:==>"+ page.getSize());
  25. //删除操作
  26. personService.deletePerson(1L);
  27. return "success";
  28. }
  29. @GetMapping(value = "/query")
  30. public String querySQL() {
  31. List<Person> list1 = personService.findPersonByIdAndName(1L, "Trump");
  32. for (Person person : list1) {
  33. String toString = person.toString();
  34. System.out.println("list1 = " + toString);
  35. }
  36. List<Person> list2 = personService.findPersonByNameStartingWith("B");
  37. for (Person person : list2) {
  38. String toString = person.toString();
  39. System.out.println("list2 = "+toString);
  40. }
  41. List<Person> list3 = personService.findPersonsByIdAndName(3L, "Bear");
  42. for (Person person : list3) {
  43. String toString = person.toString();
  44. System.out.println("list3 = " + toString);
  45. }
  46. List<Person> list4 = personService.findPersonByAgeGreaterThan(18);
  47. for (Person person : list4) {
  48. String toString = person.toString();
  49. System.out.println("list4 = " + toString);
  50. }
  51. Person person = personService.findMaxAgePerson();
  52. System.out.println(person.getAge());
  53. return "success";
  54. }
  55. }
  1. 在分页查询方法中调用的是PageRequest.of方法构造对象,of方法接收两个参数,第一个参数为页数,第二个参数为每页显示的数据条数。
  1. 测试

启动项目访问 http://localhost:8080/crud地址。

接下来访问http://localhost:8080/query 地址查看结果。

6.4 SpringBoot整合NoSQL


7. 定时任务

7.1 Timer

Timer是jdk提供的定时任务工具类,提供最基本的定时功能

  • 示例
    • 打印输出一段内容,定时为延迟10秒之后,每秒执行一次

首先需定义一个处理业务逻辑的类MyTimerTask

  1. package com.renzhell.timed.timer;
  2. import lombok.Data;
  3. import lombok.EqualsAndHashCode;
  4. import java.util.TimerTask;
  5. @EqualsAndHashCode(callSuper = true)
  6. @Data
  7. public class MyTimerTask extends TimerTask {
  8. private String name;
  9. public MyTimerTask(String name) {
  10. this.name = name;
  11. }
  12. @Override
  13. public void run() {
  14. System.out.println("current name " + name);
  15. }
  16. }

其次是提供执行任务的Timer对象

  1. package com.renzhell.timed.timer;
  2. import java.util.Timer;
  3. public class MyTimer {
  4. public static void main(String[] args) {
  5. // 1. 创建一个Timer对象实例
  6. Timer timer = new Timer();
  7. // 2. 创建一个MyTimerTask对象实例
  8. MyTimerTask timerTask = new MyTimerTask("NO.1");
  9. // 3. 通过timer对象调用MyTimerTask的业务逻辑
  10. // 延迟十秒之后,每隔一秒钟执行一次
  11. timer.schedule(timerTask, 10000L, 1000L);
  12. }
  13. }

7.1.1 Timer的定时调度函数

  1. schedule(task, time)
    1. task:安排的任务对象
    2. time:执行任务时间
    3. 作用:在时间等于或超过time的时候执行且仅执行一次
  • 示例 ```java public class MyTimerTask extends TimerTask {

    private String name;

    public MyTimerTask(String name) {

    1. this.name = name;

    } @Override public void run() {

    1. Calendar calendar = Calendar.getInstance();
    2. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    3. // 打印执行任务的当前时间
    4. System.out.println("current execute time is: " + date.format(calendar.getTime()));
    5. System.out.println("current name " + name);

    } }

// 定时为当前时间的三秒之后执行任务,只执行一次 public static void test1() { Calendar calendar = Calendar.getInstance(); SimpleDateFormat date = new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”); System.out.println(date.format(calendar.getTime())); calendar.add(Calendar.SECOND, 3); Timer timer = new Timer(); MyTimerTask timerTask = new MyTimerTask(“schedule1”); timer.schedule(timerTask, calendar.getTime()); }

  1. 2. schedule(task, time, period)
  2. 1. task:安排的任务对象
  3. 1. time:执行任务时间
  4. 1. period:执行一次task的时间间隔,单位是毫秒。
  5. 1. 作用:时间等于或超过time时首次执行task、之后每隔period毫秒重复执行一次task
  6. - 示例
  7. ```java
  8. // 首次延迟三秒后执行,之后每隔2秒执行一次
  9. public static void test2() {
  10. Calendar calendar = Calendar.getInstance();
  11. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  12. System.out.println(date.format(calendar.getTime()));
  13. calendar.add(Calendar.SECOND, 3); // 添加三秒的时间
  14. Timer timer = new Timer();
  15. MyTimerTask timerTask = new MyTimerTask("schedule2");
  16. timer.schedule(timerTask, calendar.getTime(), 2000);
  17. }
  1. schedule(task, delay)
    1. task:安排的任务对象
    2. delay:执行任务前的延迟时间,单位是毫秒
    3. 作用:等待delay毫秒之后执行且执行一次task任务
  • 示例
    1. public static void test3() {
    2. Calendar calendar = Calendar.getInstance();
    3. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    4. System.out.println(date.format(calendar.getTime()));
    5. Timer timer = new Timer();
    6. MyTimerTask timerTask = new MyTimerTask("schedule1");
    7. timer.schedule(timerTask, 2000); // 延迟2秒执行
    8. }
  1. schedule(task, delay, period)
    1. task:安排的任务对象
    2. delay:执行任务前的延迟时间,单位是毫秒。
    3. period:执行一次task的间隔,单位是毫秒。
    4. 作用:等待delay毫秒后首次执行task、之后每隔period毫秒重复执行一次。
  • 示例
    1. // 等待三秒,之后每两秒执行一次任务
    2. public static void test4() {
    3. Timer timer = new Timer();
    4. MyTimerTask timerTask = new MyTimerTask("schedule4");
    5. timer.schedule(timerTask, 3000, 2000);
    6. }

两种额外的方法。

  1. scheduleAtFixedRate(task, time, period)
    1. task:安排的任务对象
    2. time:首次执行任务的时间
    3. period:执行一次task的间隔,单位是毫秒。
  • 示例
    1. // 第一次延迟三秒执行,之后的每一次都每隔两秒执行一次
    2. public static void test5() {
    3. Calendar calendar = Calendar.getInstance();
    4. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    5. System.out.println(date.format(calendar.getTime()));
    6. calendar.add(Calendar.SECOND, 3);
    7. Timer timer = new Timer();
    8. MyTimerTask timerTask = new MyTimerTask("schedule4");
    9. timer.scheduleAtFixedRate(timerTask, calendar.getTime(), 2000);
    10. }
  1. scheduleAtFixedRate(task, delay, period)
    1. task:安排的任务对象
    2. delay:执行任务前的延迟时间,单位是毫秒。
    3. period:执行一次task的间隔,单位是毫秒。
    4. 作用:等待delay毫秒后首次执行task、之后每隔period毫秒重复执行一次。
  • 示例
    1. // 第一次延迟三秒后执行,之后每隔两秒执行一次任务。
    2. public static void test6() {
    3. Timer timer = new Timer();
    4. MyTimerTask timerTask = new MyTimerTask("schedule4");
    5. timer.scheduleAtFixedRate(timerTask, 3000, 2000);
    6. }

    7.1.2 Timer其它函数

  1. cancel():取消当前task的任务
  • 示例: ```java public class MyTimerTask extends TimerTask {

    private String name; private Integer count = 0; // 计数变量 public MyTimerTask(String name) {

    1. this.name = name;

    }

    @Override public void run() {

    1. if (count < 3) { // 小于3就继续执行
    2. Calendar calendar = Calendar.getInstance();
    3. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    4. System.out.println("current execute time is: " + date.format(calendar.getTime()));
    5. System.out.println("current name " + name);
    6. count++;
    7. } else {
    8. cancel(); // 否则取消任务
    9. System.out.println("Task Cancel");
    10. }

    } }

  1. 2. scheduledExecutionTime():返回此任务最近一次任务的执行时间
  2. ```java
  3. public static void test7() {
  4. Calendar calendar = Calendar.getInstance();
  5. SimpleDateFormat date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  6. System.out.println(date.format(calendar.getTime()));
  7. calendar.add(Calendar.SECOND, 3);
  8. Timer timer = new Timer();
  9. MyTimerTask timerTask = new MyTimerTask("schedule7");
  10. timer.schedule(timerTask, 3000);
  11. System.out.println(date.format(timerTask.scheduledExecutionTime()));
  12. }

7.1.3 Timer综合应用

功能:实现两个机器人 第一个机器人会每隔两秒打印一次最近一次计划的时间、执行内容。 第二个机器人会模拟往桶里倒水,直到桶倒满为止。

  • DancingRobot

    1. public class DancingRobot extends TimerTask {
    2. @Override
    3. public void run() {
    4. // 获取最近的一次任务执行时间,并将其格式化
    5. SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    6. System.out.println("Scheduled execution time is: " + sf.format(scheduledExecutionTime()));
    7. System.out.println("Dancing happily");
    8. }
    9. }
  • WaterRobot

    1. public class WaterRobot extends TimerTask {
    2. private final Timer timer;
    3. private Integer bucketCapacity = 0; // 最大容量为5L
    4. public WaterRobot(Timer timer) {
    5. this.timer = timer;
    6. }
    7. @Override
    8. public void run() {
    9. // 灌水直到桶满为止
    10. if (bucketCapacity < 5) {
    11. System.out.println("Add 1L water into the bucket!");
    12. bucketCapacity++;
    13. } else {
    14. // 水满之后就停止执行
    15. System.out.println("The number of canceled task in timer is: " + timer.purge());
    16. cancel();
    17. System.out.println("The waterRobot has been stopped!");
    18. System.out.println("The number of canceled task in timer is: " + timer.purge());
    19. System.out.println("The current water is" + bucketCapacity + "L");
    20. // 等待两秒钟,终止timer里的所有内容
    21. try {
    22. Thread.sleep(2000);
    23. } catch (InterruptedException e) {
    24. e.printStackTrace();
    25. }
    26. timer.cancel();
    27. }
    28. }
    29. }
  • Executor

    1. public class Executor {
    2. public static void main(String[] args) {
    3. Timer timer = new Timer();
    4. Calendar calendar = Calendar.getInstance();
    5. SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    6. System.out.println("Current time is: " + sf.format(calendar.getTime()));
    7. DancingRobot dancingRobot = new DancingRobot();
    8. WaterRobot waterRobot = new WaterRobot(timer);
    9. timer.schedule(dancingRobot, calendar.getTime(), 2000);
    10. timer.scheduleAtFixedRate(waterRobot, calendar.getTime(), 1000);
    11. }
    12. }

    7.1.4 Timer的缺点

  1. 不能管理并发任务
  2. 任务抛出异常缺陷
  3. Timer只有一个线程去执行任务,如果存在多个任务且时间过长,会导致效果与预期不符

7.2 Spring Task

Spring Task是Spring官方提供的定时任务功能

  • 示例代码

    • 首先需要创建一个Springboot工程 ```java @EnableScheduling // 开启定时任务注解 @SpringBootApplication public class TimedTaskApplication {

      public static void main(String[] args) { SpringApplication.run(TimedTaskApplication.class, args); }

      /**

      • 半小时执行一次 / // @Scheduled(fixedRate = 30 60 1000) // 半小时60一分钟六十秒 1000表示一毫秒 @Scheduled(fixedRate = 5 1000) // 5秒 * 1000表示一毫秒,五秒执行一次 public void drinkHotWater() { Calendar calendar = Calendar.getInstance(); SimpleDateFormat date = new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”); System.out.println(“多喝热水。。。” + date.format(calendar.getTime())); }

      /**

      • 两小时执行一次 / // @Scheduled(fixedRate = 2 60 60 1000) // 2小时60一小时六十分钟 60 一分钟六十秒 1000 表示一毫秒 @Scheduled(fixedRate = 10 1000) // 10 秒执行一次 public void haveMedicine() { Calendar calendar = Calendar.getInstance(); SimpleDateFormat date = new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”); System.out.println(“吃药。。。” + date.format(calendar.getTime())); }

}

  1. <a name="fwtZ6"></a>
  2. #### 7.2.1 cron表达式
  3. > 通过手写表达式的方式来指定任务的执行时间
  4. ```java
  5. @Scheduled(cron = "0 0/30 9-22 * * ?") // 从早上九点到晚上22点之间每隔30分钟执行一次
  6. public void doSomething() {
  7. System.out.println("do something");
  8. }
  9. @Scheduled(cron = "0 0 9-22/4 * * ?") // 从早上九点到晚上22点之间每隔四个小时执行一次
  10. public void doSomethings() {
  11. System.out.println("do something");
  12. }
  • 表达式符号解释
    • ,(逗号):列出枚举值,例如5,20 表示在5分钟和20分钟的时间执行一次任务
    • -(横杠):表示范围,例如5-20 表示5点-20点每分钟都执行任务
    • (星号):表示匹配该区域的任意值,在Minutes域使用表示时间分钟数不作限制,每分钟都执行
    • /(斜杠):起始时间开始触发,随后每隔固定时间触发一次。例如在Minutes域中使用5/20,表示时间分钟数为5时触发一次,随后20分钟即25、45时分别再触发一次。
    • 专有符号?:只能设置在月或者周,并且只能设置一个
    • L:表示最后的时间,只能出现在DayofWeek和DayofMonth域。如果使用5L表示则会在最后一个星期四触发任务,第一天是按照星期天计算
    • W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近有效工作日触发任务
    1. LW:这两个字符可以连用,表示在某个月最后一个工作日。
    2. :用于确定每个月第几个星期几,只能出现在DayofWeek域。例如在4#2,表示在某月的第二个星期三

    3. C:只能用在DayofMonth和DayofWeek两个域,需要关联日历,如果没有关联则忽略

      7.2.2 异步多线程定时任务

  1. 开启@EnableAsync注解
  2. 添加@Async注解。

7.3 Quartz

Quartz API的关键接:

  • Scheduler - 与任务调度程序交互的主要API。
  • Job - 你想要调度器执行的任务组件需要实现的接口
  • JobDetail - 用于定义任务作业的实例。
  • Trigger(即触发器) - 定义执行给定作业的计划的组件。
  • JobBuilder - 用于定义/构建 JobDetail 实例,用于定义作业的实例。
  • TriggerBuilder - 用于定义/构建触发器实例。
  • Scheduler 的生命期,从 SchedulerFactory 创建它时开始,到 Scheduler 调用shutdown() 方法时结束Scheduler 被创建后,可以增加、删除和列举 Job 和 Trigger,以及执行其它与调度相关的操作(如暂停 Trigger)。但是,Scheduler 只有在调用 start() 方法后,才会真正地触发 trigger(即执行 job)。

三、日志

1、日志框架

小张;开发一个大型系统;

  1. 1System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?
  2. 2、框架来记录系统的一些运行时信息;日志框架 zhanglogging.jar
  3. 3、高大上的几个功能?异步模式?自动归档?xxxx zhanglogging-good.jar
  4. 4、将以前框架卸下来?换上新的框架,重新修改之前相关的APIzhanglogging-prefect.jar
  5. 5JDBC---数据库驱动;
  6. 写了一个统一的接口层;日志门面(日志的一个抽象层);logging-abstract.jar
  7. 给项目中导入具体的日志实现就行了;我们之前的日志框架都是实现的抽象层;

市面上的日志框架;

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j….

日志门面 (日志的抽象层) 日志实现
JCL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java) jboss-logging Log4j JUL(java.util.logging) Log4j2 Logback

左边选一个门面(抽象层)、右边来选一个实现;

日志门面: SLF4J;

日志实现:Logback;

SpringBoot:底层是Spring框架,Spring框架默认是用JCL;‘

  1. **SpringBoot选用 SLF4jlogback;**

2、SLF4j使用

1、如何在系统中使用SLF4j https://www.slf4j.org

以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;

给系统里面导入slf4j的jar和 logback的实现jar

  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. public class HelloWorld {
  4. public static void main(String[] args) {
  5. Logger logger = LoggerFactory.getLogger(HelloWorld.class);
  6. logger.info("Hello World");
  7. }
  8. }

图示;

Spring Boot - 图1

每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是做成日志实现框架自己本身的配置文件;

2、遗留问题

a(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx

统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?

Spring Boot - 图2

如何让系统中所有的日志都统一到slf4j;

1、将系统中其他日志框架先排除出去;

2、用中间包来替换原有的日志框架;

3、我们导入slf4j其他的实现

3、SpringBoot日志关系

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

SpringBoot使用它来做日志功能;

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

底层依赖关系

Spring Boot - 图3

总结:

  1. 1)、SpringBoot底层也是使用slf4j+logback的方式进行日志记录
  2. 2)、SpringBoot也把其他的日志都替换成了slf4j
  3. 3)、中间替换包?
  1. @SuppressWarnings("rawtypes")
  2. public abstract class LogFactory {
  3. static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
  4. static LogFactory logFactory = new SLF4JLogFactory();

Spring Boot - 图4

  1. 4)、如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉?
  2. Spring框架用的是commons-logging
  1. <dependency>
  2. <groupId>org.springframework</groupId>
  3. <artifactId>spring-core</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <groupId>commons-logging</groupId>
  7. <artifactId>commons-logging</artifactId>
  8. </exclusion>
  9. </exclusions>
  10. </dependency>

SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;

4、日志使用;

1、默认配置

SpringBoot默认帮我们配置好了日志;

  1. //记录器
  2. Logger logger = LoggerFactory.getLogger(getClass());
  3. @Test
  4. public void contextLoads() {
  5. //System.out.println();
  6. //日志的级别;
  7. //由低到高 trace<debug<info<warn<error
  8. //可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
  9. logger.trace("这是trace日志...");
  10. logger.debug("这是debug日志...");
  11. //SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
  12. logger.info("这是info日志...");
  13. logger.warn("这是warn日志...");
  14. logger.error("这是error日志...");
  15. }
  1. 日志输出格式:
  2. %d表示日期时间,
  3. %thread表示线程名,
  4. %-5level:级别从左显示5个字符宽度
  5. %logger{50} 表示logger名字最长50个字符,否则按照句点分割。
  6. %msg:日志消息,
  7. %n是换行符
  8. -->
  9. %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

SpringBoot修改日志的默认配置

  1. logging.level.com.atguigu=trace
  2. #logging.path=
  3. # 不指定路径在当前项目下生成springboot.log日志
  4. # 可以指定完整的路径;
  5. #logging.file=G:/springboot.log
  6. # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹;使用 spring.log 作为默认文件
  7. logging.path=/spring/log
  8. # 在控制台输出的日志的格式
  9. logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
  10. # 指定文件中日志输出的格式
  11. logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
logging.file logging.path Example Description
(none) (none) 只在控制台输出
指定文件名 (none) my.log 输出日志到my.log文件
(none) 指定目录 /var/log 输出到指定目录的 spring.log 文件中

2、指定配置

给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了

Logging System Customization
Logback logback-spring.xml
, logback-spring.groovy
, logback.xml
or logback.groovy
Log4j2 log4j2-spring.xml
or log4j2.xml
JDK (Java Util Logging) logging.properties

logback.xml:直接就被日志框架识别了;

logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能

  1. <springProfile name="staging">
  2. <!-- configuration to be enabled when the "staging" profile is active -->
  3. 可以指定某段配置只在某个环境下生效
  4. </springProfile>

如:

  1. <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  2. <!--
  3. 日志输出格式:
  4. %d表示日期时间,
  5. %thread表示线程名,
  6. %-5level:级别从左显示5个字符宽度
  7. %logger{50} 表示logger名字最长50个字符,否则按照句点分割。
  8. %msg:日志消息,
  9. %n是换行符
  10. -->
  11. <layout class="ch.qos.logback.classic.PatternLayout">
  12. <springProfile name="dev">
  13. <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
  14. </springProfile>
  15. <springProfile name="!dev">
  16. <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
  17. </springProfile>
  18. </layout>
  19. </appender>

如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误

no applicable action for [springProfile]

5、切换日志框架

可以按照slf4j的日志适配图,进行相关的切换;

slf4j+log4j的方式;

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <artifactId>logback-classic</artifactId>
  7. <groupId>ch.qos.logback</groupId>
  8. </exclusion>
  9. <exclusion>
  10. <artifactId>log4j-over-slf4j</artifactId>
  11. <groupId>org.slf4j</groupId>
  12. </exclusion>
  13. </exclusions>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.slf4j</groupId>
  17. <artifactId>slf4j-log4j12</artifactId>
  18. </dependency>

切换为log4j2

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <artifactId>spring-boot-starter-logging</artifactId>
  7. <groupId>org.springframework.boot</groupId>
  8. </exclusion>
  9. </exclusions>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-log4j2</artifactId>
  14. </dependency>

四、Web开发

1、简介

使用SpringBoot;

1)、创建SpringBoot应用,选中我们需要的模块;

2)、SpringBoot已经默认将这些场景配置好了,只需要在配置文件中指定少量配置就可以运行起来

3)、自己编写业务代码;

自动配置原理?

这个场景SpringBoot帮我们配置了什么?能不能修改?能修改哪些配置?能不能扩展?xxx

  1. xxxxAutoConfiguration:帮我们给容器中自动配置组件;
  2. xxxxProperties:配置类来封装配置文件的内容;

2、SpringBoot对静态资源的映射规则;

  1. @ConfigurationProperties(prefix = "spring.resources", ignoreUnknownFields = false)
  2. public class ResourceProperties implements ResourceLoaderAware {
  3. //可以设置和静态资源有关的参数,缓存时间等
  1. WebMvcAuotConfiguration
  2. @Override
  3. public void addResourceHandlers(ResourceHandlerRegistry registry) {
  4. if (!this.resourceProperties.isAddMappings()) {
  5. logger.debug("Default resource handling disabled");
  6. return;
  7. }
  8. Integer cachePeriod = this.resourceProperties.getCachePeriod();
  9. if (!registry.hasMappingForPattern("/webjars/**")) {
  10. customizeResourceHandlerRegistration(
  11. registry.addResourceHandler("/webjars/**")
  12. .addResourceLocations(
  13. "classpath:/META-INF/resources/webjars/")
  14. .setCachePeriod(cachePeriod));
  15. }
  16. String staticPathPattern = this.mvcProperties.getStaticPathPattern();
  17. //静态资源文件夹映射
  18. if (!registry.hasMappingForPattern(staticPathPattern)) {
  19. customizeResourceHandlerRegistration(
  20. registry.addResourceHandler(staticPathPattern)
  21. .addResourceLocations(
  22. this.resourceProperties.getStaticLocations())
  23. .setCachePeriod(cachePeriod));
  24. }
  25. }
  26. //配置欢迎页映射
  27. @Bean
  28. public WelcomePageHandlerMapping welcomePageHandlerMapping(
  29. ResourceProperties resourceProperties) {
  30. return new WelcomePageHandlerMapping(resourceProperties.getWelcomePage(),
  31. this.mvcProperties.getStaticPathPattern());
  32. }
  33. //配置喜欢的图标
  34. @Configuration
  35. @ConditionalOnProperty(value = "spring.mvc.favicon.enabled", matchIfMissing = true)
  36. public static class FaviconConfiguration {
  37. private final ResourceProperties resourceProperties;
  38. public FaviconConfiguration(ResourceProperties resourceProperties) {
  39. this.resourceProperties = resourceProperties;
  40. }
  41. @Bean
  42. public SimpleUrlHandlerMapping faviconHandlerMapping() {
  43. SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
  44. mapping.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
  45. //所有 **/favicon.ico
  46. mapping.setUrlMap(Collections.singletonMap("**/favicon.ico",
  47. faviconRequestHandler()));
  48. return mapping;
  49. }
  50. @Bean
  51. public ResourceHttpRequestHandler faviconRequestHandler() {
  52. ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
  53. requestHandler
  54. .setLocations(this.resourceProperties.getFaviconLocations());
  55. return requestHandler;
  56. }
  57. }

1)、所有 /webjars/** ,都去 classpath:/META-INF/resources/webjars/ 找资源;

  1. webjars:以jar包的方式引入静态资源;

http://www.webjars.org/

Spring Boot - 图5

localhost:8080/webjars/jquery/3.3.1/jquery.js

  1. <!--引入jquery-webjar-->在访问的时候只需要写webjars下面资源的名称即可
  2. <dependency>
  3. <groupId>org.webjars</groupId>
  4. <artifactId>jquery</artifactId>
  5. <version>3.3.1</version>
  6. </dependency>

2)、”/**” 访问当前项目的任何资源,都去(静态资源的文件夹)找映射

  1. "classpath:/META-INF/resources/",
  2. "classpath:/resources/",
  3. "classpath:/static/",
  4. "classpath:/public/"
  5. "/":当前项目的根路径

localhost:8080/abc === 去静态资源文件夹里面找abc

3)、欢迎页; 静态资源文件夹下的所有index.html页面;被”/**”映射;

  1. localhost:8080/ index页面

4)、所有的 **/favicon.ico 都是在静态资源文件下找;

3、模板引擎

JSP、Velocity、Freemarker、Thymeleaf

Spring Boot - 图6

SpringBoot推荐的Thymeleaf;

语法更简单,功能更强大;

1、引入thymeleaf;

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-thymeleaf</artifactId>
  4. 2.1.6
  5. </dependency>
  6. 切换thymeleaf版本
  7. <properties>
  8. <thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
  9. <!-- 布局功能的支持程序 thymeleaf3主程序 layout2以上版本 -->
  10. <!-- thymeleaf2 layout1-->
  11. <thymeleaf-layout-dialect.version>2.2.2</thymeleaf-layout-dialect.version>
  12. </properties>

2、Thymeleaf使用

  1. @ConfigurationProperties(prefix = "spring.thymeleaf")
  2. public class ThymeleafProperties {
  3. private static final Charset DEFAULT_ENCODING = Charset.forName("UTF-8");
  4. private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
  5. public static final String DEFAULT_PREFIX = "classpath:/templates/";
  6. public static final String DEFAULT_SUFFIX = ".html";
  7. //

只要我们把HTML页面放在classpath:/templates/,thymeleaf就能自动渲染;

使用:

1、导入thymeleaf的名称空间

  1. <html lang="en" xmlns:th="http://www.thymeleaf.org">

2、使用thymeleaf语法;

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Title</title>
  6. </head>
  7. <body>
  8. <h1>成功!</h1>
  9. <!--th:text 将div里面的文本内容设置为 -->
  10. <div th:text="${hello}">这是显示欢迎信息</div>
  11. </body>
  12. </html>

3、语法规则

1)、th:text;改变当前元素里面的文本内容;

  1. th:任意html属性;来替换原生属性的值

Spring Boot - 图7

2)、表达式?

  1. Simple expressions:(表达式语法)
  2. Variable Expressions: ${...}:获取变量值;OGNL
  3. 1)、获取对象的属性、调用方法
  4. 2)、使用内置的基本对象:
  5. #ctx : the context object.
  6. #vars: the context variables.
  7. #locale : the context locale.
  8. #request : (only in Web Contexts) the HttpServletRequest object.
  9. #response : (only in Web Contexts) the HttpServletResponse object.
  10. #session : (only in Web Contexts) the HttpSession object.
  11. #servletContext : (only in Web Contexts) the ServletContext object.
  12. ${session.foo}
  13. 3)、内置的一些工具对象:
  14. #execInfo : information about the template being processed.
  15. #messages : methods for obtaining externalized messages inside variables expressions, in the same way as they would be obtained using #{…} syntax.
  16. #uris : methods for escaping parts of URLs/URIs
  17. #conversions : methods for executing the configured conversion service (if any).
  18. #dates : methods for java.util.Date objects: formatting, component extraction, etc.
  19. #calendars : analogous to #dates , but for java.util.Calendar objects.
  20. #numbers : methods for formatting numeric objects.
  21. #strings : methods for String objects: contains, startsWith, prepending/appending, etc.
  22. #objects : methods for objects in general.
  23. #bools : methods for boolean evaluation.
  24. #arrays : methods for arrays.
  25. #lists : methods for lists.
  26. #sets : methods for sets.
  27. #maps : methods for maps.
  28. #aggregates : methods for creating aggregates on arrays or collections.
  29. #ids : methods for dealing with id attributes that might be repeated (for example, as a result of an iteration).
  30. Selection Variable Expressions: *{...}:选择表达式:和${}在功能上是一样;
  31. 补充:配合 th:object="${session.user}:
  32. <div th:object="${session.user}">
  33. <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
  34. <p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
  35. <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
  36. </div>
  37. Message Expressions: #{...}:获取国际化内容
  38. Link URL Expressions: @{...}:定义URL;
  39. @{/order/process(execId=${execId},execType='FAST')}
  40. Fragment Expressions: ~{...}:片段引用表达式
  41. <div th:insert="~{commons :: main}">...</div>
  42. Literals(字面量)
  43. Text literals: 'one text' , 'Another one!' ,…
  44. Number literals: 0 , 34 , 3.0 , 12.3 ,…
  45. Boolean literals: true , false
  46. Null literal: null
  47. Literal tokens: one , sometext , main ,…
  48. Text operations:(文本操作)
  49. String concatenation: +
  50. Literal substitutions: |The name is ${name}|
  51. Arithmetic operations:(数学运算)
  52. Binary operators: + , - , * , / , %
  53. Minus sign (unary operator): -
  54. Boolean operations:(布尔运算)
  55. Binary operators: and , or
  56. Boolean negation (unary operator): ! , not
  57. Comparisons and equality:(比较运算)
  58. Comparators: > , < , >= , <= ( gt , lt , ge , le )
  59. Equality operators: == , != ( eq , ne )
  60. Conditional operators:条件运算(三元运算符)
  61. If-then: (if) ? (then)
  62. If-then-else: (if) ? (then) : (else)
  63. Default: (value) ?: (defaultvalue)
  64. Special tokens:
  65. No-Operation: _

4、SpringMVC自动配置

https://docs.spring.io/spring-boot/docs/1.5.10.RELEASE/reference/htmlsingle/#boot-features-developing-web-applications

1. Spring MVC auto-configuration

Spring Boot 自动配置好了SpringMVC

以下是SpringBoot对SpringMVC的默认配置:(WebMvcAutoConfiguration)

  • Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
    • 自动配置了ViewResolver(视图解析器:根据方法的返回值得到视图对象(View),视图对象决定如何渲染(转发?重定向?))
    • ContentNegotiatingViewResolver:组合所有的视图解析器的;
    • 如何定制:我们可以自己给容器中添加一个视图解析器;自动的将其组合进来;
  • Support for serving static resources, including support for WebJars (see below).静态资源文件夹路径,webjars
  • Static index.html support. 静态首页访问
  • Custom Favicon support (see below). favicon.ico
  • 自动注册了 of Converter, GenericConverter, Formatter beans.
    • Converter:转换器; public String hello(User user):类型转换使用Converter
    • Formatter 格式化器; 2017.12.17===Date;
  1. @Bean
  2. @ConditionalOnProperty(prefix = "spring.mvc", name = "date-format")//在文件中配置日期格式化的规则
  3. public Formatter<Date> dateFormatter() {
  4. return new DateFormatter(this.mvcProperties.getDateFormat());//日期格式化组件
  5. }
  1. 自己添加的格式化器转换器,我们只需要放在容器中即可
  • Support for HttpMessageConverters (see below).
    • HttpMessageConverter:SpringMVC用来转换Http请求和响应的;User—-Json;
    • HttpMessageConverters 是从容器中确定;获取所有的HttpMessageConverter;
      自己给容器中添加HttpMessageConverter,只需要将自己的组件注册容器中(@Bean,@Component)
  • Automatic registration of MessageCodesResolver (see below).定义错误代码生成规则
  • Automatic use of a ConfigurableWebBindingInitializer bean (see below).
    我们可以配置一个ConfigurableWebBindingInitializer来替换默认的;(添加到容器)
    1. 初始化WebDataBinder
    2. 请求数据=====JavaBean

org.springframework.boot.autoconfigure.web:web的所有自动场景;

If you want to keep Spring Boot MVC features, and you just want to add additional MVC configuration (interceptors, formatters, view controllers etc.) you can add your own @Configuration class of type WebMvcConfigurerAdapter, but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter or ExceptionHandlerExceptionResolver you can declare a WebMvcRegistrationsAdapter instance providing such components.

If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.

2、扩展SpringMVC

  1. <mvc:view-controller path="/hello" view-name="success"/>
  2. <mvc:interceptors>
  3. <mvc:interceptor>
  4. <mvc:mapping path="/hello"/>
  5. <bean></bean>
  6. </mvc:interceptor>
  7. </mvc:interceptors>

编写一个配置类(@Configuration),是WebMvcConfigurerAdapter类型;不能标注@EnableWebMvc ;

既保留了所有的自动配置,也能用我们扩展的配置;

  1. //使用WebMvcConfigurerAdapter可以来扩展SpringMVC的功能
  2. @Configuration
  3. public class MyMvcConfig extends WebMvcConfigurerAdapter {
  4. @Override
  5. public void addViewControllers(ViewControllerRegistry registry) {
  6. // super.addViewControllers(registry);
  7. //浏览器发送 /atguigu 请求来到 success
  8. registry.addViewController("/atguigu").setViewName("success");
  9. }
  10. }

原理:

  1. 1)、WebMvcAutoConfigurationSpringMVC的自动配置类
  2. 2)、在做其他自动配置时会导入;@Import(**EnableWebMvcConfiguration**.class)
  1. @Configuration
  2. public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration {
  3. private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
  4. //从容器中获取所有的WebMvcConfigurer
  5. @Autowired(required = false)
  6. public void setConfigurers(List<WebMvcConfigurer> configurers) {
  7. if (!CollectionUtils.isEmpty(configurers)) {
  8. this.configurers.addWebMvcConfigurers(configurers);
  9. //一个参考实现;将所有的WebMvcConfigurer相关配置都来一起调用;
  10. @Override
  11. // public void addViewControllers(ViewControllerRegistry registry) {
  12. // for (WebMvcConfigurer delegate : this.delegates) {
  13. // delegate.addViewControllers(registry);
  14. // }
  15. }
  16. }
  17. }
  1. 3)、容器中所有的WebMvcConfigurer都会一起起作用;
  2. 4)、我们的配置类也会被调用;
  3. 效果:SpringMVC的自动配置和我们的扩展配置都会起作用;

3、全面接管SpringMVC;

SpringBoot对SpringMVC的自动配置不需要了,所有都是我们自己配置;所有的SpringMVC的自动配置都失效了

我们需要在配置类中添加@EnableWebMvc即可;

  1. //使用WebMvcConfigurerAdapter可以来扩展SpringMVC的功能
  2. @EnableWebMvc
  3. @Configuration
  4. public class MyMvcConfig extends WebMvcConfigurerAdapter {
  5. @Override
  6. public void addViewControllers(ViewControllerRegistry registry) {
  7. // super.addViewControllers(registry);
  8. //浏览器发送 /atguigu 请求来到 success
  9. registry.addViewController("/atguigu").setViewName("success");
  10. }
  11. }

原理:

为什么@EnableWebMvc自动配置就失效了;

1)@EnableWebMvc的核心

  1. @Import(DelegatingWebMvcConfiguration.class)
  2. public @interface EnableWebMvc {

2)、

  1. @Configuration
  2. public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {

3)、

  1. @Configuration
  2. @ConditionalOnWebApplication
  3. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
  4. WebMvcConfigurerAdapter.class })
  5. //容器中没有这个组件的时候,这个自动配置类才生效
  6. @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
  7. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
  8. @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
  9. ValidationAutoConfiguration.class })
  10. public class WebMvcAutoConfiguration {

4)、@EnableWebMvc将WebMvcConfigurationSupport组件导入进来;

5)、导入的WebMvcConfigurationSupport只是SpringMVC最基本的功能;

5、如何修改SpringBoot的默认配置

模式:

  1. 1)、SpringBoot在自动配置很多组件的时候,先看容器中有没有用户自己配置的(@Bean@Component)如果有就用用户配置的,如果没有,才自动配置;如果有些组件可以有多个(ViewResolver)将用户配置的和自己默认的组合起来;
  2. 2)、在SpringBoot中会有非常多的xxxConfigurer帮助我们进行扩展配置
  3. 3)、在SpringBoot中会有很多的xxxCustomizer帮助我们进行定制配置

6、RestfulCRUD

1)、默认访问首页

  1. //使用WebMvcConfigurerAdapter可以来扩展SpringMVC的功能
  2. //@EnableWebMvc 不要接管SpringMVC
  3. @Configuration
  4. public class MyMvcConfig extends WebMvcConfigurerAdapter {
  5. @Override
  6. public void addViewControllers(ViewControllerRegistry registry) {
  7. // super.addViewControllers(registry);
  8. //浏览器发送 /atguigu 请求来到 success
  9. registry.addViewController("/atguigu").setViewName("success");
  10. }
  11. //所有的WebMvcConfigurerAdapter组件都会一起起作用
  12. @Bean //将组件注册在容器
  13. public WebMvcConfigurerAdapter webMvcConfigurerAdapter(){
  14. WebMvcConfigurerAdapter adapter = new WebMvcConfigurerAdapter() {
  15. @Override
  16. public void addViewControllers(ViewControllerRegistry registry) {
  17. registry.addViewController("/").setViewName("login");
  18. registry.addViewController("/index.html").setViewName("login");
  19. }
  20. };
  21. return adapter;
  22. }
  23. }

2)、国际化

1)、编写国际化配置文件;

2)、使用ResourceBundleMessageSource管理国际化资源文件

3)、在页面使用fmt:message取出国际化内容

步骤:

1)、编写国际化配置文件,抽取页面需要显示的国际化消息

Spring Boot - 图8

2)、SpringBoot自动配置好了管理国际化资源文件的组件;

  1. @ConfigurationProperties(prefix = "spring.messages")
  2. public class MessageSourceAutoConfiguration {
  3. /**
  4. * Comma-separated list of basenames (essentially a fully-qualified classpath
  5. * location), each following the ResourceBundle convention with relaxed support for
  6. * slash based locations. If it doesn't contain a package qualifier (such as
  7. * "org.mypackage"), it will be resolved from the classpath root.
  8. */
  9. private String basename = "messages";
  10. //我们的配置文件可以直接放在类路径下叫messages.properties;
  11. @Bean
  12. public MessageSource messageSource() {
  13. ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
  14. if (StringUtils.hasText(this.basename)) {
  15. //设置国际化资源文件的基础名(去掉语言国家代码的)
  16. messageSource.setBasenames(StringUtils.commaDelimitedListToStringArray(
  17. StringUtils.trimAllWhitespace(this.basename)));
  18. }
  19. if (this.encoding != null) {
  20. messageSource.setDefaultEncoding(this.encoding.name());
  21. }
  22. messageSource.setFallbackToSystemLocale(this.fallbackToSystemLocale);
  23. messageSource.setCacheSeconds(this.cacheSeconds);
  24. messageSource.setAlwaysUseMessageFormat(this.alwaysUseMessageFormat);
  25. return messageSource;
  26. }

3)、去页面获取国际化的值;

Spring Boot - 图9

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  6. <meta name="description" content="">
  7. <meta name="author" content="">
  8. <title>Signin Template for Bootstrap</title>
  9. <!-- Bootstrap core CSS -->
  10. <link href="asserts/css/bootstrap.min.css" th:href="@{/webjars/bootstrap/4.0.0/css/bootstrap.css}" rel="stylesheet">
  11. <!-- Custom styles for this template -->
  12. <link href="asserts/css/signin.css" th:href="@{/asserts/css/signin.css}" rel="stylesheet">
  13. </head>
  14. <body class="text-center">
  15. <form class="form-signin" action="dashboard.html">
  16. <img class="mb-4" th:src="@{/asserts/img/bootstrap-solid.svg}" src="asserts/img/bootstrap-solid.svg" alt="" width="72" height="72">
  17. <h1 class="h3 mb-3 font-weight-normal" th:text="#{login.tip}">Please sign in</h1>
  18. <label class="sr-only" th:text="#{login.username}">Username</label>
  19. <input type="text" class="form-control" placeholder="Username" th:placeholder="#{login.username}" required="" autofocus="">
  20. <label class="sr-only" th:text="#{login.password}">Password</label>
  21. <input type="password" class="form-control" placeholder="Password" th:placeholder="#{login.password}" required="">
  22. <div class="checkbox mb-3">
  23. <label>
  24. <input type="checkbox" value="remember-me"/> [[#{login.remember}]]
  25. </label>
  26. </div>
  27. <button class="btn btn-lg btn-primary btn-block" type="submit" th:text="#{login.btn}">Sign in</button>
  28. <p class="mt-5 mb-3 text-muted">© 2017-2018</p>
  29. <a class="btn btn-sm">中文</a>
  30. <a class="btn btn-sm">English</a>
  31. </form>
  32. </body>
  33. </html>

效果:根据浏览器语言设置的信息切换了国际化;

原理:

  1. 国际化Locale(区域信息对象);LocaleResolver(获取区域信息对象);
  1. @Bean
  2. @ConditionalOnMissingBean
  3. @ConditionalOnProperty(prefix = "spring.mvc", name = "locale")
  4. public LocaleResolver localeResolver() {
  5. if (this.mvcProperties
  6. .getLocaleResolver() == WebMvcProperties.LocaleResolver.FIXED) {
  7. return new FixedLocaleResolver(this.mvcProperties.getLocale());
  8. }
  9. AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver();
  10. localeResolver.setDefaultLocale(this.mvcProperties.getLocale());
  11. return localeResolver;
  12. }
  13. 默认的就是根据请求头带来的区域信息获取Locale进行国际化

4)、点击链接切换国际化

  1. /**
  2. * 可以在连接上携带区域信息
  3. */
  4. public class MyLocaleResolver implements LocaleResolver {
  5. @Override
  6. public Locale resolveLocale(HttpServletRequest request) {
  7. String l = request.getParameter("l");
  8. Locale locale = Locale.getDefault();
  9. if(!StringUtils.isEmpty(l)){
  10. String[] split = l.split("_");
  11. locale = new Locale(split[0],split[1]);
  12. }
  13. return locale;
  14. }
  15. @Override
  16. public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
  17. }
  18. }
  19. @Bean
  20. public LocaleResolver localeResolver(){
  21. return new MyLocaleResolver();
  22. }
  23. }

3)、登陆

开发期间模板引擎页面修改以后,要实时生效

1)、禁用模板引擎的缓存

  1. # 禁用缓存
  2. spring.thymeleaf.cache=false

2)、页面修改完成以后ctrl+f9:重新编译;

登陆错误消息的显示

  1. <p style="color: red" th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>

4)、拦截器进行登陆检查

拦截器

  1. /**
  2. * 登陆检查,
  3. */
  4. public class LoginHandlerInterceptor implements HandlerInterceptor {
  5. //目标方法执行之前
  6. @Override
  7. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  8. Object user = request.getSession().getAttribute("loginUser");
  9. if(user == null){
  10. //未登陆,返回登陆页面
  11. request.setAttribute("msg","没有权限请先登陆");
  12. request.getRequestDispatcher("/index.html").forward(request,response);
  13. return false;
  14. }else{
  15. //已登陆,放行请求
  16. return true;
  17. }
  18. }
  19. @Override
  20. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  21. }
  22. @Override
  23. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  24. }
  25. }

注册拦截器

  1. //所有的WebMvcConfigurerAdapter组件都会一起起作用
  2. @Bean //将组件注册在容器
  3. public WebMvcConfigurerAdapter webMvcConfigurerAdapter(){
  4. WebMvcConfigurerAdapter adapter = new WebMvcConfigurerAdapter() {
  5. @Override
  6. public void addViewControllers(ViewControllerRegistry registry) {
  7. registry.addViewController("/").setViewName("login");
  8. registry.addViewController("/index.html").setViewName("login");
  9. registry.addViewController("/main.html").setViewName("dashboard");
  10. }
  11. //注册拦截器
  12. @Override
  13. public void addInterceptors(InterceptorRegistry registry) {
  14. //super.addInterceptors(registry);
  15. //静态资源; *.css , *.js
  16. //SpringBoot已经做好了静态资源映射
  17. registry.addInterceptor(new LoginHandlerInterceptor()).addPathPatterns("/**")
  18. .excludePathPatterns("/index.html","/","/user/login");
  19. }
  20. };
  21. return adapter;
  22. }

5)、CRUD-员工列表

实验要求:

1)、RestfulCRUD:CRUD满足Rest风格;

URI: /资源名称/资源标识 HTTP请求方式区分对资源CRUD操作

普通CRUD(uri来区分操作) RestfulCRUD
查询 getEmp emp—-GET
添加 addEmp?xxx emp—-POST
修改 updateEmp?id=xxx&xxx=xx emp/{id}—-PUT
删除 deleteEmp?id=1 emp/{id}—-DELETE

2)、实验的请求架构;

实验功能 请求URI 请求方式
查询所有员工 emps GET
查询某个员工(来到修改页面) emp/1 GET
来到添加页面 emp GET
添加员工 emp POST
来到修改页面(查出员工进行信息回显) emp/1 GET
修改员工 emp PUT
删除员工 emp/1 DELETE

3)、员工列表:

thymeleaf公共页面元素抽取

  1. 1、抽取公共片段
  2. <div th:fragment="copy">
  3. &copy; 2011 The Good Thymes Virtual Grocery
  4. </div>
  5. 2、引入公共片段
  6. <div th:insert="~{footer :: copy}"></div>
  7. ~{templatename::selector}:模板名::选择器
  8. ~{templatename::fragmentname}:模板名::片段名
  9. 3、默认效果:
  10. insert的公共片段在div标签中
  11. 如果使用th:insert等属性进行引入,可以不用写~{}:
  12. 行内写法可以加上:[[~{}]];[(~{})];

三种引入公共片段的th属性:

th:insert:将公共片段整个插入到声明引入的元素中

th:replace:将声明引入的元素替换为公共片段

th:include:将被引入的片段的内容包含进这个标签中

  1. <footer th:fragment="copy">
  2. &copy; 2011 The Good Thymes Virtual Grocery
  3. </footer>
  4. 引入方式
  5. <div th:insert="footer :: copy"></div>
  6. <div th:replace="footer :: copy"></div>
  7. <div th:include="footer :: copy"></div>
  8. 效果
  9. <div>
  10. <footer>
  11. &copy; 2011 The Good Thymes Virtual Grocery
  12. </footer>
  13. </div>
  14. <footer>
  15. &copy; 2011 The Good Thymes Virtual Grocery
  16. </footer>
  17. <div>
  18. &copy; 2011 The Good Thymes Virtual Grocery
  19. </div>

引入片段的时候传入参数:

  1. <nav class="col-md-2 d-none d-md-block bg-light sidebar" id="sidebar">
  2. <div class="sidebar-sticky">
  3. <ul class="nav flex-column">
  4. <li class="nav-item">
  5. <a class="nav-link active"
  6. th:class="${activeUri=='main.html'?'nav-link active':'nav-link'}"
  7. href="#" th:href="@{/main.html}">
  8. <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-home">
  9. <path d="M3 9l9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"></path>
  10. <polyline points="9 22 9 12 15 12 15 22"></polyline>
  11. </svg>
  12. Dashboard <span class="sr-only">(current)</span>
  13. </a>
  14. </li>
  15. <!--引入侧边栏;传入参数-->
  16. <div th:replace="commons/bar::#sidebar(activeUri='emps')"></div>

6)、CRUD-员工添加

添加页面

  1. <form>
  2. <div class="form-group">
  3. <label>LastName</label>
  4. <input type="text" class="form-control" placeholder="zhangsan">
  5. </div>
  6. <div class="form-group">
  7. <label>Email</label>
  8. <input type="email" class="form-control" placeholder="zhangsan@atguigu.com">
  9. </div>
  10. <div class="form-group">
  11. <label>Gender</label><br/>
  12. <div class="form-check form-check-inline">
  13. <input class="form-check-input" type="radio" name="gender" value="1">
  14. <label class="form-check-label"></label>
  15. </div>
  16. <div class="form-check form-check-inline">
  17. <input class="form-check-input" type="radio" name="gender" value="0">
  18. <label class="form-check-label"></label>
  19. </div>
  20. </div>
  21. <div class="form-group">
  22. <label>department</label>
  23. <select class="form-control">
  24. <option>1</option>
  25. <option>2</option>
  26. <option>3</option>
  27. <option>4</option>
  28. <option>5</option>
  29. </select>
  30. </div>
  31. <div class="form-group">
  32. <label>Birth</label>
  33. <input type="text" class="form-control" placeholder="zhangsan">
  34. </div>
  35. <button type="submit" class="btn btn-primary">添加</button>
  36. </form>

提交的数据格式不对:生日:日期;

2017-12-12;2017/12/12;2017.12.12;

日期的格式化;SpringMVC将页面提交的值需要转换为指定的类型;

2017-12-12—-Date; 类型转换,格式化;

默认日期是按照/的方式;

7)、CRUD-员工修改

修改添加二合一表单

  1. <!--需要区分是员工修改还是添加;-->
  2. <form th:action="@{/emp}" method="post">
  3. <!--发送put请求修改员工数据-->
  4. <!--
  5. 1、SpringMVC中配置HiddenHttpMethodFilter;(SpringBoot自动配置好的)
  6. 2、页面创建一个post表单
  7. 3、创建一个input项,name="_method";值就是我们指定的请求方式
  8. -->
  9. <input type="hidden" name="_method" value="put" th:if="${emp!=null}"/>
  10. <input type="hidden" name="id" th:if="${emp!=null}" th:value="${emp.id}">
  11. <div class="form-group">
  12. <label>LastName</label>
  13. <input name="lastName" type="text" class="form-control" placeholder="zhangsan" th:value="${emp!=null}?${emp.lastName}">
  14. </div>
  15. <div class="form-group">
  16. <label>Email</label>
  17. <input name="email" type="email" class="form-control" placeholder="zhangsan@atguigu.com" th:value="${emp!=null}?${emp.email}">
  18. </div>
  19. <div class="form-group">
  20. <label>Gender</label><br/>
  21. <div class="form-check form-check-inline">
  22. <input class="form-check-input" type="radio" name="gender" value="1" th:checked="${emp!=null}?${emp.gender==1}">
  23. <label class="form-check-label"></label>
  24. </div>
  25. <div class="form-check form-check-inline">
  26. <input class="form-check-input" type="radio" name="gender" value="0" th:checked="${emp!=null}?${emp.gender==0}">
  27. <label class="form-check-label"></label>
  28. </div>
  29. </div>
  30. <div class="form-group">
  31. <label>department</label>
  32. <!--提交的是部门的id-->
  33. <select class="form-control" name="department.id">
  34. <option th:selected="${emp!=null}?${dept.id == emp.department.id}" th:value="${dept.id}" th:each="dept:${depts}" th:text="${dept.departmentName}">1</option>
  35. </select>
  36. </div>
  37. <div class="form-group">
  38. <label>Birth</label>
  39. <input name="birth" type="text" class="form-control" placeholder="zhangsan" th:value="${emp!=null}?${#dates.format(emp.birth, 'yyyy-MM-dd HH:mm')}">
  40. </div>
  41. <button type="submit" class="btn btn-primary" th:text="${emp!=null}?'修改':'添加'">添加</button>
  42. </form>

8)、CRUD-员工删除

  1. <tr th:each="emp:${emps}">
  2. <td th:text="${emp.id}"></td>
  3. <td>[[${emp.lastName}]]</td>
  4. <td th:text="${emp.email}"></td>
  5. <td th:text="${emp.gender}==0?'女':'男'"></td>
  6. <td th:text="${emp.department.departmentName}"></td>
  7. <td th:text="${#dates.format(emp.birth, 'yyyy-MM-dd HH:mm')}"></td>
  8. <td>
  9. <a class="btn btn-sm btn-primary" th:href="@{/emp/}+${emp.id}">编辑</a>
  10. <button th:attr="del_uri=@{/emp/}+${emp.id}" class="btn btn-sm btn-danger deleteBtn">删除</button>
  11. </td>
  12. </tr>
  13. <script>
  14. $(".deleteBtn").click(function(){
  15. //删除当前员工的
  16. $("#deleteEmpForm").attr("action",$(this).attr("del_uri")).submit();
  17. return false;
  18. });
  19. </script>

7、错误处理机制

1)、SpringBoot默认的错误处理机制

默认效果:

  1. 1)、浏览器,返回一个默认的错误页面

Spring Boot - 图10

浏览器发送请求的请求头:

Spring Boot - 图11

  1. 2)、如果是其他客户端,默认响应一个json数据

Spring Boot - 图12

  1. ![](images/%E6%90%9C%E7%8B%97%E6%88%AA%E5%9B%BE20180226180504.png#id=Onpeg&originalType=binary&ratio=1&status=done&style=none)

原理:

  1. 可以参照ErrorMvcAutoConfiguration;错误处理的自动配置;
  1. 给容器中添加了以下组件
  1. 1DefaultErrorAttributes
  1. 帮我们在页面共享信息;
  2. @Override
  3. public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
  4. boolean includeStackTrace) {
  5. Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
  6. errorAttributes.put("timestamp", new Date());
  7. addStatus(errorAttributes, requestAttributes);
  8. addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
  9. addPath(errorAttributes, requestAttributes);
  10. return errorAttributes;
  11. }
  1. 2BasicErrorController:处理默认/error请求
  1. @Controller
  2. @RequestMapping("${server.error.path:${error.path:/error}}")
  3. public class BasicErrorController extends AbstractErrorController {
  4. @RequestMapping(produces = "text/html")//产生html类型的数据;浏览器发送的请求来到这个方法处理
  5. public ModelAndView errorHtml(HttpServletRequest request,
  6. HttpServletResponse response) {
  7. HttpStatus status = getStatus(request);
  8. Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
  9. request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
  10. response.setStatus(status.value());
  11. //去哪个页面作为错误页面;包含页面地址和页面内容
  12. ModelAndView modelAndView = resolveErrorView(request, response, status, model);
  13. return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
  14. }
  15. @RequestMapping
  16. @ResponseBody //产生json数据,其他客户端来到这个方法处理;
  17. public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
  18. Map<String, Object> body = getErrorAttributes(request,
  19. isIncludeStackTrace(request, MediaType.ALL));
  20. HttpStatus status = getStatus(request);
  21. return new ResponseEntity<Map<String, Object>>(body, status);
  22. }
  1. 3ErrorPageCustomizer
  1. @Value("${error.path:/error}")
  2. private String path = "/error"; 系统出现错误以后来到error请求进行处理;(web.xml注册的错误页面规则)
  1. 4DefaultErrorViewResolver
  1. @Override
  2. public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
  3. Map<String, Object> model) {
  4. ModelAndView modelAndView = resolve(String.valueOf(status), model);
  5. if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
  6. modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
  7. }
  8. return modelAndView;
  9. }
  10. private ModelAndView resolve(String viewName, Map<String, Object> model) {
  11. //默认SpringBoot可以去找到一个页面? error/404
  12. String errorViewName = "error/" + viewName;
  13. //模板引擎可以解析这个页面地址就用模板引擎解析
  14. TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
  15. .getProvider(errorViewName, this.applicationContext);
  16. if (provider != null) {
  17. //模板引擎可用的情况下返回到errorViewName指定的视图地址
  18. return new ModelAndView(errorViewName, model);
  19. }
  20. //模板引擎不可用,就在静态资源文件夹下找errorViewName对应的页面 error/404.html
  21. return resolveResource(errorViewName, model);
  22. }
  1. 步骤:
  2. 一但系统出现4xx或者5xx之类的错误;ErrorPageCustomizer就会生效(定制错误的响应规则);就会来到/error请求;就会被**BasicErrorController**处理;
  3. 1)响应页面;去哪个页面是由**DefaultErrorViewResolver**解析得到的;
  1. protected ModelAndView resolveErrorView(HttpServletRequest request,
  2. HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
  3. //所有的ErrorViewResolver得到ModelAndView
  4. for (ErrorViewResolver resolver : this.errorViewResolvers) {
  5. ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
  6. if (modelAndView != null) {
  7. return modelAndView;
  8. }
  9. }
  10. return null;
  11. }

2)、如果定制错误响应:

1)、如何定制错误的页面;

  1. **1)、有模板引擎的情况下;error/状态码;** 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】,发生此状态码的错误就会来到 对应的页面;
  2. 我们可以使用4xx5xx作为错误页面的文件名来匹配这种类型的所有错误,精确优先(优先寻找精确的状态码.html);
  3. 页面能获取的信息;
  4. timestamp:时间戳
  5. status:状态码
  6. error:错误提示
  7. exception:异常对象
  8. message:异常消息
  9. errorsJSR303数据校验的错误都在这里
  10. 2)、没有模板引擎(模板引擎找不到这个错误页面),静态资源文件夹下找;
  11. 3)、以上都没有错误页面,就是默认来到SpringBoot默认的错误提示页面;

2)、如何定制错误的json数据;

  1. 1)、自定义异常处理&返回定制json数据;
  1. @ControllerAdvice
  2. public class MyExceptionHandler {
  3. @ResponseBody
  4. @ExceptionHandler(UserNotExistException.class)
  5. public Map<String,Object> handleException(Exception e){
  6. Map<String,Object> map = new HashMap<>();
  7. map.put("code","user.notexist");
  8. map.put("message",e.getMessage());
  9. return map;
  10. }
  11. }
  12. //没有自适应效果...
  1. 2)、转发到/error进行自适应响应效果处理
  1. @ExceptionHandler(UserNotExistException.class)
  2. public String handleException(Exception e, HttpServletRequest request){
  3. Map<String,Object> map = new HashMap<>();
  4. //传入我们自己的错误状态码 4xx 5xx,否则就不会进入定制错误页面的解析流程
  5. /**
  6. * Integer statusCode = (Integer) request
  7. .getAttribute("javax.servlet.error.status_code");
  8. */
  9. request.setAttribute("javax.servlet.error.status_code",500);
  10. map.put("code","user.notexist");
  11. map.put("message",e.getMessage());
  12. //转发到/error
  13. return "forward:/error";
  14. }

3)、将我们的定制数据携带出去;

出现错误以后,会来到/error请求,会被BasicErrorController处理,响应出去可以获取的数据是由getErrorAttributes得到的(是AbstractErrorController(ErrorController)规定的方法);

  1. 1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】,放在容器中;
  2. 2、页面上能用的数据,或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到;
  3. 容器中DefaultErrorAttributes.getErrorAttributes();默认进行数据处理的;

自定义ErrorAttributes

  1. //给容器中加入我们自己定义的ErrorAttributes
  2. @Component
  3. public class MyErrorAttributes extends DefaultErrorAttributes {
  4. @Override
  5. public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
  6. Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
  7. map.put("company","atguigu");
  8. return map;
  9. }
  10. }

最终的效果:响应是自适应的,可以通过定制ErrorAttributes改变需要返回的内容,

Spring Boot - 图13

8、配置嵌入式Servlet容器

SpringBoot默认使用Tomcat作为嵌入式的Servlet容器;

Spring Boot - 图14

问题?

1)、如何定制和修改Servlet容器的相关配置;

1、修改和server有关的配置(ServerProperties【也是EmbeddedServletContainerCustomizer】);

  1. server.port=8081
  2. server.context-path=/crud
  3. server.tomcat.uri-encoding=UTF-8
  4. //通用的Servlet容器设置
  5. server.xxx
  6. //Tomcat的设置
  7. server.tomcat.xxx

2、编写一个EmbeddedServletContainerCustomizer:嵌入式的Servlet容器的定制器;来修改Servlet容器的配置

  1. @Bean //一定要将这个定制器加入到容器中
  2. public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer(){
  3. return new EmbeddedServletContainerCustomizer() {
  4. //定制嵌入式的Servlet容器相关的规则
  5. @Override
  6. public void customize(ConfigurableEmbeddedServletContainer container) {
  7. container.setPort(8083);
  8. }
  9. };
  10. }

2)、注册Servlet三大组件【Servlet、Filter、Listener】

由于SpringBoot默认是以jar包的方式启动嵌入式的Servlet容器来启动SpringBoot的web应用,没有web.xml文件。

注册三大组件用以下方式

ServletRegistrationBean

  1. //注册三大组件
  2. @Bean
  3. public ServletRegistrationBean myServlet(){
  4. ServletRegistrationBean registrationBean = new ServletRegistrationBean(new MyServlet(),"/myServlet");
  5. return registrationBean;
  6. }

FilterRegistrationBean

  1. @Bean
  2. public FilterRegistrationBean myFilter(){
  3. FilterRegistrationBean registrationBean = new FilterRegistrationBean();
  4. registrationBean.setFilter(new MyFilter());
  5. registrationBean.setUrlPatterns(Arrays.asList("/hello","/myServlet"));
  6. return registrationBean;
  7. }

ServletListenerRegistrationBean

  1. @Bean
  2. public ServletListenerRegistrationBean myListener(){
  3. ServletListenerRegistrationBean<MyListener> registrationBean = new ServletListenerRegistrationBean<>(new MyListener());
  4. return registrationBean;
  5. }

SpringBoot帮我们自动SpringMVC的时候,自动的注册SpringMVC的前端控制器;DIspatcherServlet;

DispatcherServletAutoConfiguration中:

  1. @Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
  2. @ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
  3. public ServletRegistrationBean dispatcherServletRegistration(
  4. DispatcherServlet dispatcherServlet) {
  5. ServletRegistrationBean registration = new ServletRegistrationBean(
  6. dispatcherServlet, this.serverProperties.getServletMapping());
  7. //默认拦截: / 所有请求;包静态资源,但是不拦截jsp请求; /*会拦截jsp
  8. //可以通过server.servletPath来修改SpringMVC前端控制器默认拦截的请求路径
  9. registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
  10. registration.setLoadOnStartup(
  11. this.webMvcProperties.getServlet().getLoadOnStartup());
  12. if (this.multipartConfig != null) {
  13. registration.setMultipartConfig(this.multipartConfig);
  14. }
  15. return registration;
  16. }

2)、SpringBoot能不能支持其他的Servlet容器;

3)、替换为其他嵌入式Servlet容器

Spring Boot - 图15

默认支持:

Tomcat(默认使用)

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. 引入web模块默认就是使用嵌入式的Tomcat作为Servlet容器;
  5. </dependency>

Jetty

  1. <!-- 引入web模块 -->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. <exclusions>
  6. <exclusion>
  7. <artifactId>spring-boot-starter-tomcat</artifactId>
  8. <groupId>org.springframework.boot</groupId>
  9. </exclusion>
  10. </exclusions>
  11. </dependency>
  12. <!--引入其他的Servlet容器-->
  13. <dependency>
  14. <artifactId>spring-boot-starter-jetty</artifactId>
  15. <groupId>org.springframework.boot</groupId>
  16. </dependency>

Undertow

  1. <!-- 引入web模块 -->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. <exclusions>
  6. <exclusion>
  7. <artifactId>spring-boot-starter-tomcat</artifactId>
  8. <groupId>org.springframework.boot</groupId>
  9. </exclusion>
  10. </exclusions>
  11. </dependency>
  12. <!--引入其他的Servlet容器-->
  13. <dependency>
  14. <artifactId>spring-boot-starter-undertow</artifactId>
  15. <groupId>org.springframework.boot</groupId>
  16. </dependency>

4)、嵌入式Servlet容器自动配置原理;

EmbeddedServletContainerAutoConfiguration:嵌入式的Servlet容器自动配置?

  1. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
  2. @Configuration
  3. @ConditionalOnWebApplication
  4. @Import(BeanPostProcessorsRegistrar.class)
  5. //导入BeanPostProcessorsRegistrar:Spring注解版;给容器中导入一些组件
  6. //导入了EmbeddedServletContainerCustomizerBeanPostProcessor:
  7. //后置处理器:bean初始化前后(创建完对象,还没赋值赋值)执行初始化工作
  8. public class EmbeddedServletContainerAutoConfiguration {
  9. @Configuration
  10. @ConditionalOnClass({ Servlet.class, Tomcat.class })//判断当前是否引入了Tomcat依赖;
  11. @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)//判断当前容器没有用户自己定义EmbeddedServletContainerFactory:嵌入式的Servlet容器工厂;作用:创建嵌入式的Servlet容器
  12. public static class EmbeddedTomcat {
  13. @Bean
  14. public TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory() {
  15. return new TomcatEmbeddedServletContainerFactory();
  16. }
  17. }
  18. /**
  19. * Nested configuration if Jetty is being used.
  20. */
  21. @Configuration
  22. @ConditionalOnClass({ Servlet.class, Server.class, Loader.class,
  23. WebAppContext.class })
  24. @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
  25. public static class EmbeddedJetty {
  26. @Bean
  27. public JettyEmbeddedServletContainerFactory jettyEmbeddedServletContainerFactory() {
  28. return new JettyEmbeddedServletContainerFactory();
  29. }
  30. }
  31. /**
  32. * Nested configuration if Undertow is being used.
  33. */
  34. @Configuration
  35. @ConditionalOnClass({ Servlet.class, Undertow.class, SslClientAuthMode.class })
  36. @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
  37. public static class EmbeddedUndertow {
  38. @Bean
  39. public UndertowEmbeddedServletContainerFactory undertowEmbeddedServletContainerFactory() {
  40. return new UndertowEmbeddedServletContainerFactory();
  41. }
  42. }

1)、EmbeddedServletContainerFactory(嵌入式Servlet容器工厂)

  1. public interface EmbeddedServletContainerFactory {
  2. //获取嵌入式的Servlet容器
  3. EmbeddedServletContainer getEmbeddedServletContainer(
  4. ServletContextInitializer... initializers);
  5. }

Spring Boot - 图16

2)、EmbeddedServletContainer:(嵌入式的Servlet容器)

Spring Boot - 图17

3)、以TomcatEmbeddedServletContainerFactory为例

  1. @Override
  2. public EmbeddedServletContainer getEmbeddedServletContainer(
  3. ServletContextInitializer... initializers) {
  4. //创建一个Tomcat
  5. Tomcat tomcat = new Tomcat();
  6. //配置Tomcat的基本环节
  7. File baseDir = (this.baseDirectory != null ? this.baseDirectory
  8. : createTempDir("tomcat"));
  9. tomcat.setBaseDir(baseDir.getAbsolutePath());
  10. Connector connector = new Connector(this.protocol);
  11. tomcat.getService().addConnector(connector);
  12. customizeConnector(connector);
  13. tomcat.setConnector(connector);
  14. tomcat.getHost().setAutoDeploy(false);
  15. configureEngine(tomcat.getEngine());
  16. for (Connector additionalConnector : this.additionalTomcatConnectors) {
  17. tomcat.getService().addConnector(additionalConnector);
  18. }
  19. prepareContext(tomcat.getHost(), initializers);
  20. //将配置好的Tomcat传入进去,返回一个EmbeddedServletContainer;并且启动Tomcat服务器
  21. return getTomcatEmbeddedServletContainer(tomcat);
  22. }

4)、我们对嵌入式容器的配置修改是怎么生效?

  1. ServerPropertiesEmbeddedServletContainerCustomizer

EmbeddedServletContainerCustomizer:定制器帮我们修改了Servlet容器的配置?

怎么修改的原理?

5)、容器中导入了EmbeddedServletContainerCustomizerBeanPostProcessor

  1. //初始化之前
  2. @Override
  3. public Object postProcessBeforeInitialization(Object bean, String beanName)
  4. throws BeansException {
  5. //如果当前初始化的是一个ConfigurableEmbeddedServletContainer类型的组件
  6. if (bean instanceof ConfigurableEmbeddedServletContainer) {
  7. //
  8. postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean);
  9. }
  10. return bean;
  11. }
  12. private void postProcessBeforeInitialization(
  13. ConfigurableEmbeddedServletContainer bean) {
  14. //获取所有的定制器,调用每一个定制器的customize方法来给Servlet容器进行属性赋值;
  15. for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) {
  16. customizer.customize(bean);
  17. }
  18. }
  19. private Collection<EmbeddedServletContainerCustomizer> getCustomizers() {
  20. if (this.customizers == null) {
  21. // Look up does not include the parent context
  22. this.customizers = new ArrayList<EmbeddedServletContainerCustomizer>(
  23. this.beanFactory
  24. //从容器中获取所有这葛类型的组件:EmbeddedServletContainerCustomizer
  25. //定制Servlet容器,给容器中可以添加一个EmbeddedServletContainerCustomizer类型的组件
  26. .getBeansOfType(EmbeddedServletContainerCustomizer.class,
  27. false, false)
  28. .values());
  29. Collections.sort(this.customizers, AnnotationAwareOrderComparator.INSTANCE);
  30. this.customizers = Collections.unmodifiableList(this.customizers);
  31. }
  32. return this.customizers;
  33. }
  34. ServerProperties也是定制器

步骤:

1)、SpringBoot根据导入的依赖情况,给容器中添加相应的EmbeddedServletContainerFactory【TomcatEmbeddedServletContainerFactory】

2)、容器中某个组件要创建对象就会惊动后置处理器;EmbeddedServletContainerCustomizerBeanPostProcessor;

只要是嵌入式的Servlet容器工厂,后置处理器就工作;

3)、后置处理器,从容器中获取所有的EmbeddedServletContainerCustomizer,调用定制器的定制方法

5)、嵌入式Servlet容器启动原理;

什么时候创建嵌入式的Servlet容器工厂?什么时候获取嵌入式的Servlet容器并启动Tomcat;

获取嵌入式的Servlet容器工厂:

1)、SpringBoot应用启动运行run方法

2)、refreshContext(context);SpringBoot刷新IOC容器【创建IOC容器对象,并初始化容器,创建容器中的每一个组件】;如果是web应用创建AnnotationConfigEmbeddedWebApplicationContext,否则:AnnotationConfigApplicationContext

3)、refresh(context);刷新刚才创建好的ioc容器;

  1. public void refresh() throws BeansException, IllegalStateException {
  2. synchronized (this.startupShutdownMonitor) {
  3. // Prepare this context for refreshing.
  4. prepareRefresh();
  5. // Tell the subclass to refresh the internal bean factory.
  6. ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
  7. // Prepare the bean factory for use in this context.
  8. prepareBeanFactory(beanFactory);
  9. try {
  10. // Allows post-processing of the bean factory in context subclasses.
  11. postProcessBeanFactory(beanFactory);
  12. // Invoke factory processors registered as beans in the context.
  13. invokeBeanFactoryPostProcessors(beanFactory);
  14. // Register bean processors that intercept bean creation.
  15. registerBeanPostProcessors(beanFactory);
  16. // Initialize message source for this context.
  17. initMessageSource();
  18. // Initialize event multicaster for this context.
  19. initApplicationEventMulticaster();
  20. // Initialize other special beans in specific context subclasses.
  21. onRefresh();
  22. // Check for listener beans and register them.
  23. registerListeners();
  24. // Instantiate all remaining (non-lazy-init) singletons.
  25. finishBeanFactoryInitialization(beanFactory);
  26. // Last step: publish corresponding event.
  27. finishRefresh();
  28. }
  29. catch (BeansException ex) {
  30. if (logger.isWarnEnabled()) {
  31. logger.warn("Exception encountered during context initialization - " +
  32. "cancelling refresh attempt: " + ex);
  33. }
  34. // Destroy already created singletons to avoid dangling resources.
  35. destroyBeans();
  36. // Reset 'active' flag.
  37. cancelRefresh(ex);
  38. // Propagate exception to caller.
  39. throw ex;
  40. }
  41. finally {
  42. // Reset common introspection caches in Spring's core, since we
  43. // might not ever need metadata for singleton beans anymore...
  44. resetCommonCaches();
  45. }
  46. }
  47. }

4)、 onRefresh(); web的ioc容器重写了onRefresh方法

5)、webioc容器会创建嵌入式的Servlet容器;createEmbeddedServletContainer();

6)、获取嵌入式的Servlet容器工厂:

EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory();

  1. ioc容器中获取EmbeddedServletContainerFactory 组件;**TomcatEmbeddedServletContainerFactory**创建对象,后置处理器一看是这个对象,就获取所有的定制器来先定制Servlet容器的相关配置;

7)、使用容器工厂获取嵌入式的Servlet容器:this.embeddedServletContainer = containerFactory .getEmbeddedServletContainer(getSelfInitializer());

8)、嵌入式的Servlet容器创建对象并启动Servlet容器;

先启动嵌入式的Servlet容器,再将ioc容器中剩下没有创建出的对象获取出来;

IOC容器启动创建嵌入式的Servlet容器

9、使用外置的Servlet容器

嵌入式Servlet容器:应用打成可执行的jar

  1. 优点:简单、便携;
  2. 缺点:默认不支持JSP、优化定制比较复杂(使用定制器【ServerProperties、自定义EmbeddedServletContainerCustomizer】,自己编写嵌入式Servlet容器的创建工厂【EmbeddedServletContainerFactory】);

外置的Servlet容器:外面安装Tomcat—-应用war包的方式打包;

步骤

1)、必须创建一个war项目;(利用idea创建好目录结构)

2)、将嵌入式的Tomcat指定为provided;

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-tomcat</artifactId>
  4. <scope>provided</scope>
  5. </dependency>

3)、必须编写一个SpringBootServletInitializer的子类,并调用configure方法

  1. public class ServletInitializer extends SpringBootServletInitializer {
  2. @Override
  3. protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
  4. //传入SpringBoot应用的主程序
  5. return application.sources(SpringBoot04WebJspApplication.class);
  6. }
  7. }

4)、启动服务器就可以使用;

原理

jar包:执行SpringBoot主类的main方法,启动ioc容器,创建嵌入式的Servlet容器;

war包:启动服务器,服务器启动SpringBoot应用【SpringBootServletInitializer】,启动ioc容器;

servlet3.0(Spring注解版):

8.2.4 Shared libraries / runtimes pluggability:

规则:

  1. 1)、服务器启动(web应用启动)会创建当前web应用里面每一个jar包里面ServletContainerInitializer实例:
  2. 2)、ServletContainerInitializer的实现放在jar包的META-INF/services文件夹下,有一个名为javax.servlet.ServletContainerInitializer的文件,内容就是ServletContainerInitializer的实现类的全类名
  3. 3)、还可以使用@HandlesTypes,在应用启动的时候加载我们感兴趣的类;

流程:

1)、启动Tomcat

2)、org\springframework\spring-web\4.3.14.RELEASE\spring-web-4.3.14.RELEASE.jar!\META-INF\services\javax.servlet.ServletContainerInitializer:

Spring的web模块里面有这个文件:org.springframework.web.SpringServletContainerInitializer

3)、SpringServletContainerInitializer将@HandlesTypes(WebApplicationInitializer.class)标注的所有这个类型的类都传入到onStartup方法的Set>;为这些WebApplicationInitializer类型的类创建实例;

4)、每一个WebApplicationInitializer都调用自己的onStartup;

Spring Boot - 图18

5)、相当于我们的SpringBootServletInitializer的类会被创建对象,并执行onStartup方法

6)、SpringBootServletInitializer实例执行onStartup的时候会createRootApplicationContext;创建容器

  1. protected WebApplicationContext createRootApplicationContext(
  2. ServletContext servletContext) {
  3. //1、创建SpringApplicationBuilder
  4. SpringApplicationBuilder builder = createSpringApplicationBuilder();
  5. StandardServletEnvironment environment = new StandardServletEnvironment();
  6. environment.initPropertySources(servletContext, null);
  7. builder.environment(environment);
  8. builder.main(getClass());
  9. ApplicationContext parent = getExistingRootWebApplicationContext(servletContext);
  10. if (parent != null) {
  11. this.logger.info("Root context already created (using as parent).");
  12. servletContext.setAttribute(
  13. WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, null);
  14. builder.initializers(new ParentContextApplicationContextInitializer(parent));
  15. }
  16. builder.initializers(
  17. new ServletContextApplicationContextInitializer(servletContext));
  18. builder.contextClass(AnnotationConfigEmbeddedWebApplicationContext.class);
  19. //调用configure方法,子类重写了这个方法,将SpringBoot的主程序类传入了进来
  20. builder = configure(builder);
  21. //使用builder创建一个Spring应用
  22. SpringApplication application = builder.build();
  23. if (application.getSources().isEmpty() && AnnotationUtils
  24. .findAnnotation(getClass(), Configuration.class) != null) {
  25. application.getSources().add(getClass());
  26. }
  27. Assert.state(!application.getSources().isEmpty(),
  28. "No SpringApplication sources have been defined. Either override the "
  29. + "configure method or add an @Configuration annotation");
  30. // Ensure error pages are registered
  31. if (this.registerErrorPageFilter) {
  32. application.getSources().add(ErrorPageFilterConfiguration.class);
  33. }
  34. //启动Spring应用
  35. return run(application);
  36. }

7)、Spring的应用就启动并且创建IOC容器

  1. public ConfigurableApplicationContext run(String... args) {
  2. StopWatch stopWatch = new StopWatch();
  3. stopWatch.start();
  4. ConfigurableApplicationContext context = null;
  5. FailureAnalyzers analyzers = null;
  6. configureHeadlessProperty();
  7. SpringApplicationRunListeners listeners = getRunListeners(args);
  8. listeners.starting();
  9. try {
  10. ApplicationArguments applicationArguments = new DefaultApplicationArguments(
  11. args);
  12. ConfigurableEnvironment environment = prepareEnvironment(listeners,
  13. applicationArguments);
  14. Banner printedBanner = printBanner(environment);
  15. context = createApplicationContext();
  16. analyzers = new FailureAnalyzers(context);
  17. prepareContext(context, environment, listeners, applicationArguments,
  18. printedBanner);
  19. //刷新IOC容器
  20. refreshContext(context);
  21. afterRefresh(context, applicationArguments);
  22. listeners.finished(context, null);
  23. stopWatch.stop();
  24. if (this.logStartupInfo) {
  25. new StartupInfoLogger(this.mainApplicationClass)
  26. .logStarted(getApplicationLog(), stopWatch);
  27. }
  28. return context;
  29. }
  30. catch (Throwable ex) {
  31. handleRunFailure(context, listeners, analyzers, ex);
  32. throw new IllegalStateException(ex);
  33. }
  34. }

启动Servlet容器,再启动SpringBoot应用

五、Docker

1、简介

Docker是一个开源的应用容器引擎;是一个轻量级容器技术;

Docker支持将软件编译成一个镜像;然后在镜像中各种软件做好配置,将镜像发布出去,其他使用者可以直接使用这个镜像;

运行中的这个镜像称为容器,容器启动是非常快速的。

Spring Boot - 图19

Spring Boot - 图20

2、核心概念

docker主机(Host):安装了Docker程序的机器(Docker直接安装在操作系统之上);

docker客户端(Client):连接docker主机进行操作;

docker仓库(Registry):用来保存各种打包好的软件镜像;

docker镜像(Images):软件打包好的镜像;放在docker仓库中;

docker容器(Container):镜像启动后的实例称为一个容器;容器是独立运行的一个或一组应用

Spring Boot - 图21

使用Docker的步骤:

1)、安装Docker

2)、去Docker仓库找到这个软件对应的镜像;

3)、使用Docker运行这个镜像,这个镜像就会生成一个Docker容器;

4)、对容器的启动停止就是对软件的启动停止;

3、安装Docker

1)、安装linux虚拟机

  1. 1)、VMWareVirtualBox(安装);
  2. 2)、导入虚拟机文件centos7-atguigu.ova
  3. 3)、双击启动linux虚拟机;使用 root/ 123456登陆
  4. 4)、使用客户端连接linux服务器进行命令操作;
  5. 5)、设置虚拟机网络;
  6. 桥接网络=选好网卡==接入网线;
  7. 6)、设置好网络以后使用命令重启虚拟机的网络
  1. service network restart
  1. 7)、查看linuxip地址
  1. ip addr
  1. 8)、使用客户端连接linux

2)、在linux虚拟机上安装docker

步骤:

  1. 1、检查内核版本,必须是3.10及以上
  2. uname -r
  3. 2、安装docker
  4. yum install docker
  5. 3、输入y确认安装
  6. 4、启动docker
  7. [root@localhost ~]# systemctl start docker
  8. [root@localhost ~]# docker -v
  9. Docker version 1.12.6, build 3e8e77d/1.12.6
  10. 5、开机启动docker
  11. [root@localhost ~]# systemctl enable docker
  12. Created symlink from /etc/systemd/system/multi-user.target.wants/docker.service to /usr/lib/systemd/system/docker.service.
  13. 6、停止docker
  14. systemctl stop docker

4、Docker常用命令&操作

1)、镜像操作

操作 命令 说明
检索 docker search 关键字 eg:docker search redis 我们经常去docker hub上检索镜像的详细信息,如镜像的TAG。
拉取 docker pull 镜像名:tag :tag是可选的,tag表示标签,多为软件的版本,默认是latest
列表 docker images 查看所有本地镜像
删除 docker rmi image-id 删除指定的本地镜像

https://hub.docker.com/

2)、容器操作

软件镜像(QQ安装程序)——运行镜像——产生一个容器(正在运行的软件,运行的QQ);

步骤:

  1. 1、搜索镜像
  2. [root@localhost ~]# docker search tomcat
  3. 2、拉取镜像
  4. [root@localhost ~]# docker pull tomcat
  5. 3、根据镜像启动容器
  6. docker run --name mytomcat -d tomcat:latest
  7. 4docker ps
  8. 查看运行中的容器
  9. 5 停止运行中的容器
  10. docker stop 容器的id
  11. 6、查看所有的容器
  12. docker ps -a
  13. 7、启动容器
  14. docker start 容器id
  15. 8、删除一个容器
  16. docker rm 容器id
  17. 9、启动一个做了端口映射的tomcat
  18. [root@localhost ~]# docker run -d -p 8888:8080 tomcat
  19. -d:后台运行
  20. -p: 将主机的端口映射到容器的一个端口 主机端口:容器内部的端口
  21. 10、为了演示简单关闭了linux的防火墙
  22. service firewalld status ;查看防火墙状态
  23. service firewalld stop:关闭防火墙
  24. 11、查看容器的日志
  25. docker logs container-name/container-id
  26. 更多命令参看
  27. https://docs.docker.com/engine/reference/commandline/docker/
  28. 可以参考每一个镜像的文档

3)、安装MySQL示例

  1. docker pull mysql

错误的启动

  1. [root@localhost ~]# docker run --name mysql01 -d mysql
  2. 42f09819908bb72dd99ae19e792e0a5d03c48638421fa64cce5f8ba0f40f5846
  3. mysql退出了
  4. [root@localhost ~]# docker ps -a
  5. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  6. 42f09819908b mysql "docker-entrypoint.sh" 34 seconds ago Exited (1) 33 seconds ago mysql01
  7. 538bde63e500 tomcat "catalina.sh run" About an hour ago Exited (143) About an hour ago compassionate_
  8. goldstine
  9. c4f1ac60b3fc tomcat "catalina.sh run" About an hour ago Exited (143) About an hour ago lonely_fermi
  10. 81ec743a5271 tomcat "catalina.sh run" About an hour ago Exited (143) About an hour ago sick_ramanujan
  11. //错误日志
  12. [root@localhost ~]# docker logs 42f09819908b
  13. error: database is uninitialized and password option is not specified
  14. You need to specify one of MYSQL_ROOT_PASSWORD, MYSQL_ALLOW_EMPTY_PASSWORD and MYSQL_RANDOM_ROOT_PASSWORD;这个三个参数必须指定一个

正确的启动

  1. [root@localhost ~]# docker run --name mysql01 -e MYSQL_ROOT_PASSWORD=123456 -d mysql
  2. b874c56bec49fb43024b3805ab51e9097da779f2f572c22c695305dedd684c5f
  3. [root@localhost ~]# docker ps
  4. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  5. b874c56bec49 mysql "docker-entrypoint.sh" 4 seconds ago Up 3 seconds 3306/tcp mysql01

做了端口映射

  1. [root@localhost ~]# docker run -p 3306:3306 --name mysql02 -e MYSQL_ROOT_PASSWORD=123456 -d mysql
  2. ad10e4bc5c6a0f61cbad43898de71d366117d120e39db651844c0e73863b9434
  3. [root@localhost ~]# docker ps
  4. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  5. ad10e4bc5c6a mysql "docker-entrypoint.sh" 4 seconds ago Up 2 seconds 0.0.0.0:3306->3306/tcp mysql02

几个其他的高级操作

  1. docker run --name mysql03 -v /conf/mysql:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
  2. 把主机的/conf/mysql文件夹挂载到 mysqldocker容器的/etc/mysql/conf.d文件夹里面
  3. mysql的配置文件就只需要把mysql配置文件放在自定义的文件夹下(/conf/mysql
  4. docker run --name some-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
  5. 指定mysql的一些配置参数

六、SpringBoot与数据访问

1、JDBC

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-jdbc</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>mysql</groupId>
  7. <artifactId>mysql-connector-java</artifactId>
  8. <scope>runtime</scope>
  9. </dependency>
  1. spring:
  2. datasource:
  3. username: root
  4. password: 123456
  5. url: jdbc:mysql://192.168.15.22:3306/jdbc
  6. driver-class-name: com.mysql.jdbc.Driver

效果:

  1. 默认是用org.apache.tomcat.jdbc.pool.DataSource作为数据源;
  2. 数据源的相关配置都在DataSourceProperties里面;

自动配置原理:

org.springframework.boot.autoconfigure.jdbc:

1、参考DataSourceConfiguration,根据配置创建数据源,默认使用Tomcat连接池;可以使用spring.datasource.type指定自定义的数据源类型;

2、SpringBoot默认可以支持;

  1. org.apache.tomcat.jdbc.pool.DataSourceHikariDataSourceBasicDataSource

3、自定义数据源类型

  1. /**
  2. * Generic DataSource configuration.
  3. */
  4. @ConditionalOnMissingBean(DataSource.class)
  5. @ConditionalOnProperty(name = "spring.datasource.type")
  6. static class Generic {
  7. @Bean
  8. public DataSource dataSource(DataSourceProperties properties) {
  9. //使用DataSourceBuilder创建数据源,利用反射创建响应type的数据源,并且绑定相关属性
  10. return properties.initializeDataSourceBuilder().build();
  11. }
  12. }

4、DataSourceInitializer:ApplicationListener

  1. 作用:
  2. 1)、runSchemaScripts();运行建表语句;
  3. 2)、runDataScripts();运行插入数据的sql语句;

默认只需要将文件命名为:

  1. schema-*.sqldata-*.sql
  2. 默认规则:schema.sqlschema-all.sql
  3. 可以使用
  4. schema:
  5. - classpath:department.sql
  6. 指定位置

5、操作数据库:自动配置了JdbcTemplate操作数据库

2、整合Druid数据源

  1. 导入druid数据源
  2. @Configuration
  3. public class DruidConfig {
  4. @ConfigurationProperties(prefix = "spring.datasource")
  5. @Bean
  6. public DataSource druid(){
  7. return new DruidDataSource();
  8. }
  9. //配置Druid的监控
  10. //1、配置一个管理后台的Servlet
  11. @Bean
  12. public ServletRegistrationBean statViewServlet(){
  13. ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
  14. Map<String,String> initParams = new HashMap<>();
  15. initParams.put("loginUsername","admin");
  16. initParams.put("loginPassword","123456");
  17. initParams.put("allow","");//默认就是允许所有访问
  18. initParams.put("deny","192.168.15.21");
  19. bean.setInitParameters(initParams);
  20. return bean;
  21. }
  22. //2、配置一个web监控的filter
  23. @Bean
  24. public FilterRegistrationBean webStatFilter(){
  25. FilterRegistrationBean bean = new FilterRegistrationBean();
  26. bean.setFilter(new WebStatFilter());
  27. Map<String,String> initParams = new HashMap<>();
  28. initParams.put("exclusions","*.js,*.css,/druid/*");
  29. bean.setInitParameters(initParams);
  30. bean.setUrlPatterns(Arrays.asList("/*"));
  31. return bean;
  32. }
  33. }

3、整合MyBatis

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

Spring Boot - 图22

步骤:

  1. 1)、配置数据源相关属性(见上一节Druid
  2. 2)、给数据库建表
  3. 3)、创建JavaBean

4)、注解版

  1. //指定这是一个操作数据库的mapper
  2. @Mapper
  3. public interface DepartmentMapper {
  4. @Select("select * from department where id=#{id}")
  5. public Department getDeptById(Integer id);
  6. @Delete("delete from department where id=#{id}")
  7. public int deleteDeptById(Integer id);
  8. @Options(useGeneratedKeys = true,keyProperty = "id")
  9. @Insert("insert into department(departmentName) values(#{departmentName})")
  10. public int insertDept(Department department);
  11. @Update("update department set departmentName=#{departmentName} where id=#{id}")
  12. public int updateDept(Department department);
  13. }

问题:

自定义MyBatis的配置规则;给容器中添加一个ConfigurationCustomizer;

  1. @org.springframework.context.annotation.Configuration
  2. public class MyBatisConfig {
  3. @Bean
  4. public ConfigurationCustomizer configurationCustomizer(){
  5. return new ConfigurationCustomizer(){
  6. @Override
  7. public void customize(Configuration configuration) {
  8. configuration.setMapUnderscoreToCamelCase(true);
  9. }
  10. };
  11. }
  12. }
  1. 使用MapperScan批量扫描所有的Mapper接口;
  2. @MapperScan(value = "com.atguigu.springboot.mapper")
  3. @SpringBootApplication
  4. public class SpringBoot06DataMybatisApplication {
  5. public static void main(String[] args) {
  6. SpringApplication.run(SpringBoot06DataMybatisApplication.class, args);
  7. }
  8. }

5)、配置文件版

  1. mybatis:
  2. config-location: classpath:mybatis/mybatis-config.xml 指定全局配置文件的位置
  3. mapper-locations: classpath:mybatis/mapper/*.xml 指定sql映射文件的位置

更多使用参照

http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/

4、整合SpringData JPA

1)、SpringData简介

Spring Boot - 图23

2)、整合SpringData JPA

JPA:ORM(Object Relational Mapping);

1)、编写一个实体类(bean)和数据表进行映射,并且配置好映射关系;

  1. //使用JPA注解配置映射关系
  2. @Entity //告诉JPA这是一个实体类(和数据表映射的类)
  3. @Table(name = "tbl_user") //@Table来指定和哪个数据表对应;如果省略默认表名就是user;
  4. public class User {
  5. @Id //这是一个主键
  6. @GeneratedValue(strategy = GenerationType.IDENTITY)//自增主键
  7. private Integer id;
  8. @Column(name = "last_name",length = 50) //这是和数据表对应的一个列
  9. private String lastName;
  10. @Column //省略默认列名就是属性名
  11. private String email;

2)、编写一个Dao接口来操作实体类对应的数据表(Repository)

  1. //继承JpaRepository来完成对数据库的操作
  2. public interface UserRepository extends JpaRepository<User,Integer> {
  3. }

3)、基本的配置JpaProperties

  1. spring:
  2. jpa:
  3. hibernate:
  4. # 更新或者创建数据表结构
  5. ddl-auto: update
  6. # 控制台显示SQL
  7. show-sql: true

七、启动配置原理

几个重要的事件回调机制

配置在META-INF/spring.factories

ApplicationContextInitializer

SpringApplicationRunListener

只需要放在ioc容器中

ApplicationRunner

CommandLineRunner

启动流程:

1、创建SpringApplication对象

  1. initialize(sources);
  2. private void initialize(Object[] sources) {
  3. //保存主配置类
  4. if (sources != null && sources.length > 0) {
  5. this.sources.addAll(Arrays.asList(sources));
  6. }
  7. //判断当前是否一个web应用
  8. this.webEnvironment = deduceWebEnvironment();
  9. //从类路径下找到META-INF/spring.factories配置的所有ApplicationContextInitializer;然后保存起来
  10. setInitializers((Collection) getSpringFactoriesInstances(
  11. ApplicationContextInitializer.class));
  12. //从类路径下找到ETA-INF/spring.factories配置的所有ApplicationListener
  13. setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
  14. //从多个配置类中找到有main方法的主配置类
  15. this.mainApplicationClass = deduceMainApplicationClass();
  16. }

Spring Boot - 图24

Spring Boot - 图25

2、运行run方法

  1. public ConfigurableApplicationContext run(String... args) {
  2. StopWatch stopWatch = new StopWatch();
  3. stopWatch.start();
  4. ConfigurableApplicationContext context = null;
  5. FailureAnalyzers analyzers = null;
  6. configureHeadlessProperty();
  7. //获取SpringApplicationRunListeners;从类路径下META-INF/spring.factories
  8. SpringApplicationRunListeners listeners = getRunListeners(args);
  9. //回调所有的获取SpringApplicationRunListener.starting()方法
  10. listeners.starting();
  11. try {
  12. //封装命令行参数
  13. ApplicationArguments applicationArguments = new DefaultApplicationArguments(
  14. args);
  15. //准备环境
  16. ConfigurableEnvironment environment = prepareEnvironment(listeners,
  17. applicationArguments);
  18. //创建环境完成后回调SpringApplicationRunListener.environmentPrepared();表示环境准备完成
  19. Banner printedBanner = printBanner(environment);
  20. //创建ApplicationContext;决定创建web的ioc还是普通的ioc
  21. context = createApplicationContext();
  22. analyzers = new FailureAnalyzers(context);
  23. //准备上下文环境;将environment保存到ioc中;而且applyInitializers();
  24. //applyInitializers():回调之前保存的所有的ApplicationContextInitializer的initialize方法
  25. //回调所有的SpringApplicationRunListener的contextPrepared();
  26. //
  27. prepareContext(context, environment, listeners, applicationArguments,
  28. printedBanner);
  29. //prepareContext运行完成以后回调所有的SpringApplicationRunListener的contextLoaded();
  30. //s刷新容器;ioc容器初始化(如果是web应用还会创建嵌入式的Tomcat);Spring注解版
  31. //扫描,创建,加载所有组件的地方;(配置类,组件,自动配置)
  32. refreshContext(context);
  33. //从ioc容器中获取所有的ApplicationRunner和CommandLineRunner进行回调
  34. //ApplicationRunner先回调,CommandLineRunner再回调
  35. afterRefresh(context, applicationArguments);
  36. //所有的SpringApplicationRunListener回调finished方法
  37. listeners.finished(context, null);
  38. stopWatch.stop();
  39. if (this.logStartupInfo) {
  40. new StartupInfoLogger(this.mainApplicationClass)
  41. .logStarted(getApplicationLog(), stopWatch);
  42. }
  43. //整个SpringBoot应用启动完成以后返回启动的ioc容器;
  44. return context;
  45. }
  46. catch (Throwable ex) {
  47. handleRunFailure(context, listeners, analyzers, ex);
  48. throw new IllegalStateException(ex);
  49. }
  50. }

3、事件监听机制

配置在META-INF/spring.factories

ApplicationContextInitializer

  1. public class HelloApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
  2. @Override
  3. public void initialize(ConfigurableApplicationContext applicationContext) {
  4. System.out.println("ApplicationContextInitializer...initialize..."+applicationContext);
  5. }
  6. }

SpringApplicationRunListener

  1. public class HelloSpringApplicationRunListener implements SpringApplicationRunListener {
  2. //必须有的构造器
  3. public HelloSpringApplicationRunListener(SpringApplication application, String[] args){
  4. }
  5. @Override
  6. public void starting() {
  7. System.out.println("SpringApplicationRunListener...starting...");
  8. }
  9. @Override
  10. public void environmentPrepared(ConfigurableEnvironment environment) {
  11. Object o = environment.getSystemProperties().get("os.name");
  12. System.out.println("SpringApplicationRunListener...environmentPrepared.."+o);
  13. }
  14. @Override
  15. public void contextPrepared(ConfigurableApplicationContext context) {
  16. System.out.println("SpringApplicationRunListener...contextPrepared...");
  17. }
  18. @Override
  19. public void contextLoaded(ConfigurableApplicationContext context) {
  20. System.out.println("SpringApplicationRunListener...contextLoaded...");
  21. }
  22. @Override
  23. public void finished(ConfigurableApplicationContext context, Throwable exception) {
  24. System.out.println("SpringApplicationRunListener...finished...");
  25. }
  26. }

配置(META-INF/spring.factories)

  1. org.springframework.context.ApplicationContextInitializer=\
  2. com.atguigu.springboot.listener.HelloApplicationContextInitializer
  3. org.springframework.boot.SpringApplicationRunListener=\
  4. com.atguigu.springboot.listener.HelloSpringApplicationRunListener

只需要放在ioc容器中

ApplicationRunner

  1. @Component
  2. public class HelloApplicationRunner implements ApplicationRunner {
  3. @Override
  4. public void run(ApplicationArguments args) throws Exception {
  5. System.out.println("ApplicationRunner...run....");
  6. }
  7. }

CommandLineRunner

  1. @Component
  2. public class HelloCommandLineRunner implements CommandLineRunner {
  3. @Override
  4. public void run(String... args) throws Exception {
  5. System.out.println("CommandLineRunner...run..."+ Arrays.asList(args));
  6. }
  7. }

八、自定义starter

starter:

  1. 1、这个场景需要使用到的依赖是什么?
  2. 2、如何编写自动配置
  1. @Configuration //指定这个类是一个配置类
  2. @ConditionalOnXXX //在指定条件成立的情况下自动配置类生效
  3. @AutoConfigureAfter //指定自动配置类的顺序
  4. @Bean //给容器中添加组件
  5. @ConfigurationPropertie结合相关xxxProperties类来绑定相关的配置
  6. @EnableConfigurationProperties //让xxxProperties生效加入到容器中
  7. 自动配置类要能加载
  8. 将需要启动就加载的自动配置类,配置在META-INF/spring.factories
  9. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  10. org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
  11. org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
  1. 3、模式:

启动器只用来做依赖导入;

专门来写一个自动配置模块;

启动器依赖自动配置;别人只需要引入启动器(starter)

mybatis-spring-boot-starter;自定义启动器名-spring-boot-starter

步骤:

1)、启动器模块

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <modelVersion>4.0.0</modelVersion>
  6. <groupId>com.atguigu.starter</groupId>
  7. <artifactId>atguigu-spring-boot-starter</artifactId>
  8. <version>1.0-SNAPSHOT</version>
  9. <!--启动器-->
  10. <dependencies>
  11. <!--引入自动配置模块-->
  12. <dependency>
  13. <groupId>com.atguigu.starter</groupId>
  14. <artifactId>atguigu-spring-boot-starter-autoconfigurer</artifactId>
  15. <version>0.0.1-SNAPSHOT</version>
  16. </dependency>
  17. </dependencies>
  18. </project>

2)、自动配置模块

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>com.atguigu.starter</groupId>
  6. <artifactId>atguigu-spring-boot-starter-autoconfigurer</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <packaging>jar</packaging>
  9. <name>atguigu-spring-boot-starter-autoconfigurer</name>
  10. <description>Demo project for Spring Boot</description>
  11. <parent>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-parent</artifactId>
  14. <version>1.5.10.RELEASE</version>
  15. <relativePath/> <!-- lookup parent from repository -->
  16. </parent>
  17. <properties>
  18. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  20. <java.version>1.8</java.version>
  21. </properties>
  22. <dependencies>
  23. <!--引入spring-boot-starter;所有starter的基本配置-->
  24. <dependency>
  25. <groupId>org.springframework.boot</groupId>
  26. <artifactId>spring-boot-starter</artifactId>
  27. </dependency>
  28. </dependencies>
  29. </project>
  1. package com.atguigu.starter;
  2. import org.springframework.boot.context.properties.ConfigurationProperties;
  3. @ConfigurationProperties(prefix = "atguigu.hello")
  4. public class HelloProperties {
  5. private String prefix;
  6. private String suffix;
  7. public String getPrefix() {
  8. return prefix;
  9. }
  10. public void setPrefix(String prefix) {
  11. this.prefix = prefix;
  12. }
  13. public String getSuffix() {
  14. return suffix;
  15. }
  16. public void setSuffix(String suffix) {
  17. this.suffix = suffix;
  18. }
  19. }
  1. package com.atguigu.starter;
  2. public class HelloService {
  3. HelloProperties helloProperties;
  4. public HelloProperties getHelloProperties() {
  5. return helloProperties;
  6. }
  7. public void setHelloProperties(HelloProperties helloProperties) {
  8. this.helloProperties = helloProperties;
  9. }
  10. public String sayHellAtguigu(String name){
  11. return helloProperties.getPrefix()+"-" +name + helloProperties.getSuffix();
  12. }
  13. }
  1. package com.atguigu.starter;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
  4. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  7. @Configuration
  8. @ConditionalOnWebApplication //web应用才生效
  9. @EnableConfigurationProperties(HelloProperties.class)
  10. public class HelloServiceAutoConfiguration {
  11. @Autowired
  12. HelloProperties helloProperties;
  13. @Bean
  14. public HelloService helloService(){
  15. HelloService service = new HelloService();
  16. service.setHelloProperties(helloProperties);
  17. return service;
  18. }
  19. }

更多SpringBoot整合示例

https://github.com/spring-projects/spring-boot/tree/master/spring-boot-samples