Scala 值类的惯用方法

Question

>有谁知道是否有一种惯用的方式来命名 Scala 值类的内部值？假设我有一个产品 ID 的值类，它是否更好地定义为：

case class ProductId(productId:String) extends AnyVal
case class ProductId(underlying:String) extends AnyVal
case class ProductId(value:String) extends AnyVal

？

这只是一个偏好问题还是有惯用的指导方针？

Answer 1

我一般喜欢使用以下模式 -

final class ProductId(val underlying: String) extends AnyVal

这有以下好处 -

• 您可以随时访问underlying值
• 通过使用 case class 来防止构造函数上的模式匹配，这有助于避免实际构造对象，以便运行时值保持为String(或任何基础值(
• 您可以使用配套对象创建智能构造函数来验证其输入，并在构造值时提供更干净的接口，以便用户不必使用 new 。

下面的智能构造函数示例 -

final class ProductId(val underlying: String) extends AnyVal
object ProductId {
  def apply(s: String): Result = {
    if (s.isEmpty) {
      new Failure("ProductId cannot be empty!")
    } else {
      new Success(new ProductId(s))
    }
  }
  sealed trait Result
  final case class Success(productId: ProductId) extends Result
  final case class Failure(message: String) extends Result
}

如果要确保用户必须使用智能构造函数，请将值类的构造函数标记为私有 -

final class ProductId private (val underlying: String) extends AnyVal

如果你想确保你没有意外分配ProductId的实例，你可以检查字节码 -

scala> :paste
class Test {
  def testProductId = new ProductId("foo")
  def testSmartCtor = ProductId("bar") match {
    case ProductId.Success(productId) => productId
    case ProductId.Failure(message) => throw new AssertionError(message)
  }
}
// Ctrl+D
:javap -c ProductId$
// Skipping to the apply() method
public ProductId$Result apply(java.lang.String);
  Code:
     0: aload_1
     1: invokevirtual #20                 // Method java/lang/String.isEmpty:()Z
     4: ifeq          19
     7: new           #22                 // class ProductId$Failure
    10: dup
    11: ldc           #24                 // String ProductId cannot be empty!
    13: invokespecial #27                 // Method ProductId$Failure."<init>":(Ljava/lang/String;)V
    16: goto          27
    19: new           #29                 // class ProductId$Success
    22: dup
    23: aload_1
    24: invokespecial #30                 // Method ProductId$Success."<init>":(Ljava/lang/String;)V
    27: areturn

字节码中没有new ProductId引用，因此在运行时，您的ProductId将表示为String。

请注意，如果您尝试将值类包装在使用泛型(例如 Option、Both(的类中，那么您的值将被装箱。您可以通过创建专用于您的值类的简单案例类来避免这种情况。虽然 case 类将被实例化(因为您无法将一个值类与另一个值类包装在一起(，但基础ProductId仍将在运行时表示为 String。

Answer 2

惯用的方法是让它成为private val，现在你可以了。

就标准而言，标准库更喜欢self。

implicit final class ArrowAssoc[A](private val self: A) extends AnyVal

还有repr，让人想起AnyVal的scaladoc中的短语"底层运行时表示"和集合的repr。

class StringOps(override val repr: String) extends AnyVal with StringLike[String]

还有少量的i和n.

就个人而言，我使用特殊标识符，YMMV .