區(qū)塊鏈應(yīng)用開發(fā)組件:助力低代碼開發(fā)

區(qū)塊鏈技術(shù)在經(jīng)歷了十余年的發(fā)展后，漸呈“燎原之勢(shì)”，不斷在各行業(yè)落地生根。但同時(shí)，從技術(shù)的角度看，區(qū)塊鏈應(yīng)用開發(fā)仍然有著較高的門檻，存在不少痛點(diǎn)，在應(yīng)用開發(fā)各個(gè)環(huán)節(jié)上的用戶體驗(yàn)、效率及安全有待提升。

• 如何在solidity代碼中將賬戶地址和字符串互轉(zhuǎn)？
• 現(xiàn)有的solidity代碼是否支持高級(jí)語言中常用但相對(duì)復(fù)雜的數(shù)據(jù)結(jié)構(gòu)，例如可迭代的mapping？
• 是否可以提供一套基于明確應(yīng)用場(chǎng)景的可供復(fù)用、參考的智能合約代碼？
• solidity智能合約如何快速編譯為abi和binary文件？
• 如何在使用gradle構(gòu)建的區(qū)塊鏈應(yīng)用中快速編譯智能合約代碼，而不必使用編譯腳本？
• 寫完智能合約后，如何編寫區(qū)塊鏈應(yīng)用？
• 是否可以提供一個(gè)便于開發(fā)的區(qū)塊鏈應(yīng)用代碼生成器？

• 編程小白如何快速上手區(qū)塊鏈應(yīng)用開發(fā)？

  ...

這些問題既有與合約開發(fā)相關(guān)的，也有與應(yīng)用開發(fā)相關(guān)的?；诖祟悎?chǎng)景問題，結(jié)合自身實(shí)踐經(jīng)驗(yàn)，微眾銀行區(qū)塊鏈正式開源區(qū)塊鏈應(yīng)用開發(fā)組件WeBankBlockchain-SmartDev，期望從區(qū)塊鏈應(yīng)用開發(fā)中的各個(gè)環(huán)節(jié)入手，多維度地提高區(qū)塊鏈應(yīng)用的開發(fā)效率，幫助開發(fā)者成為區(qū)塊鏈應(yīng)用開發(fā)的“10倍工程師”。目前，整個(gè)組件基于solidity語言開發(fā)。近期微眾銀行區(qū)塊鏈還開源了Liquid合約語言，未來我們也會(huì)適配Liquid語言。

  什么是應(yīng)用開發(fā)組件？

區(qū)塊鏈應(yīng)用開發(fā)組件WeBankBlockchain-SmartDev的研發(fā)初衷在于打造低代碼開發(fā)的組件庫，全方位助力開發(fā)者高效、敏捷地開發(fā)區(qū)塊鏈應(yīng)用。WeBankBlockchain-SmartDev包含了一套開放、輕量的開發(fā)組件集，覆蓋合約的開發(fā)、編譯、應(yīng)用開發(fā)等環(huán)節(jié)，開發(fā)者可根據(jù)自己的情況選擇相應(yīng)開發(fā)工具，提升開發(fā)效率。

從合約開發(fā)的視角來看，對(duì)于常用的功能，不必再重復(fù)造輪子，只需按需引用，參考“智能合約庫”中的代碼，就可以引入相應(yīng)功能，為合約開發(fā)的效率和安全保駕護(hù)航。對(duì)于非基礎(chǔ)性功能，例如業(yè)務(wù)場(chǎng)景，我們也提供了代碼模板供參考復(fù)用。

從合約編譯的視角來看，對(duì)于正在開發(fā)中的區(qū)塊鏈應(yīng)用，不必再依賴控制臺(tái)對(duì)合約代碼進(jìn)行編譯，只需使用合約gradle編譯插件就地編譯，便可立即得到abi、bin和java合約。這些編譯物直接被輸出到Java項(xiàng)目中，省去了拷貝的步驟，提供了如開發(fā)原生java程序一樣迅捷、絲滑的體驗(yàn)。

從應(yīng)用開發(fā)的視角來看，從智能合約到項(xiàng)目搭建，包含了大量機(jī)械而重復(fù)的工作，如創(chuàng)建項(xiàng)目、引入依賴、編寫配置代碼、訪問智能合約、編寫相關(guān)實(shí)體類等。相形之下，通過WeBankBlockchain-SmartDev，開發(fā)者可以選用應(yīng)用開發(fā)腳手架。腳手架會(huì)根據(jù)智能合約自動(dòng)生成項(xiàng)目工程。工程中已經(jīng)包含了上述邏輯代碼，開發(fā)者只需基于該工程繼續(xù)添加業(yè)務(wù)邏輯代碼，聚焦在自身的業(yè)務(wù)上即可。

  應(yīng)用開發(fā)組件包含哪些子組件？

智能合約庫組件

“天下苦solidity久矣”，在solidity智能合約開發(fā)過程中，如果沒有一套可參考的模板和代碼庫，不僅影響開發(fā)的效率，同時(shí)可能因?yàn)閷?duì)智能合約開發(fā)的不熟悉而引入安全風(fēng)險(xiǎn)。智能合約庫涵蓋了從基礎(chǔ)類型到上層業(yè)務(wù)的常見solidity庫代碼，用戶可根據(jù)實(shí)際需要進(jìn)行參考、復(fù)用。智能合約庫的層級(jí)結(jié)構(gòu)如下：

1、基礎(chǔ)類型層：提供了常見的solidity內(nèi)置類型的復(fù)雜操作庫函數(shù)，涵蓋了數(shù)學(xué)運(yùn)算，整型轉(zhuǎn)換操作、字符串操作、地址操作合數(shù)組操作等。在增強(qiáng)內(nèi)置基礎(chǔ)類型功能的同時(shí)，還為智能合約的安全保駕護(hù)航。

2、數(shù)據(jù)結(jié)構(gòu)層：提供了其他高級(jí)編程語言中常見、而solidity語言中未提供的基礎(chǔ)數(shù)據(jù)結(jié)構(gòu)，讓智能合約開發(fā)如虎添翼。

3、通用功能層：作為合約開發(fā)的“粘合劑”，現(xiàn)階段整合了CRUD、Table庫，并提供了密碼學(xué)庫，極大地便利了智能合約業(yè)務(wù)邏輯中的相關(guān)操作。

4、上層業(yè)務(wù)層：提供了積分和存證這兩個(gè)常見業(yè)務(wù)場(chǎng)景的智能合約模板。上述智能合約模板代碼遵循了高內(nèi)聚、低耦合、易于升級(jí)的設(shè)計(jì)理念，既可供智能合約初學(xué)者學(xué)習(xí)和參考，也能給經(jīng)驗(yàn)豐富的智能合約開發(fā)者帶來啟迪和思考。

智能合約編譯插件

在以往的FISCO BCOS開發(fā)中，智能合約需要編譯，首先要安裝控制臺(tái)，然后在調(diào)試階段，需要把合約導(dǎo)入控制臺(tái)，編譯后再把java文件拷貝出來調(diào)試。且只要合約有變更，此流程就需要重新執(zhí)行。因此，我們提供了智能合約編譯插件，用戶只需要在項(xiàng)目中調(diào)用gradle相關(guān)命令，就會(huì)自動(dòng)根據(jù)項(xiàng)目中的合約生成abi、bin和java代碼，節(jié)省了大量寶貴的時(shí)間。

應(yīng)用開發(fā)腳手架

區(qū)塊鏈應(yīng)用的開發(fā)流程，除了合約開發(fā)外、還包括應(yīng)用開發(fā)。其中，應(yīng)用開發(fā)又包括項(xiàng)目建立、引入依賴、配置代碼編寫、模型類編寫、服務(wù)類編寫、業(yè)務(wù)邏輯編寫等步驟。這些步驟相對(duì)繁瑣，影響了開發(fā)的效率。因此，我們提供了智能合約腳手架，用于一鍵式生成區(qū)塊鏈應(yīng)用開發(fā)工程，降低了應(yīng)用開發(fā)的難度。用戶將自己的合約導(dǎo)入腳手架，即可生成對(duì)應(yīng)的應(yīng)用開發(fā)模板工程，包含對(duì)應(yīng)的POJO類、服務(wù)類等，用戶可基于此直接開發(fā)區(qū)塊鏈應(yīng)用項(xiàng)目。

  應(yīng)用開發(fā)組件使用場(chǎng)景

場(chǎng)景1：智能合約開發(fā)

在智能合約開發(fā)中，從基礎(chǔ)的四則運(yùn)算到上層的業(yè)務(wù)場(chǎng)景，都可以使用成熟的、可復(fù)用的庫。

以四則運(yùn)算為例，需要判斷是否存在溢出的風(fēng)險(xiǎn)，此時(shí)可以使用數(shù)學(xué)相關(guān)庫LibSafeMathForUint256Utils。

以數(shù)據(jù)結(jié)構(gòu)為例，在solidity中，mapping類型的key不可被迭代，此時(shí)若需要使用對(duì)key進(jìn)行迭代的映射，可以使用mapping相關(guān)的庫LibBytesMap。

以通用功能為例，如果希望引入哈希、驗(yàn)簽等密碼學(xué)功能，則可以使用Crypto庫。

以業(yè)務(wù)場(chǎng)景為例，如果想實(shí)現(xiàn)存證功能，可以參考場(chǎng)景模板Evidence，模板中納入了相關(guān)實(shí)現(xiàn)，起到拋磚引玉的效果。

場(chǎng)景2：合約修改與調(diào)試

在區(qū)塊鏈應(yīng)用開發(fā)、調(diào)試過程中，通常需要在項(xiàng)目中用到abi、bin、java合約等內(nèi)容，并基于這些內(nèi)容進(jìn)行相應(yīng)的調(diào)試。如果合約出于調(diào)整等原因而需要重新編譯，此時(shí)不必將合約拷入控制臺(tái)編譯，只需運(yùn)行相應(yīng)的gradle指令，就可以生成新的編譯物。同時(shí)，這些編譯物直接嵌在了項(xiàng)目中。如下圖示例中，對(duì)HelloWorld合約編譯后，產(chǎn)生的編譯物示例：

場(chǎng)景3：區(qū)塊鏈應(yīng)用開發(fā)

假如用戶已經(jīng)寫好了智能合約，需要基于智能合約，開發(fā)一個(gè)提供rest接口的web項(xiàng)目。在這種情況下，用戶可以將合約拖入腳手架，一鍵生成項(xiàng)目。下圖是生成的樣例工程，包含了必要的配置類、DAO（Data Access Object）相關(guān)代碼。開發(fā)者只需對(duì)項(xiàng)目進(jìn)行必要的配置，并添加相應(yīng)的controller等代碼，就可以輕松實(shí)現(xiàn)上述需求。

  開源地址

github代碼庫地址

SmartDev-Contract 智能合約庫組件

SmartDev-SCGP 智能合約編譯插件

SmartDev-Scaffold 智能合約應(yīng)用開發(fā)腳手架

https://github.com/WeBankBlockchain/SmartDev-Scaffold

gitee代碼庫地址

SmartDev-Contract 智能合約庫組件

歡迎參與WeBankBlockchain的社區(qū)建設(shè)：

• 如項(xiàng)目對(duì)您有幫助，歡迎點(diǎn)亮我們的小星星(點(diǎn)擊項(xiàng)目左上方Star按鈕)。

• 歡迎提交代碼(Pull requests)。

• 提問和提交BUG。

• 如果發(fā)現(xiàn)代碼存在安全漏洞，可通過以下地址上報(bào)：

  https://security.webank.com/