如何警告 Swift 中函数的调用者

Question

我正在逐步重构一个大型iOS Swift项目。 一些 function 必须重命名，我不能直接重命名，因为许多其他模块直接调用它。 相反，对于第一阶段的发布，我想让 function 的调用者知道请使用这个函数而不是这个函数。 让我用一个例子来解释，

func length() - > Int {
    //..... some logic
}

期待在下一个版本中将其重构为，

func count() - > Int {
    //..... same logic
}

对于第一阶段，我想同时保留length()和count() ，但要警告其他开发人员不要使用现有的，即 length()。 所以我尝试了，

func length() - > Int {
    #warning("Please use count() instead")
    //..... some logic
}

但是警告被抛出，而不是给调用者。 那么，让来电者知道错误来电的最佳方法是什么？

注意：这里的示例只是理解问题的最简单形式。 scope 和模块尺寸的实际实现要广泛得多。

Answer 1

您可以使用@available关键字管理方法的可用性。

警告用户：

@available(*, deprecated, message: "Please use count() instead")
func length() - > Int { }

强制用户：

@available(*, unavailable, message: "Please use count() instead")
func length() - > Int { }

建议用户重命名 function：

@available(*, renamed: "count()")
func length() - > Int { }

如果需要，您还可以设置平台和弃用版本（即使没有消息）：

@available(iOS, deprecated:11.2)
func length() - > Int { }

Answer 2

使用available的关键字

您可以通过多种方式使用它，如果您想向开发人员显示警告，那么您应该使用deprecated ，但是如果您想强制它们，则使用unavailable

@available(*, deprecated, message: "Please use count() instead")
func length() - > Int {
}