在 Scala 中使用选项的惯用方法

Question

我正在将一些 Java 代码转换为 Scala，试图使代码尽可能地惯用。

所以，我现在有一些使用选项而不是可为空值的代码，我想知道事情是否是 Scalaiish，或者我是否错了。那么，你们能批评一下下面的代码片段吗？

我特别寻求反馈的领域是：

• 使用伴生对象作为工厂，根据我们是否要传递选项或字符串提供 2 个选项： String 构造函数好吗，或者我们应该始终暴露这样的事实：它是一个选项吗？
• 前提条件的使用：是否有更好的方法来断言 alpha3Code 和 name 是强制性的，并且必须为 alpha2Code 传递非空选项？ （我求助于 Guava 来获取字符串实用程序，因为我还没有找到Scala API 中的任何内容）
• hashCode、equals 和 toString 的实现。 equals 和 toString 再次委托给 Guava，而 equals 使用模式匹配。有没有更 Scala 风格的方式？
• 我知道我可以使用案例类，这会创建默认实现，但我最感兴趣的是学习如何在无法使用案例类的情况下实现这些实现。

    package com.sirika.openplacesearch.api.language
    
    import com.google.common.base.Objects
    import com.google.common.base.Strings
    
    object Language {
        def apply(name : String, alpha3Code : String, alpha2Code : Option[String]) = new Language(name, alpha3Code, alpha2Code)
        def apply(name : String, alpha3Code : String, alpha2Code : String = null) = new Language(name, alpha3Code, Option(alpha2Code))
        def unapply(l : Language) = Some(l.name, l.alpha3Code, l.alpha2Code )
    }
    
    
    class Language(val name : String, val alpha3Code : String, val alpha2Code : Option[String]) {
        require(!Strings.isNullOrEmpty(alpha3Code))
        require(!Strings.isNullOrEmpty(name))
        require(alpha2Code != null)
        
        override def hashCode(): Int = Objects.hashCode(alpha3Code)
        
                override def equals(other: Any): Boolean = other match {
            case that: Language => this.alpha3Code == that.alpha3Code
            case _ => false
        }
    
        override def toString() : String = Objects.toStringHelper(this)
            .add("name", name)    
            .add("alpha3", alpha3Code)
            .add("alpha2", alpha2Code)
            .toString()
    }

Answer 1

我认为你应该在工厂方法中只公开 Option[String] 。例如，作为您库的用户，我也会问自己应该使用哪种工厂方法的问题。我很可能会使用 Option。

Scala 为我们提供了足够的工具来让我们的生活更轻松。例如，您可以使用默认选项，如下所示：

def apply(name: String, alpha3Code: String, alpha2Code: Option[String] = None) = 
 new Language(name, alpha3Code, alpha2Code)

如果我再次作为库的用户，只想传递字符串而不每次将其包装在 Some 中，我可以像这样编写自己的隐式转换:

implicit def anyToOption[T](t: T): Option[T] = Some(t)

甚至（如果我个人使用 nulls）：

implicit def anyToOption[T](t: T): Option[T] = 
 if (t == null) None else Some(t)

但我相信，如果你强制执行选项，它会让你的 API 更加坚实和清晰。

Answer 2

您应该避免使用 null ，除非有充分的理由不这样做。事实上，你可以这样写：

def apply(name : String, alpha3Code : String, alpha2Code : String) = new Language(name, alpha3Code, Option(alpha2Code))
def apply(name : String, alpha3Code : String) = new Language(name, alpha3Code, None)

前提条件很好。你可以这样写：

require(Option(alpha3Code) exists (_.nonEmpty))
require(Option(name) exists (_.nonEmpty))

不过，不一定是改进。

String 有 hashCode，所以我不明白为什么你要调用另一个方法来生成哈希码，而不是仅仅调用 alpha3Code.hashCode 。不过，我确实认为 Scala API 中有一些东西。没有把握。

equals 代码应该有一个 canEqual 方法，除非您将类设为 sealed 或 final。模式匹配几乎就是实现它的方法，尽管考虑到提取器的存在，您可以像这样编写它：

case Language(_, `alpha3Code`, _) => true

但是您编写它的方式几乎是通常编写的方式。

Answer 3

我不喜欢选项——它们增加了一定程度的间接性，在许多情况下这是不必要的和令人困惑的。我更不喜欢空值，所以我知道使用选项通常是合理的。但是，您应该始终查看是否有更自然的方法来消除界面中 Option 的使用。

默认参数或单独的重载通常是更好的选择。所以我会像这样重写你的代码：

package com.sirika.openplacesearch.api.language

import com.google.common.base.Strings
import com.google.common.base.Objects

object Language {
    def apply(name : String, alpha3Code : String, alpha2Code : String) = new Language(name, alpha3Code, alpha2Code)
    def apply(name : String, alpha3Code : String ) = new Language(name, alpha3Code)
    def unapply(l : Language) = Some(l.name, l.alpha3Code, l.alpha2Code )
}


class Language private (val name : String, val alpha3Code : String, val alpha2Code : Option[String]) {
    def this(name:String,alpha3Code: String ,alpha2Code:String) = this(name,alpha3Code,Option(alpha2Code))
    def this(name:String,alpha3Code: String) = this(name,alpha3Code,None)

    require(!Strings.isNullOrEmpty(alpha3Code))
    require(!Strings.isNullOrEmpty(name))

    override def hashCode  = alpha3Code.hashCode

    override def equals(other: Any) = other match {
        case that: Language => this.alpha3Code == that.alpha3Code
        case _ => false
    }

    override def toString = MoreObjects.toStringHelper(this)
        .add("name", name)    
        .add("alpha3", alpha3Code)
        .add("alpha2", alpha2Code)
        .toString()
}

番石榴文档