spring boot 自定义starter

最新推荐文章于 2023-10-25 22:18:54 发布
最新推荐文章于 2023-10-25 22:18:54 发布
阅读量219 收藏
点赞数
分类专栏： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xixingzhe2/article/details/84070807
版权

 spring boot提供了一系列的starter pom来简化maven的依赖加载，例如spring-boot-starter-web、spring-boot-starter-test等。

    在我们定制自己的starter前先了解一下必须知道的概念。

1、@Enable*注释

    @Enable*注释并不是新发明的注释，早在Spring 3框架就引入了这些注释，用这些注释替代XML配置文件。很多Spring开发者都知道@EnableTransactionManagement注释，它能够声明事务管理；@EnableWebMvc注释，它能启用Spring MVC；以及@EnableScheduling注释，它可以初始化一个调度器。 这些注释事实上都是简单的配置，通过@Import注释导入。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({ EnableAutoConfigurationImportSelector.class,
        AutoConfigurationPackages.Registrar.class })
public @interface EnableAutoConfiguration {

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     */
    Class<?>[] exclude() default {};

}

  EnableAutoConfigurationImportSelector类使用了Spring Core包的SpringFactoriesLoader类的loadFactoryNamesof()方法。

    SpringFactoriesLoader会查询META-INF/spring.factories文件中包含的JAR文件。 


    当找到spring.factories文件后，SpringFactoriesLoader将查询配置文件命名的属性。在例子中，是org.springframework.boot.autoconfigure.EnableAutoConfiguration。 


    让我们来看看spring-boot-autoconfigure JAR文件，它真的包含了一个spring.factories文件，内容如下：

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JmsTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.mobile.DeviceResolverAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,\
org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.web.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration

    在这个文件中，可以看到一系列Spring Boot自动配置的列表。下面我们来看这些配置的细节，以MongoAutoConfiguration为例：

@Configuration
@ConditionalOnClass(Mongo.class)
@EnableConfigurationProperties(MongoProperties.class)
public class MongoAutoConfiguration {

    @Autowired
    private MongoProperties properties;

    private Mongo mongo;

    @PreDestroy
    public void close() throws UnknownHostException {
        if (this.mongo != null) {
            this.mongo.close();
        }
    }

    @Bean
    @ConditionalOnMissingBean
    public Mongo mongo() throws UnknownHostException {
        this.mongo = this.properties.createMongoClient();
        return this.mongo;
    }

}

    这个类进行了简单的Spring配置，声明了MongoDB所需典型Bean。 
    这个类跟其它很多类一样，重度依赖于Spring Boot注释： 

  • @ConditionOnClass激活一个配置，在类路径中只能存在一到几个这样的类。 
  • @EnableConfigurationProperties自动映射一个POJO到Spring Boot配置文件（默认是application.properties文件）的属性集。 
  • @ConditionalOnMissingBean启用一个Bean定义，但必须是这个Bean之前未定义过才有效。 
    还可以使用@ AutoConfigureBefore注释、@AutoConfigureAfter注释来定义这些配置类的载入顺序。

2、@Conditional注释

    Spring Boot的强大之处在于使用了Spring 4框架的新特性：@Conditional注释，此注释使得只有在特定条件满足时才启用一些配置。 
    在Spring Boot的org.springframework.boot.autoconfigure.condition包中说明了使用@Conditional注释能给我们带来什么，下面对这些注释做一个概述：

  • @ConditionalOnBean
  • @ConditionalOnClass
  • @ConditionalOnExpression
  • @ConditionalOnMissingBean
  • @ConditionalOnMissingClass
  • @ConditionalOnNotWebApplication
  • @ConditionalOnResource
  • @ConditionalOnWebApplication

    以@ConditionalOnExpression注释为例，它允许在Spring的EL表达式中写一个条件。

@Conditional(OnExpressionCondition.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface ConditionalOnExpression {

    /**
     * The SpEL expression to evaluate. Expression should return {@code true} if the
     * condition passes or {@code false} if it fails.
     */
    String value() default "true";

}

在这个类中，我们想利用@Conditional注释，条件在OnExpressionCondition类中定义：

public class OnExpressionCondition extends SpringBootCondition {

    @Override
    public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // ...
        // we first get a handle on the EL context via the ConditionContext

        boolean result = (Boolean) resolver.evaluate(expression, expressionContext);

        // ...
        // here we create a message the user will see when debugging

        return new ConditionOutcome(result, message.toString());
    }
}

在最后，@Conditional通过简单的布尔表达式（即ConditionOutcome方法）来决定。

 

3、应用程序上下文初始化器

    spring.factories还提供了第二种可能性，即定义应用程序的初始化。这使得我们可以在应用程序载入前操纵Spring的应用程序上下文ApplicationContext。 
  特别是，可以在上下文创建监听器，使用ConfigurableApplicationContext类的addApplicationListener()方法。 
    AutoConfigurationReportLoggingInitializer监听到系统事件时，比如上下文刷新或应用程序启动故障之类的事件，Spring Boot可以执行一些工作。这有助于我们以调试模式启动应用程序时创建自动配置的报告。 
    要以调试模式启动应用程序，可以使用-Ddebug标识，或者在application.properties文件这添加属性debug= true。

4、调试Spring Boot自动配置

 Spring Boot的官方文档（http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-troubleshoot-auto-configuration）有助于理解自动配置期间发生了什么。当以调试模式运行时，Spring Boot会产生一个报告，如下：

Positive matches:
-----------------

   MessageSourceAutoConfiguration
      - @ConditionalOnMissingBean (types: org.springframework.context.MessageSource; SearchStrategy: all) found no beans (OnBeanCondition)

   JmxAutoConfiguration
      - @ConditionalOnClass classes found: org.springframework.jmx.export.MBeanExporter (OnClassCondition)
      - SpEL expression on org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration: ${spring.jmx.enabled:true} (OnExpressionCondition)
      - @ConditionalOnMissingBean (types: org.springframework.jmx.export.MBeanExporter; SearchStrategy: all) found no beans (OnBeanCondition)

   DispatcherServletAutoConfiguration
      - found web application StandardServletEnvironment (OnWebApplicationCondition)
      - @ConditionalOnClass classes found: org.springframework.web.servlet.DispatcherServlet (OnClassCondition)


Negative matches:
-----------------

   DataSourceAutoConfiguration
      - required @ConditionalOnClass classes not found: org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType (OnClassCondition)

   DataSourceTransactionManagerAutoConfiguration
      - required @ConditionalOnClass classes not found: org.springframework.jdbc.core.JdbcTemplate,org.springframework.transaction.PlatformTransactionManager (OnClassCondition)

   MongoAutoConfiguration
      - required @ConditionalOnClass classes not found: com.mongodb.Mongo (OnClassCondition)

   FallbackWebSecurityAutoConfiguration
      - SpEL expression on org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration: !${security.basic.enabled:true} (OnExpressionCondition)

   SecurityAutoConfiguration
      - required @ConditionalOnClass classes not found: org.springframework.security.authentication.AuthenticationManager (OnClassCondition)

   EmbeddedServletContainerAutoConfiguration.EmbeddedJetty
      - required @ConditionalOnClass classes not found: org.eclipse.jetty.server.Server,org.eclipse.jetty.util.Loader (OnClassCondition)

   WebMvcAutoConfiguration.WebMvcAutoConfigurationAdapter#localeResolver
      - @ConditionalOnMissingBean (types: org.springframework.web.servlet.LocaleResolver; SearchStrategy: all) found no beans (OnBeanCondition)
      - SpEL expression: '${spring.mvc.locale:}' != '' (OnExpressionCondition)

   WebSocketAutoConfiguration
      - required @ConditionalOnClass classes not found: org.springframework.web.socket.WebSocketHandler,org.apache.tomcat.websocket.server.WsSci (OnClassCondition)

    对于每个自动配置，可以看到它启动或失败的原因。

    Spring Boot通过配置信息指出：特定配置项被选中的原因、列出匹配到对应类的配置项（positive match）、不包括某个配置项的原因（negative match）。

-------------demo-----------

5、创建starter项目

5.1 创建一个enable注解

package com.aa.cloud.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @ClassName: EnableDemo 
 * @Description:  
 * @author weiyb 
 * @date 2017年9月20日 下午4:19:19 
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface EnableDemo {

}

5.2 服务类

package com.aa.cloud.service;

/**
 * @ClassName: UserService 
 * @Description:  
 * @author weiyb 
 * @date 2017年9月20日 下午4:08:51 
 */
public class DemoService {
	public void demoStarter() {
		System.out.println("hello world");
	}
}

5.3 自动配置类

package com.aa.cloud.auto.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.aa.cloud.annotation.EnableDemo;
import com.aa.cloud.service.DemoService;

/**
 * @ClassName: DemoAutoConfiguration 
 * @Description:  
 * @author weiyb 
 * @date 2017年9月20日 下午4:09:07 
 */
@Configuration
@ConditionalOnBean(annotation = EnableDemo.class)//条件判断，只有在使用了@EnableUser时，才会启动
public class DemoAutoConfiguration {
	@Bean
	public DemoService dbCountRunner() {
		return new DemoService();
	}
}

5.4 配置META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.aa.cloud.auto.config.DemoAutoConfiguration

6、创建demo starter test项目

6.1 启动类

package com.cloud;

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

import com.aa.cloud.annotation.EnableDemo;

/**
 * @ClassName: ProviderApplication 
 * @Description:  
 * @author weiyb 
 * @date 2017年9月20日 下午4:08:42 
 */
@SpringBootApplication
@EnableDemo
public class ProviderApplication {
	public static void main(String[] args) {
		SpringApplication.run(ProviderApplication.class, args);
	}
}

6.2 测试类

package com.demo.starter.test;

import javax.annotation.Resource;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import com.aa.cloud.service.DemoService;
import com.cloud.ProviderApplication;

/**
 * @ClassName: DemoServiceTest 
 * @Description:  
 * @author weiyb 
 * @date 2017年9月20日 下午4:08:35 
 */
@RunWith(value = SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = ProviderApplication.class)
public class DemoServiceTest {

	@Resource
	private DemoService userService;

	@Test
	public void demoStarter() {
		userService.demoStarter();
	}
}
xixingzhe2
关注
专栏目录
SpringBoot核心运行原理解析之-------@EnableAutoConfiguration
qq_41934990的博客
05-16 4403
下面通过一张图来从整体了解AutoConfigurationImportSelector的核心功能及流程，然后再对照源码看具体的功能实现。当AutoConfigurationImportSelector被@Import注解引入之后，它的selectImports方法会被调用并执行其实现的自动装配逻辑。selectImports方法涵盖了组件自动装配的所有的处理逻辑。if(!if(!
Spring Boot自定义starter
洛卡JAVA架构师每日分享Java架构师知识
06-06 505
starter 是 SpringBoot 中一种非常重要的机制，它可以繁杂的配置统一集成到 starter 中，我们只需要通过 maven 将 starter 依赖引入到项目中，SpringBoot 就能自动扫描并加载相应的默认配置。starter 的出现让开发人员从繁琐的框架配置中解放出来，将更多的精力专注于业务逻辑的开发，极大的提高了开发效率。 在一些特殊情况下，我们也可以将一些通用功能封装成自定义的 starter 进行使用，本节我们将为您详细介绍如何自定义 starter。 命名规范 SpringB
理解Spring Boot
热门推荐
chszs的专栏
02-16 4万+
理解Spring Boot作者：chszs，未经博主允许不得转载。经许可的转载需注明作者和博客主页：http://blog.csdn.net/chszsSpring Boot是一个偏执的开源框架，它可用于创建可执行的Spring应用程序，采用了习惯优于配置的方法。 此框架的神奇之处在于@EnableAutoConfiguration注释，此注释自动载入应用程序所需的所有Bean——这依赖于Spri
@EnableAutoConfiguration
lqbz的总结
11-14 563
在引导类的@SpringBootApplication下有@EnableAutoConfiguration 继续查看有@Import导入自动配置AutoConfigurationImportSelector 继续查看下面类的selectImports方法，返回字符串数组，在数组中定义了很多需要被加载的类。 重点查看getAutoConfigurationEntry方法中的getCandidateConfigurations方法。此方法返回一个list集合，集合中都是configurations。
SpringBoot 自动配置@EnableAutoConfiguration
weixin_44612246的博客
10-25 726
SpringBoot自动配置 @EnableAutoConfiguration
springboot @EnableAutoConfiguration自动配置超详解
mayfly_hml的博客
11-26 2006
springboot相关逻辑 1. main启动类 首先就是springboot项目习以为常的main方法调用SpringApplication.run将标注有@SpringBootApplication注解的class对象作为参数传递。SpringBootApplication注解是个组合注解，主要组合了@Configuration，@EnableAutoConfiguration,@Import(AutoConfigurationImportSelector.class)， @ComponentScan
Java spi学习与Spring Boot自定义starter、开箱即用starter
最新发布
07-30
Java spi学习与Spring Boot自定义starter、开箱即用starter
Spring Boot 自定义starter启动器(demo).zip
04-05
Spring Boot 自定义starter启动器 Demo 部分，用于记录使用。该demo 配套教程 https://blog.csdn.net/lzb348110175/article/details/105330274。
自动配置@EnableAutoConfiguration
joy_tom的博客
07-08 4408
在spring中有很多Enable开头的注解，作用就是@Import来收集并注册特定的场景相关的bean，并且加入到IOC容器。 @EnableAutoConfiguration就是借助@Import来收集所有符合自动配置条件的bean定义，并加载到IOC容器中。 在这里可能会好奇的是为什么@SpringBootApplication必须跟业务包放在同一级路劲上，这里需要了解的一个注解是：@AutoConfigurationPackage 在Registrar.class类中 .
Springboot启动源码详解
刘建平Pinard的博客
03-13 1594
我们开发任何一个Spring Boot项目，都会用到如下的启动类 @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }
SpringBoot 源码阅读（4）：@EnableAutoConfiguration
qq_42323598的博客
07-27 309
@EnableAutoConfiguration 该注解用于自动配置，而自动配置是大部分人使用SpringBoot开发的主要原因。 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @AutoConfigurationPackage @Import(AutoConfigurationImportSelector.class) public @interface EnableAutoConf
总结：Spring boot之@EnableAutoConfiguration
w2009211777的专栏
01-20 1万+
一、@EnableAutoConfiguration的作用 简单点说就是Spring Boot根据依赖中的jar包，自动选择实例化某些配置，配置类必须有@Configuration注解。 说白了，还是实例化对象，只是实例化的是非main类之外的包。 另外，我们也可以按照自动装配的规范自己定义装配的类。 二、@EnableAutoConfiguration和@Configuration的区别 @Configuration：表示作用的类是个配置类。我们平时也会写配置类，比如我们系统中的Data..
SpringBoot2.x @EnableAutoConfiguration 以及自定义Starter
小白鼠丶
09-17 438
参考博客SpringBoot2.x @EnableAutoConfiguration解析 @EnableAutoConfiguration 当项目启动时如果某个类存在就自动配置这个Bean @EnableAutoConfiguration 是自定义Starter 的基础 自定义starter 就是把许多项目共用的抽出来放到一个项目里 打成jar包 放到maven远程仓库供所有...
EnableAutoConfiguration自动配置使用
zhglhy的专栏
02-18 669
EnableAutoConfiguration 自动配置
Spring Boot 自定义Starter实战教程
创建Spring Boot自定义starter是通过组合依赖、配置类和`spring.factories`文件来实现的，它能帮助开发者快速集成和使用特定功能，降低项目的复杂性。这个过程需要理解Spring Boot的自动配置机制，以及如何编写可被...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值