SpringBoot(一)——注解配置

2023-10-31

文章目录

一、简介

1、概述

SpringBoot是Spring一个全新的框架，用来简化Spring应用程序的创建和开发，简化了ssm框架开发的过程。
使用SpringBoot之后，可以说是抛弃了繁琐的xml文件配置过程，采用大量默认配置来简化开发过程。
采用了SpringBoot可以非常容易和快速的创建基于Spring框架的应用程序，让各方面的配置变得更加简单。

2、特性

能够快速创建基于Spring的应用程序
能够直接使用java main方法启动内嵌的Tomcat，Jetty服务器运行SpringBoot程序，不需要部署war包文件
提供约定的starter POM简化了Maven的配置，使Maven的配置变得更简单
根据项目的Maven依赖配置，SpringBoot自动配置Spring，SpringMVC
提供了程序的健康检查等功能
基本可以实现完全不使用xml来配置文件，采用注解配置

3、四大核心

自动配置：针对很多应用程序和常见的应用功能，SpringBoot能自动提供相关配置
起步依赖：告知SpringBoot需要什么功能就可以自动引入所需要的依赖库
Actuator：可以深入运行SpringBoot，探查内部信息
命令行界面：可选择性

二、搭建环境

在这里插入图片描述

等待下载完成即可

三、入门小程序–HelloWorld

创建一个springboot应用类，也就是像我们mvc的index.jsp一样的那个启动类，起名叫HelloWorldMainApplication
用@SpringBootApplication标注、说明这是一个SpringBoot应用类，然后再创建一个Controller的class，和SpringBoot应用类连接上，即可完成。
在这里插入图片描述

@SpringBootApplication
public class HelloWorldMainApplication {

    public static void main(String[] args) {

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

@Controller
public class HelloController {

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

@SpringBootApplication: SpringBoot应用标注在某个类上说明这个类是SpringBoot的主配置类，SpringBoot就应该运行这个类的main方法来启动SpringBoot应用；

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
      @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

@SpringBootConfiguration:Spring Boot的配置类；

标注在某个类上，表示这是一个Spring Boot的配置类；
@Configuration:配置类上来标注这个注解；
配置类 ----- 配置文件；配置类也是容器中的一个组件；@Component
@EnableAutoConfiguration：开启自动配置功能；
以前我们需要配置的东西，Spring Boot帮我们自动配置；@EnableAutoConfiguration告诉SpringBoot开启自动配置功能；这样自动配置才能生效；

@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

@AutoConfigurationPackage：自动配置包
@Import(AutoConfigurationPackages.Registrar.class)：
Spring的底层注解@Import，将主配置类（@SpringBootApplication标注的类）的所在包及下面所有子包里面的所有组件扫描到Spring容器
EnableAutoConfigurationImportSelector：导入哪些组件的选择器；
将所有需要导入的组件以全类名的方式返回；这些组件就会被添加到容器中；
会给容器中导入非常多的自动配置类（xxxAutoConfiguration）；就是给容器中导入这个场景需要的所有组件，并配置好这些组件；

四、配置文件

1、YML文件

之前我们使用.properties文件来配置我们需要的功能，我们也可以使用.yml方式来配置
在resources文件下创建一个application.yml，在里面编写即可。

server:
  port: 8081

2、YML语法

<1>、基本语法

k:(空格)v：表示一对键值对（空格必须有）；
以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的，并且属性和值也是大小写敏感。

<2>、值的写法

(1)、字面量(数字、字符串、布尔)

k: v：字面直接来写；
字符串默认不用加上单引号或者双引号；
“”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思
name: “lisi \n wangwu”：输出；lisi 换行 wangwu
‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据
name: ‘lisi \n wangwu’：输出；lisi \n wangwu

(2)、对象、Map

k: v:在下一行来写对象的属性和值的关系；注意缩进
对象还是k: v方式

friends:
		lastName: wangwu
		age: 40

行内写法：

friends: {lastName: wangwu,age: 40}

(3)、数组(List, Set)

用- 值来表示数组中的一个元素

pets:
 - cat
 - dog
 - elephant

行内写法：

pets: [cat,dog,pig]

(4)、简单实现、基于以上的语法

首先编写一个主类Person，写几个私有属性，并且补上get、set方法

package com.example.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

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

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @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> map;
    private List<Object> list;
    private Dog dog;

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public boolean isBoss() {
        return boss;
    }

    public void setBoss(boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMap() {
        return map;
    }

    public void setMap(Map<String, Object> map) {
        this.map = map;
    }

    public List<Object> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", map=" + map +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}

Dog类中声明了name和age，进行yml文件的配置

person:
  lastName: zpw
  age: 19
  boss: true
  birth: 1998/01/01
  map: {k1: v1, k2: 11}
  list:
   - zz
   - pp
  dog:
   name: ww
   age: 2

编写测试方法：

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot02ConfigApplicationTests {

    @Autowired
    Person person;
    
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
}

直接运行程序即可。
这时我们思考如何使用properties文件来配置。
在配置之前、我们需要在设置中修改一个配置、不然会出现乱码
在这里插入图片描述
这时，我们可以在properties中配置达到和yml相同的效果

person.last-name=zpw
person.age=10
person.birth=2019/09/9
person.boss=true
person.list=a,b
person.map.k1=1
person.map.k2=12
person.dog.name=dog
person.dog.age=2

3、配置文件注入

<1>、@PropertySource

编写的类，默认加载配置都会从resources目录下加载application.properties和application.yml文件的配置，但是我们也可以按照自己的想法去读取自己所创建的配置文件。
在这里插入图片描述

person.last-name=zz
person.age=10
person.birth=2019/09/9
person.boss=true
person.list=a,b
person.map.k1=1
person.map.k2=12
person.dog.name=dog
person.dog.age=2

在Person类上加上一个注解即可。

@PropertySource(value = {"classpath:person.properties"})

<2>、@ImportResource

导入Spring的配置文件，让配置文件里面的内容生效；
Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；
想让Spring的配置文件生效，加载进来；需要将@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class Springboot02ConfigApplication {

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

beans.xml配置文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<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.example.service.HelloService"></bean>
    
</beans>

测试方法：

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot02ConfigApplicationTests {
    @Autowired
    ApplicationContext ioc;

    @Test
    public void testHelloService(){
        boolean b = ioc.containsBean("helloService");
        System.out.println(b);
    }
}

以上俩种方法都是手动添加组件来完成配置；
SpringBoot推荐给容器中添加组件的方式：推荐使用全注解的方式
1、配置类@Configuration------>Spring配置文件
2、使用@Bean给容器中添加组件

/**
 * 指明当前类是一个配置类
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){

        System.out.println("配置类@Bean给容器中添加组件了");
        return new HelloService();
    }
}

将beans.xml配置注释，再进行测试，也是可以成功的。

4、配置文件占位符

可以使用随机数：

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

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

person.last-name=zz${random.uuid}
person.age=${random.int}
person.birth=2019/09/9
person.boss=true
person.list=a,b
person.map.k1=1
person.map.k2=12
person.dog.name=${person_hello:hello}_dog
person.dog.age=2

5、Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境

<1>、多Profile文件

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置；

<2>、yml支持多文档块方式

server:
  port: 8888
spring:
  profiles:
    active: dev
# 默认使用8888，一旦为激活状态就会转换为dev就是8083
---
server:
  port: 8083
spring:
  profiles: dev

---
server:
  port: 8084
spring:
  profiles: prod

<3>、激活指定Profile

1、在配置文件中指定 spring.profiles.active=dev，即可切换到开发模式
2、命令行：
java -jar springboot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；
可以直接在测试的时候，配置传入命令行参数
3、虚拟机参数；
-Dspring.profiles.active=dev

6、配置文件的加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/（根目录下的config目录下）
–file:./ （根目录下）
–classpath:/config/ （resources的config目录下）
–classpath:/ （resources目录下）
优先级由高到底，高优先级的配置会覆盖低优先级的配置；
SpringBoot会从这四个位置全部加载主配置文件；互补配置；
我们还可以通过spring.config.location来改变默认的配置文件位置：前提是项目已经打好包，可以使用命令行参数来修改。

7、自动配置原理

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

<2>、@EnableAutoConfiguration 作用

利用EnableAutoConfigurationImportSelector给容器中导入一些组件
可以查看selectImports()方法的内容；
List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到容器中；

<3>、每一个自动配置类进行自动配置功能

<4>、以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理

@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;
	}

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

<5>、所有的配置类都是在不同的Properties类中进行封装的

@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:封装配置文件中相关属性；

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

JavaEE企业级开发