手写一个springboot的starter

starter 自动注入组件,为用户省去组件引入、配置类、jar包冲突解决。starter一般都包含2个类:ConfigurationProperties和AutoConfiguration。

手写一个springboot的starter_第1张图片

命名规则

由于SpringBoot官方本身就提供了很多Starter,为了区别那些是官方的,哪些是第三方的,所以SpringBoot官方提出:

第三方提供的Starter统一用 xxx-spring-boot-starter

而官方提供的Starter统一用 spring-boot-starter-xxx

手写starter

项目目录

手写一个springboot的starter_第2张图片

1、pom.xml



    4.0.0

    org.example
    yzh-spring-boot-starter
    1.0-SNAPSHOT

    
        8
        8
        1.8
        2.4.6
    

    
        
        
            org.springframework.boot
            spring-boot-configuration-processor
            
            true
            ${spring-boot.version}
        

        
            org.springframework.boot
            spring-boot-autoconfigure
            ${spring-boot.version}
        

        
            org.projectlombok
            lombok
            1.18.20
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

2、属性配置类

@ConfigurationProperties(prefix = "yzh.hello")
@Data
public class HelloProperties {

    private String name = "default";

}

3、业务执行类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class HelloStarter {

    private HelloProperties helloProperties;

    public String hello() {
        return "welcome " + helloProperties.getName() + "!";
    }

}

4、自动装配类

@ConditionalOnClass(HelloStarter.class)
@EnableConfigurationProperties(HelloProperties.class)
@Configuration
public class HelloAutoConfiguration {

    @Bean
    public HelloStarter helloStarter(HelloProperties helloProperties) {
        return new HelloStarter(helloProperties);
    }

}

5、自动装配类被springboot识别的配置文件

在resource目录下,新建一个META-INF文件夹,在META-INF文件夹下新建一个spring.factories文件。

#声明配置类的全路径
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.yang.HelloAutoConfiguration

  

6、使用 mvn install 打包

手写一个springboot的starter_第3张图片 

7、其它项目引入使用

引入:

        
            org.example
            yzh-spring-boot-starter
            1.0-SNAPSHOT
        

 application.properties中的配置:

yzh.hello.name=gouwa

代码: 

@RestController
@RequestMapping("/starter")
@Slf4j
public class StarterController {

    @Resource
    private HelloStarter helloStarter;

    @GetMapping("/index")
    public String index() {
        return helloStarter.hello();
    }
}

 启动后,访问:http://localhost:8080/starter/index

手写一个springboot的starter_第4张图片

项目GitHub地址:https://github.com/zihea/yzh-spring-boot-starter

你可能感兴趣的:(springboot,spring,boot,java,starter)