spring-boot教学笔记（一）入门知识

=笔记出自尚硅谷视频=

一 快速入门

1 Spring Boot 简介

简化Spring应用开发的一个框架；
整个Spring技术栈的一个大整合；
J2EE开发的一站式解决方案；

2 微服务

2014，martin fowler

微服务：架构风格（服务微化）

一个应用应该是一组小型服务；可以通过HTTP的方式进行互通；

单体应用：ALL IN ONE

微服务：每一个功能元素最终都是一个可独立替换和独立升级的软件单元；

3 搭建springboot项目

1. 创建一个maven工程
2. 导入spring boot相关的依赖

       org.springframework.boot
       spring-boot-starter-parent
       1.5.9.RELEASE
   
   
       
           org.springframework.boot
           spring-boot-starter-web
       
   

3. 编写一个主程序；启动Spring Boot应用

/**
 *  @SpringBootApplication 来标注一个主程序类，说明这是一个Spring Boot应用
 */
@SpringBootApplication
public class HelloWorldMainApplication {
     

    public static void main(String[] args) {
     

        // Spring应用启动起来
        SpringApplication.run(HelloWorldMainApplication.class,args);
    }
}

4. 编写相关的Controller、Service（放在SpringBootApplicaiton的子包下，不能放在同一级包）

@Controller
public class HelloController {
     

    @ResponseBody
    @RequestMapping("/hello")
    public String hello(){
     
        return "Hello World!";
    }
}

5. 运行主程序测试
6. 简化部署

 
    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

4、使用Spring Initializer快速创建Spring Boot项目

IDEA支持使用Spring的项目创建向导快速创建一个Spring Boot项目；
选择我们需要的模块；向导会联网创建Spring Boot项目；
默认生成的Spring Boot项目；

主程序已经生成好了，我们只需要我们自己的逻辑
——resources文件夹中目录结构
————static：保存所有的静态资源； js css images；
————templates：保存所有的模板页面；（Spring Boot默认jar包使用嵌入式的Tomcat，默认不支持JSP页面）；可以使用模板引擎（freemarker、thymeleaf）；
————application.properties：Spring Boot应用的配置文件；可以修改一些默认设置；

二 配置文件

1 配置文件

1. SpringBoot使用一个全局的配置文件，配置文件名是固定的：

• application.properties

• application.yml

2. 配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好

2 yaml语法

1. k:(空格)v：表示一对键值对（空格必须有）

2. 以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

3. 属性和值也是大小写敏感

server:
    port: 8081

4. 值的写法
   字面量：普通的值（数字，字符串，布尔）
   ​ k: v：字面直接来写；

​ 字符串默认不用加上单引号或者双引号；

​ “”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

​ name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

​ ‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

​ name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

对象、Map（属性和值）（键值对）：
​ k: v：在下一行来写对象的属性和值的关系；注意缩进

​ 对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

或者

friends: {
     lastName: zhangsan,age: 18}

数组（List、Set）：
用- 值表示数组中的一个元素

pets:
 - cat
 - dog
 - pig

或

pets: [cat,dog,pig]

3 配置文件注入

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {
     k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

javaBean：

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
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;

已导入配置文件处理器，以后编写配置就有提示了

		
			org.springframework.boot
			spring-boot-configuration-processor
			true
		

4 properties配置文件在idea中编码乱码

Settings–>File Encodings-UTF-8–>Transparent …

5 @Value获取值和@ConfigurationProperties获取值比较

功能	@ConfigurationProperties	@Value
松散绑定(松散语法)	批量注入配置文件中的属性	一个个指定
–	–	–
SpEL	支持	不支持
–	–	–
JSR303数据校验	不支持	支持
–	–	–
复杂类型封装	支持	不支持

1. 只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；
2. 专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties

6 配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated//数据校验
public class Person {
     

    /**
     * 
     *      
     * 
     */

   //lastName必须是邮箱格式
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

7 @PropertySource @ImportResource @Bean

@PropertySource：加载指定的配置文件；

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {
     "classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
     

    /**
     * 
     *      
     * 
     */

   //lastName必须是邮箱格式
   // @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来；将@ImportResource标注在一个配置类上

@ImportResource(locations = {
     "classpath:beans.xml"})

导入Spring的配置文件让其生效
方式一：配置配置文件

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">


    <bean id="helloService" class="com.atguigu.springboot.service.HelloService">bean>
beans>

方式二：全注解
SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1. 配置类**@Configuration**------>Spring配置文件

2. 使用**@Bean**给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 * 在配置文件中用标签添加组件
 *
 */
@Configuration
public class MyAppConfig {
     

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
     
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

8 配置文件占位符

（1）随机数

${
     random.value}、${
     random.int}、${
     random.long}
${
     random.int(10)}、${
     random.int[1024,65536]}

（2）占位符获取之前配置的值，如果没有可以是用:指定默认值

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

9 profile

（1）多profile文件
我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml

默认使用application.properties的配置；
（2）yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: dev


---

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

（3）激活profile
①在配置文件中指定 spring.profiles.active=dev
②命令行：
​ java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；
③虚拟机参数；

10 配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

–file:./config/

–file:./

–classpath:/config/

–classpath:/

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

SpringBoot会从这四个位置全部加载主配置文件；互补配置；
​ -Dspring.

11 自动配置原理

1. SpringBoot启动的时候加载主配置类@SpringBootApplication，开启了自动配置功能 @EnableAutoConfiguration

2. @EnableAutoConfiguration 作用：利用EnableAutoConfigurationImportSelector给容器中导入一些组件
   将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；
   每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置

3. 每一个自动配置类进行自动配置功能

4. 例子

@Configuration   //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class)  //启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；    判断当前应用是否是web应用，如果是，当前配置类生效

@ConditionalOnClass(CharacterEncodingFilter.class)  //判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)  //判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
public class HttpEncodingAutoConfiguration {
     
  
  	//他已经和SpringBoot的配置文件映射了
  	private final HttpEncodingProperties properties;
  
   //只有一个有参构造器的情况下，参数的值就会从容器中拿
  	public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
     
		this.properties = properties;
	}
  
    @Bean   //给容器中添加一个组件，这个组件的某些值需要从properties中获取
	@ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件？
	public CharacterEncodingFilter characterEncodingFilter() {
     
		CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
		filter.setEncoding(this.properties.getCharset().name());
		filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
		filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
		return filter;
	}

根据当前不同的条件判断，决定这个配置类是否生效？

一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

5. 所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘；配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {
     

   public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

精髓：
​ 1） SpringBoot启动会加载大量的自动配置类
​ 2） 我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；
​ 3） 我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）
​ 4） 给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值；
xxxxAutoConfigurartion：自动配置类；给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

@Conditional派生注解
作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@ConditionalOnJava 系统的java版本是否符合要求
@ConditionalOnBean 容器中存在指定Bean；
@ConditionalOnMissingBean 容器中不存在指定Bean；
@ConditionalOnExpression 满足SpEL表达式指定
@ConditionalOnClass 系统中有指定的类
@ConditionalOnMissingClass 系统中没有指定的类
@ConditionalOnSingleCandidate 容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty 系统中指定的属性是否有指定的值
@ConditionalOnResource 类路径下是否存在指定资源文件
@ConditionalOnWebApplication 当前是web环境
@ConditionalOnNotWebApplication 当前不是web环境
@ConditionalOnJndi JNDI存在指定项

自动配置类必须在一定的条件下才能生效；
通过启用 debug=true属性；来让控制台打印自动配置报告，就可以很方便的知道哪些自动配置类生效；

三 日志

1 历史背景

开发一个大型系统；

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

2 市面上的日志框架

日志门面 （日志的抽象层）	日志实现
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；‘

​ SpringBoot选用 SLF4j和logback；

3 SLF4j使用

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

给系统里面导入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");
  }
}

4 遗留问题

项目中依赖的框架可能使用不同的日志：

Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx

当项目是使用多种日志API时，可以统一适配到SLF4J，中间使用SLF4J或者第三方提供的日志适配器适配到SLF4J，SLF4J在底层用开发者想用的一个日志框架来进行日志系统的实现，从而达到了多种日志的统一实现。

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

• 将系统中其他日志框架先排除出去；
• 用中间包来替换原有的日志框架（适配器的类名和包名与替换的被日志框架一致）；
• 导入slf4j其他的实现
  SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

6 日志使用

1. 日志输出格式：
   %d表示日期时间，
   %thread表示线程名，
   %-5level：级别从左显示5个字符宽度
   %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
   %msg：日志消息，
   %n是换行符

   %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

2. SpringBoot修改日志的默认配置

也可以指定一个包路径 logging.level.com.xxx=error
logging.level.root=error

#logging.path=
不指定路径在当前项目下生成springboot.log日志
可以指定完整的路径；
#logging.file=G:/springboot.log

在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.path=/spring/log

在控制台输出的日志的格式
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

3. 指定配置
   给类路径下放上每个日志框架自己的配置文件即可；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功能

<springProfile name="staging">
    
      可以指定某段配置只在某个环境下生效
springProfile>