Vert.x+Scala API应用多测试用例端口占用问题求解

我明白你遇到的麻烦了——多个测试用例共用同一端口时，第二个测试总是报BindException: Address already in use。虽然你用了官方的VerticleTesting抽象类做了前后置处理，但端口还是没被正确释放，我来帮你分析并解决这个问题。

问题根源分析 #

你的VerticleTesting类中，vertx是一个类级别的val实例，意味着所有测试方法（或测试类）会共享同一个Vert.x实例。虽然你在after方法里调用了undeployFuture卸载Verticle，但：

1. 仅仅卸载Verticle不会关闭Vert.x底层的NIO线程池和网络资源，端口可能不会立刻释放
2. 如果ScalaTest默认开启了并行测试，多个测试会同时尝试绑定同一个端口，直接导致冲突
3. 若undeploy过程中出现异常（比如Verticle启动失败后未正确清理），端口会被残留的资源占用

解决方案 #

方案1：彻底关闭Vert.x实例（最直接） #

修改VerticleTesting的after方法，在卸载Verticle后关闭整个Vert.x实例，确保所有网络资源被释放：

after {
  Await.result(
    vertx.undeployFuture(deploymentId)
      // 卸载完成后关闭Vertx实例，彻底释放端口
      .flatMap(_ => vertx.closeFuture())
      .andThen {
        case Success(_) => println("Vertx instance closed successfully")
        case Failure(t) => throw new RuntimeException("Failed to clean up Vertx resources", t)
      },
    10000 millis
  )
}

同时，把vertx的定义改成lazy val，确保每个测试类（或测试方法）使用独立的Vert.x实例：

lazy val vertx = Vertx.vertx

方案2：使用随机端口（避免冲突的最佳实践） #

让每个测试用例使用随机端口，从根源上避免端口占用问题。步骤如下：

1. 修改你的API Verticle，让它支持从配置读取端口，若未指定则使用0（表示让系统分配随机可用端口）：

class ApiVerticle extends ScalaVerticle {
  override def start(): Future[Unit] = {
    // 从配置取端口，默认用0（随机端口）
    val port = config().getInteger("http.port", 0)
    vertx.createHttpServer()
      .requestHandler(yourRouter)
      .listen(port)
      .onSuccess(server => {
        // 可以把实际端口存到context里，方便测试获取
        vertx.getOrCreateContext().put("actualPort", server.actualPort())
      })
      .map(_ => ())
  }
}

2. 在VerticleTesting中，添加方法获取实际绑定的端口：

// 获取测试中实际使用的端口
def getActualPort(): Int = {
  Await.result(
    vertx.deploymentInfoFuture(deploymentId)
      .map(info => info.config().getInteger("actualPort")),
    5000 millis
  )
}

3. 测试时用这个动态端口发送请求：

class ApiTest extends VerticleTesting[ApiVerticle] {
  "API endpoint /foo" should "return 200" in {
    val port = getActualPort()
    vertx.createHttpClient().get(port, "localhost", "/foo").send()
      .map(response => assert(response.statusCode() == 200))
  }

  "API endpoint /bar" should "return 200" in {
    val port = getActualPort()
    vertx.createHttpClient().get(port, "localhost", "/bar").send()
      .map(response => assert(response.statusCode() == 200))
  }
}

方案3：禁用ScalaTest并行测试 #

如果必须使用固定端口，可以禁用ScalaTest的并行执行，确保测试按顺序运行：

在测试类上添加@DoNotParallelize注解（ScalaTest 3.2.0+版本支持）：

import org.scalatest.DoNotParallelize

@DoNotParallelize
class ApiTest extends VerticleTesting[ApiVerticle] {
  // ... 测试方法
}

或者在build.sbt中全局配置并行度：

Test / parallelExecution := false

验证方法 #

可以在before和after方法中添加日志，确认Verticle的部署和卸载流程是否正常执行：

before {
  println("Starting to deploy verticle...")
  deploymentId = Await.result(
    vertx.deployVerticleFuture(/* ... */)
      .andThen {
        case Success(d) => println(s"Verticle deployed with ID: $d")
        case Failure(t) => println(s"Deployment failed: ${t.getMessage}")
      },
    10000 millis
  )
}

after {
  println(s"Undeploying verticle with ID: $deploymentId")
  Await.result(
    vertx.undeployFuture(deploymentId)
      .flatMap(_ => vertx.closeFuture())
      .andThen {
        case Success(_) => println("Cleanup completed")
        case Failure(t) => println(s"Cleanup failed: ${t.getMessage}")
      },
    10000 millis
  )
}

内容的提问来源于stack exchange，提问作者MrNierda