一、简介
mica-auto 是 Spring cloud 微服务框架 Mica 中的一个基础组件,用来生成 Spring boot starter 的一些基础配置。仅仅编译级别即可,maven、gradle 编译时会自动处理生成所需的配置。
二、初衷
在开发和维护大量 Spring boot stater 时我们需要添加 spring.factories 配置,偶尔忘记 添加和删减 spring.factories 配置中的类会导致微服务启动失败。为了减少失误和人工介入故开发了 mica-auto,在 2019年1月12日开源 0.0.1 版本,之后在 mica 和 pig 团队的多个组件中使用。
三、功能
- 生成 spring.factories。
- 生成 spring-devtools.properties
- 生成 FeignClient 到 spring.factories 中,供 mica-cloud 中完成 Feign 自动化配置。
- 生成 java Spi 配置,需要添加 @AutoService 注解。
注解 | spring.factories 或 Spi key |
---|---|
@AutoContextInitializer | ApplicationContextInitializer |
@AutoListener |
ApplicationListener |
@AutoRunListener |
SpringApplicationRunListener |
@AutoEnvPostProcessor |
EnvironmentPostProcessor |
@AutoFailureAnalyzer |
FailureAnalyzer |
@AutoConfigImportFilter | AutoConfigurationImportFilter |
@AutoTemplateProvider |
TemplateAvailabilityProvider |
@AutoEnableCircuitBreaker | EnableCircuitBreaker |
@AutoConfigDataLocationResolver | ConfigDataLocationResolver |
@AutoConfigDataLoader |
ConfigDataLoader |
@AutoDatabaseInitializerDetector | DatabaseInitializerDetector |
@AutoDependsOnDatabaseInitializationDetector | DependsOnDatabaseInitializationDetector |
@Component |
EnableAutoConfiguration |
@AutoIgnore |
忽略,不生成到 spring.factories |
@AutoService |
java Spi 生成配置 |
四、变更记录
- ✨ 添加 DatabaseInitializer 相关支持
- ✨ 优化 jar manifest
- ✅ Adding google compile-testing.
- ⬆️ 升级 Spring boot 到 2.5.2
五、使用
注意: 如果你项目中使用了 Lombok 请将 mica-auto 的依赖放置到 Lombok 后面。
5.1 maven
<dependency>
<groupId>net.dreamlu</groupId>
<artifactId>mica-auto</artifactId>
<version>2.1.1</version>
<scope>provided</scope>
</dependency>
5.2 gradle >= 5.x
annotationProcessor("net.dreamlu:mica-auto:2.1.1")
5.3 gradle < 5.x
compileOnly "net.dreamlu:mica-auto:2.1.1"
5.4 java spi 示例:
- 添加注解 @AutoService 指定 spi 接口 Processor.class。
package foo.bar;
import javax.annotation.processing.Processor;
@AutoService(Processor.class)
public class MyProcessor implements Processor {
// …
}
AutoService 将会自动生成 spi 的配置文件 META-INF/services/javax.annotation.processing.Processor 。内容:
foo.bar.MyProcessor
六、使用场景
- Spring boot starter 开发利器,自动生成 spring.factories、spring-devtools.properties 配置。
- 多模块项目中的子项目,包名不同时的自动配置(主项目不建议添加)。
- java spi 扩展自动生成配置。
建议关注如梦技术码云:https://gitee.com/596392912 ,更多微服务核心组件值得拥有。
七、关注我们
扫描上面二维码,更多精彩内容每天推荐!