專案中的程式碼規範和資料夾結構

---

我將盡力在這篇文章中介紹基於學習和理解的RPA最佳實踐。這將幫助您理解每個RPA開發者在建立機器人時都應遵循的RPA程式碼規範和最佳實踐。它有助於提高整個軟體系統的質量和程式碼的可維護性。

我們提供的資訊是一般性的，適用於所有RPA工具，如下所示。

• 任何地方的自動化程式碼標準

• UiPath 編碼規範

• Blue Prism 編碼標準

• Power Automate 編碼標準

RPA有哪些最佳實踐？

以下是使用RPA時應遵循的一些最佳實踐：

拆分任務

將一個任務拆分成多個相關子任務，以便在需要更新或除錯時快速理解程式碼，任務不應超過400行。確保將建立的任何子任務與主要任務整合。例如，以下子任務：讀取配置檔案、登入應用程式、建立資料夾等。

• 機器人異常場景

• 帶有共享驅動器路徑的資料夾結構

• 應用程式名稱，應用程式路徑

• 除錯模式 – 保持除錯標誌啟用以停用訊息框

• 電子郵件地址

• 電子郵件主題

配置檔案

為了防止在將機器人轉移到生產環境時進行任何程式碼修改，請確保您正在生成和使用來自配置檔案的資料。所有將來可能更改的資訊都應在您的配置檔案中。以下資訊應在您的配置檔案中。

• 機器人的異常情況

• 資料夾組織和共享驅動器路徑

• 應用程式的名稱和位置

• 在除錯模式下，保持除錯標誌啟用以關閉訊息框

• 聯絡郵箱

• 電子郵件主題

應該有適當的命名約定

為了簡化複雜的專案並方便維護，變數和活動的命名規範至關重要。在建立任務、變數或子任務時，確保為其提供正確的名稱。您應該按照如下所示正確宣告您的作業和變數的名稱。

XYZ MasterTask version, Process Name Task Name
XYZ SAPLoginTask v01
Name of the variable− strCustomerName
numAccountNumber
dtLoanDate

備註和日誌

新增足夠的註釋和日誌條目的好處是，它們使人們更容易理解生成的程式碼的流程，而無需開啟作業中的每個命令。

為了確保清晰度，每個註釋和日誌都應格式正確且語法正確。為了跟蹤資訊並確定任務何時開始和結束，應在執行操作的任何地方新增日誌。

• 使用井號、斜槓或星號建立註釋框。

• 使用一個簡短的註釋來闡明前提、問題或推理。

• 為了確保清晰度，請提供有用的註釋。

程式碼中不應有任何硬編碼

為了防止將來修改程式碼，請確保程式碼中沒有硬編碼的變數或資訊。相反，請從配置檔案中讀取。無論如何，都應避免在程式碼、變數或配置檔案中儲存敏感資料或客戶端資料；相反，應安全地儲存它。為了防止任何安全執行緒，請保持加密或憑據鎖模式。

利用可重用元件

為了節省其他開發人員或其他專案的時間，請務必將任何常見活動建立為可重用元件。

例如，建立資料夾結構、讀取配置檔案和登入應用程式等常規操作，應僅在組織內部進行最少的修改後才能被其他開發人員或其他流程使用。

機器人結構

以下是RPA中檔案的建議結構。

├── bin
│  └── # Place your external binaries & executable in this file
├── config
│  └── conda.yaml
├── devdata
│  ├── env.json
│  └── # A place for your development phase test data
├── .gitignore
├── libraries
│  └── # Collect your library files here
├── LICENSE
├── output
│  └── # Having a standard place for outputs is always good
├── README.md # Mark−down readme in the root is a good place to describe what the thing does.
├── resources
│  └── #
A common style in Robot Framework is to place your keyword implementations in one location
├── robot.yaml # The must−have configuration file in the root
├── tasks
│  └── # Another common style in Robot Framework is to place your robot task implementations in one location
├── temp
│  └── # Always good to have one standard place for temp files
└── variables
  └── # A place for your variable definitions makes these easy to find and manage

類別

使用RPA平臺，任何非IT專家都可以建立RPA機器人。雖然這聽起來像是RPA技術的標準銷售宣傳，但為什麼RPA的失敗率如此之高？為什麼擴充套件RPA的好處如此困難？為什麼整個IT環境中RPA機器人的使用仍然構成安全風險？為了確保高質量的機器人結論，業界非常重視這些問題，並開始著手開發標準框架。

大多數這些標準和最佳實踐，無論RPA產品如何，都可以分為以下五大類：

• 可讀性 – 程式碼邏輯和命名約定的簡單性、無垃圾程式碼以及其他因素使其易於理解。

• 可配置性 – 透過包含可調整的元素（如效能引數、URL、檔案和資料夾路徑、電子郵件ID、憑據、業務規則閾值引數、日誌訊息、電子郵件格式等）和通用設計，簡化管理調整和機器人校準。

• 可靠性 – 透過包含有效異常處理、最佳可能的互動方法、記憶體洩漏預防以及正確構建的自動恢復和自動修復系統，實現高精度和低異常率。

• 安全性 – 安全性是對已知和未知風險的自由程度的衡量，它包括憑據管理、授權和身份驗證以及公司資料的儲存和交換等元件。

• 效能 – 透過有效的延遲管理、並行執行、使用最佳介面樣式、有效的記憶體管理和有效的業務邏輯設定，實現儘可能低的平均處理時間。