SpringBoot中使用@Bean注解创建组件对象

       Spring Boot 由于没有XML文件，所以所有的Bean管理都放入在一个配置类中实现。 配置类就是类上具有@Configuration的类。这个类就相当于之前的applicationContext.xml。

1.配置初始设置

1.pom.xml文件

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.test</groupId>
    <artifactId>SpringBootBeanAnnoTest</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--  2.引入当前项目的父项目，会继承父项目配置，自动引入父项目中所需的所有配置项和依赖包  -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.5</version>
    </parent>

    <!--  3.本项目依赖的其他包  -->
    <dependencies>
        <!--    引入SpringBoot核心启动包，内部也会自动引入它所依赖的第三方包    -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.4.5</version>
        </dependency>

        <!--    引入SpringBoot-web，它是SpringMVC项目的启动器（Starter），内置了内嵌式的Tomcat    -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.4.5</version>
        </dependency>

        <!-- 引入SpringBoot对测试的支持starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <version>2.4.5</version>
            <scope>test</scope>
        </dependency>

        <!--    引入jUnit单元测试依赖包    -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
        </dependency>

        <!-- 引入FastJson依赖包 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.79</version>
        </dependency>

        <!-- 引入Lombok依赖包 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>
    </dependencies>

    <!--  4.当前项目统一需要的打包、编译插件  -->
    <build>
        <plugins>
            <!-- 引入maven编译插件，maven默认会使用JDK1.5编译打包，我们指定为1.8 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>

            <!-- 引入SpringBoot项目打包工具 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.4.5</version>
                <configuration>
                    <!-- 如果没有该配置，devTools不会起作用，应用不会自动restart重启 -->
                    <fork>true</fork>
                    <includeSystemScope>true</includeSystemScope>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2.resource中application.yml文件 

spring:
  application:
    name: spring-boot-bean-anno-test

server:
  port: 8088

#设置日志输出的各个选项
logging:
  level:
    com.chinasofti.xian.controller: debug

3.运行主体类

package com.test;

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

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

 2.通过模拟上传设置，理解@Bean的使用

1.新建配置包config,在包中设置配置信息

  注意： 配置类要有@Configuration ；方法要有@Bean

2.在appication.yml中设置配置信息

#下面是模拟用于上传使用的自定义配置信息
my-upload-config:
  black-list: exe,bat,com
  max-size: 10485760
  upload-folder: D:/uploadFiles/

 3.config包中设置配置类

1.对应application.yml中的配置，在类中获取application.yml中的部分上传配置对象

package com.test.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Data
@Configuration
@ConfigurationProperties(prefix = "my-upload-config")
public class UploadConfigLoader {
    private String blackList;//上传文件黑名单
    private Integer maxSize;//上传文件大小
    private String uploadFolder;//上传文件路径
}

2.设置模拟上传助手类 ，模拟部分参数从application.yml中获取，部分从数据库中获取

package com.test.config;

import lombok.Data;

//上传助手类组件，模拟通过它进行文件上传
//@Component//我们对于创建过程较为复杂的组件对象，可以不使用@Component注解完成创建
//我们本例通过@Bean注解，在方法中完成创建和初始化
@Data
public class SmartUploadHelper {
    private String whiteNameList;//白名单
    private String blackNameList;//黑名单
    private int singleFileSize;//单个文件大小限制
    private int totalFileSize;//总文件大小显示
    private String uploadPath;//上传路径
    private String downloadPath;//下载路径
}

 4.在运行主体类SpringBootAppClass中加入配置信息

        装配方式比较复杂时，使用@Bean，本例中@Bean对象中一部分配置信息来自application.yml，另一部分来自数据库。

package com.test;

import com.test.config.SmartUploadHelper;
import com.test.config.UploadConfigLoader;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.context.annotation.Bean;

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

    //@Bean的使用：为了通过方法创建一个Bean组件（放入Spring上下文中）
    //1).在SpringBoot中，任意能够被扫描到的组件类中，可以随意编写方法在之前使用@Bean注解。
    //2).@Bean方法的返回值，就是创建的Bean对象，会自动放入Spring上下文中。
    //3).添加了@Bean的方法，会在SpringBoot启动时，自动调用。
    //4).@Bean方法的参数，必须是另一个Bean组件对象(例子中为UploadConfigLoader)，会自动注入！
    //下面的方法会自动调用，我们在其中创建了一个“上传助手类组件Bean对象”，会作为Bean自动放入Spring上下文中
    @Bean
    public SmartUploadHelper createSmartUploadHelper(UploadConfigLoader uploadConfigLoader){
        //创建对象
        SmartUploadHelper smartUploadHelper = new SmartUploadHelper();

        //下面初始化这个组件对象的6个属性：
        //1).其中3个属性，是来自于application.yml中的配置信息
        smartUploadHelper.setBlackNameList(uploadConfigLoader.getBlackList());
        smartUploadHelper.setTotalFileSize(uploadConfigLoader.getMaxSize());
        smartUploadHelper.setUploadPath(uploadConfigLoader.getUploadFolder());

        //2).另外的3个属性，模拟从数据库加载的信息，完成初始化
        smartUploadHelper.setWhiteNameList("jpg,png,gif");
        smartUploadHelper.setSingleFileSize(1048576);
        smartUploadHelper.setDownloadPath("D:/downloadFiles/");

        //返回值就是创建好的Bean对象，会自动放入Spring上下文中
        return smartUploadHelper;
    }
}

 3.设置controller包，进行测试

    建立testController类进行设置

package com.test.controller;

import com.test.config.SmartUploadHelper;
import com.alibaba.fastjson.JSONObject;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
@RequestMapping("/")
public class TestController {
    @Resource
    private SmartUploadHelper smartUploadHelper;

    @RequestMapping(value = "testUpload", produces = "application/json;charset=utf-8")
    public String testUpload(){
        //返回上传助手类中的属性数据，转换为JSON字符串
        return JSONObject.toJSONString(smartUploadHelper);
    }
}

4.运行结果