開發軟件包的標準編碼實踐和準則

本主題涵蓋標準編碼實務和準則、可協助確保開發高品質套件。

測試

確保高質量代碼。爲您的軟件包編寫足夠的設備測試和集成測試。

圖示

爲您的軟件包設置適當的圖標。

手動設定版本

每次生成時， SDK 軟件包生成版本都會自動更新。但是，您可以在通用 build.gradle 文件的命令項目中手動設置它。

在生成之前更新 build.gradle 文件。
輸入最多四位數的數字、並將我的句號分隔、如下所示：


. . .
ext {
    version '2.0.8'
}
dependencies {...}

相依項目

將所有依賴項嵌入到包 JAR 中。通過將依賴項提取到臨時位置，在運行時加載它們。請確保在加載依賴項後清潔臨時位置。

相關 JAR 文件

在 build.gradle 文件的相關性下添加相關 JAR 文件作爲實現，以便打包相關 JAR 文件。

	
. . .
dependencies {
		compileOnly name: 'command-annotations'
		compileOnly name: 'bot-runtime'
		compileOnly name: 'bot-api'
		implementation name: 'i18n-api'
              implementation name: 'mydependentjavafile.jar'
		apt name: 'command-processor'
		compileOnly group: 'org.apache.logging.log4j', name: 'log4j-core', version: "$loggerVersion"
		testImplementation "org.testng:testng:$testNgVersion"
		testImplementation name: 'bot-runtime'
		testImplementation name: 'bot-api'
	}
. . .

將新操作添加到退出軟件包

在將新操作添加到現有包時，請確保在包裝前清潔。進行全新構建始終是一種良好的做法 - gradlew.bat Clean build shadowJar 。

錯誤訊息

提供有意義的錯誤訊息。

執行拋出有意義的錯誤消息。例如，在本地語言中，使用帶 BotCommandException 的 i18n API，拋出新異常 BotCommandException(messages.getString("Run.Exception.InvalidWorkingDirPath")。
不要拋出一般錯誤消息，如 ex.message。

基本驗證

使用此開發套件隨附的驗證註釋規則、例如 @NotEmpty 。不要爲代碼添加基本驗證。請參閱驗證註釋。

迴圈

避免代碼中出現長時間的運行循環。長時間執行迴圈可能會導致 CPU 使用率過高、導致錯誤、例如「 Bot is responsive 」。

添加日誌記錄

使用機器人程式執行時間架構中提供的預設 log4j 記錄器。不要添加您自己的記錄器。有關詳細信息，請參閱示例代碼。

日誌記錄級別

錯誤 / 致命：使用者受影響的嚴重錯誤事件，沒有因應措施。
警告：發生意外錯誤，但系統已從該錯誤恢復。
信息：有關狀態更改的信息性消息，例如，已接受的請求。
調試：發生錯誤時需要偵錯的詳細診斷資訊。
跟蹤：擷取應用程式行為的所有資訊。
如果您不確定日誌級別，請將其設置爲 trace。

正在載入資源

應使用當前線程上下文類加載器加載所有資源，如下例所示：

Thread.currentThread().getContextClassLoader().getResourceAsStream("resource.json");

Automation 360