**一、**Spring Boot 入门
1.1、Spring Boot 简介
简化Spring应用开发的一个框架;
整个Spring技术栈的一个大整合;
J2EE开发的一站式解决方案;
1.2、微服务
2014,martin fowler
微服务:架构风格(服务微化)
一个应用应该是一组小型服务的组合;可以通过HTTP的方式进行互通;
- 单体应用:ALL IN ONE
- 微服务:每一个功能元素最终都是一个可独立替换和独立升级的软件单元;
1.3、MAVEN准备
http://www.gulixueyuan.com/ 谷粒学院
环境约束
–jdk1.8:Spring Boot 推荐jdk1.7及以上;java version “1.8.0_112”
–maven3.x:maven 3.3以上版本;Apache Maven 3.3.9
–IntelliJIDEA2017:IntelliJ IDEA 2017.2.2 x64、STS
–SpringBoot 1.5.9.RELEASE:1.5.9;
1.3.1、MAVEN设置;
给maven 的settings.xml配置文件的profiles标签添加(指定maven用jdk1.8运行项目)
<profile>
<id>jdk-1.8</id>
<activation>
<activeByDefault>true</activeByDefault>
<jdk>1.8</jdk>
</activation>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
</properties>
</profile>
1.3.2、IDEA设置
整合maven进来;打开IDEA的settings,选择Build Execution Deployment/Maven/下面的version版本选择对应的版本
1.4、HelloWorld
实现功能:浏览器发送hello请求,服务器接受请求并处理,响应Hello World字符串;
1.4.1、创建一个maven工程;(jar)
1.4.2、pom依赖
导入spring boot相关的依赖
Spring Boot的版本仲裁中心;
依赖管理
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.4.RELEASE</version>
</parent>
他的父项目
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.3.4.RELEASE</version>
</parent>
几乎声明了所有开发中常用的依赖的版本号,自动版本仲裁机制
以后我们导入依赖默认是不需要写版本;
默认里没有的依赖我们再自己去手动导入
1、引入依赖默认都可以不写版本
2、引入非版本仲裁的jar,要写版本号
• 可以修改默认版本号
1、查看spring-boot-dependencies里面规定当前依赖的版本 用的 key。
2、在当前项目里面重写配置
<properties>
<mysql.version>5.1.43</mysql.version>
</properties>
<!--
spring-boot-starter:spring-boot场景启动器;帮我们导入了web模块正常运行所依赖的组件;如tomcat、hibernate、spring-webmvc-jackson-databind、spring-web。
1、见到很多 spring-boot-starter-* : *就某种场景
2、只要引入starter,这个场景的所有常规需要的依赖我们都自动引入
3、SpringBoot所有支持的场景
https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-starter
4、见到的 *-spring-boot-starter: 第三方为我们提供的简化开发的场景启动器。
5、所有场景启动器最底层的依赖
Spring Boot将所有的功能场景都抽取出来,做成一个个的starters(启动器),只需要在项目里面引入这些starter相关场景的所有依赖都会导入进来。要用什么功能就导入什么场景的启动器
-->
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
maven-plugin打包
<!-- 在pom.xml中导入:这个插件,可以将应用打包成一个可执行的jar包;
将这个应用打成jar包,直接使用java -jar的命令进行执行;
点击 右侧maven Project/项目名/package,mvn -f 项目名 clean package
就生成了一个jar包。拿jdk运行就行
java -jar XXX.jar
-->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
1.4.3、配置类
启动Spring Boot应用
//@SpringBootApplication 来标注一个主程序类,说明这是一个Spring Boot应用
@SpringBootApplication
public class HelloWorldMainApplication {
public static void main(String[] args) {
// Spring应用启动起来
SpringApplication.run(HelloWorldMainApplication.class,args);
}
}
①热部署
在实际开发过程中,每次修改代码就得将项目重启,重新部署,对于一些大型应用来说,重启时间需要花费大量的时间成本。对于一个后端开发者来说,重启过程确实很难受啊。在 Java 开发领域,热部署一直是一个难以解决的问题,目前的 Java 虚拟机只能实现方法体的修改热部署,对于整个类的结构修改,仍然需要重启虚拟机,对类重新加载才能完成更新操作。下面我们就看看对于简单的类修改的热部署怎么实现。
<!--SpringBoot热部署配置 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
#"关闭缓存, 即时刷新"
#spring.freemarker.cache=false
#spring.thymeleaf.cache=true 如果开启此处会导致每次输入删除都会自动刷新哪怕你没保存
#热部署生效
spring.devtools.restart.enabled=true
#设置重启的目录,添加那个目录的文件需要restart
spring.devtools.restart.additional-paths=src/main/java
spring.devtools.restart.exclude=WEB-INF/**
- (1) devtools可以实现页面热部署(即页面修改后会立即生效,这个可以直接在application.properties文件中配置spring.thymeleaf.cache=false来实现),
实现类文件热部署(类文件修改后不会立即生效),实现对属性文件的热部署。
即devtools会监听classpath下的文件变动,并且会立即重启应用(发生在保存时机),注意:因为其采用的虚拟机机制,该项重启是很快的 - (2)配置了true后在修改java文件后也就支持了热启动,不过这种方式是属于项目重启(速度比较快的项目重启),会清空session中的值,也就是如果有用户登陆的话,项目重启后需要重新登陆。
默认情况下,/META-INF/maven,/META-INF/resources,/resources,/static,/templates,/public这些文件夹下的文件修改不会使应用重启,但是会重新加载(devtools内嵌了一个LiveReload server,当资源发生改变时,浏览器刷新)。
1 原理
深层原理是使用了两个ClassLoader,
- 一个Classloader加载那些不会改变的类(第三方Jar包),Base classloader
- 一个ClassLoader加载会更改的类,称为
restart ClassLoader
,
这样在有代码更改的时候,原来的restart ClassLoader
被丢弃,重新创建一个restart ClassLoader
,由于需要加载的类相比较少,所以实现了较快的重启时间。
Base classloader加载不变的,如引入的包,restart classloader重新加载我们的代码
所以并不是重启全部
2 devtools工具包
Pom: Spring boot devtools依赖
devtools会监听classpath下的文件变动,并且会立即重启应用(发生在保存时机),
这个意思是说得编译后才重启。Ctrl+F9
java类文件热部署(类文件修改后不会立即生效),实现对属性文件的热部署。
devtools可以实现页面热部署(页面修改后会立即生效,这个可以直接在application.properties文件中配置spring.thymeleaf.cache=false来实现,后面讲到)。
3 idea的工具设置
当我们修改了类文件后,idea不会自动编译,需要通过ctrl+F9来触发,
如果想要自动生效得修改idea设置,该功能按着个人的喜好来设置,修改类后,当我们窗口切换时候可以看到热部署的发生
(1)File-Settings-Compiler-Build Project automatically
(2)ctrl + shift + alt + /
,选择Registry,勾上 Compiler autoMake allow when app running
并不是没改一个字就重启,而是切换窗口才重启
4 热部署的排除
默认情况下,/META-INF/maven
,/META-INF/resources
,/resources
,/static
,/templates
,/public
这些文件夹下的文件修改不会使应用重启,但是会重新加载(devtools内嵌了一个LiveReload server,当资源发生改变时,浏览器刷新)。
\1. 我们在resources/static目录下创建tx.js文件每次发生修改后的并不重启,而是采用liveReload的方式。
\2. 同时我们可以根据自己的意愿来设置想要排除的资源
spring.devtools.restart.exclude=static/**,public/**
②configuration-processor
我们可以导入配置文件处理器,以后编写配置就有提示了
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
properites的编码问题:properties配置文件在idea中默认utf-8可能会乱码,而properties使用的是ASCII

③Lombok
简化JavaBean开发
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
idea中搜索安装lombok插件,安装
===============================简化JavaBean开发===================================
@NoArgsConstructor
//@AllArgsConstructor
@Data
@ToString
@EqualsAndHashCode
public class User {
private String name;
private Integer age;
private Pet pet;
public User(String name,Integer age){
this.name = name;
this.age = age;
}
}
================================简化日志开发===================================
@Slf4j
@RestController
public class HelloController {
@RequestMapping("/hello")
public String handle01(@RequestParam("name") String name){
log.info("请求进来了....");
return "Hello, Spring Boot 2!"+"你好:"+name;
}
}
1.4.4、Controller、Service
@Controller
public class HelloController {
@ResponseBody
@RequestMapping("/hello")
public String hello(){
return "Hello World!";
}
}
包扫描
不需要包扫描,由于springBoot默认包扫描机制是:从启动类所在包开始,扫描当前包及其子包下的所有文件。
也可以在@SpringBootApplication注解里面分配@SpringBootApplication(scanBasePackages="com")
访问localhost:8080/hello,显示的页面上显示hello world
1.6、Spring Initializer
IDE都支持使用Spring的项目创建向导快速创建一个Spring Boot项目;
在IDEA中New–Spring Initializer–输入Group和Artifact–下一步到Dependencies页面,先放入Core/web/SQL/NOSQL等,右侧为更具体的选项,选择我们需要的模块;向导会联网创建Spring Boot项目;
-
自动在pom.xml导入了parent、web、test、maven-plugin,
-
自动写好了配置类
@SpringBootApplication public class DemoApplication {
-
resources一些空文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
自动生成的Spring Boot项目:主程序已经生成好了,我们只需要我们自己的逻辑
resources文件夹中目录结构
- resources文件夹中目录结构
- static:保存所有的静态资源; js css images;
- templates:保存所有的模板页面;(Spring Boot默认jar包使用嵌入式的Tomcat,默认不支持JSP页面);可以使用模板引擎(freemarker、thymeleaf);
- application.properties:Spring Boot应用的配置文件;可以修改一些默认设置;比如把端口号改为8081:
server.port=8081
此外,@RestController==@Controller+@ResponseBody
注:同样也可以STS使用 Spring Starter Project快速创建项目,这里不再赘述
二、配置文件
2.1、初识yaml文件
配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;所以我们得按照一定的规范命名配置文件。
SpringBoot使用一个全局的配置文件,配置文件名是固定的:
- application.properties
- application.yml
配置文件放在src/main/resources目录或者类路径/config下
什么是YAML:
YAML(YAML Ain’t Markup Language)
- YAML A Markup Language:是一个标记语言
- YAML isn’t Markup Language:不是一个标记语言;
标记语言:
以前的配置文件;大多都使用的是 xxxx.xml文件;
YAML:以数据为中心,比json、xml等更适合做配置文件;
下面分别是YAML、XML、properties的配置方式,命名为application,系统就会默认调用
-
yaml方式
server: port: 8081
-
xml方式
<server> <port>8081</port> </server>
-
properties方式
server.port=8081
取值方法:
//在类上标注
@Component//只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
@ConfigurationProperties(prefix = "person")//表示这个类的属性是配置文件中的属性
//在类中使用
${person.name}
YAML语法:
1、基本语法
yaml语法由键值对组成;类似于python用空格表示层次关系,只要是左对齐的一列数据,都是同一个层级的
key:(空格)value:(空格必须有);
如
server:
port: 8081
path: /hello
- 使用缩进表示层级关系
- 缩进时不允许使用Tab键,只允许使用空格。
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
- 大小写敏感
- 键last-name相当于java中的lastName
2、yaml值的写法
2.1 普通值(数字,字符串,布尔)
语法:k:空格 v:字面直接来写
。字符串默认不用加上单引号或者双引号;
-
“”:双引号;会转义字符串里面的特殊字符;如
name: "zhangsan \n lisi"
,输出zhangsan 换行 lisi
-
’ ':单引号;不会转义特殊字符。如:
name: 'zhangsan \n lisi'
,输出zhangsan \n lisi
2.2 对象、Map:
k: v:在下一行来写对象的属性和值的关系;注意缩进
friends:
lastName: zhangsan
age: 20
行内写法:用{}
friends: {lastName: zhangsan,age: 18}
2.3 数组(List、Set):
用减号-
表示数组中的一个元素
行内写法: k: [v1,v2,v3]
pets:
- cat
- dog
- pig
yaml其他用法
1、随机数
RandomValuePropertySource:配置文件中可以使用随机数
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
2、属性配置占位符
– 可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
– ${app.name:默认值}来指定找不到属性时的默认值
在properties文件中写入下面内容,获取的时候就可以自动转换
person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15
自动提示看前面的
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
2.2、配置文件加载位置
默认加载位置:springboot 启动会扫描以下位置的application.properties
或者application.yml
文件作为Spring boot的默认配置文件
file:./config/
#代表项目路径下 # 最优先- file:./
classpath:/config/
classpath:/
(即src/main/resources)
优先级由高到底,高优先级的配置会覆盖低优先级的配置;但只会覆盖相同的配置,意思是如果配置不一样,那么会添加配置。(互补配置)
SpringBoot会从这四个位置全部加载主配置文件;互补配置;
-
自定义加载位置:我们还可以通过配置文件中的
spring.config.location
选项来改变默认的配置文件位置,用法是作为参数跟在命令行的后面,启动项目的时候来指定配置文件的新位置;同样,自定义的配置文件和默认加载的这些配置文件共同起作用形成互补配置。例:
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
这个方式可以用于我们打包后想临时更改配置时候使用
-
此外还自动加载下面这些地方的配置信息:
注意是配置,不是配置文件,比如之前我们设置的server.port
SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置
# 1. 命令行参数
所有的配置都可以在命令行上进行指定,多个配置用空格分开; --配置项=值。
例:`java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc`
# 2. 来自java:comp/env的JNDI属性
# 3. Java系统属性( System.getProperties())
# 4. 操作系统环境变量
# 5. RandomValuePropertySource配置的random.*属性值
==**由jar包外向jar包内进行寻找;**==
==**优先加载带profile**==
# 6. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
# 7. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
==**再来加载不带profile**==
# 8. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
# 9. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
# 10. @Configuration注解类上的@PropertySource
# 11. 通过SpringApplication.setDefaultProperties指定的默认属性
2.3 常用注解
@Configuration
- 基本使用
- Full模式与Lite模式
- 配置 类组件之间无依赖关系用Lite模式加速容器启动过程,减少判断
- 配置类组件之间有依赖关系,方法会被调用得到之前单实例组件,用Full模式
#############################Configuration使用示例######################################################
/**
* 1、配置类里面使用@Bean标注在方法上给容器注册组件,默认也是单实例的
* 2、配置类本身也是组件
* 3、proxyBeanMethods:代理bean的方法
* Full(proxyBeanMethods = true)、【保证每个@Bean方法被调用多少次返回的组件都是单实例的】
* Lite(proxyBeanMethods = false)【每个@Bean方法被调用多少次返回的组件都是新创建的】
* 组件依赖必须使用Full模式默认。其他默认是否Lite模式
*
*/
@Configuration(proxyBeanMethods = false) //告诉SpringBoot这是一个配置类 == 配置文件
public class MyConfig {
/**
* Full:外部无论对配置类中的这个组件注册方法调用多少次获取的都是之前注册容器中的单实例对象
* @return
*/
@Bean //给容器中添加组件。以方法名作为组件的id。返回类型就是组件类型。返回的值,就是组件在容器中的实例
public User user01(){
User zhangsan = new User("zhangsan", 18);
//user组件依赖了Pet组件
zhangsan.setPet(tomcatPet());
return zhangsan;
}
@Bean("tom")
public Pet tomcatPet(){
return new Pet("tomcat");
}
}
################################@Configuration测试代码如下########################################
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan("com.atguigu.boot")
public class MainApplication {
public static void main(String[] args) {
//1、返回我们IOC容器
ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
//2、查看容器里面的组件
String[] names = run.getBeanDefinitionNames();
for (String name : names) {
System.out.println(name);
}
//3、从容器中获取组件
Pet tom01 = run.getBean("tom", Pet.class);
Pet tom02 = run.getBean("tom", Pet.class);
System.out.println("组件:"+(tom01 == tom02));
//4、com.atguigu.boot.config.MyConfig$$EnhancerBySpringCGLIB$$51f1e1ca@1654a892
MyConfig bean = run.getBean(MyConfig.class);
System.out.println(bean);
//如果@Configuration(proxyBeanMethods = true)代理对象调用方法。SpringBoot总会检查这个组件是否在容器中有。
//保持组件单实例
User user = bean.user01();
User user1 = bean.user01();
System.out.println(user == user1);
User user01 = run.getBean("user01", User.class);
Pet tom = run.getBean("tom", Pet.class);
System.out.println("用户的宠物:"+(user01.getPet() == tom));
}
}
比如我们在yaml文件中写了如下内容,那么如何将他注入到bean中呢?
person:
lastName: hello
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhaoliu
dog:
name: 小狗
age: 12
答案是使用@ConfigurationProperties可以将yaml中的信息与bean属性绑定
@ConfigurationProperties
与松散绑定
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
@Component//只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;也可以取而代之使用Enablecp(class
@ConfigurationProperties(prefix = "person")//prefix指定要绑定yaml文件中哪些前缀的值//也可以注释掉后在成员上使用@Value(""),支持${}和#{SpEL}
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
松散绑定
Spring Boot使用一些宽松的规则将环境属性绑定到@ConfigurationProperties bean,因此环境属性名和bean属性名之间不需要完全匹配。
@Data
@Component
@ConfigurationProperties("acme.my-person.person")
public class Person {
private String firstName;
@Value("${person.last-name}")
private String lastName;
@Value("#{11*2}")
private Integer age;
@Value("true")
private Boolean boss;
}
acme:
my-person:
person:
first-name: 泰森
属性文件中配置 | 说明 |
---|---|
acme.my-project.person.first-name | 羊肉串模式case, 推荐使用 |
acme.myProject.person.firstName | 标准驼峰模式 |
acme.my_project.person.first_name | 下划线模式 |
ACME_MYPROJECT_PERSON_FIRSTNAME | 大写下划线,如果使用系统环境时候推荐使用 |
@Email等数据校验
内部类的检验不报错。需要在属性上加@Valid
检测数据是否符合格式的
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.0.Final</version>
</dependency>
@Data
@Component
@ConfigurationProperties("acme.my-person.person")
@Validated //spring提供的注解
public class OwnerProperties {
@NotNull //javax.validation.constraints提供
private String firstName;
@Max(35)
private int age;
@Email
private String email;
}
acme:
my-person:
person:
FIRST_name: 泰森
age: 34
email: aaa
Constraint | 详细信息 |
---|---|
@Null | 被注释的元素必须为 null |
@NotNull | 被注释的元素必须不为 null |
@AssertTrue | 被注释的元素必须为 true |
@AssertFalse | 被注释的元素必须为 false |
@Min(value) | 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 |
@Max(value) | 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 |
@DecimalMin(value) | 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 |
@DecimalMax(value) | 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 |
@Size(max, min) | 被注释的元素的大小必须在指定的范围内 |
@Digits (integer, fraction) | 被注释的元素必须是一个数字,其值必须在可接受的范围内 |
@Past | 被注释的元素必须是一个过去的日期 |
@Future | 被注释的元素必须是一个将来的日期 |
@Pattern(value) | 被注释的元素必须符合指定的正则表达式 |
校验:
每当使用Spring的@Validated
注释对@ConfigurationProperties
类进行注释时,Spring Boot就会尝试验证它们。你可以用JSR-303 javax.validation直接在配置类上的约束注释。为此,请确保类路径上有一个兼容的JSR-303实现,此处我们用的是hibernate的实现,然后将约束注释添加到字段中
@EnableConfigurationProperties
等价于@Component + @ConfigurationProperties
要使用构造器绑定的话
@ConfigurationProperties("acme")
@ConstructorBinding
public class AcmeProperties {
public AcmeProperties(boolean enabled, InetAddress remoteAddress, Security security) {
this.enabled = enabled;
this.remoteAddress = remoteAddress;
}
}
要使用构造函数绑定,必须使用@EnableConfigurationProperties或配置属性扫描启用类。
不能对由常规Spring机制创建的Bean使用构造函数绑定(例如@Component Bean、通过@Bean方法创建的Bean或使用@Import加载的Bean)
@RestController
@EnableConfigurationProperties(AcmeProperties.class)
public class YamlController {
@Autowired
private AcmeProperties acmeProperties;
@PropertySource
上面的yaml是系统指定路径下的文件才能扫描到,如果我们想自定义配置文件,可以使用**@PropertySource**注解通知springboot扫描
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
// @Email //lastName必须是邮箱格式
//@Value("${person.last-name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
@ImportResource
也可以使用@Import(XXXConfiguration.class)代替我们原来的xml
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上
@ImportResource(locations = {"classpath:beans.xml"})//导入Spring的配置文件让其生效
@SpringBootApplication
public class SpringBoot02ConfigApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBoot02ConfigApplication.class, args);
}
}
但是springboot推荐不编写Spring的配置xml文件。SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式
1、配置类**@Configuration**------>Spring配置文件
2、使用**@Bean**给容器中添加组件,@Bean的作用:将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
package com.atguigu.springboot.config;
/**
* @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置xml文件
* 以前在配置文件中用<bean><bean/>标签添加组件,现在我们使用@Bean
*/
@Configuration
public class MyAppConfig {
//@Bean的作用:将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
@Bean
public HelloService helloService02(){
System.out.println("配置类@Bean给容器中添加组件了...");
return new HelloService();
}
}
@Value
获取配置文件中的值:配置文件yml还是properties他们都能获取到值;
注释掉类上的@ConfigurationProperties可以在变量上使用@Value代替
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
松散绑定(松散语法) | 支持 | 不支持受限驼峰可以原样。注解里必须-,配置文件-大写也可以 |
SpEL | 不支持 | 支持 |
JSR303数据校验(如@Email) | 支持 | 不支持,不报错但无效 |
复杂类型封装 | 支持 | 不支持 |
适应场景 | 如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties; | 如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value; |
什么是松散语法:在配置文件中大写用-,小写用_
元数据,提示,生成json文件,c f9。value没有提示。
提示的pom spring boot configure processor
属性名匹配规则( Relaxed binding)
– person.firstName:使用标准方式
– person.first-name:大写用-
– person.first_name:大写用_
– PERSON_FIRST_NAME:
@Conditional
作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
@Conditional扩展注解 | 作用(判断是否满足当前指定条件) |
---|---|
@ConditionalOnJava | 系统的java版本是否符合要求 |
@ConditionalOnBean | 容器中存在指定Bean; |
@ConditionalOnMissingBean | 容器中不存在指定Bean; |
@ConditionalOnExpression | 满足SpEL表达式指定 |
@ConditionalOnClass | 系统中有指定的类。他的注解上有@Conditional(OnClassCondition.class) 类里有match() 这个方法 |
@ConditionalOnMissingClass | 系统中没有指定的类 |
@ConditionalOnSingleCandidate | 容器中只有一个指定的Bean,或者这个Bean是首选Bean |
@ConditionalOnProperty | 系统中指定的属性是否有指定的值 |
@ConditionalOnResource | 类路径下是否存在指定资源文件 |
@ConditionalOnWebApplication | 当前是web环境 |
@ConditionalOnNotWebApplication | 当前不是web环境 |
@ConditionalOnJndi | JNDI存在指定项 |
自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
debug=true
我们可以通过在配置文件中启用 debug=true属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置类生效;
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:#(自动配置类启用的)
-----------------
DispatcherServletAutoConfiguration matched:
- @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
- @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
Negative matches:#(没有启动,没有匹配成功的自动配置类)
----------------
ActiveMQAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
AopAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)
2.4、Profile多环境
Profile是Spring对不同环境提供不同配置功能的支持,可以通过激活、指定参数等方式快速切换环境 ,如开发环境、生产环境
可以使用下面3种方法配置多种环境
- 多properties文件
- yaml中指定
- 命令行参数
1、多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
- application.properties(默认)
- application-dev.properties、
- application-prod.properties
2、yml支持多文档块方式
server:
port: 8081
spring:
profiles:
active: prod # 激活了下面的prod生产环境
---
server:
port: 8083
spring:
profiles: dev
---
server:
port: 8084
spring:
profiles: prod #指定属于哪个环境
三个横线是固定写法,分隔document模块
3、激活指定profile
1、配置文件中指定 spring.profiles.active=dev
2、命令行:--spring.profiles.active=dev
例:java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
在IDEA中指定Program arguments中添加和在cmd的后面添加是一样的。
3、虚拟机参数;-Dspring.profiles.active=dev
VM options
在启动的时候我们通过spring.profiles.active: development来指定开启哪个profile
我们也可以采用多个文件来做。
我们创建application-dev.yml, application-pro.yml
application-{profile}.xml
三、日志
可以直接把logback.xml放在根目录下,也可以在application.properties中用Logging.config=指定
3.1、日志框架
常见日志框架:JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…
日志门面(日志的抽象层)(我们调用的) | 日志实现 |
---|---|
Log4j JUL(java.util.logging) Log4j2 Logback |
左边选一个门面(抽象层)、右边来选一个实现;
SpringBoot:底层是Spring框架,Spring框架默认是用JCL;
SpringBoot选用 SLF4j和logback;
读作self four j
spring用的是commons logging
3.2、SLF4j使用
3.2.1、如何在系统中使用SLF4
https://www.slf4j.org
以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;调用抽象层的方法就会自动调用是实现类的方法
先给系统里面导入slf4j的jar和 logback的实现jar
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);//创建一个记录器
logger.info("Hello World");
}
}
下图
- 第一列因为没有实现层所以没有用
- 第二列是我们正常的用法
- 第三列因为我们要用log4j,但是log4j出现的比较早,所以需要一个适配层,来进行过渡调用
每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是做成日志实现框架自己本身的配置文件;
3.2.2、遗留问题
如果使用了多个框架,而且每个框架里也有日志功能,我们得统一
a(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx
统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?删除原jar包,替换
如何让系统中所有的日志都统一到slf4j;
1、将系统中其他日志框架先排除出去;
2、用中间包来替换原有的日志框架;
3、我们导入slf4j其他的实现
3.3、SpringBoot日志关系
SpringBoot使用它来做日志功能;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
底层依赖关系
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9YeGMVKa-1613986827278)(images/搜狗截图20180131220946.png)]
总结:
1)、SpringBoot底层也是使用slf4j+logback的方式进行日志记录。spring使用的是jakarta comming logging(JCL)
2)、SpringBoot也把其他的日志都替换成了slf4j;
3)、中间替换包?
@SuppressWarnings("rawtypes")
public abstract class LogFactory {
static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
static LogFactory logFactory = new SLF4JLogFactory();
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-8HjN28pB-1613986827281)(images/搜狗截图20180131221411.png)]
4)、如果我们要引入其他框架,一定要把这个框架的默认日志依赖移除掉
SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;
比如Spring框架用的是commons-logging;
在默认导入的starter/core中有如下的内容
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
4、日志使用;
1、默认配置
SpringBoot默认帮我们配置好了日志;(启动容器的时候有输出)
package com.atguigu.springboot;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot03LoggingApplicationTests {
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//日志的级别;由低到高 trace<debug<info<warn<error 级别代表从此位置往右都输出
//可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
//在application.properties中配置级别logging.level.包=级别
logger.trace("这是trace日志...");//默认不输出
logger.debug("这是debug日志...");//默认不输出
logger.info("这是info日志...");//SpringBoot默认给我们使用的是info级别的,前面的不输出,没有指定级别的就用SpringBoot默认规定的级别;root级别
logger.warn("这是warn日志...");
logger.error("这是error日志...");
}
}
SpringBoot修改日志的默认配置
不指定的话,日志只在控制台输出
logging.file | logging.path | Example | 结果 |
---|---|---|---|
不指定 | 不指定 | 只在控制台输出 | |
指定文件名 | 不指定 | my.log | 输出日志到my.log文件 |
不指定 | 指定目录 | /var/log | 输出到指定目录的 spring.log 文件中 |
logging.level.com.atguigu=trace
#logging.path=
# 默认为当前项目下
# 可以指定完整的路径;
#logging.file=G:/springboot.log
#logging.file和path是两个冲突设置
# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹;使用 spring.log 作为默认文件#/代表是的盘符,不是项目路径
logging.path=/spring/log
# 在控制台输出的日志的格式 #5代表向左对齐#{}代表只取50个字节
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
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 |
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml
,而不是logback.xml
),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项。如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:
logback.xml:直接就被日志框架识别了;
logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能
<springProfile name="staging">
<!-- configuration to be enabled when the "staging" profile is active -->
可以指定某段配置只在某个环境下生效
</springProfile>
如:
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误
no applicable action for [springProfile]
5、切换日志框架
可以按照slf4j的日志适配图,进行相关的切换;
slf4j+log4j的方式;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>logback-classic</artifactId>
<groupId>ch.qos.logback</groupId>
</exclusion>
<exclusion>
<artifactId>log4j-over-slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</dependency>
切换为log4j2
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<!--排除-->
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
7、错误处理机制
1)、SpringBoot默认的错误处理机制
默认效果:
1)、浏览器,返回一个默认的错误页面
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-6kr46gzk-1613986827283)(images/搜狗截图20180226173408.png)]
浏览器发送请求的请求头:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tugBEtBb-1613986827284)(images/搜狗截图20180226180347.png)]
2)、如果是其他客户端,默认响应一个json数据
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-c48d8e6H-1613986827287)(images/搜狗截图20180226173527.png)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hWLO6xxF-1613986827288)(images/搜狗截图20180226180504.png)]
原理:
可以参照ErrorMvcAutoConfiguration;错误处理的自动配置;
给容器中添加了以下组件
1、DefaultErrorAttributes:
帮我们在页面共享信息;
@Override
public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
boolean includeStackTrace) {
Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
errorAttributes.put("timestamp", new Date());
addStatus(errorAttributes, requestAttributes);
addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
addPath(errorAttributes, requestAttributes);
return errorAttributes;
}
2、BasicErrorController:处理默认/error请求
@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
@RequestMapping(produces = "text/html")//产生html类型的数据;浏览器发送的请求来到这个方法处理
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {
HttpStatus status = getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
//去哪个页面作为错误页面;包含页面地址和页面内容
ModelAndView modelAndView = resolveErrorView(request, response, status, model);
return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
}
@RequestMapping
@ResponseBody //产生json数据,其他客户端来到这个方法处理;
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
Map<String, Object> body = getErrorAttributes(request,
isIncludeStackTrace(request, MediaType.ALL));
HttpStatus status = getStatus(request);
return new ResponseEntity<Map<String, Object>>(body, status);
}
3、ErrorPageCustomizer:
@Value("${error.path:/error}")
private String path = "/error"; 系统出现错误以后来到error请求进行处理;(web.xml注册的错误页面规则)
4、DefaultErrorViewResolver:
@Override
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
Map<String, Object> model) {
ModelAndView modelAndView = resolve(String.valueOf(status), model);
if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
}
return modelAndView;
}
private ModelAndView resolve(String viewName, Map<String, Object> model) {
//默认SpringBoot可以去找到一个页面? error/404
String errorViewName = "error/" + viewName;
//模板引擎可以解析这个页面地址就用模板引擎解析
TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
.getProvider(errorViewName, this.applicationContext);
if (provider != null) {
//模板引擎可用的情况下返回到errorViewName指定的视图地址
return new ModelAndView(errorViewName, model);
}
//模板引擎不可用,就在静态资源文件夹下找errorViewName对应的页面 error/404.html
return resolveResource(errorViewName, model);
}
步骤:
一但系统出现4xx或者5xx之类的错误;ErrorPageCustomizer就会生效(定制错误的响应规则);就会来到/error请求;就会被BasicErrorController处理;
1)响应页面;去哪个页面是由DefaultErrorViewResolver解析得到的;
protected ModelAndView resolveErrorView(HttpServletRequest request,
HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
//所有的ErrorViewResolver得到ModelAndView
for (ErrorViewResolver resolver : this.errorViewResolvers) {
ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
if (modelAndView != null) {
return modelAndView;
}
}
return null;
}
2)、如果定制错误响应:
1)、如何定制错误的页面;
1)、有模板引擎的情况下;error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】,发生此状态码的错误就会来到 对应的页面;
我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误,精确优先(优先寻找精确的状态码.html);
页面能获取的信息;
timestamp:时间戳
status:状态码
error:错误提示
exception:异常对象
message:异常消息
errors:JSR303数据校验的错误都在这里
2)、没有模板引擎(模板引擎找不到这个错误页面),静态资源文件夹下找;
3)、以上都没有错误页面,就是默认来到SpringBoot默认的错误提示页面;
2)、如何定制错误的json数据;
1)、自定义异常处理&返回定制json数据;
@ControllerAdvice
public class MyExceptionHandler {
@ResponseBody
@ExceptionHandler(UserNotExistException.class)
public Map<String,Object> handleException(Exception e){
Map<String,Object> map = new HashMap<>();
map.put("code","user.notexist");
map.put("message",e.getMessage());
return map;
}
}
//没有自适应效果...
2)、转发到/error进行自适应响应效果处理
@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
Map<String,Object> map = new HashMap<>();
//传入我们自己的错误状态码 4xx 5xx,否则就不会进入定制错误页面的解析流程
/**
* Integer statusCode = (Integer) request
.getAttribute("javax.servlet.error.status_code");
*/
request.setAttribute("javax.servlet.error.status_code",500);
map.put("code","user.notexist");
map.put("message",e.getMessage());
//转发到/error
return "forward:/error";
}
3)、将我们的定制数据携带出去;
出现错误以后,会来到/error请求,会被BasicErrorController处理,响应出去可以获取的数据是由getErrorAttributes得到的(是AbstractErrorController(ErrorController)规定的方法);
1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】,放在容器中;
2、页面上能用的数据,或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到;
容器中DefaultErrorAttributes.getErrorAttributes();默认进行数据处理的;
自定义ErrorAttributes
//给容器中加入我们自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
map.put("company","atguigu");
return map;
}
}
最终的效果:响应是自适应的,可以通过定制ErrorAttributes改变需要返回的内容,
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-aMCUuAf5-1613986827289)(images/搜狗截图20180228135513.png)]