我想在编译时强制限制Scala方法的参数值。
例如:
case class Foo(numberOfFoo: Int, ...)
numberOfFoo
上面是Int
,但我真的想让它成为一个正整数。我已经尝试过像PositiveInt这样的类来强制执行此操作,但是这只是将检查推送到另一个仍未进行编译时检查的类。
使用上面的例子,我想要这个:
val n: Int = ...
val f: Foo = Foo(n)
编译n > 0
而不编译n <= 0
。我不希望实例化代码必须处理可能的异常,处理Option[Foo]
,或最终使用Foo
Foo.numberOfFoo != n
(即我不要)想要使用输入参数的绝对值。)
更新:感谢您提供有用的信息。这是我所担心的。大多数情况下,我希望能够指定必须具有正整数大小的东西的大小。所以这似乎是最好的方法:
case class Foo(bar: Bar) {val n = bar size}
答案 0 :(得分:8)
您将不得不使用refined库。这是不诉诸Nat
或其他类型技巧的唯一方法。从自述文件中的示例:
import eu.timepit.refined._
import eu.timepit.refined.api.Refined
import eu.timepit.refined.auto._
import eu.timepit.refined.numeric._
// This refines Int with the Positive predicate and checks via an
// implicit macro that the assigned value satisfies it:
scala> val i1: Int Refined Positive = 5
i1: Int Refined Positive = 5
// If the value does not satisfy the predicate, we get a meaningful
// compile error:
scala> val i2: Int Refined Positive = -5
<console>:22: error: Predicate failed: (-5 > 0).
val i2: Int Refined Positive = -5
答案 1 :(得分:2)
另一种方法是使用shapeless
库并使用Nat
。限制是您需要在编译时基本上使用已知常量实例化那些Foo
实体。
import shapeless.ops.nat_
import shapeless.nat._
case class Foo[T <: Nat](numberOfFoo: Int)(implicit ev: GT[T, _0]
object Foo {
// The problem is this won't work.
def apply[T <: Nat](n: Int): Foo[T] = Foo(Nat(n))
}
只有在这样使用时才会起作用:
Foo(_1)
_1
来自shapeless.nat._
。如果深入研究实现,0
部分恰好是强制执行的,即使没有你的意思:
if (n < 0) c.abort(c.enclosingPosition, s"A Nat cannot represent $n")
坚持简单的事情
然而,这非常麻烦,因为无论采用哪种方法,它都将依赖于宏,并且除非在编译时已知值,否则宏无法正常工作。如果最简单的委托方法不再有效,这可能会变得非常有限。
在实践中,绕过这种方法并使用常规方法可能更有效。无论你使用无形还是上面提到的精致库,故事都没有改变,所以对于正常的用例,运行时验证可能更清晰。