🎱 Gen

CI

可组合、可转换、可控制的随机性。

目录

动机

Swift 的随机性 API 功能强大且易于使用。它允许我们从许多基本类型(例如布尔类型和数值类型)创建随机值,并且允许我们随机打乱数组并从集合中选取随机元素。

然而,它并没有使我们能够轻松扩展随机性 API,也没有提供可组合的 API,而这种 API 将允许我们从更简单的部分创建复杂类型的随机性。

Gen 是 Swift 随机性 API 的轻量级封装,可以轻松构建任何类型值的自定义生成器。

示例

Gen 的同名类型 Gen 负责生成随机值。通常,您会使用 Gen 中的静态变量之一来访问 Gen

Gen.bool
// Gen<Bool>

Gen 并非立即生成随机值,而是描述了一个可以通过调用其 run 方法生成的随机值

let myGen = Gen.bool
// Gen<Bool>

myGen.run() // true
myGen.run() // true
myGen.run() // false

Swift 附带的每个随机函数也可作为 Gen 上的静态函数使用

Swift 的 API Gen 的 API
Int.random(in: 0...9) Gen.int(in: 0...9)
Double.random(in: 0...9) Gen.double(in: 0...9)
Bool.random() Gen.bool
[1, 2, 3].randomElement() Gen.element(of: [1, 2, 3])
[1, 2, 3].shuffled() Gen.shuffle([1, 2, 3])

将随机性封装在 Gen 类型中之所以强大的原因是我们可以使 Gen 类型可组合。例如,整数生成器可以通过简单地应用 map 函数转换为数字字符串生成器

let digit = Gen.int(in: 0...9)           // Gen<Int>
let stringDigit = digit.map(String.init) // Gen<String>

stringDigit.run() // "7"
stringDigit.run() // "1"
stringDigit.run() // "3"

这已经是一种 Swift 的 API 未开箱即用的随机性形式。

Gen 提供了许多用于生成新型随机性的运算符,例如 mapflatMapzip,以及用于生成随机数组、集合、字典、字符串、分布等的辅助函数!例如,一个随机密码生成器只需几个运算符即可实现。

// Take a generator of random letters and numbers.
let password = Gen.letterOrNumber
  // Generate 6-character strings of them.
  .string(of: .always(6))
  // Generate 3 segments of these strings.
  .array(of: .always(3))
  // And join them.
  .map { $0.joined(separator: "-") }

password.run() // "9BiGYA-fmvsOf-VYDtDv"
password.run() // "dS2MGr-FQSuC4-ZLEicl"
password.run() // "YusZGF-HILrCo-rNGfCA"

这种组合方式使得生成任何事物的随机值变得简单。

// Use `zip` to combine generators together and build structures.

let randomPoint = zip(.int(in: -10...10), .int(in: -10...10))
  .map(CGPoint.init(x:y:))
// Gen<CGPoint>

但可组合性并不是 Gen 类型出色的唯一原因。通过延迟随机值的创建,直到调用 run 方法,我们可以在需要确定性的情况下(例如测试)控制随机性。run 方法有一个重载,它接受 RandomNumberGenerator 值,这是 Swift 的协议,为他们的随机性 API 提供支持。默认情况下,它使用 SystemRandomNumberGenerator,这是一个很好的随机性来源,但我们也可以提供可播种的“伪”随机数生成器,以便我们可以在测试中获得可预测的结果

var xoshiro = Xoshiro(seed: 0)
Gen.int(in: 0...9).run(using: &xoshiro) // "1"
Gen.int(in: 0...9).run(using: &xoshiro) // "0"
Gen.int(in: 0...9).run(using: &xoshiro) // "4"

xoshiro = Xoshiro(seed: 0)
Gen.int(in: 0...9).run(using: &xoshiro) // "1"
Gen.int(in: 0...9).run(using: &xoshiro) // "0"
Gen.int(in: 0...9).run(using: &xoshiro) // "4"

这意味着在应用程序中利用随机性时,您不必牺牲可测试性。

有关使用 Gen 构建复杂随机性的更多示例,请参阅我们关于创建 Zalgo 生成器的博客文章以及关于创建生成艺术的两部分视频系列(第 1 部分第 2 部分)。

安装

如果您想在使用 SwiftPM 的项目中使用 Gen,只需将 dependencies 子句添加到您的 Package.swift 中即可

dependencies: [
  .package(url: "https://github.com/pointfreeco/swift-gen.git", from: "0.4.0")
]

有兴趣了解更多?

这些概念(以及更多)在 Point-Free 中进行了详尽的探讨,Point-Free 是一个由 Brandon WilliamsStephen Celis 主持的探索函数式编程和 Swift 的视频系列。

本库的设计在以下 Point-Free 剧集中进行了探讨

video poster image

许可证

所有模块均在 MIT 许可证下发布。有关详细信息,请参阅许可证