一般情況下,一個SpringBoot應用 = 一個微服務 = 一個模塊 = 一個有邊界的上下文,如果有多個模塊,我們就開發(fā)多個微服務,多個SpringBoot應用,然后使用Springcloud實現(xiàn)它們之間動態(tài)訪問和監(jiān)控。 但是有時我們也會希望將多個模塊放入一個SpringBoot應用中,這樣模塊之間調用可以在一個JVM內進行,適合小型系統(tǒng)的部署,隨著規(guī)模擴大,我們還可將這些模塊變成一個個微服務,以SpringBoot應用分布式運行。
SpringBoot為模塊化提供了非常直接簡單的組合方式,可以說完全替代OSGI或其他模塊插件技術。
什么是Spring Boot中的模塊?
本文意義上的“模塊”是一組加載到應用程序上下文中的Spring組件。
模塊可以是業(yè)務模塊,為應用程序提供一些業(yè)務服務,或者為幾個其他模塊或整個應用程序提供跨領域關注的技術模塊。
創(chuàng)建模塊的幾種辦法
Spring模塊的基礎是一個@Configuration注釋,這是一種Spring的Java配置特性,可以用來標注在你的模塊配置類中,配合@Configuration有幾種更細粒度的方式:
(1)@ComponentScan
創(chuàng)建模塊的最簡單方法是使用@ComponentScan注釋:
@Configuration@ComponentScan(basePackages = "io.reflectoring.booking")public class BookingModuleConfiguration {}
如果這個配置類由importing 機制(稍后解釋)導入的一個,它將查看包io.reflectoring.booking中的所有類,如果使用了 Spring的構造型注釋 中任何一個注釋,這些類的實例將被加載到Spring的應用上下文中。
只要你總是希望將包及其子包的所有類加載到Spring應用上下文中,那么使用這種方式就可以了。如果你需要更多控制加載內容,請繼續(xù)。。
(2)@Bean 定義
Spring的Java配置功能還有一個@Bean注釋,用于創(chuàng)建加載bean的實例到Spring應用上下文中:
@Configurationpublic class BookingModuleConfiguration { @Bean public BookingService bookingService(){ return new BookingService(); } // potentially more @Bean definitions ...}
導入此配置類時,BookingService實例將被創(chuàng)建并插入Spring的應用上下文中。
使用這種方式進行模塊的創(chuàng)建就可以更清楚地了解實際加載的bean,因為你只需要查看一個地方(配置類),更方便 ,這種辦法與使用@ComponentScan地方相比,后者需要你查看包中所有類的構造型注釋,看看是什么構造型,符合條件才能被加載。
(3)@Conditional 注釋
如果你需要對哪些組件應該加載到Spring應用上下文中要進行更細粒度的控制,則可以使用Spring Boot的@Conditional...注釋:
@Configuration@ConditionalOnProperty(name = "io.reflectoring.security.enabled", havingValue = "true", matchIfMissing = true)public class SecurityModuleConfiguration { // @Bean definitions ...}
在使用這個模塊時,必須在application配置文件中設置屬性io.reflectoring.security.enabled為true才能使用這個模塊。(見后面使用模塊)
還可以使用其他@Conditional...注釋來定義加載模塊的條件。有一個依賴條件,具體取決于JVM的版本以及某個類是否存在于類路徑中或某個bean是否存在于Spring應用上下文中。
如果你曾經問??過自己Spring Boot如何神奇地將應用程序所需的bean加載到應用程序上下文中,原理就在于使用了這個注釋@Conditional,Spring Boot本身大量使用@Conditional注釋。
以上三種辦法是創(chuàng)建一個模塊的方式,那么如何使用這些模塊呢?也有幾種方式可選,注意,要分清模塊創(chuàng)建和模塊使用兩個大的邊界。
使用模塊的幾種辦法
創(chuàng)建模塊后,我們需要將其導入到SpringBoot應用程序中,有下面幾種辦法:
(1)@Import
最直接的方法是使用@Import注釋:
@SpringBootApplication@Import(BookingModuleConfiguration.class)public class ModularApplication { // ...}
這將導入BookingModuleConfiguration類及其隨附的所有bean - 無論它們是由聲明@ComponentScan還是@Bean注釋。
(2)@Enable... 注釋
Spring Boot帶有一組注釋,每個注釋都自己導入某個模塊。一個例子是@EnableScheduling,它導入調度子系統(tǒng)所需的所有Beans及其@Scheduled注釋,也就是說,如果你在你的應用類中使用了@Scheduled注釋,如果想使得這種調度功能起效,還必須在入口處加入@EnableScheduling,否則就不起效,這也是SpringBoot使用中容易掉的坑,關鍵還是沒有了解Spring的模塊機制:
@SpringBootApplication@EnableSchedulingpublic class SpringbatchApplication { public static void main(String[] args) { SpringApplication.run(SpringbatchApplication.class, args); }}
我們也可以導入自己的Enable配置:
@SpringBootApplication@EnableBookingModulepublic class ModularApplication { public static void main(String[] args) { SpringApplication.run(ModularApplication.class, args); }}
上面代碼中EnableBookingModule不是Spring自己的注釋,而是我們自己的定做的,代碼如下:
@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE})@Documented@Import(BookingModuleConfiguration.class)@Configurationpublic @interface EnableBookingModule {}
該@EnableBookingModule注釋實際上只是包裝了@Import,首先導入我們的BookingModuleConfiguration,如果我們有一個模塊是由多個配置類組成,這種辦法是一種將這些配置類聚合到單個模塊中的方便且富有表現(xiàn)力的方法。
(3)自動配置Auto-Configuration
如果我們想自動加載模塊而不是將之前那樣在源代碼中導入指定的硬連接hard-wiring,我們可以使用Spring Boot的自動配置功能,也就是不再源代碼中使用注釋,而是使用配置文件。
請在模塊所在項目下(注意,不是模塊使用的項目)建立文件META-INF/spring.factories,運行時需要放入classpath類路徑中 ,在該文件中寫入:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=/ io.reflectoring.security.SecurityModuleConfiguration
多個配置:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=/com.mycorp.libx.autoconfigure.LibXAutoConfiguration,/com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration
該模塊的使用者所在Springboot項目啟動時會將SecurityModuleConfiguration類的所有bean導入到Spring應用上下文中。
要在SpringBoot中使用這個SecurityModuleConfiguration,還需要在模塊使用的項目中在application.yml中定義:
io: reflectoring: security: enabled: true
這里將io.reflectoring.security.enabled設置true,是對應前面該模塊創(chuàng)建時使用@Conditional注釋時有一個條件:
@ConditionalOnProperty(name = "io.reflectoring.security.enabled", havingValue = "true", matchIfMissing = true)
使用模塊的策略
前面介紹了在Spring Boot應用程序中使用模塊的幾個辦法,但是我們什么時候在什么情況下選擇哪一個呢?
(1)業(yè)務模塊使用@Import
對于包含業(yè)務邏輯的模塊 - 比如上面的BookingModuleConfiguration - 在大多數(shù)情況下使用@Import,使用帶注釋的靜態(tài)導入應該足夠了。通常那些沒有加載業(yè)務模塊也是沒有意義的,因此我們不需要對它們的加載條件進行任何控制。
(2)技術模塊使用自動配置
另一方面,技術性的模塊 - 如安全SecurityModuleConfiguration - 這些技術通常會提供一些跨域的切面關注(類似AOP),例如日志記錄,異常處理,授權或監(jiān)視功能,這些功能在開發(fā)和運行時需求不一樣,在開發(fā)過程中,可能根本不需要這些功能,因此我們希望有一種方法來禁用它們。
我們不希望使用@Import靜態(tài)地導入每個技術模塊,因為它們不應該對我們的代碼產生任何影響。
因此,使用技術模塊的最佳選擇是自動配置功能。模塊在后臺靜默加載,我們可以使用在代碼之外配置屬性中影響它們。
本文案例: github
總結
以上所述是小編給大家介紹的Spring Boot實現(xiàn)模塊化的幾種方法,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對VeVb武林網網站的支持!
新聞熱點
疑難解答
圖片精選