首页开发技术正文

如何使用SpringBoot自定义starter

爱秀

作者

这篇文章主要介绍了如何使用SpringBoot自定义starter，具有一定借鉴价值，感兴趣的朋友可以参考下，希望大家阅读完这篇文章之后大有收获，下面让小编带着大家一起了解一下。

springboot是什么

springboot一种全新的编程规范，其设计目的是用来简化新Spring应用的初始搭建以及开发过程，SpringBoot也是一个服务于框架的框架，服务范围是简化配置文件。

一、新建一个工程

工程由xxx-sprig-boot-starter和xxx-sprig-boot-starter-configure两个模块组成；

xxx-sprig-boot-starter模块

只用来做依赖导入
依赖于 xxx-sprig-boot-starter-configure模块，没有实际代码



4.0.0

com.ander
ander-spring-boot-starter
1.0-SNAPSHOT




com.ander
ander-spring-boot-starter-configure
0.0.1-SNAPSHOT

xxx-sprig-boot-starter-configure模块

专门自动配置模块
依赖于spring-boot-starter-web



4.0.0

org.springframework.boot
spring-boot-starter-parent
2.3.10.RELEASE



com.ander
ander-spring-boot-starter-configure
0.0.1-SNAPSHOT
ander-spring-boot-starter-configure
DemoprojectforSpringBoot


1.8




org.springframework.boot
spring-boot-starter-web

二、xxx-sprig-boot-starter-configure模块自动配置编码

2.1 服务层编码

/**
*Service层
*
*@Author:Ander
*@Date:2021-05-04
*/
publicclassHelloService{

privateHelloServicePropertieshelloServiceProperties;

publicStringhelloService(Stringname){
returnhelloServiceProperties.getPrefix()+""+name+""+helloServiceProperties.getSuffix();
}

publicHelloServicePropertiesgetHelloServiceProperties(){
returnhelloServiceProperties;
}

publicvoidsetHelloServiceProperties(HelloServicePropertieshelloServiceProperties){
this.helloServiceProperties=helloServiceProperties;
}
}

2.2 属性配置类编码

/**
*属性配置类
*
*@Author:Ander
*@Date:2021-05-04
*/
@ConfigurationProperties(prefix="com.ander")
publicclassHelloServiceProperties{

privateStringprefix="hi";
privateStringsuffix="helloworld";

publicStringgetPrefix(){
returnprefix;
}

publicvoidsetPrefix(Stringprefix){
this.prefix=prefix;
}

publicStringgetSuffix(){
returnsuffix;
}

publicvoidsetSuffix(Stringsuffix){
this.suffix=suffix;
}
}

2.3 starter自动配置类编码

@EnableConfigurationProperties({HelloServiceProperties.class})作用：让xxxProperties生效加入到容器中

/**
*自定义starter自动配置类
*
*@Date:2021-05-04
*/
@Configuration
@ConditionalOnWebApplication//指定web应用才生效
@EnableConfigurationProperties({HelloServiceProperties.class})
publicclassHelloServiceAutoConfigure{

@Autowired
privateHelloServicePropertieshelloServiceProperties;

@Bean
publicHelloServicehelloService(){
HelloServicehelloService=newHelloService();
helloService.setHelloServiceProperties(helloServiceProperties);
returnhelloService;
}
}

2.4 添加自动配置类到META-INF路径下

2.5 将工程安装到本地

注意先安装xxx-spring-boot-starter-configure，再安装xxx-spring-boot-starter

三、新建一个工程测试自定义starter

3.1 编写controller层

/**
*starter测试控制类
*
*@Author:Ander
*@Date:2021-05-05
*/
@RestController
publicclassStarterTestController{

@Autowired
privateHelloServicehelloService;

@GetMapping("hello")
publicStringhello(Stringname){
returnhelloService.helloService(name);
}
}