一般情況下,一個springboot應(yīng)用 = 一個微服務(wù) = 一個模塊 = 一個有邊界的上下文,如果有多個模塊,我們就開發(fā)多個微服務(wù),多個springboot應(yīng)用,然后使用springcloud實現(xiàn)它們之間動態(tài)訪問和監(jiān)控。 但是有時我們也會希望將多個模塊放入一個springboot應(yīng)用中,這樣模塊之間調(diào)用可以在一個jvm內(nèi)進行,適合小型系統(tǒng)的部署,隨著規(guī)模擴大,我們還可將這些模塊變成一個個微服務(wù),以springboot應(yīng)用分布式運行。
springboot為模塊化提供了非常直接簡單的組合方式,可以說完全替代osgi或其他模塊插件技術(shù)。
什么是spring boot中的模塊?
本文意義上的“模塊”是一組加載到應(yīng)用程序上下文中的spring組件。
模塊可以是業(yè)務(wù)模塊,為應(yīng)用程序提供一些業(yè)務(wù)服務(wù),或者為幾個其他模塊或整個應(yīng)用程序提供跨領(lǐng)域關(guān)注的技術(shù)模塊。
創(chuàng)建模塊的幾種辦法
spring模塊的基礎(chǔ)是一個@configuration注釋,這是一種spring的java配置特性,可以用來標注在你的模塊配置類中,配合@configuration有幾種更細粒度的方式:
(1)@componentscan
創(chuàng)建模塊的最簡單方法是使用@componentscan注釋:
1
2
3
4
|
@configuration @componentscan (basepackages = "io.reflectoring.booking" ) public class bookingmoduleconfiguration { } |
如果這個配置類由importing 機制(稍后解釋)導(dǎo)入的一個,它將查看包io.reflectoring.booking中的所有類,如果使用了 Spring的構(gòu)造型注釋 中任何一個注釋,這些類的實例將被加載到spring的應(yīng)用上下文中。
只要你總是希望將包及其子包的所有類加載到spring應(yīng)用上下文中,那么使用這種方式就可以了。如果你需要更多控制加載內(nèi)容,請繼續(xù)。。
(2)@bean 定義
spring的java配置功能還有一個@bean注釋,用于創(chuàng)建加載bean的實例到spring應(yīng)用上下文中:
1
2
3
4
5
6
7
8
|
@configuration public class bookingmoduleconfiguration { @bean public bookingservice bookingservice(){ return new bookingservice(); } // potentially more @bean definitions ... } |
導(dǎo)入此配置類時,bookingservice實例將被創(chuàng)建并插入spring的應(yīng)用上下文中。
使用這種方式進行模塊的創(chuàng)建就可以更清楚地了解實際加載的bean,因為你只需要查看一個地方(配置類),更方便 ,這種辦法與使用@componentscan地方相比,后者需要你查看包中所有類的構(gòu)造型注釋,看看是什么構(gòu)造型,符合條件才能被加載。
(3)@conditional 注釋
如果你需要對哪些組件應(yīng)該加載到spring應(yīng)用上下文中要進行更細粒度的控制,則可以使用spring boot的@conditional...注釋:
1
2
3
4
5
6
|
@configuration @conditionalonproperty (name = "io.reflectoring.security.enabled" , havingvalue = "true" , matchifmissing = true ) public class securitymoduleconfiguration { // @bean definitions ... } |
在使用這個模塊時,必須在application配置文件中設(shè)置屬性io.reflectoring.security.enabled為true才能使用這個模塊。(見后面使用模塊)
還可以使用其他@conditional...注釋來定義加載模塊的條件。有一個依賴條件,具體取決于jvm的版本以及某個類是否存在于類路徑中或某個bean是否存在于spring應(yīng)用上下文中。
如果你曾經(jīng)問??過自己spring boot如何神奇地將應(yīng)用程序所需的bean加載到應(yīng)用程序上下文中,原理就在于使用了這個注釋@conditional,spring boot本身大量使用@conditional注釋。
以上三種辦法是創(chuàng)建一個模塊的方式,那么如何使用這些模塊呢?也有幾種方式可選,注意,要分清模塊創(chuàng)建和模塊使用兩個大的邊界。
使用模塊的幾種辦法
創(chuàng)建模塊后,我們需要將其導(dǎo)入到springboot應(yīng)用程序中,有下面幾種辦法:
(1)@import
最直接的方法是使用@import注釋:
1
2
3
4
5
|
@springbootapplication @import (bookingmoduleconfiguration. class ) public class modularapplication { // ... } |
這將導(dǎo)入bookingmoduleconfiguration類及其隨附的所有bean - 無論它們是由聲明@componentscan還是@bean注釋。
(2)@enable... 注釋
spring boot帶有一組注釋,每個注釋都自己導(dǎo)入某個模塊。一個例子是@enablescheduling,它導(dǎo)入調(diào)度子系統(tǒng)所需的所有beans及其@scheduled注釋,也就是說,如果你在你的應(yīng)用類中使用了@scheduled注釋,如果想使得這種調(diào)度功能起效,還必須在入口處加入@enablescheduling,否則就不起效,這也是springboot使用中容易掉的坑,關(guān)鍵還是沒有了解spring的模塊機制:
1
2
3
4
5
6
7
8
|
@springbootapplication @enablescheduling public class springbatchapplication { public static void main(string[] args) { springapplication.run(springbatchapplication. class , args); } } |
我們也可以導(dǎo)入自己的enable配置:
1
2
3
4
5
6
7
|
@springbootapplication @enablebookingmodule public class modularapplication { public static void main(string[] args) { springapplication.run(modularapplication. class , args); } } |
上面代碼中enablebookingmodule不是spring自己的注釋,而是我們自己的定做的,代碼如下:
1
2
3
4
5
6
7
|
@retention (retentionpolicy.runtime) @target ({elementtype.type}) @documented @import (bookingmoduleconfiguration. class ) @configuration public @interface enablebookingmodule { } |
該@enablebookingmodule注釋實際上只是包裝了@import,首先導(dǎo)入我們的bookingmoduleconfiguration,如果我們有一個模塊是由多個配置類組成,這種辦法是一種將這些配置類聚合到單個模塊中的方便且富有表現(xiàn)力的方法。
(3)自動配置auto-configuration
如果我們想自動加載模塊而不是將之前那樣在源代碼中導(dǎo)入指定的硬連接hard-wiring,我們可以使用spring boot的自動配置功能,也就是不再源代碼中使用注釋,而是使用配置文件。
請在模塊所在項目下(注意,不是模塊使用的項目)建立文件meta-inf/spring.factories,運行時需要放入classpath類路徑中 ,在該文件中寫入:
1
2
|
org.springframework.boot.autoconfigure.enableautoconfiguration=\ io.reflectoring.security.securitymoduleconfiguration |
多個配置:
1
2
3
|
org.springframework.boot.autoconfigure.enableautoconfiguration=\ com.mycorp.libx.autoconfigure.libxautoconfiguration,\ com.mycorp.libx.autoconfigure.libxwebautoconfiguration |
該模塊的使用者所在springboot項目啟動時會將securitymoduleconfiguration類的所有bean導(dǎo)入到spring應(yīng)用上下文中。
要在springboot中使用這個securitymoduleconfiguration,還需要在模塊使用的項目中在application.yml中定義:
1
2
3
4
|
io: reflectoring: security: enabled: true |
這里將io.reflectoring.security.enabled設(shè)置true,是對應(yīng)前面該模塊創(chuàng)建時使用@conditional注釋時有一個條件:
1
2
|
@conditionalonproperty (name = "io.reflectoring.security.enabled" , havingvalue = "true" , matchifmissing = true ) |
使用模塊的策略
前面介紹了在spring boot應(yīng)用程序中使用模塊的幾個辦法,但是我們什么時候在什么情況下選擇哪一個呢?
(1)業(yè)務(wù)模塊使用@import
對于包含業(yè)務(wù)邏輯的模塊 - 比如上面的bookingmoduleconfiguration - 在大多數(shù)情況下使用@import,使用帶注釋的靜態(tài)導(dǎo)入應(yīng)該足夠了。通常那些沒有加載業(yè)務(wù)模塊也是沒有意義的,因此我們不需要對它們的加載條件進行任何控制。
(2)技術(shù)模塊使用自動配置
另一方面,技術(shù)性的模塊 - 如安全securitymoduleconfiguration - 這些技術(shù)通常會提供一些跨域的切面關(guān)注(類似aop),例如日志記錄,異常處理,授權(quán)或監(jiān)視功能,這些功能在開發(fā)和運行時需求不一樣,在開發(fā)過程中,可能根本不需要這些功能,因此我們希望有一種方法來禁用它們。
我們不希望使用@import靜態(tài)地導(dǎo)入每個技術(shù)模塊,因為它們不應(yīng)該對我們的代碼產(chǎn)生任何影響。
因此,使用技術(shù)模塊的最佳選擇是自動配置功能。模塊在后臺靜默加載,我們可以使用在代碼之外配置屬性中影響它們。
本文案例: github
總結(jié)
以上所述是小編給大家介紹的spring boot實現(xiàn)模塊化的幾種方法,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復(fù)大家的。在此也非常感謝大家對服務(wù)器之家網(wǎng)站的支持!
原文鏈接:https://www.jdon.com/49643