配置BizWorks Toolkit(適用于0.12.0版本及之后的版本)
使用BizWorks Toolkit插件前您需要完成相關(guān)配置,例如:基礎(chǔ)信息配置、代碼配置、雙向聯(lián)動(dòng)配置和bizworks.yml配置等。
配置基礎(chǔ)信息
打開IDEA,在頂部導(dǎo)航欄選擇 。
BizWorks Toolkit插件的一些基礎(chǔ)配置,例如,是否使用BizWorks Toolkit、是否啟用代碼檢查等,這些配置項(xiàng)建議您全部選中開啟。
配置代理
在Settings對話框的左側(cè)導(dǎo)航欄中,選擇 。
您可以參考下圖進(jìn)行動(dòng)態(tài)代理配置。
相關(guān)配置項(xiàng)說明請參見下表。
配置項(xiàng)
說明
No proxy
如果您選中該配置項(xiàng),則不能使用代理功能。
HTTP
如果您選中該配置項(xiàng),則網(wǎng)絡(luò)使用HTTP代理。
Host name
代理服務(wù)器地址。
Port number
代理服務(wù)器端口號。
Proxy authentication
支持配置是否需要驗(yàn)證。
Login
驗(yàn)證賬號。
Password
驗(yàn)證密碼。
配置雙向聯(lián)動(dòng)
您可以通過雙向聯(lián)動(dòng)配置,設(shè)置在提交本地掃描結(jié)果時(shí)是否刪除平臺上本地不存在的模型,默認(rèn)為不刪除。
在Settings對話框的左側(cè)導(dǎo)航欄中,選擇 。
雙向聯(lián)動(dòng)配置用于上報(bào)模型、下拉模型時(shí)進(jìn)行一些自定義的配置。例如,上報(bào)時(shí)是否刪除本地不存在的模型,掃描時(shí)是否掃描一些static
、final
修飾的field
和method
等。
配置連接本地工程與平臺應(yīng)用的配置文件
配置文檔相關(guān)說明
該配置文件是連接“本地工程”與“平臺應(yīng)用“的媒介,在本地工程中需保證有且僅有一份,主要起到關(guān)聯(lián)配置、配置文件內(nèi)容結(jié)構(gòu)化展示、以及配置文件內(nèi)容編輯輔助的作用。
配置信息包括但不限于:與“平臺應(yīng)用”的關(guān)聯(lián)、工程結(jié)構(gòu)信息記錄(例如:包路徑哪個(gè)是M、哪個(gè)是V、哪個(gè)是C)、應(yīng)用架構(gòu)(MVC、DDD、其他)、掃描代碼的
annotation
對應(yīng)關(guān)系(例如:接口或API可以配置掃描@Controller或@API進(jìn)行獲?。?、代碼掃描的路徑配置等。
原有配置方式為什么要做遷移呢?
由于多種因素,平臺版本升級后,舍棄了modules.yaml配置文件,生成了bizworks.yml文件,所以BizWorks Toolkit針對bizworks.yml文件可以使您更直觀的修改與理解配置文件,創(chuàng)建了BizWorks Editor界面。
新的配置方式參考maven
、gradle
等方式,以純文件存在,且修改后需要重新加載配置。
配置文件關(guān)鍵內(nèi)容說明
默認(rèn)名稱:
bizworks.yml
默認(rèn)位置:
項(xiàng)目根目錄/.bizworks/bizworks.yml
分組 | 配置項(xiàng) | 配置項(xiàng)Key | 說明 |
項(xiàng)目基本信息 | 項(xiàng)目編碼 | project.code | 無。 |
應(yīng)用基本信息 | 應(yīng)用編碼 | application.code | 無。 |
架構(gòu)模式 | application.archPattern | MVC、DDD、其他。 | |
版本信息 | application.version | 無。 | |
模塊關(guān)聯(lián) | 模塊關(guān)聯(lián) | modules | 代碼與業(yè)務(wù)域/商業(yè)能力的關(guān)聯(lián)信息。 |
配置文件示例
# 結(jié)構(gòu)
bizworks:
# project code
project:
code: theProjectCode
# 應(yīng)用 Code
application:
code: theAppCode
# 架構(gòu)模式,MVC/DDD
archPattern: DDD
# 版本信息
version: v1.0.0
# 模塊關(guān)聯(lián)
modules:
- type: "MODULE_CENTER"
code: "Domain2"
packages:
- "com.demo.plugintestapp1.businessdomain.domain2"
- type: "BUSINESS_CAPABILITY"
code: "BizCap1"
packages:
- "com.demo.plugintestapp1.businesscapability.bizcap1"
- type: "MODULE_CENTER"
code: "Domain1"
# 臺掃描本地代碼時(shí)只會(huì)掃描已關(guān)聯(lián)的Package下的類。
packages:
- "com.demo.plugintestapp1.businessdomain.domain1"
一鍵創(chuàng)建BizWorks配置
您可在以下目錄單擊右鍵,選擇
后,選擇目標(biāo)目錄即可。項(xiàng)目根目錄/.bizworks/
項(xiàng)目根目錄(如果您是在項(xiàng)目根目錄進(jìn)行此操作,則BizWorks Toolkit則會(huì)默認(rèn)補(bǔ)充.bizworks目錄)
如果您之前配置過關(guān)聯(lián)平臺配置,那么新建配置文件的內(nèi)容將會(huì)以您IDEA中存儲的內(nèi)容為主。
修改連接本地工程與平臺應(yīng)用的配置文件
完成配置文件修改后,需重新加載配置信息,加載完成后生效。
您可通過配置文件內(nèi)容了解配置文件格式,若您知道每項(xiàng)配置值,您可在Text頁面進(jìn)行手動(dòng)編輯。
完成修改配置文件之后,您可單擊右上角重新加載,進(jìn)行配置的重新加載。
您可通過單擊下方Text或BIZWORKS EDITOR進(jìn)行頁簽切換,您在Text或BIZWORKS EDITOR頁簽的修改都會(huì)即時(shí)生效。
在BIZWORKS EDITOR頁簽,單擊packages文本框,在package輸入框中,配置多條packages時(shí)需用英文分號(;)進(jìn)行分割。
配置修改完成后,請您請選擇
,加載完成后生效。
如何遷移配置文件?
平臺生成的配置文件目錄默認(rèn)為項(xiàng)目根目錄/.bizworks/bizworks.yml。
遷移老版本
如果您使用過BizWorks Toolkit 0.12.0之前的版本,那么您以前的配置文件是modules.yaml。如果您在本地升級了BizWorks Toolkit,則您本地是沒有bizworks.yml的,那么當(dāng)您打開項(xiàng)目時(shí)或重新加載配置時(shí),BizWorks Toolkit會(huì)引導(dǎo)您進(jìn)行配置文件的遷移。
您可按照提示進(jìn)行操作即可,bizworks.yml默認(rèn)位置為項(xiàng)目根目錄/.bizworks/bizworks.yml。
對接全新項(xiàng)目
如果您在本地新創(chuàng)建了一個(gè)項(xiàng)目,想對接平臺,您可在以下目錄單擊右鍵,選擇
后,選擇目標(biāo)目錄即可。項(xiàng)目根目錄/.bizworks/
項(xiàng)目根目錄/模塊名稱-starter/src/main/resources/bizworks
項(xiàng)目根目錄(如果您是在項(xiàng)目根目錄進(jìn)行此操作,則BizWorks Toolkit則會(huì)默認(rèn)補(bǔ)充.bizworks目錄)
BizWorks配置文件ToolWindow說明
您可通過IDEA下方ToolWindow尋找BizWorks ToolWindow,您可以在BizWorks ToolWindow中查看您本地工程中的所有配置文件,單擊配置文件之后,您可在ToolWindow右側(cè)窗口看到該配置文件的介紹。
右鍵單擊您選中的配置文件,您可看到您可對該配置文件的操作。雙擊您選中的配置文件,則會(huì)在IDEA主界面中打開此配置文件。