Rustのgardeトレイトを使うときはUnvalidatedを使いたい
gardeトレイトの概要
gardeトレイトはVaridateというマクロを提供しており、structのフィールドの検証を行えます。
公式ドキュメントに記載されている下記の例ではUserというstructのフィールドの文字列がASCII文字列であるかどうか、と長さが適切かどうかを検証しています。
use garde::{Validate, Valid};
#[derive(Validate)]
struct User<'a> {
#[garde(ascii, length(min=3, max=25))]
username: &'a str,
#[garde(length(min=15))]
password: &'a str,
}
let user = User {
username: "test",
password: "not_a_very_good_password",
};
// Userが不正な値を保持していないか検証する
if let Err(e) = user.validate() {
println!("invalid user: {e}");
}
課題感
上記のようにValidateマクロのvalidate関数を使う場合、
検証済の型と未検証の型が一緒くたにされてしまいます。
上記の例で言うとif let Err(e) = user.validate() {..}より下のブロックでは、userが検証済の値として利用できますが、それ以前では未検証の値になります。
関数型ドメインモデリングで提唱されているように厳格な型システムによる、堅牢なプログラミングのためには
「不正な状態を定義不能にせよ」"make illegal states unrepresentable"や「検証せず、パースせよ」Parse, don’t validateといった考え方が重要になります。
つまり不正な状態があり得る型と正常な値の型を区別して利用するべきです。
そのため、明示的に未検証の値と検証済の値を分けて定義しましょう。
解決方法
gardeにはUnvalidatedとValidというstructがあり、これを利用します。
Unvalidated<T>エンティティの.validate()の戻り値はResult<Valid<T>, Report>であるため、Valid<T>という検証済の型を作ることができます
RustのgardeトレイトはRustの代表的Webサーバーのトレイトであるaxumとも連携して、リクエストの値などの検証を宣言的に行うことができます。
Webの開発ではaxumと連携して以下のように使われます。
（コードの大枠はRustによるWebアプリケーション開発 設計からリリース・運用までから拝借しています。）
修正前
use garde::Validate;
use serde::Deserialize;
// gardeを使ったstructの定義
#[derive(Deserialize, Validate)]
#[serde(rename_all = "camelCase")]
pub struct CreateUserRequest {
#[garde(length(min = 1))]
name: String,
#[garde(email)]
email: String,
#[garde(length(min = 1))]
password: String,
}
// Fromトレイトで型の詰め替えを定義
impl From<CreateUserRequest> for CreateUser {
//...
}
// ユーザーを追加する
pub async fn register_user(
// 他引数は省略
Json(req): Json<CreateUserRequest>,
) -> AppResult<Json<UserResponse>> {
// 認証関連の処理など省略
// ここで値を検証し、以降reqを検証済とみなす
// ただしコンパイラとしてはreqが検証済かわからない
req.validate(&())?;
let registered_user = registry.user_repository()
.create(req.into()) // ← ここでモデルの型（CreateUser）にinto()で変換する
.await?;
Ok(Json(registered_user.into()))
}
これをUnvalidatedとValidを使って以下のように記述します。
修正後
use garde::{Validate, Unvalidated}; // <- Unvalidatedを追加
// register_user以前は同じ
pub async fn register_user(
// 他引数は省略
Json(raw_req): Json<CreateUserRequest>, // ← raw_reqは未検証の型
) -> AppResult<Json<UserResponse>> {
// 認証関連の処理など省略
// 値を検証、valid_reqは検証済の値
let valid_req = Unvalidated::new(raw_req).validate(&())?;
let registered_user = registry.user_repository()
.create(valid_req.into_inner().into())
.await?;
Ok(Json(registered_user.into()))
}
このようにすることで、valid_reqをreqとは分けて定義することができ、不正な状態があり得る型を未検証のまま使うこともなくなりました。
コンパイラからも検証済の型と未検証の型を区別することができます。
Discussion