乐趣区

自定义Stater

### 2.3 自定义 Stater

**SpringBoot starter 机制 **

​ SpringBoot 由众多 Starter 组成(一系列的自动化配置的 starter 插件),SpringBoot 之所以流行,也是因为 starter。

starter 是 SpringBoot 非常重要的一部分,可以理解为一个可拔插式的插件,正是这些 starter 使得使用某个功能的开发者不需要关注各种依赖库的处理,不需要具体的配置信息,由 Spring Boot 自动通过 classpath 路径下的类发现需要的 Bean,并织入相应的 Bean。

例如,你想使用 Reids 插件,那么可以使用 spring-boot-starter-redis;如果想使用 MongoDB,可以使用 spring-boot-starter-data-mongodb

** 为什么要自定义 starter**

开发过程中,经常会有一些独立于业务之外的配置模块。如果我们将这些可独立于业务代码之外的功能配置模块封装成一个个 starter,复用的时候只需要将其在 pom 中引用依赖即可,SpringBoot 为我们完成自动装配

** 自定义 starter 的命名规则 **

SpringBoot 提供的 starter 以 `spring-boot-starter-xxx` 的方式命名的。官方建议自定义的 starter 使用 `xxx-spring-boot-starter` 命名规则。以区分 SpringBoot 生态提供的 starter

整个过程分为两部分:

– 自定义 starter

– 使用 starter

首先,先完成自定义 starter

(1)新建 maven jar 工程,工程名为 zdy-spring-boot-starter,导入依赖:

“`xml

<dependencies>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-autoconfigure</artifactId>

<version>2.2.2.RELEASE</version>

</dependency>

</dependencies>

“`

(2)编写 javaBean

“`java

@EnableConfigurationProperties(SimpleBean.class)

@ConfigurationProperties(prefix = “simplebean”)

public class SimpleBean {

private int id;

private String name;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

@Override

public String toString() {

return “SimpleBean{” +

“id=” + id +

“, name='” + name + ‘\” +

‘}’;

}

}

“`

(3)编写配置类 MyAutoConfiguration

“`java

@Configuration

@ConditionalOnClass //@ConditionalOnClass:当类路径 classpath 下有指定的类的情况下进行自动配置

public class MyAutoConfiguration {

static {

System.out.println(“MyAutoConfiguration init….”);

}

@Bean

public SimpleBean simpleBean(){

return new SimpleBean();

}

}

“`

(4)resources 下创建 /META-INF/spring.factories

注意:META-INF 是自己手动创建的目录,spring.factories 也是手动创建的文件, 在该文件中配置自己的自动配置类

<img src=”./images/image-20200111123116471.png” alt=”image-20200111123116471″ style=”zoom:67%;” />

“`factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

com.lagou.config.MyAutoConfiguration

“`

使用自定义 starter

(1)导入自定义 starter 的依赖

“`xml

<dependency>

<groupId>com.lagou</groupId>

<artifactId>zdy-spring-boot-starter</artifactId>

<version>1.0-SNAPSHOT</version>

</dependency>

“`

(2)在全局配置文件中配置属性值

“`properties

simplebean.id=1

simplebean.name= 自定义 starter

“`

(3)编写测试方法

“`java

// 测试自定义 starter

@Autowired

private SimpleBean simpleBean;

@Test

public void zdyStarterTest(){

System.out.println(simpleBean);

退出移动版