web3j Gradle插件是從Solidity智能合約生成web3j Java封裝的構建工具。它通過添加可以獨立運行的特定任務,順利地與項目的構建生命週期集成。
插件配置
在開始之前,如果計算機中尚未安裝Solidity編譯器,則需要安裝它。
使用buildscript約定
要使用舊的Gradle buildscript
約定安裝web3j插件,應該將以下內容添加到構建文件的第一行(目前只有Gradle支持發行版本,而不是SNAPSHOT):
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.web3j:web3j-gradle-plugin:0.1.6'
}
}
apply plugin: 'web3j'
使用插件DSL
或者,如果你使用的是更現代的插件DSL,請將以下行添加到你的構建文件中:
plugins {
id 'org.web3j' version '0.1.6'
}
然後運行包含Solidity智能合約的項目:
./gradlew build
應用插件後,生成代碼的基本目錄(默認爲$buildDir/generated/source/web3j
)將包含每個源集的目錄(默認爲main
和test
),其中包含智能合約封裝器的Java類。
代碼生成
web3j
DSL允許配置生成的代碼,例如:
web3j {
generatedPackageName = 'com.mycompany.{0}'
generatedFilesBaseDir = "$buildDir/custom/destination"
excludedContracts = ['Ownable']
useNativeJavaTypes = false
}
DSL接受的屬性如下表所示:
generatedPackageName
被評估爲接受大括號({0})之間的單個參數的消息格式字符串,允許使用合約名稱格式化生成的值。爲方便起見,當應用於Java包名稱時,它將轉換爲小寫。
例如,在一個具有組com.mycompany
的項目將generatedPackageName
設置爲${group}.{0}
,那名爲MyToken.sol
的Solidity智能合約將被在com.mycompany.mytoken
包中生成。
此外,默認值包含${group}
屬性,該屬性對應於項目中的組(例如com.mycompany
)。如果項目未定義組屬性,則生成的包名稱將爲org.web3j.{0}
。
請注意,消息格式參數不是Gradle屬性,不應以$
開頭。
來源設置
默認情況下,$projectDir/src/main/solidity
中的所有.sol
文件都將由插件處理。要指定和添加不同的來源,請使用sourceSets DSL:
sourceSets {
main {
solidity {
srcDir {
"my/custom/path/to/solidity"
}
}
}
}
檢查Solidity Plugin文檔以配置智能合約源代碼目錄。
生成的智能合約封裝器Java代碼的輸出目錄將自動添加到你的構建中。
插件任務
Java插件使用基於每個源的命名約定(即compileJava
,compileTestJava
)向項目構建添加任務。
類似地,Solidity插件將爲項目主源添加generateContractWrappers
任務,併爲每個剩餘的源(例如test
)添加generate[SourceSet]ContractWrappers
。
要獲取所有已添加任務的列表和說明,請運行以下命令:
./gradlew tasks --all
更多的信息
有關web3j的更多信息,請參閱web3j主頁中文版。
分享2個以太坊、比特幣區塊鏈相關的交互式在線編程實戰教程:
- java以太坊開發教程,主要是針對java和android程序員進行區塊鏈以太坊開發的web3j詳解。
- java比特幣開發教程,本課程面向初學者,內容即涵蓋比特幣的核心概念,例如區塊鏈存儲、去中心化共識機制、密鑰與腳本、交易與UTXO等,同時也詳細講解如何在Java代碼中集成比特幣支持功能,例如創建地址、管理錢包、構造裸交易等,是Java工程師不可多得的比特幣開發學習課程。
匯智網原創翻譯,轉載請標明出處。這裏是原文web3j的Gradle插件