Spring Boot Starter自定义总结

步骤一，配置信息绑定bean

java bean文件：FilePorperties

@Configuration
@ConfigurationProperties(prefix = "spring.file")
public class FilePorperties {
	private String name;
	private String path;
	
	// setter getter
}

配置文件：application.properties

spring.file.path=C:\\data
spring.file.name=test.txt

正常情况，Spring容器可以通过FilePorperties对象直接获取配置文件信息

步骤二，创建一个根据配置文件管理的bean对象

对象

public class CustomFile {
	private String absolutePath;
	// setter getter
}

动态创建对象，交于spring容器管理

@Configuration
@ConditionalOnProperty(prefix = "spring.file", value = "enabled", havingValue = "true")
public class FileAutoConfigure {
	@Bean
    public CustomFile createCustomFile() {
        CustomFile customFile = new CustomFile();
		return customFile;
    }
}

当配置文件application.properties，配置spring.file.enabled=true时，spring容器创建CustomFile对象并管理

如何生效？，在META-INF目录下新建文件spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.starter.demo.config.FileAutoConfigure

com.example.starter.demo.config.FileAutoConfigure

标记红色的是包名

步骤三，结合配置文件使用

结合配置文件FilePorperties，动态给CustomFile对象赋值

@Configuration
@EnableConfigurationProperties(FilePorperties.class)
@ConditionalOnProperty(prefix = "spring.file", value = "enabled", havingValue = "true")
public class FileAutoConfigure {
	@Autowired
	private FilePorperties filePorperties;
	
	@Bean
    public CustomFile createCustomFile() {
        CustomFile customFile = new CustomFile();
        customFile.setAbsolutePath(filePorperties.getPath() + File.separator + filePorperties.getName());
		return customFile;
    }
}

步骤四，测试

@RestController
public class TestController {
	@Autowired(required = false)
	private CustomFile customFile;
	
	@GetMapping("/test")
	public Map<String, String> test() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "10001");
		
		if (customFile != null) {
			data.put("absolutePath", customFile.getAbsolutePath());
		} else {
			data.put("absolutePath", "/");
		}
		
		return data;
	}
}

• 测试一，当配置文件：application.properties

spring.file.path=C:\\data
spring.file.name=test.txt

没有配置spring.file.enabled，对象不会创建

• 测试二，当配置文件：application.properties

spring.file.enabled=true
spring.file.path=C:\\data
spring.file.name=test.txt

• 测试三，更改配置参数，实时生效