Chuẩn hoá và validate dữ liệu trong Phoenix với thư viện Tarams

Yêu cầu chuẩn hoá và các tham số truyền lên từ 클라이언트 là yêu cầu cơ bản khi xây dựng API Web. Mình đã có một bài hướng dẫn sử dụng Ecto.Changeset để chuẩn hoá tong bài viết này:

Trong bài viết này, mình sẽ hướng dẫn một cách ngắn và đơn giản hơn bằng cách sử dụng thư. Thư viện này thực ra là sử dụng lại Ecto.Changeset nhưng nó giúp cho chúng ta không phải lặp lại quánhi code

Một vài tính năng thú vị của Tarams:

Cung cấp cách thức đơn giản để định nghĩa các cấu truc tham số

Cho phép định nghĩa các giá trị 기본값 động

Cho phép định nghĩa các hàm để cast giá trị về đúng kiểu dữ liệu

Định nghĩa hàm để dữ liệu를 확인하다

Sau đây là cách sử dụng Ecto.Changeset . Ví dụ chúng ta đang viết API để cập nhật 프로필 của nhân viên. 예우 까우 라

email: bắt buộc, đúng định dạng
first_name: bắt buộc
last_name: bắt buộc
birthday: không bắt buộc, kiểu ngày tháng
title: không bắt buộc
start_date: ngày bắt đầu làm việc, ngày tháng, mặc định là ngày hiện tại

타람스 1. Định nghĩa cấu truc của tham số truyền lên kha đơn giản

@schema  %{
    email: [type: :string],
    first_name: [type: :string],
    last_name: [type: :string],
    title: :string,
    birth_day: [type: :date],
    start_date: [type: :date]
}

Schema đơn giản chỉ là một map với key là tên field và value là 1 list option của field đó.

2. Bây giờ thêm các ràng buộc

Để đánh dấu 1 trường là bắt buộc, têm option Tarams

required: true cũng cho phép validate data sử dụng lại các hàm validate của Taram

@schema  %{
    email: [type: :string, required: true, validate: {:format, ~r/@/}],
    first_name: [type: :string, required: true],
    last_name: [type: :string, required: true],
    title: :string,
    birth_day: [type: :date],
    start_date: [type: :date]
}

3. Bây giờ thì 기본 설정 các giá trị

Changeset có thể la 1 giá trị hoặc 1 hàm. Mỗi khi parse tham số thì hàm này sẽ được gọi để lấy giá trị mặc định

@schema  %{
    ...
    title: [type: :string, default: "staff"],
    birth_day: [type: :date],
    start_date: [type: :date, default: &Timex.today/0]
}

4. các giá trị tham số về đúng kiểu

Nhiều các giá trị tham số truyền lên phải được chuyển về đúng các loại dữ liệu phức tại
Ví dụ ngày tháng truyền lên là string default thì phải chuyển về kiểu date để sử dụng lại đượ Tarams hỗ trợ định nghĩa 1 hàm custom để cast giá trị, hàm này trả về

01/12/1994 nếu parse thành công

{:ok, value} nếu thất bại

def parse_date(date_str) do
    Timex.parse(date_str, "{0D}/{0M}/{YYYY}")
end

@schema  %{
    ...
    title: [type: :string, default: "staff"],
    birth_day: [type: :date, cast_func: &parse_date/1],
    start_date: [type: :date, default: &Timex.today/0]
}

5. Bây giờ sử dụng nào

def update(conn, params) do
    with {:ok, user_data} <- Tarams.parse(@schema, params) do
        # do anything with your params
        # access data bằng atom key: user_data.email
    else
        {:error, changset} -> # return params error
    end
end

Hàm {:error, error_message} sẽ parse và validate dữ liệu. Nếu mọi thứ đều ổn, sẽ trả về parse và ngược lại thì trả về {:ok, data} .

완료! 코드 của bạn sẽ trở nên đơn giản và ngắn gọn hơn nhiều