<!-- 1.引入spring-boot-autoconfigure,用于自动配置应用程序的各种组件和功能.自定义starter时必须要有 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-autoconfigure</artifactId>
</dependency>

<!-- 2.引入spring-boot-configuration-processor,自定义starter时,调用方的配置文件中可以给出提示信息(如不引用,则不会提示,此包非必须) -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <!-- 表示两个项目之间依赖不传递:不设置optional或者optional是false,表示传递依赖;当出现依赖冲突时候,会自动剔除该依赖- -->
  <optional>true</optional>
</dependency>

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	
	<!-- 项目基本信息 -->
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.qfx.starter</groupId>
	<artifactId>qfx-test-spring-boot-starter</artifactId>
	<version>1.0-SNAPSHOT</version>
	<packaging>jar</packaging>
	<name>qfx-test-spring-boot-starter</name>
	<description>一个自定义的测试spring.boot.starter</description>
	
	<!-- 设置父类,整合第三方常用框架依赖信息(各种依赖信息),这里继承SpringBoot提供的父工程 -->
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.17</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	
	<!-- 设置公共参数 -->
	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<!-- Maven install 时,测试环境@Test中如果有中文输出是乱码，加上这句话试试 -->
		<argLine>-Dfile.encoding=UTF-8</argLine>
		<!-- Maven编译时的编码 -->
		<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
		<!-- 编译打包时关掉单元测试 -->
		<skipTests>true</skipTests>
		
		<!-- jdk版本 -->
		<java.version>1.8</java.version>
	</properties>
	
	<dependencies>
		<!-- 1.引入spring-boot-autoconfigure,用于自动配置应用程序的各种组件和功能.自定义starter时必须要有 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-autoconfigure</artifactId>
		</dependency>

		<!-- 2.引入spring-boot-configuration-processor,自定义starter时,调用方的配置文件中可以给出提示信息(如不引用,则不会提示,此包非必须) -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<!-- 表示两个项目之间依赖不传递:不设置optional或者optional是false,表示传递依赖;当出现依赖冲突时候,会自动剔除该依赖- -->
			<optional>true</optional>
		</dependency>
	</dependencies>
</project>

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

/**
 * <h5>功能:将配置文件中以 "qfx" 为前缀的属性值绑定到此Java类上</h5>
 * starter被引用时,会将驼峰命名的参数名称转化为全小写,并在原大写的前面添加"-",
 * 如本类的userName属性,会以qfx.user-name来进行展现
 * 
 */
@ConfigurationProperties(prefix = "qfx")
public class TestProperties {
	
	private String userName;
	private String userPwd;
	
	public String getUserName() {
		return userName;
	}
	public void setUserName(String userName) {
		this.userName = userName;
	}
	public String getUserPwd() {
		return userPwd;
	}
	public void setUserPwd(String userPwd) {
		this.userPwd = userPwd;
	}
}

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.qfx.module.common.properties.TestProperties;
import com.qfx.module.test.service.TestStarterService;

/**
 * <h5>功能:自动配置类</h5>
 * @ConditionalOnClass
 */
@Configuration	// 表示这个类为配置类
@EnableConfigurationProperties(TestProperties.class)	// 启用 TestProperties 类的配置属性
public class TestAutoConfig {
	// 在这里定义你要注册的对象
}

import org.springframework.beans.factory.annotation.Autowired;

import com.qfx.module.common.properties.TestProperties;

/**
 * 这里不要添加@Service等类似的注解,要放在自动配置类中根据条件加载 
 */
public class TestStarterService {
	@Autowired
	private TestProperties properties;
	
  /**
   * 模拟方法,获取属性类的信息 
   */
	public String getPropertiesInfo() {
		System.out.println("模拟执行业务...");
		return properties.getUserName() + "_" + properties.getUserPwd();
	}
}

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.qfx.module.common.properties.TestProperties;
import com.qfx.module.test.service.TestStarterService;

/**
 * <h5>功能:自动配置类</h5>
 * @ConditionalOnClass
 */
@Configuration	// 表示这个类为配置类
@EnableConfigurationProperties(TestProperties.class)	// 启用 TestProperties 类的配置属性
public class TestAutoConfig {

	@Bean
	@ConditionalOnClass(TestStarterService.class)		// 只有当指定的类存在于类路径中时，才会创建该方法返回的 Bean
	public TestStarterService testStarterService() {
		return new TestStarterService();
	}
}

# 自动配置,如果有多个配置则使用",\"结尾的方式即可
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.qfx.module.common.config.TestAutoConfig

<dependency>
	<groupId>com.qfx.starter</groupId>
    <artifactId>qfx-test-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

@Autowired
TestStarterService testStarterService;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import com.qfx.module.test.service.TestStarterService;

@RestController
@RequestMapping("test")
public class TestCtl {

	@Autowired
	TestStarterService testStarterService;

	/**
	 * <h5>描述:调用starter方法,并返回数据</h5>
	 * 
	 * @return 
	 */
	@RequestMapping("starter")
	@ResponseBody
	public String starter() {
		return testStarterService.getPropertiesInfo();
	}
}