Lui*_*rez 3 design-patterns scala optional
正如标题所说,在Scala 中建模可选参数的最佳方法是什么?
对于可选参数,我的意思是执行函数体不需要的值。
要么因为该参数存在默认值,要么根本不需要该参数本身(例如配置或调试标志);请注意,在Java 上,我可能会传递null给这些参数。
这是Scala社区的常见问题解答,特别是由新手制作的。
例如:
总的来说,社区一致认为下面列出的所有提案或替代方案都不值得为他们的权衡取舍。
因此,推荐的解决方案是只使用Option数据类型并手动/显式地将值包装在一个Some
def test(required: Int, optional: Option[String] = None): String =
optional.map(_ * required).getOrElse("")
test(required = 100) // ""
test(required = 3, optional = Some("Foo")) // "FooFooFoo"
Run Code Online (Sandbox Code Playgroud)
然而,这种方法的明显缺点是必要的样板待命站点。但是,可以说它使代码更易于阅读和理解,从而更易于维护。
不过,有时您可以使用其他技术(如默认参数或重载(下文讨论))提供更好的 API 。
由于前一个解决方案的样板文件,使用隐式转换的常见替代方案被反复提及;例如:
implicit def a2opt[A](a: A): Option[A] = Some(a)
Run Code Online (Sandbox Code Playgroud)
这样前面的函数就可以这样调用:
test(required = 3, optional = "Foo")
Run Code Online (Sandbox Code Playgroud)
这样做的缺点是隐式转换隐藏了optional作为可选参数的事实(当然,如果它的名称不同),并且这种转换可以应用于代码的许多其他(非预期)部分;这就是为什么不鼓励隐式转换的原因。
一个子替代方法是使用扩展方法而不是隐式转换,例如optional = "foo".opt. 然而,扩展方法需要添加更多代码,并且站点调用仍然有一些样板文件,这一事实使这成为一个平庸的中间点。
(免责声明,如果您正在使用猫,您已经在范围内拥有这样的扩展方法,.some因此您可能想要使用它)。
该语言支持为函数的参数提供默认值,这样如果没有传递,编译器将插入默认值。
有人可能认为这应该是建模可选参数的最佳方式;然而,他们遇到了三个问题。
您并不总是有默认值,有时您只想知道该值是否被传递。例如,一面旗帜。
如果它在自己的参数组上,您仍然需要添加可能看起来很难看的空括号(当然,这是一个主观意见)。
def transact[A](config: Config = Config.default)(f: Transaction => A): A
transact()(tx => ???)
Run Code Online (Sandbox Code Playgroud)
object Functions {
def run[A](query: Query[A], config: Config = Config.default): A = ???
def run[A](query: String, config: Config = Config.default): A = ???
}
Run Code Online (Sandbox Code Playgroud)
错误:在对象函数中,方法 run 的多个重载替代方案定义了默认参数。
另一种常见的解决方法是提供该方法的重载版本;例如:
def test(required: Int, optional: String): String =
optional * required
def test(required: Int): String =
test(required, optional = "")
Run Code Online (Sandbox Code Playgroud)
这个的优点是它封装了样板定义站点而不是调用站点;还使代码更易于阅读,并且得到了工具的良好支持。
然而,最大的缺点是,如果您有多个可选参数,这将无法很好地扩展;例如,对于三个参数,您需要七个( 7)重载。
但是,如果您有许多可选参数,也许最好只要求一个Config/Context参数并使用Builder。
def foo(data: Dar, config: Config = Config.default)
// It probably would be better not to use a case class for binary compatibility.
// And rather define your own private copy method or something.
// But that is outside of the scope of this question / answer.
final case class Config(
flag1: Option[Int] = None,
flag2: Option[Int] = None,
flag3: Option[Int] = None
) {
def withFlag1(flag: Int): Config =
this.copy(flag1 = Some(flag))
def withFlag2(flag: Int): Config =
this.copy(flag2 = Some(flag))
def withFlag3(flag: Int): Config =
this.copy(flag3 = Some(flag))
}
object Config {
def default: Config = new Config()
}
Run Code Online (Sandbox Code Playgroud)
在贡献者的话语中,有人提议为此用例添加语言级别或标准库级别的支持。但是,由于上述相同的原因,它们都已被丢弃。
此类提案的示例:
与往常一样,根据您的具体情况和您想要提供的 API 选择要使用的技术。
也许联合类型的引入可以打开一种更简单的方法来编码可选参数的可能性?