项目中的代码规范和文件夹结构

---

我将尽力在这篇文章中介绍基于学习和理解的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、凭据、业务规则阈值参数、日志消息、电子邮件格式等）和通用设计，简化管理调整和机器人校准。

• 可靠性 – 通过包含有效异常处理、最佳可能的交互方法、内存泄漏预防以及正确构建的自动恢复和自动修复系统，实现高精度和低异常率。

• 安全性 – 安全性是对已知和未知风险的自由程度的衡量，它包括凭据管理、授权和身份验证以及公司数据的存储和交换等组件。

• 性能 – 通过有效的延迟管理、并行执行、使用最佳接口样式、有效的内存管理和有效的业务逻辑设置，实现尽可能低的平均处理时间。