智能合約從入門到精通：Solidity語言的開發規範和開發流程

標籤：有用   ibus   log   資料結構   介紹   interface   Owner   course   username   

簡介：上面介紹的在Solidity中嵌入的內聯組合語言也可以單獨使用。實際上，它是被計劃用來作為編譯器的一種中繼語言。本文我們將介紹開發智能合約過程中Solidity語言的開發規範和開發流程。

Solidity作為編譯器的一種中繼語言。在開發智能合約時需要遵守相應的開發規範和開發流程。

開發規範
命名規範
目錄和檔案

• 目錄使用小寫，請勿使用特殊符號；
• 庫檔案和合約檔案統一以.sol為尾碼；
• 合約檔案名稱保持與合約名一致；
• 檔案名稱採用駝峰命名（首字母大寫）；

合約、庫檔案命名

• 合約名採用駝峰命名（首字元大寫），例如：UserManager、ActionManager；
• 方法的命名使用駝峰法（首字母小寫），例如：getNumber；
• 屬性的命名使用駝峰法（首字母小寫），例如：userName；
• 以雙底線__打頭的函數或方法作為內部合約調用方法；
• 合約library庫命名以首碼Lib+結構體名稱，如：LibUser、LibAction；

常量和配置

• 常量以大寫字母和底線命名，例如 APP_PATH；
• 配置參數以小寫字母和底線命名，例如url_route_on和url_convert；
  目錄結構

  |-app(truffle服務類別目錄)|-contracts(合約目錄)                    |  └─interfaces(抽象合約目錄)                   |                  |  └─library(結構解析庫目錄)                    |     |  └─sysbase(公用合約目錄)                |     |-OwnerNamed.sol(基礎合約，所有使用者業務合約，必須繼承此基礎合約)       |     └─BaseModule.sol  |        |  └─utillib(工具庫目錄)                    |     |-LibDB.sol|     |-LibDecode.sol|     |-LibInt.sol|     |-LibJson.sol|     |-LibLog.sol|     |-LibNIZK.sol|     |-LibNizkParam.sol|     |-LibPaillier.sol|     |-LibStack.sol|     |-LibString.sol|     └─Strings.sol|  |-migrations(truffle發布配置目錄)|-test(測試指令碼目錄)|-truffle.jsCopy

  常規開發中，使用目錄對合約檔案的功能進行分類，下面逐一介紹功能：

• contracts truffle 標準工作目錄中的合約目錄，合約存放在此目錄下，如：UserManager.sol；
• interfaces 存放抽象合約，如：IConsumerManager.sol；
• library 存放struct結構庫檔案；
• sysbase 儲存公用合約目錄，例如：OwnerNamed.sol；
• utillib 存放工具庫，如：LibString.sol, LibLog.sol；

開發流程

• 合約介面定義
  按照良好的編程習慣，在編寫業務方法前，首先定義介面，並交付給調用者。
• 資料結構定義
  使用者定義的合約介面中，如果有比較複雜的輸入/輸出資料，就有必要提前定義一些資料結構，並提供操作這些資料結構的一些常用方法（主要是一些序列化成JSON字串的方法）。
• 業務合約編寫
  實現合約介面定義，並實現使用者的商務邏輯。在業務合約的建構函式中，需要把業務合約註冊到模組合約中。
  如果使用者只是想編寫業務合約，做學習，測試用，則可以把業務合約註冊到"juzix.io.debugModule"這個特殊名稱的模組合約中，則使用者可以不需要編寫模組合約，從而在JUICE用戶端IDE中直接調用業務合約的方法。
• 模組合約編寫
  編寫模組合約，這是JUICE開放服務平台的要求，以便系統管理使用者的DAPP應用、業務合約。在模組合約的建構函式中，需要把模組合約註冊到鏈上，並在建構函式中說明模組合約將會使用到的所有業務合約。
  使用者編寫了模組合約、並部署到JUICE區塊鏈後，模組的名稱將會顯示在JUICE開放服務平台的“我的應用程式”中，點擊“我的應用程式”的某個應用，將會跳轉到使用者開放的DAPP應用。如何設定應用的跳轉URL，參考模組合約編寫。
• 編譯部署、測試
  通過JUICE用戶端，或者線上IDE，都可以完成編譯、部署、測試使用者合約。

參考內容：https://open.juzix.net/doc

智能合約開發教程視頻：區塊鏈系列視頻課程之智能合約簡介

智能合約從入門到精通：Solidity語言的開發規範和開發流程