swift - 在 swift 5 中使用 UnsafeMutableBytes 更新代码以避免弃用警告时出错

Question

我已经更新到 swift 5，我使用的依赖项之一无法在 swift 5 中编译。我已经修复了它，但现在我在整个文件中收到了 350 多个弃用警告。它们都与此类似:

withUnsafeMutableBytes is deprecated: use withUnsafeMutableBytes<R>(_: (UnsafeMutableRawBufferPointer) throws -> R) rethrows -> R instead

这是代码片段(它基本上只是调用 c 库的函数):

var k = Data(count: crypto_generichash_keybytes())
k.withUnsafeMutableBytes { kPtr in
    flutter_sodium.crypto_generichash_keygen(kPtr)
}

作为引用，在上面的 crypto_generichash_keybytes() 中只返回一个 size_t 和 crypto_generichash_keygen的签名是void crypto_generichash_keygen(unsigned char k[crypto_generichash_KEYBYTES]); .

我发现(如 this answer 所述)解决这个问题的方法应该是调用 kPtr.baseAddress:

var k = Data(count: crypto_generichash_keybytes())
k.withUnsafeMutableBytes { kPtr in
    flutter_sodium.crypto_generichash_keygen(kPtr.baseAddress)
}

因为那应该使用 withUnsafeMutableBytes<ResultType>变体而不是已弃用的 withUnsafeMutableBytes<ResultType, ContentType> .但是，这反而会导致错误

value of type 'UnsafeMutablePointer<_>' has no member 'baseAddress'.

如果我明确指定 resultType 和 kPtr:

var k = Data(count: crypto_generichash_keybytes())
k.withUnsafeMutableBytes { (kPtr: UnsafeMutableRawBufferPointer) -> Void in
    flutter_sodium.crypto_generichash_keygen(kPtr.baseAddress)
}

我反而得到

UnsafeMutableRawBufferPointer' is not convertible to 'UnsafeMutablePointer<_>'.

是否有任何快速的专家可以帮助我找出正确的方法来做到这一点？我知道警告只是警告，但我更喜欢编译时没有警告的代码。

我看了一下Swift 5.0: 'withUnsafeBytes' is deprecated: use `withUnsafeBytes<R>(...)在发布这个问题之前，它对我的​​情况没有帮助，因为我没有加载指针而是使用数据。此外，我已经完全按照文档中的指示进行操作，但这仍然无济于事。

编辑:为了更清楚一点，350 多个警告中的一些与 Data 的代码相关。在代码中分配，但是其中一些是我收到 Data 的地方来自外部来源。看起来像这样:

let args = call.arguments as! NSDictionary
let server_pk = (args["server_pk"] as! FlutterStandardTypedData).data
let server_sk = (args["server_sk"] as! FlutterStandardTypedData).data
let client_pk = (args["client_pk"] as! FlutterStandardTypedData).data

var rx = Data(count: flutter_sodium.crypto_kx_sessionkeybytes())
var tx = Data(count: flutter_sodium.crypto_kx_sessionkeybytes())
let ret = rx.withUnsafeMutableBytes { rxPtr in
  tx.withUnsafeMutableBytes { txPtr in
    server_pk.withUnsafeBytes { server_pkPtr in
      server_sk.withUnsafeBytes { server_skPtr in
        client_pk.withUnsafeBytes { client_pkPtr in
          flutter_sodium.crypto_kx_server_session_keys(rxPtr, txPtr, server_pkPtr, server_skPtr, client_pkPtr)
        }
      }
    }
  }
}

用相应的方法调用

SODIUM_EXPORT
int crypto_kx_client_session_keys(unsigned char rx[crypto_kx_SESSIONKEYBYTES],
                                  unsigned char tx[crypto_kx_SESSIONKEYBYTES],
                                  const unsigned char client_pk[crypto_kx_PUBLICKEYBYTES],
                                  const unsigned char client_sk[crypto_kx_SECRETKEYBYTES],
                                  const unsigned char server_pk[crypto_kx_PUBLICKEYBYTES])
            __attribute__ ((warn_unused_result));

(我知道代码并不是真正最优的 swift，但是在处理 dart 和 swift 之间的互操作性时，这就是 flutter 团队想出的方法)。

当我问这个问题时，我试图将它提炼成最简单的案例，但那个案例有一个特定的答案，这与我遇到的整体问题不同。

Answer 1

我不会使用 Data这里——Data表示“原始”字节的无类型集合，但是 crypto_generichash_keygen想要一个指向类型化内存的可变指针。 UnsafeMutablePointer<T>的原因withUnsafeMutableBytes 的变体被弃用的原因是它在非类型化内存上提供的抽象从根本上是错误的。

在 Swift 中获取类型内存缓冲区的最简单方法是使用 Array :

var k = [UInt8](repeating: 0, count: crypto_generichash_keybytes())
flutter_sodium.crypto_generichash_keygen(&k)

您始终可以将生成的缓冲区转换为 Data事后说 Data(k) 的值(value).

另一种选择是使用 UnsafeMutableBufferPointer :

let k = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: crypto_generichash_keybytes())
defer {
  k.deallocate()
}
flutter_sodium.crypto_generichash_keygen(k.baseAddress!)
// Now use the buffer `k` – just make sure you finish using it before the end of
// the scope when `deallocate()` gets called!

不同于Array ，这避免了在传递给 C API 之前必须用零预填充结果缓冲区，但这可能并不重要。但就像Array , 你可以把这样的缓冲区变成 Data只说Data(k) .

---

对于您收到 Data 的情况来自某些外部源的值并需要将其作为类型化指针传递给 API，最简单和最安全的选择是在通过说 Array(someData) 传递之前将其转换为数组。 .

例如:

let args = call.arguments as! NSDictionary
let server_pk = (args["server_pk"] as! FlutterStandardTypedData).data
let server_sk = (args["server_sk"] as! FlutterStandardTypedData).data
let client_pk = (args["client_pk"] as! FlutterStandardTypedData).data

var rx = [UInt8](repeating: 0, count: flutter_sodium.crypto_kx_sessionkeybytes())
var tx = [UInt8](repeating: 0, count: flutter_sodium.crypto_kx_sessionkeybytes())

flutter_sodium.crypto_kx_server_session_keys(
  &rx, &tx, Array(server_pk), Array(server_sk), Array(client_pk)
)

你可能可以使用withUnsafeBytes并调用bindMemory在底层指针上，但我不鼓励它，因为它改变了底层内存的类型，这可能会微妙地影响共享该内存的任何其他 Swift 代码的健全性，因为您正在从它下面切换类型。