UDF 和 UDL 名称的最佳实践 - BlueCat Integrity - 9.5.0

管理指南

Locale
中文 (大陆)
Product name
BlueCat Integrity
Version
9.5.0

Address Manager 在为用户定义的字段和用户定义的链接(UDF 和 UDL)创建名称时不实施任何限制。可以使用具有几乎任何 Unicode 字符的任何名称。但是,在将 UDL 与外部工具和应用程序集成时,某些名称可能会导致问题。如果更新使用的名称与创建的名称冲突,其他名称可能会导致问题。

我们推荐使用以下一组非正式规则以避免当前和未来的问题。

一般准则:
  • 仅使用标准 ASCII 字母和数字。避免使用符号、标点、重音字符和其他非英文字符。在某些情况下,下划线字符(“_”)也是可以接受的。

    这确保了名称几乎可以在任何设备和任何脚本或编程语言中使用。即使当前的第三方工具兼容 Unicode,将来使用的工具也可能不兼容。

  • 保持长度为 24 个字符或以下。一些编程语言只考虑标识符的前 32 个字符。将名称限制为 24 个字符允许在第三方脚本中使用前缀和后缀。

    另一方面,名称不要太短。太短的名称(如“address”或“private”)会增加与其他工具和应用程序发生名称冲突的机会。

  • 不要使用 Java、JavaScript 或 Python 的保留名称和关键字。

    同样,不要使用任何 BlueCat 定义的属性或方法使用的名称。

  • 确保每个定义的 UDF 或 UDL 的名称是全局唯一的。也就是说,不仅要求在它们被继承的当前范围中是唯一的。

    这样做会增加每个 UDF 和 UDL 的未来灵活性,从而更易扩展其功能。

  • 确保即使忽略字母大小写名称也是唯一的。例如,避免同时使用“MyAddress”和“MYADDRESS”。

    Address Manager 对 UDF 和 UDL 名称区分大小写。许多第三方应用程序和脚本工具不区分大小写。

  • 以 BlueCat 不太可能使用的前缀为 UDF 和 UDL 名称的开头。一个比较好的选择是贵公司的缩写。例如,如果贵公司名称是“Example Company”,可以使用诸如“excIntrusionCount”或“excStoreStatus”之类的 UDF 名称。

    这样做有助于避免与未来更新中的功能发生名称冲突。它还可以帮助您将 BlueCat 功能与您自己的团队创建的任何功能区分开来。

UDF 名称的附加准则:
  • UDF 名称应以小写字母开头。将 UDF 名称中的单词大写,使用“驼峰式拼写”(例如,myIndexName
UDL 名称的附加准则:
  • UDL 名称通常全部使用大写字母,单词之间用下划线分隔(例如,MY_INDEX_NAME)。使用此惯例有助于区分 UDL 和 UDF 名称。但是,如果您愿意,也可以遵循与 UDF 名称相同的惯例。