结合具体实例讲解SpringFactories机制。问题引入未注入报错昨天开发项目时有两个独立的Module我需要在Module A中调用Module B的方法Slf4j SpringBootTest(classes Application.class) RunWith(SpringJUnit4ClassRunner.class) public class AlertMsgTest { // Module B的类 Autowired private AlarmMsgMqConsumer alarmMsgMqConsumer; Test public void testLoad() throws MQClientException { alarmMsgMqConsumer.init(); return; } }调用过程中提示报错我们看看AlarmMsgMqConsumer类Component public class AlarmMsgMqConsumer { }可以发现报错的原因是因为Module A没有将AlarmMsgMqConsumer加入到Spring Bean中那么我们直接在Module A中通过ComponentScan去加载Module B的类么这样其实不能实现解耦这时可以引入spring.factories。自动加载为了能让Module B中的Bean能提前注入到Spring中我们新增类Configuration ComponentScan(basePackages com.mi.info.sales.middle.alarm) public class AlertAutoConfig { }其中“com.mi.info.sales.middle.alarm”就是Module B的路径那怎样将这文件能自动启动呢我们再新增一个spring.factories文件org.springframework.boot.autoconfigure.EnableAutoConfiguration\ com.mi.info.sales.middle.alarm.AlertAutoConfig通过spring.factories将AlertAutoConfig配置进去可以实现自动加载的功能下面是项目目录结构SpringFactories机制Spring Boot中有一种非常解耦的扩展机制Spring Factories。这种扩展机制实际上是仿照Java中的SPI扩展机制来实现的。什么是 SPI机制SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java SPI机制的思想。我们系统里抽象的各个模块往往有很多不同的实现方案比如日志模块的方案xml解析模块、jdbc模块的方案等。面向的对象的设计里我们一般推荐模块之间基于接口编程模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类就违反了可拔插的原则如果需要替换一种实现就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明这就需要一种服务发现机制。java SPI就是提供这样的一个机制为某个接口寻找服务实现的机制。有点类似IOC的思想就是将装配的控制权移到程序之外在模块化设计中这个机制尤其重要。Spring Boot中的SPI机制在Spring中也有一种类似与Java SPI的加载机制。它在META-INF/spring.factories文件中配置接口的实现类名称然后在程序中读取这些配置文件并实例化。这种自定义的SPI机制是Spring Boot Starter实现的基础。在日常工作中我们可能需要实现一些SDK或者Spring Boot Starter给被人使用这个使用我们就可以使用Factories机制。Factories机制可以让SDK或者Starter的使用只需要很少或者不需要进行配置只需要在服务中引入我们的jar包。spring.factoriesspring.factories的是通过Properties解析得到的所以我们在写文件中的内容都是按照下面这种方式配置的com.xxx.interfacecom.xxx.classname比如spring-boot包中的spring.factories文件# PropertySource Loaders org.springframework.boot.env.PropertySourceLoader\ org.springframework.boot.env.PropertiesPropertySourceLoader,\ org.springframework.boot.env.YamlPropertySourceLoader # Run Listeners org.springframework.boot.SpringApplicationRunListener\ org.springframework.boot.context.event.EventPublishingRunListener # Error Reporters org.springframework.boot.SpringBootExceptionReporter\ org.springframework.boot.diagnostics.FailureAnalyzers # Application Context Initializers org.springframework.context.ApplicationContextInitializer\ org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\ org.springframework.boot.context.ContextIdApplicationContextInitializer,\ org.springframework.boot.context.config.DelegatingApplicationContextInitializer,\ org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer # 省略...SpringFactoriesLoader在这个类中主要的方法loadFactories根据接口类获取其实现类的实例这个方法返回的是对象列表。public static T ListT loadFactories(ClassT factoryClass, Nullable ClassLoader classLoader) { Assert.notNull(factoryClass, factoryClass must not be null); ClassLoader classLoaderToUse classLoader; if (classLoaderToUse null) { classLoaderToUse SpringFactoriesLoader.class.getClassLoader(); } // 调用loadFactoryNames获取接口的实现类 ListString factoryNames loadFactoryNames(factoryClass, classLoaderToUse); if (logger.isTraceEnabled()) { logger.trace(Loaded [ factoryClass.getName() ] names: factoryNames); } // 遍历 factoryNames 数组创建实现类的对象 ListT result new ArrayList(factoryNames.size()); for (String factoryName : factoryNames) { result.add(instantiateFactory(factoryName, factoryClass, classLoaderToUse)); } // 排序 AnnotationAwareOrderComparator.sort(result); return result; }loadFactoryNames根据接口获取其接口类的名称这个方法返回的是类名的列表。public static ListString loadFactoryNames(Class? factoryClass, ClassLoader classLoader) { String factoryClassName factoryClass.getName(); try { EnumerationURL urls (classLoader ! null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION)); ListString result new ArrayListString(); while (urls.hasMoreElements()) { URL url urls.nextElement(); Properties properties PropertiesLoaderUtils.loadProperties(new UrlResource(url)); String factoryClassNames properties.getProperty(factoryClassName); result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames))); } return result; } catch (IOException ex) { throw new IllegalArgumentException(Unable to load [ factoryClass.getName() ] factories from location [ FACTORIES_RESOURCE_LOCATION ], ex); } }instantiateFactory根据类创建实例对象。private static T T instantiateFactory(String instanceClassName, ClassT factoryClass, ClassLoader classLoader) { try { Class? instanceClass ClassUtils.forName(instanceClassName, classLoader); // 是否实现了指定接口 if (!factoryClass.isAssignableFrom(instanceClass)) { throw new IllegalArgumentException(Class [ instanceClassName ] is not assignable to [ factoryClass.getName() ]); } // 创建对象 return (T) ReflectionUtils.accessibleConstructor(instanceClass).newInstance(); } catch (Throwable ex) { throw new IllegalArgumentException(Unable to instantiate factory class: factoryClass.getName(), ex); }
