使用SpringBoot自定义starter详解

使用SpringBoot自定义starter详解

一、新建一个工程

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

xxx-sprig-boot-starter模块

只用来做依赖导入

依赖于 xxx-sprig-boot-starter-configure模块，没有实际代码

xmlns:xsi="http://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">

4.0.0

com.ander

ander-spring-boot-starter

1.0-SNAPSHOT

com.ander

ander-spring-boot-starter-configure

0.0.1-SNAPSHOT

xmlns:xsi="http://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">

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

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

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

Demo project for Spring Boot

1.8

org.springframework.boot

spring-boot-starter-web

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

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

Demo project for Spring Boot

1.8

org.springframework.boot

spring-boot-starter-web

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

2.1 服务层编码

/**

* Service层

*

* @Author: Ander

* @Date: 2021-05-04

*/

public class HelloService {

private HelloServiceProperties helloServiceProperties;

public String helloService(String name) {

return helloServiceProperties.getPrefix() + " "+ name + " " + helloServiceProperties.getSuffix();

}

public HelloServiceProperties getHelloServiceProperties() {

return helloServiceProperties;

}

public void setHelloServiceProperties(HelloServiceProperties helloServiceProperties) {

this.helloServiceProperties = helloServiceProperties;

}

}

2.2 属性配置类编码

/**

* 属性配置类

*

* @Author: Ander

* @Date: 2021-05-04

*/

@ConfigurationProperties(prefix = "com.ander")

public class HelloServiceProperties {

private String prefix = "hi";

private String suffix = "hello world";

public String getPrefix() {

return prefix;

}

public void setPrefix(String prefix) {

this.prefix = prefix;

}

public String getSuffix() {

return suffix;

}

public void setSuffix(String suffix) {

this.suffix = suffix;

}

}

2.3 starter自动配置类编码

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

/**

* 自定义starter自动配置类

*

* @Author: Ander

* @Date: 2021-05-04

*/

@Configuration

@ConditionalOnWebApplication // 指定web应用才生效

@EnableConfigurationProperties({HelloServiceProperties.class})

public class HelloServiceAutoConfigure {

@Autowired

private HelloServiceProperties helloServiceProperties;

@Bean

public HelloService helloService() {

HelloService helloService = new HelloService();

helloService.setHelloServiceProperties(helloServiceProperties);

bIGpGHreturn helloService;

}

}

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

public class StarterTestController {

@Autowired

private HelloService helloService;

@GetMapping("hello")

public String hello(String name) {

return helloService.helloService(name);

}

}

3.2 编写配置文件

server.port=8888

com.ander.prefix=HI

com.ander.suffix=HELLO WORLD

四、测试结果

4.1 使用starter默认配置

4.2 使用自定义配置

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。