Spring注解相关

Spring注解

EnableConfigurationProperties

如果@ConfigurationProperties是在第三方包中，那么@component是不能注入到容器的。只有@EnableConfigurationProperties才可以注入到容器。

ConditionalOnClass

image.png

componentscan的作用如下：

@ComponentScan告诉Spring 哪个packages 的用注解标识的类会被spring自动扫描并且装入bean容器。

例如，如果你有个类用@Controller注解标识了，那么，如果不加上@ComponentScan，自动扫描该controller，那么该Controller就不会被spring扫描到，更不会装入spring容器中，因此你配置的这个Controller也没有意义。

配置文件类比注解

@Configuation等价于
@Bean 等价于
@ComponentScan等价于
@Component 等价于

@Bean VS @Component

两个注解的结果是相同的，bean都会被添加到Spring上下文中。

@Component 标注的是类,允许通过自动扫描发现。@Bean需要在配置类@Configuation中使用。
@Component类使用的方法或字段时不会使用CGLIB增强。而在@Configuration类中使用方法或字段时则使用CGLIB创造协作对象
假设我们需要将一些第三方的库组件装配到应用中或者我们有一个在多个应用程序中共享的模块，它包含一些服务。并非所有应用都需要它们。
如果在这些服务类上使用@Component并在应用程序中使用组件扫描，我们最终可能会检测到超过必要的bean。导致应用程序无法启动
但是我们可以使用 @Bean来加载

因此，基本上，使用@Bean将第三方类添加到上下文中。和@Component，如果它只在你的单个应用程序中

获取yml配置文件

/**
对接配置内容
 */
@Data
@ConfigurationProperties(prefix = "insurance")
@Component
public class InsuranceDockingConfig {
    /**
     * 是否打印日志
     * 0:否 1：是
     */
    public String consoleType;
    /**
     * 项目负责人
     */
    public String projectLeader;
    /**
     * 订单负责人
     */
    public String orderLeader;
}

ConditionalOnProperty 注解

1. 简介

Spring Boot源码中大量使用@ConditionalOnProperty来控制Configuration是否生效。

2. 实战

2.1 name的用法

user类

public class User {
}

Dept类

public class Dept {
}

配置类


/**
 * @Author: wgs
 * @Date 2022/2/23 16:02
 * @Classname Config1
 * @Description 当配置文件中只要出现config1.enable时(内容为空 ， 同样也是有效的)，则该配置生效。
 */
@Configuration
@ConditionalOnProperty(name = "config1.enable")
public class Config1 {
    @Bean
    public User user() {
        User user = new User();
        System.err.println("----------------初始化user--------------");
        return user;
    }
}


/**
 * @Author: wgs
 * @Date 2022/2/23 16:05
 * @Classname Config2
 * @Description 当配置文件中只要出现config1.enable时(内容为空，同样也是有效的)，则该配置生效。
 */
@Configuration
@ConditionalOnProperty(name = "config2.enable")
public class Config2 {
    @Bean
    public Dept dept() {
        System.err.println("=============dept初始化========");
        return new Dept();
    }
}

配置文件

config1:
  enable: test

启动项目

2022-02-23 16:24:33.004  INFO 20313 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 459 ms
----------------初始化user--------------
2022-02-23 16:24:33.162  INFO 20313 --- [

2.2 根据配置开关进行动态加载配置（havingValue）

在上述代码的基础上，我们首先的Config1和Config2中稍作一些修改。

配置类


/**
 * @Author: wgs
 * @Date 2022/2/23 16:02
 * @Classname Config1
 * @Description 当配置文件中只要出现config1.enable时(内容为空 ， 同样也是有效的)，则该配置生效。
 */
@Configuration
//  当配置文件中config1.enable的值为true才加载，否则就不加载
@ConditionalOnProperty(name = "config1.enable", havingValue = "true")
public class Config1 {
    @Bean
    public User user() {
        User user = new User();
        System.err.println("----------------初始化user--------------");
        return user;
    }
}


/**
 * @Author: wgs
 * @Date 2022/2/23 16:05
 * @Classname Config2
 * @Description 当配置文件中只要出现config1.enable时(内容为空，同样也是有效的)，则该配置生效。
 */
@Configuration
//  当配置文件中config1.enable的值为true才加载，否则就不加载
@ConditionalOnProperty(name = "config2.enable", havingValue = "true")
public class Config2 {
    @Bean
    public Dept dept() {
        System.err.println("=============dept初始化========");
        return new Dept();
    }
}

配置文件

config1:
  enable: false
config2:
  enable: true

启动项目

2022-02-23 16:28:38.633  INFO 20439 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2022-02-23 16:28:38.633  INFO 20439 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 449 ms
=============dept初始化========
2022-02-23 16:28:38.830  INFO 20439 --- [

2.3 配置缺失加载配置（havingValue）

在上述代码的基础上，我们首先的Config1和Config2中稍作一些修改。

配置类

@Configuration
//  当配置文件中config2.enable,匹配如果缺失加载
@ConditionalOnProperty(name = "config2.enable", havingValue = "true", matchIfMissing = true)
public class Config2 {
    @Bean
    public Dept dept() {
        System.err.println("=============dept初始化========");
        return new Dept();
    }
}

配置文件

config1:
  enable: false

启动项目

2022-02-23 16:28:38.633  INFO 20439 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2022-02-23 16:28:38.633  INFO 20439 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 449 ms
=============dept初始化========
2022-02-23 16:28:38.830  INFO 20439 --- [

Bean的加载

在Spring Boot应用中要让一个普通类交给Spring容器管理，通常有以下方法：

1、使用 @Configuration与@Bean 注解

2、使用@Controller @Service @Repository @Component 注解标注该类并且启用@ComponentScan自动扫描

3、使用@Import 方法

其中Spring Boot实现自动配置使用的是@Import注解这种方式，AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名，这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。

2.2.3 自动配置总结
我们可以将自动配置的关键几步以及相应的注解总结如下：

1、@Configuration与@Bean：基于Java代码的bean配置

2、@Conditional：设置自动配置条件依赖

3、@EnableConfigurationProperties与@ConfigurationProperties：读取配置文件转换为bean

4、@EnableAutoConfiguration与@Import：实现bean发现与加载

2.3 自定义starter

本小节我们通过自定义两个starter来加强starter的理解和应用。

2.3.1 案例一

2.3.1.1 开发starter

第一步：创建starter工程hello-spring-boot-starter并配置pom.xml文件



    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.2.2.RELEASE
        
    
    cn.itcast
    hello-spring-boot-starter
    1.0-SNAPSHOT
    
        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-autoconfigure

第二步：创建配置属性类HelloProperties

package cn.itcast.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

/*
 *读取配置文件转换为bean
 * */
@ConfigurationProperties(prefix = "hello")
public class HelloProperties {
    private String name;
    private String address;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "HelloProperties{" +
                "name='" + name + '\'' +
                ", address='" + address + '\'' +
                '}';
    }
}

第三步：创建服务类HelloService

package cn.itcast.service;

public class HelloService {
    private String name;
    private String address;

    public HelloService(String name, String address) {
        this.name = name;
        this.address = address;
    }

    public String sayHello(){
        return "你好！我的名字叫 " + name + "，我来自 " + address;
    }
}

第四步：创建自动配置类HelloServiceAutoConfiguration

package cn.itcast.config;

import cn.itcast.service.HelloService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/*
* 配置类，基于Java代码的bean配置
* */

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {
    private HelloProperties helloProperties;

    //通过构造方法注入配置属性对象HelloProperties
    public HelloServiceAutoConfiguration(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    //实例化HelloService并载入Spring IoC容器
    @Bean
    @ConditionalOnMissingBean
    public HelloService helloService(){
        return new HelloService(helloProperties.getName(),helloProperties.getAddress());
    }
}

第五步：在resources目录下创建META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.itcast.config.HelloServiceAutoConfiguration

至此starter已经开发完成了，可以将当前starter安装到本地maven仓库供其他应用来使用。

2.3.1.2 使用starter

第一步：创建maven工程myapp并配置pom.xml文件



    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.2.2.RELEASE
        
    
    cn.itcast
    myapp
    1.0-SNAPSHOT
    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
        
            cn.itcast
            hello-spring-boot-starter
            1.0-SNAPSHOT

第二步：创建application.yml文件

server:
  port: 8080
hello:
  name: xiaoming
  address: beijing

第三步：创建HelloController

package cn.itcast.controller;

import cn.itcast.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/hello")
public class HelloController {
    //HelloService在我们自定义的starter中已经完成了自动配置，所以此处可以直接注入
    @Autowired
    private HelloService helloService;

    @GetMapping("/say")
    public String sayHello(){
        return helloService.sayHello();
    }
}

第四步：创建启动类HelloApplication

package cn.itcast;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

执行启动类main方法，访问地址http://localhost:8080/hello/say

Spring注解相关

Spring注解

EnableConfigurationProperties

ConditionalOnClass

componentscan的作用如下：

配置文件类比注解

@Bean VS @Component

获取yml配置文件

ConditionalOnProperty 注解

1. 简介

2. 实战

2.1 name的用法

2.2 根据配置开关进行动态加载配置（havingValue）

2.3 配置缺失加载配置（havingValue）

Bean的加载

2.3 自定义starter

2.3.1 案例一

2.3.1.1 开发starter

2.3.1.2 使用starter

你可能感兴趣的:(Spring注解相关)