🎱 Gen

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

目录

• 动机
• 示例
• 安装
• 想了解更多？
• 许可证

动机

Swift的随机性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提供了许多用于生成新类型随机性的操作符，如map、flatMap和zip，以及用于生成随机数组、集合、字典、字符串、分布等的辅助函数！例如，一个随机密码生成器只需几个操作符就可以实现。

// 使用随机字母和数字的生成器。
let password = Gen.letterOrNumber
  // 生成6个字符的字符串。
  .string(of: .always(6))
  // 生成3段这样的字符串。
  .array(of: .always(3))
  // 然后将它们连接起来。
  .map { $0.joined(separator: "-") }

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

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

// 使用`zip`组合生成器并构建结构。

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，只需在Package.swift中添加一个dependencies子句即可：

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

想了解更多？

这些概念（以及更多）在Point-Free中得到了深入探讨，这是一个由Brandon Williams和Stephen Celis主持的探索函数式编程和Swift的视频系列。

该库的设计在以下Point-Free剧集中得到了探讨：

• 第30集：可组合的随机性
• 第31集：可解码的随机性：第1部分
• 第32集：可解码的随机性：第2部分
• 第47集：可预测的随机性：第1部分
• 第48集：可预测的随机性：第2部分
• 第49集：生成艺术：第1部分 🆓
• 第50集：生成艺术：第2部分 🆓

<a href="https://www.pointfree.co/episodes/ep30-composable-randomness"> <img alt="视频海报图片" src="https://yellow-cdn.veclightyear.com/2b54e442/1f25776a-7d7c-488c-9ca1-56f605e9166e.jpeg" width="600"> </a>

许可证

所有模块均在MIT许可证下发布。详情请见LICENSE。