带有自定义验证的 Play Framework JSON 自动映射

Question

大家好，我是 Scala 世界的新手，我想使用 Play Framework 创建一个简单的 REST API。我正在处理 JSON 到案例类的映射，我可能有一个愚蠢的问题。

我有一个代表UserDto 的案例类（它用于用户注册，并获取有关用户的一些基本信息）

case class UserDto(id: Option[Int], email: String, username: String, password: Option[String], confirmedPassword: Option[String])

正如 Play Framework 文档中所说，有多种方法可以将其映射到 JSON，我正在查看 automated mapping part

我的做法是

val userDtoWrites: OWrites[UserDto] = Json.writes[UserDto]
val userDtoReads: Reads[UserDto] = Json.reads[UserDto]

现在我想为我的 UserDto 添加一些验证，例如，检查电子邮件是否正确。

所以我的问题是，是否有可能创建一个仅检查电子邮件字段的 Read 并将其添加到自动生成的 Read 中？

我用 composeWith 尝试过，但在运行第二个 Read 后，它只返回电子邮件部分。

val checkEmail: String = (JsPath \ "email").read[String](email)
val checkEmailJsString: JsString = checkEmail.map(s => JsString(s))
val newRead = userDtoReads.composeWith(checkEmailJsString))

例如，当用户想要注册时：

{"email": "user@email.com", "username": "user","password": "password1234", "confirmedPassword": "password1234"} 

这应该映射到：

UserDto(None, user@email.com, user, password1234, password1234)

如果一切都是正确的。如果密码不匹配或电子邮件格式错误，例如应该返回 400。

Answer 1

如果您想拥有只有有效电子邮件的 UserDto 实例，那么您应该考虑使用 Refined 类型（例如使用 https://github.com/avdv/play-json-refined 来提供对 Play JSON 的支持）。

import eu.timepit.refined._
import eu.timepit.refined.auto._
import eu.timepit.refined.api._
import play.api.libs.json._
import de.cbley.refined.play.json._

type EmailPattern = "^\S+@\S+\.\S+$"       // Scala 2.13 version
type EmailPattern = W.`"^\S+@\S+\.\S+$"`.T // before 2.13

type Email = String Refined string.MatchesRegex[EmailPattern]

case class UserDto(
  id: Option[Int],
  email: Email, // instead of plain String
  username: String,
  password: Option[String],
  confirmedPassword: Option[String]
)
object UserDto {
  implicit val userDtoWrites: OWrites[UserDto] = Json.writes[UserDto]
  implicit val userDtoReads: Reads[UserDto] = Json.reads[UserDto]
}

Answer 2

如果不想使用其他库，可以实现自己的Reads[UserDto]：

case class UserDto(id: Option[Int], email: String, username: String, password: Option[String], confirmedPassword: Option[String])

implicit val reads: Reads[UserDto] = (
  (__ \ "id").readNullable[Int] and
    (__ \ "email").read[String].filter(JsonValidationError("email is not valid"))(isValid) and
    (__ \ "username").read[String] and
    (__ \ "password").readNullable[String] and
    (__ \ "confirmedPassword").readNullable[String]
  ) (UserDto).filter(
  JsonValidationError("password and confirmedPassword must be equal")
) { userDto =>
  userDto.password == userDto.confirmedPassword
}

然后就可以使用了：

val successfulJsonString = """{"email": "user@email.com", "username": "user", "password": "password1234", "confirmedPassword": "password1234"}"""
val emailJsonString = """{"email": "user", "username": "user","password": "password1234", "confirmedPassword": "password1234"}"""
val passwordsJsonString = """{"email": "user@email.com", "username": "user","password": "password1234", "confirmedPassword": "1234"}"""

Json.parse(successfulJsonString).validate[UserDto].fold(println, println)
Json.parse(emailJsonString).validateOpt[UserDto].fold(println, println)
Json.parse(passwordsJsonString).validate[UserDto].fold(println, println)

并得到输出：

UserDto(None,user@email.com,user,Some(password1234),Some(password1234))
List((/email,List(JsonValidationError(List(email is not valid),List()))))
List((,List(JsonValidationError(List(field1 and field2 must be equal),List()))))

我参考了Scala play json combinators for validating equality 和how to add custom ValidationError in Json Reads in PlayFramework 来构建该解决方案。

代码在Scastie 运行。