有没有办法防止使用依赖项提供的特定函数?

Question

我的应用程序与库 A 具有编译依赖项。我知道这个库中有一个特定的函数会导致性能问题。但它没有被弃用，如果您没有这些先验信息，您会认为使用它很安全。我正在寻找一种方法来以某种方式弃用此函数或防止直接调用它。

是否有可能通过静态分析工具或内置编译器标志来实现这一点？

Answer 1

你可以为 Scalafix 编写一个规则

https://scalacenter.github.io/scalafix/docs/developers/setup.html

例如，让我们弃用scala.Predef.println

class DeprecateFunction extends SemanticRule("DeprecateFunction") {
case class Deprecation(position: Position) extends Diagnostic {
override def message = "Use loggers instead of println"
override def severity = LintSeverity.Warning
}
val deprecatedFunction = SymbolMatcher.normalized("scala.Predef.println")
override def fix(implicit doc: SemanticDocument): Patch = {
doc.tree.collect {
case deprecatedFunction(t: Name) =>
Patch.lint(Deprecation(t.pos))
}.asPatch
}
}

例：

object Scalafixdemo {
println(1)
}

输出：

[IJ]sbt:scalafix> scalafix --rules=file:rules/src/main/scala/fix/DeprecateFunction.scala
[info] Running scalafix on 1 Scala sources
[warn] .../scalafix/input/src/main/scala/fix/Scalafixdemo.scala:8:3: warning: [DeprecateFunction] Use loggers instead of println
[warn]   println(1)
[warn]   ^^^^^^^
[success] Total time: 2 s, completed 27.05.2020 21:12:13

Answer 2

我已经检查了 scalafix，但对于这种 linting 的设置太复杂了。我最终使用了疣去除剂并添加了自定义疣。

自定义疣位于子项目中，如本例所示。

lazy val myWarts = project.in(file("my-warts")).settings(
commonSettings,
libraryDependencies ++= Seq(
"org.wartremover" % "wartremover" % wartremover.Wart.PluginVersion cross CrossVersion.full
)
)
lazy val main = project.in(file("main")).settings(
commonSettings,
wartremoverWarnings += Wart.custom("mywarts.ExtractOrElse"),
wartremoverClasspaths ++= {
(fullClasspath in (myWarts, Compile)).value.map(_.data.toURI.toString)
}
)

我通过简单地修改内置的投影部分疣创建了一个自定义疣。

object ExtractOrElse extends WartTraverser {
def apply(u: WartUniverse): u.Traverser = {
import u.universe._
val extractableJsonAstNode = rootMirror.staticClass("org.json4s.ExtractableJsonAstNode")
new u.Traverser {
override def traverse(tree: Tree): Unit = {
tree match {
// Ignore trees marked by SuppressWarnings
case t if hasWartAnnotation(u)(t) =>
case Select(left, TermName("extractOrElse")) if left.tpe.baseType(extractableJsonAstNode) != NoType =>
error(u)(tree.pos, "extractOrElse is deprecated - use toOption.map or extract[Option[A]] instead")
super.traverse(tree)
case _ => super.traverse(tree)
}
}
}
}
}