使用API时的最佳实践(Apache Chemistry for Alfresco)



好的,所以我正在使用这个API https://github.com/donbalon4/API_Alfresco 从另一个服务的其他PHP站点上传文件到Alfresco。我没有任何代码问题,只是当我使用它时,我想到了关于如何正确使用 API 的一些疑问。

我基本上使用它来创建一些目录到我的Alfresco共享中。正如我所说,它运行良好,所以问题不在于我的代码,而在于如何正确使用 API(或任何一般的 API(。

首先,如果您查看该 API,您将看到每个方法如何处理异常,即如果您尝试创建一个已经存在的文件夹,那么将抛出包含正确信息的异常

到目前为止,我只是使用 API 在某个父根中创建多个目录,其中一些目录可能具有相同的名称。因此,当他们这样做时,我根本不需要创建它们(因为目录已经存在(,也不需要抛出任何异常或显示给最终用户。

实现这一目标的最佳方法是什么?我不想修改 API,因为它会与其真实含义相矛盾。如果每个人都修改现有的API,那么它就不再是API。我可以简单地删除我正在使用的方法的异常处理,但我认为这不是一个好的做法。

我还意识到有一个名为existsFolder((私有方法供内部使用。我也许可以将其更改为公共,以便我可以在我的实际PHP代码中使用它来检查自己是否已经存在给定的文件夹,但我真的不知道这是否是一个很好的方法。

管理已存在的目录的最佳方法是什么?将异常处理替换为要向最终用户显示的文本消息?或者将existsFolder((方法公开?我可能缺少任何其他想法吗?

如果 API 引发异常,您的代码应捕获它,然后采取相应的措施。您的代码需要使用 try-catch 子句将可能引发异常的任何 API 调用括起来。例如,如果您的代码看到由于文件夹已存在而引发异常,而您不在乎,则可以吞下异常并继续。

相关内容

  • 没有找到相关文章

最新更新