栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

自定义springboot-starter

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

自定义springboot-starter

自定义starter
  • 自动配置
  • 自动配置总结
  • 开发starter
  • 使用starter

自动配置
自动配置,就是无须手动配置xml,自动配置并管理bean,可以简化开发过程。那么Spring Boot是如何完成自动配置的呢?

自动配置涉及到如下几个关键步骤:

  • 基于Java代码的Bean配置
**@Configuration**和**@Bean**这两个注解一起使用就可以创建一个基于java代码的配置类,可以用来替代传统的xml配置文件。

**@Configuration** 注解的类可以看作是能生产让Spring IoC容器管理的Bean实例的工厂。

**@Bean** 注解的方法返回的对象可以被注册到spring容器中。
  • 自动配置条件依赖
注解功能说明
@ConditionalOnBean仅在当前上下文中存在某个bean时,才会实例化这个Bean
@ConditionalOnClass某个class位于类路径上,才会实例化这个Bean
@ConditionalOnExpression当表达式为true的时候,才会实例化这个Bean
@ConditionalOnMissingBean仅在当前上下文中不存在某个bean时,才会实例化这个Bean
@ConditionalOnMissingClass某个class在类路径上不存在的时候,才会实例化这个Bean
@ConditionalOnNotWebApplication不是web应用时才会实例化这个Bean
@AutoConfigureAfter在某个bean完成自动配置后实例化这个bean
@AutoConfigureBefore在某个bean完成自动配置前实例化这个bean
  • Bean参数获取
@EnableConfigurationProperties 注解的作用是使@**ConfigurationProperties**注解生效。

类上加入了 ConfigurationProperties 注解,这个注解的作用就是把yml或者properties配置文件中的配置参数信息封装到@ConfigurationProperties注解标注的bean的相应属性上。
  • Bean的发现
@SpringBootApplication 注解 :
	@SpringBootConfiguration:作用就相当于@Configuration注解,被注解的类将成为一个bean配置类

	@ComponentScan:作用就是自动扫描并加载符合条件的组件,最终将这些bean加载到spring容器中

	@EnableAutoConfiguration:这个注解很重要,借助@Import的支持,收集和注册依赖包中相关的bean定义,注解引入了@Import这个注解。







@Import:导入需要自动配置的组件,此处为EnableAutoConfigurationImportSelector这个类
EnableAutoConfigurationImportSelector类源码如下:

EnableAutoConfigurationImportSelector继承了AutoConfigurationImportSelector类,继续跟踪AutoConfigurationImportSelector类源码:


AutoConfigurationImportSelector类的getCandidateConfigurations方法中的调用了SpringFactoriesLoader类的loadFactoryNames方法,继续跟踪源码:

SpringFactoriesLoader的loadFactoryNames静态方法可以从所有的jar包中读取META-INF/spring.factories文件,而自动配置的类就在这个文件中进行配置:

spring.factories文件内容如下:

这样Spring Boot就可以加载到MybatisAutoConfiguration这个配置类了。

  • Bean的加载
在Spring Boot应用中要让一个普通类交给Spring容器管理,通常有以下方法:

1、使用 @Configuration与@Bean 注解

2、使用@Controller @Service @Repository @Component 注解标注该类并且启用@ComponentScan自动扫描

3、使用@Import 方法

其中Spring Boot实现自动配置使用的是@Import注解这种方式,AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名,这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。
自动配置总结
我们可以将自动配置的关键几步以及相应的注解总结如下:

1、@Configuration与@Bean:基于Java代码的bean配置

2、@Conditional:设置自动配置条件依赖

3、@EnableConfigurationProperties与@ConfigurationProperties:读取配置文件转换为bean

4、@EnableAutoConfiguration与@Import:实现bean发现与加载
开发starter
  1. 创建starter工程hello-spring-boot-starter并配置pom.xml文件


    
        org.springframework.boot
        spring-boot-starter-parent
        2.2.2.RELEASE
        
    
    4.0.0
    com.zhou
    hello-spring-boot-starter
    1.0-SNAPSHOT

    
        8
        8
    
    
        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-autoconfigure
        
    


  1. 创建配置属性类HelloProperties
package com.zhou.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

// Bean参数获取,读取配置文件前缀为 hello
@ConfigurationProperties(prefix = "hello")
public class HelloProperties {
    private String name;
    private String address;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "HelloProperties{" +
                "name='" + name + ''' +
                ", address='" + address + ''' +
                '}';
    }
}

  1. 创建服务类HelloService
package com.zhou.service;

public class HelloService {
		// 名称
    private String name;
    		// 地址
    private String address;

    public HelloService(String name, String address) {
        this.name = name;
        this.address = address;
    }

    public String sayHello() {
        return "名称:" + name + ",地址:" + address;
    }

}

  1. 创建自动配置类HelloServiceAutoConfiguration
package com.zhou.config;

import com.zhou.service.HelloService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
//  使@ConfigurationProperties注解生效。
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {
    private HelloProperties helloProperties;
    
     //通过构造方法注入配置属性对象HelloProperties
    public HelloServiceAutoConfiguration(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    @ConditionalOnMissingBean  //  仅当没有满足指定要求的 bean 时才匹配
    @Bean
    public HelloService helloService() {
        return new HelloService(helloProperties.getName(), helloProperties.getAddress());
    }
}

注意: 开发starter 需要 install, 这样操作后开发starter 会加载到本地仓库,为使用starter 打下基础

使用starter
  1. 创建maven工程myapp并配置pom.xml文件


    4.0.0

    org.example
    my-app
    1.0-SNAPSHOT
    
        org.springframework.boot
        spring-boot-starter-parent
        2.2.2.RELEASE
        
    
    
        8
        8
    
    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
        
            com.zhou
            hello-spring-boot-starter
            1.0-SNAPSHOT
        
    


  1. 创建application.yml文件
server:
  port: 8080
hello:
  name: 故宫
  address: 北京
  1. 创建HelloController
package com.zhou.Controller;

import com.zhou.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/hello")
public class HelloController {
    //HelloService在我们自定义的starter中已经完成了自动配置,所以此处可以直接注入
    @Autowired
    private HelloService helloService;

    @GetMapping("/say")
    public String sayHello() {
        return helloService.sayHello();
    }
}
  1. 创建启动类HelloApplication
package com.zhou;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class HelloApplication {
    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.class,args);
    }
}
  1. 执行启动类main方法: 访问地址

参考黑马b站教程

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/957200.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号