如何弃用 Objective-C 中的方法

Question

我们有我们的库交付给客户，我想将一些方法标记为“已弃用”，因为我们更改了它们（就像 Apple 在 iPhone SDK 中所做的那样）。

我看到了 __OSX_AVAILABLE_BUT_DEPRECATED 预处理器宏，它映射到 __AVAILABILITY_INTERNAL，它又映射到 __attribute__((deprecated))。 嗯，

我对这个东西有点困惑！

有人知道这件事吗？

Answer 1

__attribute__((已弃用)) 是

普通函数的语法为

__attribute__((deprecated))
void f(...) {
  ...
}

// gcc 4.5+ / clang
__attribute__((deprecated("g has been deprecated please use g2 instead")))
void g(...) {
  ...
}

，Objective-C 方法的语法为

@interface MyClass : NSObject { ... }
-(void)f:(id)x __attribute__((deprecated));
...
@end

您还可以将整个类标记为已弃用，

__attribute__((deprecated))
@interface DeprecatedClass : NSObject { ... }
...
@end

---

Apple 还提供了 标头，该标头提供了 DEPRECATED_ATTRIBUTE 和 DEPRECATED_MSG_ATTRIBUTE (msg) 扩展为上述属性的宏，或者如果编译器不支持属性则什么也不包含。请注意，此标头在 OS X / iOS 之外不存在。

---

旁注，如果您使用 Swift，则使用 @available 属性 弃用某个项目，例如

@available(*, deprecated=2.0, message="no longer needed")
func f() {
    ...
}

Answer 2

您还可以使用更具可读性的 define DEPRECATED_ATTRIBUTE

它在 usr/include/AvailabilityMacros.h 中定义：

#define DEPRECATED_ATTRIBUTE        __attribute__((deprecated))
#define DEPRECATED_MSG_ATTRIBUTE(msg) __attribute((deprecated((msg))))

Objective-C方法示例：

@interface MyClass : NSObject { ... }
-(void)foo:(id)x DEPRECATED_ATTRIBUTE;

// If you want to specify deprecated message:
-(void)bar:(id)x DEPRECATED_MSG_ATTRIBUTE("Use baz: method instead.");
...
@end

您还可以将整个类标记为已弃用：

DEPRECATED_ATTRIBUTE
@interface DeprecatedClass : NSObject { ... }
...
@end

Answer 3

Swift 5.0

使用 @available 弃用任何方法/类/结构/协议

@available(*, deprecated, message: "Parse your data by hand instead")
func parseData() { }

@available(*, deprecated, renamed: "loadData")
func fetchData() { }

@available(swift, obsoleted: 4.1, renamed: "attemptConnection")
func testConnection() { }

@available(swift, deprecated: 4.0, obsoleted: 5.0, message: "This will be removed in v5.0; please migrate to a different API.")

可能的参数：

• 引入了
• 已弃用的
• 已废弃的
• 消息
• 已重命名

有关详细信息，请参阅 Apple 文档：属性

Answer 4

如果您在 xcode 项目中使用 C++14，您还可以使用 [[deprecated]] 或 [[deprecated("reason")]] 属性现在是语言的一部分。

请参阅文档： http://en.cppreference.com/w/cpp/language/attributes< /a>

Answer 5

- 对于 SWIFT 代码：

将其放在方法的正上方：
@available(*，已弃用：<#Version#>，消息：<#Message#>)

示例：

@available(*, deprecated: 11, message: "Use color assets instead")
public struct ColorPaletteItemResource: ColorPaletteItemResourceType {
    ...
}