Spring AutoConfiguration解密[译]

本文是<code>http://sivalabs.in/2016/03/how-springboot-autoconfiguration-magic/</code>的翻译。

我们知道springboot的应用可以以非常简洁的代码去做很多的事情, 可以自动帮你注入数据库的bean，消息队列的bean等等等等，那么springboot是怎么做到的呢？

但是在探索springboot的神秘之前，我们先了解一下spring的<code>@conditional</code>注解，这是springboot的<code>autoconfiguration</code>的神奇之处所依赖的底层机制。

我们开发spring应用的时候有时候会碰到要<code>根据外界条件注册不同bean</code>的情况。

比如如果你的应用是跑在本地机器的话，你会想要让你的<code>datasource</code> bean指向一个本地的数据库，而如果是跑在线上机器的话，你会想让<code>datasource</code> bean指向一个生产的数据库。

你可以把这些数据库连接信息抽取到几个不同的配置文件里面去，然后在不同的环境下使用不同的配置文件。但是当你的应用被部署到新的环境下的时候，你还是要添加新的配置文件，并且重新打包。(译者注:这里其实只要把配置文件抽取到代码之外不就好了么?不知道原作者在想什么)

为了解决这个问题，spring 3.1引入了<code>profiles</code>的概念。你可以注册同一个类型bean的不同实例，然后把这些不同的实例绑定到不同的<code>profile</code>, 当你运行这个spring应用的时候，你可以指定你要激活的<code>profile</code>, 这样只有跟这些被激活的<code>profile</code>相关联的bean才会被注册:

然后你可以通过系统属性指定激活的profile:

这种方式对于你要基于profile来决定是否注册一个bean的情况工作得很好。但是如果你要基于一些条件性的判断逻辑来决定是否注册一个bean的话，那么光靠profile是不行的。

为了给条件性地注册bean提供更高的灵活性，spring 4提供了<code>@conditional</code>的概念。通过使用<code>@conditional</code>你可以基于任何条件来决定是否注册一个bean。

你的<code>条件</code>可能是这样的:

classpath里面有一个特定的class

applicationcontext里面有一个特定类型的bean

在指定的位置有指定的文件

配置文件里面有指定的配置项

系统属性里面配置了指定的属性

这些只是我能想到的一些，实际上你可以基于<code>任何</code>条件。下面让我们来看看spring的<code>@conditional</code>到底是如何工作的。我们先设定一个场景:

我们有一个<code>userdao</code>接口用来从数据库里面获取数据。这个接口我们有两个实现: <code>jdbcuserdao</code>从<code>mysql</code>数据库里面获取数据；<code>mongouserdao</code>从<code>mongodb</code>里面获取数据。

我们想通过一个名为<code>dbtype</code>的系统属性来决定到底使用<code>jdbcuserdao</code>还是<code>mongouserdao</code>。期望的效果是，如果通过<code>java -jar myapp.jar -ddbtype=mysql</code>那么使用的是<code>jdbcuserdao</code>, 如果通过<code>java -jar myapp.jar -ddbtype=mongo</code>启动，这使用<code>mongouserdao</code>。几个类的实现是这样的:

我们可以实现这样的一个<code>mysqldatabasetypecondition</code>来检测系统属性<code>dbtype</code>是否是<code>mysql</code>:

类似的<code>mongodbdatabasetypecondition</code>:

现在我们就可以通过<code>@conditional</code>来判断使用<code>jdbcuserdao</code>还是<code>mongouserdao</code>:

类似地我们可以通过判断classpath里面是否有<code>com.mongodb.server</code>这个driver类来决定是使用<code>mongouserdao</code>还是<code>jdbcuserdao</code>:

如果我们只在容器里面没有任何类型的<code>userdao</code>的bean的时候才注册<code>mongouserdao</code>。我们通过创建一个condition来检测是否存在一个指定类型的bean:

如果想通过配置文件里面的配置来决定dao类型呢?

我们已经试了通过各种不同条件来实现<code>condition</code>。但是其实有更优雅的、通过注解来实现condition的方式。我们不再为<code>mysql</code>和<code>mongodb</code>实现各自<code>condition</code>, 我们可以实现下面这样一个<code>databasetype</code>注解:

然后我们实现<code>databasetypecondition</code>来使用这个注解来判断dao的类型了:

现在我们就可以在我们的bean上使用<code>databasetype</code>注解了:

这里我们从<code>databasetype</code>注解里面获取元数据，并且把获取的值跟系统属性里面的<code>dbtype</code>进行对比来决定是否激活bean。

我们已经看了很多例子来看<code>@conditional</code>注解的作用。springboot大量的使用<code>@conditional</code>来实现基于条件的注册bean。你可以在<code>spring-boot-autoconfigure-{version}.jar</code> 的 <code>org.springframework.boot.autoconfigure</code> 包里面看到springboot使用的大量的<code>condition</code>的实现。

那么我们已经知道了springboot使用<code>@conditional</code>来决定是否初始化一个bean, 但是是什么机制触发了<code>auto-configuration</code>机制呢？ 我们下一节来聊聊这个事情:

springboot的自动配置的关键在于<code>@enableautoconfiguration</code>这个注解。一般来说我们把我们程序的入口类加上<code>@springbootapplication</code>注解，或者如果我们想要更加细致的定制这些默认值的话:

<code>@enableautoconfiguration</code>注解通过扫描classpath里面所有的组件，然后基于条件来决定是否注册bean来使得spring的applicationcontext自动配置。

springboot在<code>spring-boot-autoconfigure-{version}.jar</code>里面提供了很多<code>autoconfiguration</code>的类来负责注册各种不同的组件。

一般来说<code>autoconfiguration</code>类上面会标上<code>@configuration</code>注解来标明它是一个spring的配置类，标上<code>@enableconfigurationproperties</code>来绑定自定义的配置值，并且会在一到多个方法上标上<code>@conditional</code>注解来标记注册方法。

比如我们来看看<code>org.springframework.boot.autoconfigure.jdbc.datasourceautoconfiguration</code>:

这里<code>datasourceautoconfiguration</code>上标记了一个<code>@conditionalonclass({ datasource.class,embeddeddatabasetype.class })</code>, 这样只有当classpath上有<code>datasource.class</code>和<code>embeddeddatabasetype.class</code>的时候，<code>datasourceautoconfiguration</code> 才会生效。

这个类还被<code>@enableconfigurationproperties(datasourceproperties.class)</code>标记了，这样<code>application.properties</code>里面相关的配置值会自动绑定到<code>datasourceproperties</code>上面。

有了这个配置属性类，所有<code>spring.datasource.*</code>的配置都会自动绑定到<code>datasourceproperties</code>:

你还能看到一些内部类以及bean的定义方法被springboot的<code>@conditionalonmissingbean</code>, <code>@conditiononclass</code>, <code>@conditionalonproperty</code>等等标记。

这些bean的定义只有在那些条件满足的时候才会注册。

在<code>spring-boot-autoconfigure-{version}.jar</code>里面你还能看到其它的<code>autoconfiguration</code>类:

<code>org.springframework.boot.autoconfigure.web.dispatcherservletautoconfiguration</code>

<code>org.springframework.boot.autoconfigure.orm.jpa.hibernatejpaautoconfiguration</code>

<code>org.springframework.boot.autoconfigure.data.jpa.jparepositoriesautoconfiguration</code>

<code>org.springframework.boot.autoconfigure.jackson.jacksonautoconfiguration</code>

等等。我希望通过今天文章的介绍大家已经理解springboot是怎么做到自动配置bean的了。