JSON l&agrave; một định dạng xử l&yacute; dữ liệu. Định dạng n&agrave;y đặc biệt hữu &iacute;ch trong thao t&aacute;c với JavaScript hoặc TypeScript do n&oacute; gần như l&agrave; cấu tr&uacute;c gốc của ng&ocirc;n ngữ.
Ở đ&acirc;y d&ugrave;ng từ &ldquo;gần như&rdquo; bởi mặc d&ugrave; ch&uacute;ng ta thường d&ugrave;ng lẫn lộn n&oacute; với khai b&aacute;o đối tượng literal của JavaScript nhưng ch&uacute;ng kh&ocirc;ng ho&agrave;n to&agrave;n giống nhau. Khi sử dụng TypeScript, sự kh&aacute;c biệt c&ograve;n đ&aacute;ng kể hơn do định dạng JavaScript thiếu nhiều type.
Mặc d&ugrave; kh&ocirc;ng c&oacute; c&aacute;ch &ldquo;thuần t&uacute;y&rdquo; của một trong hai ng&ocirc;n ngữ để th&ecirc;m t&iacute;nh năng nhập liền mạch v&agrave;o định dạng JSON, ta vẫn c&oacute; c&aacute;ch để triển khai.
&nbsp;
<h2 style="text-align: justify;">JSON Schema cho JavaScript</h2>
Nếu th&iacute;ch sử dụng type v&agrave; JavaScript, tốt hơn hết l&agrave; bạn n&ecirc;n viết TypeScript. Mặc d&ugrave; vậy, đối với dữ liệu định dạng JSON, ta vẫn c&oacute; c&aacute;ch để triển khai trong JS, đ&oacute; l&agrave; <a href="https://json-schema.org/">JSON Schemas</a>.
Sau khi x&aacute;c định companion scheme cho JSON, bạn c&oacute; thể thiết lập đ&uacute;ng kỳ vọng cho từng thuộc t&iacute;nh. Liệu đ&oacute; c&oacute; phải l&agrave; 1 gi&aacute; trị số kh&ocirc;ng? Hay l&agrave; 1 biểu thức ch&iacute;nh quy tự x&aacute;c thực ch&iacute;nh n&oacute;? Hay l&agrave; 1 đối tượng với h&igrave;nh dạng cụ thể?
Đ&acirc;y l&agrave; một trong những t&ugrave;y chọn c&oacute; thể chỉ định trong schema. Thực ra phương ph&aacute;p n&agrave;y c&oacute; rất nhiều ưu điểm. Điểm trừ duy nhất l&agrave; y&ecirc;u cầu của schema thường kh&aacute; d&agrave;i d&ograve;ng.
V&iacute; dụ tạo schema cho JSON:
<pre class="language-python"><code>{
 "title": "Harry Potter and the Prisoner of Azkaban",
 "isbn": 9780786222742,
}</code></pre>
Ở tr&ecirc;n chỉ c&oacute; 2 thuộc t&iacute;nh n&ecirc;n code kh&aacute; ngắn gọn. Dưới đ&acirc;y l&agrave; c&aacute;ch d&ugrave;ng Schema để x&aacute;c thực định dạng:
<pre class="language-python"><code>{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "$id": "https://example.com/product.schema.json",
 "title": "Book",
 "description": "A book",
 "type": "object",
 "properties": {
 "title":{
 "type": "string",
 "description": "The full title of the book"
 },
 "isbn": {
 "type": "integer",
 "description": "The International Standard Book Number for this item"
 }
 },
 "required": ["title", "isbn"]
}</code></pre>
Nh&igrave;n code l&agrave; hiểu tại sao nhiều người ph&agrave;n n&agrave;n l&agrave; n&oacute; kh&aacute; &ldquo;d&agrave;i d&ograve;ng lan man&rdquo;. Bạn phải viết 18 d&ograve;ng khai b&aacute;o chỉ để x&aacute;c thực 2 thuộc t&iacute;nh.
Từ d&ograve;ng 2 đến 6:
<ul style="text-align: justify;">
<li style="font-weight: 400;" aria-level="1">&ldquo;$schema&rdquo; cho biết phi&ecirc;n bản schema đang d&ugrave;ng. Chủ yếu d&agrave;nh cho tập lệnh x&aacute;c thực, d&ugrave;ng để giải th&iacute;ch định nghĩa v&agrave; &aacute;p dụng bước x&aacute;c thực.</li>
<li style="font-weight: 400;" aria-level="1">&ldquo;$Id&rdquo; l&agrave; URL của file.</li>
<li style="font-weight: 400;" aria-level="1">&ldquo;title&rdquo; v&agrave; &ldquo;description&rdquo; chỉ l&agrave; th&ocirc;ng tin m&ocirc; tả v&agrave; kh&ocirc;ng nhằm thực hiện h&agrave;nh động g&igrave;.</li>
<li style="font-weight: 400;" aria-level="1">Cuối c&ugrave;ng, &ldquo;type&rdquo; l&agrave; &ldquo;object&rdquo; tức l&agrave; bạn đang x&aacute;c định cấu tr&uacute;c đối tượng như một phần của schema. Nếu đổi th&agrave;nh &ldquo;string&rdquo;, JSON sẽ l&agrave; một gi&aacute; trị chuỗi đơn giản.</li>
</ul>
Từ kh&oacute;a đ&aacute;ng ch&uacute; &yacute; tiếp theo l&agrave; &ldquo;properties&rdquo;, th&agrave;nh phần chứa phần khai b&aacute;o key-value cho mỗi kh&oacute;a. Lưu &yacute;, pattern ở đ&acirc;y bị tr&ugrave;ng lặp, &iacute;t nhất l&agrave; trong v&iacute; dụ n&agrave;y, ch&uacute;ng ta chỉ sử dụng t&ecirc;n của thuộc t&iacute;nh l&agrave;m kh&oacute;a v&agrave; th&ecirc;m thuộc t&iacute;nh &ldquo;type&rdquo; v&agrave; &ldquo;description&rdquo; v&agrave;o đ&oacute;. Phần description chỉ để m&ocirc; tả th&ocirc;ng tin v&agrave; kh&ocirc;ng được d&ugrave;ng để x&aacute;c thực dữ liệu.
Chi tiết quan trọng cuối c&ugrave;ng l&agrave; từ &ldquo;required&rdquo; ở d&ograve;ng 17. Đ&acirc;y nhẽ ra l&agrave; 1 mảng chuỗi t&ugrave;y chọn, mỗi chuỗi tham chiếu đến t&ecirc;n của những kh&oacute;a quan trọng kh&ocirc;ng thể thiếu trong JSON. Lưu &yacute;, c&aacute;c kh&oacute;a kh&ocirc;ng được th&ecirc;m v&agrave;o đ&acirc;y l&agrave; kh&oacute;a t&ugrave;y chọn v&agrave; bạn sẽ kh&ocirc;ng gặp lỗi nếu thiếu một trong số c&aacute;c kh&oacute;a đ&oacute;.&nbsp;
&nbsp;
<h2 style="text-align: justify;">Sử dụng JSON Schema cho JS&nbsp;code</h2>
C&aacute;ch sử dụng JSONSchemas trong JavaScript kh&aacute; dễ hiểu v&agrave; đơn giản bởi c&oacute; nhiều g&oacute;i được cung cấp sẵn để triển khai x&aacute;c thực.
V&iacute; dụ như NPM module <a href="https://github.com/hyperjump-io/json-schema-validator">json-schema-validator của Hyperjumps</a>. 
C&aacute;ch c&agrave;i đặt: <code>npm install @hyperjump/json-schema</code>
Bạn chỉ cần đợi tải xong schema v&agrave; gọi phương thức cần d&ugrave;ng:
<pre class="language-python"><code>const JsonSchema = require("@hyperjump/json-schema");


let myJSON = {
 "title": "Harry Potter and the Prisoner of Azkaban",
 "isbn": 9780786222742
};

(async () =&gt; {
 
 const schema = await JsonSchema.get("file:///C:/Users/ferna/workspace/personal/writing/bit/json-schema/schema.json");
 
 const output = await JsonSchema.validate(schema, myJSON, JsonSchema.DETAILED);
 if (output.valid) {
 console.log("Instance is valid :-)");
 } else {
 console.log("Instance is invalid :-(");
 output.errors.forEach(e =&gt; { //for each error type
 console.log("-----")
 e.errors.forEach( innerE =&gt; {
 console.log(innerE)
 })
 console.log("-----")
 })
 }
 
})();</code></pre>
Phần xử l&yacute; lỗi ở tr&ecirc;n kh&ocirc;ng phải l&agrave; c&aacute;ch l&yacute; tưởng nhất nhưng nếu copy paste đoạn tr&ecirc;n, bạn sẽ nhận được một số th&ocirc;ng tin hữu &iacute;ch khi sửa lỗi.&nbsp;
Nếu d&ugrave;ng g&oacute;i kh&aacute;c th&igrave; nhớ đảm bảo g&oacute;i c&oacute; thể x&aacute;c thực phi&ecirc;n bản schema mới nhất, nếu kh&ocirc;ng bạn sẽ gặp lỗi kh&ocirc;ng thể x&aacute;c định. V&agrave;o thời điểm viết b&agrave;i viết n&agrave;y (2022) th&igrave; phi&ecirc;n bản JSON Schema mới nhất l&agrave; 2020-12.
Đ&oacute; l&agrave; tất cả những g&igrave; cần biết về JS. Nếu th&iacute;ch sử dụng c&aacute;ch tiếp cận n&agrave;y, bạn c&oacute; thể tham khảo t&agrave;i liệu schema v&agrave; thử nghiệm với một số tr&igrave;nh x&aacute;c thực online (như <a href="https://www.jsonschemavalidator.net/">tr&igrave;nh x&aacute;c thực sau</a>).
&nbsp;
<h2 style="text-align: justify;">Vậy c&ograve;n TypeScript th&igrave; sao?</h2>
C&aacute;ch tiếp cận tr&ecirc;n c&oacute; thể &aacute;p dụng ho&agrave;n to&agrave;n với TypeScript. Thực ra thư viện được d&ugrave;ng ở tr&ecirc;n c&oacute; phần x&aacute;c định type d&agrave;nh cho TS.
Tuy nhi&ecirc;n trong TS c&oacute; c&aacute;ch l&agrave;m đơn giản hơn do mục ti&ecirc;u ở đ&acirc;y kh&ocirc;ng phải l&agrave; triển khai JSON Schema tr&ecirc;n TS m&agrave; chủ yếu l&agrave; th&ecirc;m hỗ trợ type cho định dạng JSON.
Do TS đ&atilde; t&iacute;ch hợp sẵn t&iacute;nh năng x&aacute;c thực type n&ecirc;n ta kh&ocirc;ng cần quan t&acirc;m đến việc x&aacute;c thực. Để x&aacute;c thực nội dung của JSON th&igrave; chỉ cần biến n&oacute; th&agrave;nh đối tượng triển khai 1 class cụ thể. Sau đ&oacute; TS sẽ l&agrave;m phần c&ograve;n lại.
V&agrave; ta c&oacute; thể sử dụng DTO (Data Transfer Object) pattern. DTO chỉ đơn giản l&agrave; một đối tượng được serialize ở 1 b&ecirc;n wire v&agrave; chuyển v&agrave;o b&ecirc;n kia, nơi n&oacute; được thu nạp v&agrave; quay trở lại th&agrave;nh đối tượng.
Nếu xem x&eacute;t kỹ một ch&uacute;t, bạn sẽ thấy bản th&acirc;n đối tượng kh&ocirc;ng chứa bất kỳ phương thức n&agrave;o (do ch&uacute;ng kh&ocirc;ng thực sự được serialize, &iacute;t nhất l&agrave; theo c&aacute;ch th&ocirc;ng thường). N&oacute;i c&aacute;ch kh&aacute;c, ta đang xử l&yacute; một đối tượng kh&ocirc;ng c&oacute; phương thức.
Tức l&agrave; ta chỉ cần khai b&aacute;o class với type ph&ugrave; hợp v&agrave; sau đ&oacute; l&agrave;m như sau:
<pre class="language-python"><code>type BookAttributes = {
 title: string,
 isbn: number
}

class Book {
 properties: BookAttributes;

 constructor( jsonProps: BookAttributes) {
 this.properties = jsonProps;
 }
}

let myJSON = {
 "title": "Harry Potter and the Prisoner of Azkaban",
 "isbn": 9780786222742,
}

let myInvalidBook = {
 "isbn": "999288392"
}

const myBook = new Book(myJSON)
const mySecondBook = new Book(myInvalidBook)</code></pre>
Về cơ bản, ta đang x&aacute;c định một type (<code>BookAttributes</code>) để chỉ định c&aacute;c attribute v&agrave; type cần c&oacute; của JSON.
Sau đ&oacute; x&aacute;c định DTO class, class n&agrave;y chứa 1 attribute <code>properties</code> duy nhất. Attribute n&agrave;y cũng thuộc type <code>BookAttributes</code> v&agrave; những g&igrave; c&oacute; thể l&agrave;m trong h&agrave;m tạo l&agrave; g&aacute;n JSON cho n&oacute;. Đ&acirc;y l&agrave; l&uacute;c điều kỳ diệu xảy ra. Khi thực hiện g&aacute;n, nếu type kh&ocirc;ng khớp th&igrave; TypeScript sẽ gửi cảnh b&aacute;o.
Đ&acirc;y l&agrave; điều xảy ra ở d&ograve;ng 24, do JSON <code>myInvalidBook</code> kh&ocirc;ng c&oacute; attribute <code>title</code> v&agrave; type của attribute <code>isbn</code> bị sai, ta nhận được cảnh b&aacute;o lỗi như sau:
<code>Argument of type '{ isbn: string; }' is not assignable to parameter of type 'BookAttributes'. &nbsp; Property 'title' is missing in type '{ isbn: string; }' but required in type 'BookAttributes'.</code>
Một giải ph&aacute;p đơn giản nhưng rất hữu &iacute;ch. Nếu tải JSON từ file hoặc tạo kiểu động, giải ph&aacute;p n&agrave;y sẽ l&agrave;m cho c&aacute;c type lu&ocirc;n lu&ocirc;n được kiểm tra.
JSON l&agrave; một kiểu định dạng dữ liệu ấn tượng, nhưng n&oacute; c&oacute; nhược điểm l&agrave; kh&ocirc;ng thể th&ecirc;m c&aacute;c định nghĩa type &ldquo;đơn giản&rdquo;. Với những c&aacute;ch tiếp cận tr&ecirc;n, bạn c&oacute; thể khắc phục nhược điểm đ&oacute;. Ngo&agrave;i ra c&ograve;n c&oacute; nhiều c&aacute;ch để giải quyết vấn đề với c&aacute;c c&ocirc;ng cụ hiện nay.
Nhớ để lại comment nếu bạn cần giải th&iacute;ch th&ecirc;m phần n&agrave;o hoặc đề xuất c&aacute;ch n&acirc;ng cao hơn!

Admin

Tổng quan về jsonschema và DTO pattern

Cùng tác giả

Admin

Có liên quan