SpringBoot学习笔记(四)——手写自定义SpringBoot启动器

今天是清明节的第一天假期，原本的学习计划是学习RocketMQ的，但是发现一个好玩的东西，自定义SpringBoot启动器，这东西逼格高啊。所以今天学习的内容就是手写一个自定义的SpringBoot的启动器，简单学习之后再去学习RocketMQ。手写启动器总的流程如下图：

流程已经有了接下来就剩实现了，接下来就开始进行内容实现

1.创建Maven工程

下一步之后就是定义自己的项目坐标，第一次的小伙伴是不是都不太会写啊，没关系，我们来看看权威人士是怎么写的。

 照着抄就完事了

接下来点击Finish

2.导入需要的依赖

只添加必用的依赖，业务中需要用到其他依赖请自行导入

<?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>

<!--    手动添加SpringBoot父项目依赖-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>org.springBoot.test</groupId>
    <artifactId>test-spring-boot-starter</artifactId>
    <version>1.0</version>

<!--    这两个依赖是自定义启动器必须要添加的两个依赖-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
<!--            表示依赖此项目的子项目不会导入此依赖-->
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>
</project>

3.进行代码开发

由于约定大于配置，所以有些地方有指定的要求，需要注意。

3-1.创建包(要与项目的groupId相同)

创建配置文件

3-2. 代码开发

3-2-1.创建普通的Java对象

package org.springboot.test;

/**
 * 普通对象不需要添加注解交给Spring管理
 *
 * @author Me
 * @date 2022/4/3 14:31
 */
public class GetDataSourceMessage {

    public GetDataSourceMessage() {
        System.out.println("启动器中的Bean是否被创建");
    }
}

3-2-2.创建Java配置类

package org.springboot.test;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author Me
 * @date 2022/4/3 14:34
 */
@Configuration
// 子项目中没有这个类时此类才会加载
@ConditionalOnClass(GetDataSourceMessage.class)
public class GetDataSourceConfig {

    // 可以取子项目中配置文件的信息
    @Value("${spring.datasource.jdbc.username}")
    private String abc;
    // 取本项目中配置文件的信息
    // 测试结果为查询不到此配置
    @Value("${org.springframework.boot.myself}")
    private String ddd;
    // 子项目与启动器的配置文件冲突结果
    // 测试结果为无法对启动器项目进行配置文件开发，所以不存在冲突
    @Value("${spring.datasource.jdbc.password}")
    private String qqq;

    @Bean
    // 子项目中没有这个Bean时才会加载
    @ConditionalOnMissingBean
    public GetDataSourceMessage getDataSourceMessage() {
        System.out.println("读取子项目中的配置文件成功：" + abc);
        System.out.println("读取启动器项目中的配置文件成功：" + ddd);
        System.out.println("当子项目与父项目中配置文件都有该值，取谁的呢？：" + qqq);
        return new GetDataSourceMessage();
    }
}

3-2-3.开发配置文件

一定要resource ——> META-INF ——> spring.factories 文件中编写，错一个地方，都找不到。

# 要注意 META-INF 与 spring.factories 都不能写错，只有这样，当子项目启动时才会读取该文件
# 像如下的键值对是不可以添加的！！！
org.springframework.boot.myself=abcdefg
spring.datasource.jdbc.password=99999919999

# 要注意配置扫描如下文件才可以使用哈，用来扫描配置类的，可别不添加
org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.springboot.test.GetDataSourceConfig

4.打成Jar包

可以使用IDEA集成的按钮进行打包，也可以使用命令行，由于我没有命令行的环境，我就直接点按钮了。

 这就是我们打完的jar包。

 5.进行使用及结果验证

我这里没有Maven私服，我只是自己练习，我就展示一下本地使用方式吧。

在子项目中导入依赖

 可以看到我们写的项目啦，接下来就是启动实验阶段了。

package com.springBoot.helloworld;

import org.springboot.test.GetDataSourceMessage;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;

@SpringBootApplication
public class HelloworldApplication {

	public static void main(String[] args) {
		ApplicationContext run = SpringApplication.run(HelloworldApplication.class, args);
		GetDataSourceMessage getDataSourceMessage = run.getBean(GetDataSourceMessage.class);
		System.out.println(getDataSourceMessage);
	}
}

我测试了半个多小时，图就不一个一个贴了，直接说结论了哈。

启动器的spring.factories文件，不可以写键值对，写了也读不到，但启动器可以读取子项目的配置文件。

其他的就没什么注意的了，小伙伴们也可以动手写写试试。