Spring Boot非常簡單容易上手,它隱藏了很多內容而不需要你去關心。但對於一個好的開發人員也許希望知道Spring Boot自動配置背後到底發生了什麼?
Spring Boot並不屬於一種新的技術,只不過Spring Boot的啓動器幫我們配置了若干個被Spring管理的bean,當我們的項目依賴這些jar並啓動Spring應用時,Spring的Container容器已經把jar包下的對象加以創建及管理了。
簡而言之,Spring Boot自動配置代表了一種基於類路徑上存在的依賴關係自動配置Spring應用程序的方法。還可以通過定義消除自動配置類中包含的某些bean。這些可以使開發更快更容易。
1. 通過啓動類創建Spring Boot應用
創建Spring Boot應用非常簡單,只要創建一個包含main的啓動類即可。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
@SpringBootApplication
public class App
{
public static void main(String[] args)
{
ApplicationContext ctx = SpringApplication.run(App.class, args);
}
}
上面這個類被稱爲Spring Boot應用的啓動類,它通過一個java的main()方法來引導和啓動一個Spring應用。它通常包含了以下內容:
- 創建一個Spring ApplicationContext實例。
- 接收命令行參數並將其轉爲Spring屬性。
- 按照配置加載所有Spring Bean。可以根據項目需求進行其他操作。
2. @SpringBootApplication註解
這個註解其實是一個應用了3個註解的快捷方式。
2.1 @SpringBootConfiguration
@SpringBootConfiguration是在Spring Boot2中出現的一個新的註解。之前我們都是使用的 @Configuration註解,可以用 @Configuration來替換它,2個都是實現同樣的功能。
它表示該類是一個配置類,應該對其進行掃描,以獲得進一步的配置和bean定義。
2.2 @EnableAutoConfiguration
此註解用於啓用Spring Application Context的自動配置,嘗試猜測和配置您可能需要的bean。自動配置類通常基於您的類路徑以及您定義的bean來應用。
自動配置嘗試儘可能智能,並在您定義更多自己的配置時進行後退。您始終可以使用兩種方法來手動排除任何您不想應用的配置:
- 使用excludeName()
- 使用spring.autoconfigure.exclude屬性文件中的屬性。
2.3 @ComponentScan
此註解提供了與Spring XML context:component-scan元素並行的支持。
無論是basePackageClasses()或basePackages()可以定義特定的軟件包進行掃描。如果未定義特定包,則將從聲明此註解的類的包進行掃描。
3.自定義自動配置
要創建自定義自動配置,我們需要創建一個註釋爲@Configuration的類並註冊它。
讓我們爲MySQL數據源創建自定義配置:
@Configuration
public class MySQLAutoconfiguration {
//...
}
下一個必須的步驟是通過在標準文件資源/ META-INF / spring.factories中的屬性org.springframework.boot.autoconfigure.EnableAutoConfiguration下添加類的名稱,將類註冊爲自動配置候選者:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.peterwanghao.samples.springboot.autoconfiguration.MySQLAutoconfiguration
如果我們希望我們的自動配置類優先於其他自動配置候選者,我們可以添加@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)註解。
自動配置是使用標有@Conditional註解的類和bean設計的,以便可以替換自動配置或其特定部分。
請注意,只有當應用程序中未定義自動配置的bean時,自動配置纔有效。如果您定義了bean,那麼將覆蓋默認值。
3.1 基於類的條件註解
Class conditions允許我們指定使用@ConditionalOnClass註解指定的類,或者使用@ConditionalOnMissingClass註解來指定不存在於 classpath 上的類。
讓我們指定只有存在類DataSource的情況下才會加載MySQLConfiguration,在這種情況下我們可以假設應用程序將使用數據庫:
@Configuration
@ConditionalOnClass(DataSource.class)
public class MySQLAutoconfiguration {
//...
}
3.2 基於Bean的條件註解
如果我們只想在指定的bean存在的情況下包含bean,我們可以使用@ConditionalOnBean和@ConditionalOnMissingBean註解。
舉例說明,讓我們將一個entityManagerFactory bean 添加到我們的配置類中,並指定如果存在一個名爲dataSource的bean 並且尚未定義一個名爲entityManagerFactory的 bean,我們就創建這個bean :
@Bean
@ConditionalOnBean(name = "dataSource")
@ConditionalOnMissingBean
public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
final LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
em.setDataSource(dataSource());
em.setPackagesToScan("com.peterwanghao.samples.springboot.autoconfiguration.example");
em.setJpaVendorAdapter(new HibernateJpaVendorAdapter());
if (additionalProperties() != null) {
em.setJpaProperties(additionalProperties());
}
return em;
}
讓我們配置一個只在尚未定義類型爲JpaTransactionManager的bean時纔會加載的transactionManager bean :
@Bean
@ConditionalOnMissingBean(type = "JpaTransactionManager")
JpaTransactionManager transactionManager(final EntityManagerFactory entityManagerFactory) {
final JpaTransactionManager transactionManager = new JpaTransactionManager();
transactionManager.setEntityManagerFactory(entityManagerFactory);
return transactionManager;
}
3.3 基於屬性的條件註解
@ConditionalOnProperty註解用於指定是否配置將基於Spring環境屬性的存在和值被加載。
首先,讓我們爲配置添加一個屬性源文件,以確定從哪裏讀取屬性:
@PropertySource("classpath:mysql.properties")
public class MySQLAutoconfiguration {
//...
}
我們可以配置主DataSource bean,它將用於創建與數據庫的連接,只有在存在名爲usemysql的屬性時纔會加載它。
我們可以使用屬性havingValue來指定必須匹配的usemysql屬性的某些值。
如果usemysql屬性設置爲local,讓我們使用默認值定義dataSource bean,該默認值連接到名爲myDb的本地數據庫:
@Bean
@ConditionalOnProperty(name = "usemysql", havingValue = "local")
@ConditionalOnMissingBean
public DataSource dataSource() {
final DriverManagerDataSource dataSource = new DriverManagerDataSource();
dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/myDb?createDatabaseIfNotExist=true&&serverTimezone=GMT%2B8");
dataSource.setUsername("root");
dataSource.setPassword("123456");
return dataSource;
}
如果usemysql屬性設置爲自定義,則數據源 bean將使用自定義屬性值的數據庫URL,用戶和密碼進行配置:
@Bean(name = "dataSource")
@ConditionalOnProperty(name = "usemysql", havingValue = "custom")
@ConditionalOnMissingBean
public DataSource dataSource2() {
final DriverManagerDataSource dataSource = new DriverManagerDataSource();
dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl(env.getProperty("mysql.url"));
dataSource.setUsername(env.getProperty("mysql.user") != null ? env.getProperty("mysql.user") : "");
dataSource.setPassword(env.getProperty("mysql.pass") != null ? env.getProperty("mysql.pass") : "");
return dataSource;
}
該mysql.properties文件將包含usemysql屬性:
usemysql=local
如果使用MySQLAutoconfiguration的應用程序希望覆蓋默認屬性,則它需要做的就是爲mysql.properties文件中的mysql.url,mysql.user和mysql.pass屬性添加不同的值以及添加usemysql = custom行。
3.4 基於資源的條件註解
添加@ConditionalOnResource註解意味着僅在存在指定資源時才加載配置。
讓我們定義一個名爲additionalProperties()的方法,該方法將返回一個Properties對象,該對象包含entityManagerFactory bean 使用的特定於Hibernate的屬性,僅當存在資源文件mysql.properties時:
@ConditionalOnResource(resources = "classpath:mysql.properties")
@Conditional(HibernateCondition.class)
final Properties additionalProperties() {
final Properties hibernateProperties = new Properties();
hibernateProperties.setProperty("hibernate.hbm2ddl.auto", env.getProperty("mysql-hibernate.hbm2ddl.auto"));
hibernateProperties.setProperty("hibernate.dialect", env.getProperty("mysql-hibernate.dialect"));
hibernateProperties.setProperty("hibernate.show_sql",
env.getProperty("mysql-hibernate.show_sql") != null ? env.getProperty("mysql-hibernate.show_sql")
: "false");
return hibernateProperties;
}
我們可以將Hibernate特定的屬性添加到mysql.properties文件中:
mysql-hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
mysql-hibernate.show_sql=true
mysql-hibernate.hbm2ddl.auto=create-drop
3.5 自定義條件
如果我們不想使用Spring Boot中的任何可用條件,我們還可以通過擴展SpringBootCondition類並重寫getMatchOutcome()方法來定義自定義條件。
讓我們爲additionalProperties()方法創建一個名爲HibernateCondition的條件,該方法將驗證類路徑上是否存在HibernateEntityManager類:
static class HibernateCondition extends SpringBootCondition {
private static final String[] CLASS_NAMES = { "org.hibernate.ejb.HibernateEntityManager",
"org.hibernate.jpa.HibernateEntityManager" };
@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
ConditionMessage.Builder message = ConditionMessage.forCondition("Hibernate");
return Arrays.stream(CLASS_NAMES)
.filter(className -> ClassUtils.isPresent(className, context.getClassLoader()))
.map(className -> ConditionOutcome.match(message.found("class").items(Style.NORMAL, className)))
.findAny().orElseGet(() -> ConditionOutcome.noMatch(
message.didNotFind("class", "classes").items(Style.NORMAL, Arrays.asList(CLASS_NAMES))));
}
}
然後我們可以將條件添加到additionalProperties()方法:
@Conditional(HibernateCondition.class)
Properties additionalProperties() {
//...
}
3.6 申請條件
我們還可以通過添加@ConditionalOnWebApplication或@ConditionalOnNotWebApplication註釋來指定只能在Web上下文內部/外部加載配置。
4. 測試自動配置
讓我們創建一個非常簡單的例子來測試我們的自動配置。我們將使用Spring Data 創建一個名爲MyUser的實體類和一個MyUserRepository接口:
@Entity
public class MyUser {
@Id
private String email;
public MyUser() {
}
public MyUser(String email) {
super();
this.email = email;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
}
public interface MyUserRepository extends JpaRepository<MyUser, String> {
}
要啓用自動配置,我們可以使用@SpringBootApplication或@EnableAutoConfiguration註解:
@SpringBootApplication
public class AutoconfigurationApplication {
public static void main(String[] args) {
SpringApplication.run(AutoconfigurationApplication.class, args);
}
}
接下來,讓我們編寫一個保存MyUser實體的JUnit測試:
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = AutoconfigurationApplication.class)
@EnableJpaRepositories(basePackages = { "com.peterwanghao.samples.springboot.autoconfiguration.example" })
public class AutoconfigurationLiveTest {
@Autowired
private MyUserRepository userRepository;
@Test
public void whenSaveUser_thenOk() {
MyUser user = new MyUser("[email protected]");
userRepository.save(user);
}
}
由於我們尚未定義DataSource配置,因此應用程序將使用我們創建的自動配置連接到名爲myDb的MySQL數據庫。
連接字符串包含createDatabaseIfNotExist = true屬性,因此數據庫不需要存在。但是,需要創建用戶mysqluser或通過mysql.user屬性指定的用戶mysqluser。
我們可以檢查應用程序日誌,看看是否正在使用MySQL數據源:
10:31:47.092 [main] INFO org.hibernate.Version - HHH000412: Hibernate Core {5.3.7.Final}
10:31:47.094 [main] INFO org.hibernate.cfg.Environment - HHH000206: hibernate.properties not found
10:31:47.227 [main] INFO o.h.annotations.common.Version - HCANN000001: Hibernate Commons Annotations {5.0.4.Final}
10:31:48.039 [main] INFO org.hibernate.dialect.Dialect - HHH000400: Using dialect: org.hibernate.dialect.MySQL5InnoDBDialect
Hibernate: drop table if exists MyUser
Hibernate: create table MyUser (email varchar(255) not null, primary key (email)) engine=InnoDB
10:31:48.655 [main] INFO o.h.t.s.internal.SchemaCreatorImpl - HHH000476: Executing import script 'org.hibernate.tool.schema.internal.exec.ScriptSourceInputNonExistentImpl@3a0b6a'
10:31:48.666 [main] INFO o.s.o.j.LocalContainerEntityManagerFactoryBean - Initialized JPA EntityManagerFactory for persistence unit 'default'
10:31:49.496 [main] INFO o.s.s.c.ThreadPoolTaskExecutor - Initializing ExecutorService 'applicationTaskExecutor'
10:31:49.569 [main] WARN o.s.b.a.o.j.JpaBaseConfiguration$JpaWebConfiguration$JpaWebMvcConfiguration - spring.jpa.open-in-view is enabled by default. Therefore, database queries may be performed during view rendering. Explicitly configure spring.jpa.open-in-view to disable this warning
10:31:49.701 [main] WARN o.s.b.a.t.ThymeleafAutoConfiguration$DefaultTemplateResolverConfiguration - Cannot find template location: classpath:/templates/ (please add some templates or check your Thymeleaf configuration)
10:31:50.091 [main] INFO c.p.s.s.a.AutoconfigurationLiveTest - Started AutoconfigurationLiveTest in 4.803 seconds (JVM running for 5.519)
Hibernate: select myuser0_.email as email1_0_0_ from MyUser myuser0_ where myuser0_.email=?
Hibernate: insert into MyUser (email) values (?)
10:31:50.279 [Thread-2] INFO o.s.s.c.ThreadPoolTaskExecutor - Shutting down ExecutorService 'applicationTaskExecutor'
10:31:50.281 [Thread-2] INFO o.s.o.j.LocalContainerEntityManagerFactoryBean - Closing JPA EntityManagerFactory for persistence unit 'default'
10:31:50.282 [Thread-2] INFO o.h.t.s.i.SchemaDropperImpl$DelayedDropActionImpl - HHH000477: Starting delayed evictData of schema as part of SessionFactory shut-down'
Hibernate: drop table if exists MyUser
5. 禁用自動配置類
如果我們想要從加載中排除自動配置,我們可以將帶有exclude或excludeName屬性的@EnableAutoConfiguration註解添加到配置類:
@Configuration
@EnableAutoConfiguration(
exclude={MySQLAutoconfiguration.class})
public class AutoconfigurationApplication {
//...
}
禁用特定自動配置的另一個方法是設置spring.autoconfigure.exclude屬性:
spring.autoconfigure.exclude=com.peterwanghao.samples.springboot.autoconfiguration.MySQLAutoconfiguration
6. 結論
在本教程中,我們介紹了Spring Boot是如何自動加載配置類,以及背後所隱藏的具體實現。展示瞭如何創建自定義Spring Boot自動配置。