Question

有没有人知道是否有一种惯用的方法来命名Scala Value Class的内部值？假设我有一个产品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通过 not 阻止构造函数上的模式匹配，这有助于避免实际构造对象，因此运行时值保持为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
}

如果您想确保用户必须使用智能构造函数，请标记您的价值类＆＃39;构造函数为私有 -

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，Either），那么您的值将被装箱。您可以通过创建一个专门用于您的值类的简单案例类来避免这种情况。虽然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。

Scala值类的惯用法

2 个答案: