Chuyển đến nội dung
MINH VO Ghi chép từ công việc
của một kỹ sư tại Việt Nam
Cơ bản11 phút đọc

Phân biệt thuộc tính vắng mặt, null và chuỗi rỗng trong JSON

Giữ riêng ý nghĩa của thuộc tính không được gửi, null và chuỗi rỗng khi cập nhật JSON; chuyển chúng thành thao tác ghi rõ ràng trước lớp lưu trữ.

Các thành phần máy chủ màu ô liu và than chì nối với nhau trên nền be ấm

Thuộc tính không có trong JSON, thuộc tính mang giá trị null và thuộc tính chứa chuỗi rỗng là ba đầu vào khác nhau. Nếu bạn là lập trình viên đang xây dựng chức năng cập nhật tài khoản, hãy giữ riêng ba trạng thái ấy cho đến khi hợp đồng API quyết định ý nghĩa của từng trạng thái. Một điều kiện chỉ kiểm tra giá trị đúng hay sai theo JavaScript có thể biến thao tác xóa tên thành “giữ nguyên”, hoặc làm mất giá trị mà người gọi không định sửa.

Tài liệu về object của JSON Schema phân biệt sự có mặt của thuộc tính với kiểu giá trị của nó. Thuộc tính bắt buộc phải có vẫn có thể nhận null nếu schema cho phép kiểu null. Ngược lại, thuộc tính không bắt buộc vẫn có thể từ chối null mỗi khi người gọi gửi nó.

Viết ba yêu cầu trước khi viết hàm xử lý

Giả sử một tài khoản đang có displayName: "Minh". Endpoint cập nhật một phần có thể nhận các yêu cầu sau:

{}
{"displayName": null}
{"displayName": ""}

Một hợp đồng có thể quy định: không gửi thuộc tính thì giữ nguyên, null thì xóa tên hiển thị tùy chọn, còn chuỗi rỗng là dữ liệu không hợp lệ. Hợp đồng khác có thể chấp nhận chuỗi rỗng như một giá trị thực. Cả hai lựa chọn đều có thể dùng được, nhưng client và server cần thống nhất trước khi mã chuyển dữ liệu biểu mẫu thành JSON có thể hoạt động đúng.

Ô nhập văn bản thường trả về một chuỗi cho JavaScript, kể cả chuỗi rỗng sau khi người dùng xóa hết nội dung. Nếu server dùng null để biểu thị thao tác xóa, client phải ánh xạ hành động đó một cách rõ ràng. Đừng mặc nhiên cho rằng trường chưa chạm đến và trường đã được chủ động xóa sẽ tự tạo ra hai JSON phân biệt được.

Hành vi trong ví dụ là quy ước của ứng dụng. RFC 5789 định nghĩa phương thức PATCH; kiểu nội dung của tài liệu vá mới quy định cách áp dụng các chỉ thị bên trong. Một object JSON thông thường không tự mang quy tắc “bỏ qua thuộc tính nghĩa là giữ nguyên” chỉ vì nó được gửi bằng PATCH.

Sự có mặt và kiểu dữ liệu là hai quy tắc riêng

Với yêu cầu tạo mới bắt buộc có tên hiển thị khác null, schema có thể thể hiện cả hai yêu cầu:

{
  "type": "object",
  "properties": {
    "displayName": {"type":"string", "minLength":1, "maxLength":80}
  },
  "required": ["displayName"],
  "additionalProperties": false
}

Bỏ displayName khỏi required khiến thuộc tính trở thành tùy chọn, nhưng không cho phép null. Muốn cho phép null, bạn có thể khai báo kiểu của thuộc tính gồm cả string và null. Các ràng buộc dành cho chuỗi còn lại được áp dụng theo quy tắc của JSON Schema.

Chú thích default cũng không phải chỉ thị chung buộc mọi công cụ phải sửa yêu cầu. Một số thư viện có tùy chọn điền giá trị mặc định; số khác chỉ kiểm tra và cung cấp thông tin chú thích. Hãy ghi rõ hành vi điền mặc định mà hệ thống thực sự bật, bao gồm việc nó chỉ áp dụng khi thiếu thuộc tính hay còn áp dụng cả với null được gửi tường minh.

Ba đầu vào cập nhật tài khoản có ba nhánh riêng: thiếu thuộc tính giữ nguyên, null xóa tên, còn chuỗi rỗng bị từ chối theo hợp đồng ví dụMở ảnh kích thước đầy đủ ↗

Các nhánh trên là chính sách của endpoint này. Sao chép nguyên chính sách sang trường khác mà không xem ý nghĩa nghiệp vụ của trường có thể tạo thêm lỗi.

Đừng dùng truthiness để kiểm tra thuộc tính có mặt

Hàm xử lý như if (body.displayName) updateName(body.displayName) bỏ qua cả null lẫn chuỗi rỗng. Luồng xử lý khi đó phụ thuộc vào truthiness, tức cách JavaScript coi một giá trị là đúng hay sai trong điều kiện, thay vì các trạng thái đầu vào đã công bố. Với trường khác, những giá trị hợp lệ như số không hoặc false cũng biến mất qua cùng kiểu kiểm tra.

Khi việc không gửi thuộc tính có ý nghĩa, hãy kiểm tra thuộc tính riêng của object một cách tường minh. Sau bước kiểm tra object, Object.hasOwn(body, 'displayName') phân biệt thuộc tính vắng mặt với thuộc tính có mặt và mang null. Cách này cũng tránh gọi một phương thức trên prototype mà nội dung không đáng tin có thể che khuất bằng thuộc tính cùng tên.

Nếu hàm có thể nhận object ngoài kết quả phân tích JSON thông thường, đừng dùng toán tử in mà bỏ qua thuộc tính kế thừa. Pipeline xử lý yêu cầu có thể chuyển đổi dữ liệu hoặc tạo object tùy biến. Kiểm tra và chuẩn hóa tại một ranh giới xác định để lớp lưu trữ nhận được một mô hình ghi đã được xây dựng có chủ đích.

Quá trình chuyển thành JSON còn có thể xóa sự khác biệt trước khi yêu cầu rời client. Khi tuần tự hóa object JavaScript thông thường, JSON.stringify bỏ thuộc tính có giá trị undefined nhưng giữ null được gửi tường minh. Với phần tử mảng, undefined được xử lý khác. Khi tìm lỗi về sự có mặt của thuộc tính, hãy xem yêu cầu thực sự được gửi; object hiện trong trình gỡ lỗi không chứng minh các byte nào đã đi qua HTTP.

Lớp lưu trữ cũng có thể gộp các trạng thái quá sớm

Một cột quan hệ thường lưu giá trị hoặc SQL NULL. Trạng thái “không được cung cấp” của yêu cầu là chỉ thị về việc có ghi cột đó hay không, chứ không phải giá trị thứ ba cần lưu. Hãy xây dựng lệnh cập nhật từ hợp đồng: bỏ cột khỏi lệnh ghi, gán NULL, hoặc gán chuỗi đã được kiểm tra.

Một hàm ORM ánh xạ mọi thuộc tính undefined thành giá trị mặc định của cơ sở dữ liệu có thể khác hẳn hàm bỏ qua undefined. Cần kiểm tra đúng ngữ nghĩa cập nhật của thư viện đang dùng. Truyền thẳng object yêu cầu xuống lớp lưu trữ thường vô tình biến các quy tắc mặc định của thư viện thành một phần API công khai.

Khi nhiều trường cùng tham gia một quy tắc, hãy kiểm tra cả trạng thái sau cập nhật. Yêu cầu bỏ qua startDate nhưng xóa endDate có thể đúng về cấu trúc mà sai với chính sách gói đăng ký. Đọc hoặc khóa trạng thái hiện tại theo hợp đồng xử lý đồng thời của thao tác trước khi kết luận tổ hợp cuối cùng được phép.

Chuyển sự khác biệt đã kiểm tra thành thao tác rõ ràng

Hãy biểu diễn hành động được yêu cầu trước khi tạo lệnh cập nhật ORM. Hàm nhỏ dưới đây chỉ chấp nhận hợp đồng một trường của bài viết và trả về keep, clear hoặc set. Hàm chạy sau bước phân tích JSON và không phụ thuộc thư viện cơ sở dữ liệu nào. Các lỗi mang tên tượng trưng để bộ ánh xạ lỗi của ứng dụng xử lý, chưa phải phản hồi HTTP hoàn chỉnh.

function displayNameChange(body) {
  if (body === null || typeof body !== 'object' || Array.isArray(body)) {
    throw new Error('invalid_object');
  }
  if (Object.keys(body).some(key => key !== 'displayName')) {
    throw new Error('unknown_field');
  }
  if (!Object.hasOwn(body, 'displayName')) return { kind: 'keep' };
  const value = body.displayName;
  if (value === null) return { kind: 'clear' };
  if (typeof value !== 'string') throw new Error('invalid_display_name');
  const length = [...value].length;
  if (length < 1 || length > 80) throw new Error('invalid_display_name');
  return { kind: 'set', value };
}

Quy tắc độ dài đếm điểm mã Unicode, không đếm byte UTF-8 hay cụm ký tự mà người đọc cảm nhận là một ký tự. Hàm giữ nguyên chuỗi được gửi, bao gồm dấu cách. Nếu sản phẩm cần cắt khoảng trắng đầu cuối hoặc cấm chuỗi toàn khoảng trắng, hãy bổ sung có chủ đích tại ranh giới này và điều chỉnh schema cho khớp. Hàm không âm thầm biến giá trị đầu vào thành một tên hiển thị khác.

Với giá trị hiện tại là Minh, object rỗng trả về keep, null tường minh trả về clear, còn chuỗi hợp lệ khác rỗng trả về set kèm chuỗi đó. Chuỗi rỗng, số và trường role thừa đều bị từ chối. Bộ chuyển đổi sang lớp lưu trữ có thể bỏ cột khi nhận keep, gán SQL NULL khi nhận clear và truyền đúng giá trị đã kiểm tra qua tham số khi nhận set. Như vậy, API không phải dựa vào việc một ORM cụ thể bỏ qua undefined, coi nó là mặc định hay từ chối nó.

Trong bộ thử JavaScript đã chạy, các nhánh này được kiểm tra mà không sửa object đầu vào. Bộ thử còn áp dụng thao tác vào bản sao tài khoản trong bộ nhớ: keep giữ Minh, clear lưu null và set lưu tên được chọn. Đây là kiểm tra mô hình ghi, không chứng minh ORM hoặc cơ sở dữ liệu SQL có cùng hành vi. Hãy lặp lại ma trận với bộ chuyển đổi thực tế trước khi kết luận việc lưu trữ đã đúng.

Gọi trực tiếp với thuộc tính undefined bị từ chối, nhưng JSON.stringify bỏ thuộc tính đó nên phân tích JSON rồi gọi cùng hàm sẽ trả keepMở ảnh kích thước đầy đủ ↗

Quan sát JSON được tạo trước khi gán ý nghĩa

JavaScript có thể giữ undefined, nhưng JSON không có giá trị undefined. So sánh các biểu diễn sau theo quy tắc tuần tự hóa JSON của ECMAScript:

JSON.stringify({ displayName: undefined }); // '{}'
JSON.stringify({ displayName: null });      // '{"displayName":null}'
JSON.stringify([undefined]);               // '[null]'

Truyền trực tiếp một object có thuộc tính riêng displayName mang undefined vào hàm sẽ phát sinh lỗi giá trị. Chuyển chính object ấy thành JSON rồi phân tích lại trước khi gọi hàm tạo ra object rỗng, vì thế hàm trả keep. Hai đường đi khác nhau vì bước tuần tự hóa đã xóa thuộc tính. Kiểm thử đơn vị bỏ qua mã tuần tự hóa của client do đó có thể bỏ sót lỗi thực tế giữa xóa và giữ nguyên.

Ví dụ mảng cũng cho thấy vì sao cần xem các byte thực tế thay vì suy rộng quy tắc object cho mọi cấu trúc JSON. Trong cách tuần tự hóa thông thường này, phần tử undefined của mảng được biểu diễn bằng null. Phương thức toJSON tùy biến và hàm replacer có thể tạo thêm các phép chuyển đổi, nên một hàm tiện ích dùng chung cần công bố phạm vi áp dụng. Các ví dụ ở đây chỉ dùng object và mảng thông thường, không có những cơ chế tùy biến đó.

Tài liệu chú thích JSON Schema phân biệt rõ default với việc điền giá trị thiếu trong lúc kiểm tra. Nếu thư viện bổ sung chế độ tự áp dụng mặc định, hãy kiểm tra riêng đúng cấu hình ấy. Thao tác xóa tường minh không nên biến mất chỉ vì lớp khác đánh đồng null, thuộc tính vắng mặt và giá trị dự phòng.

Kiểm tra một ma trận đầu vào nhỏ

Với mỗi trường được sửa, hãy thử thuộc tính vắng mặt, null, giá trị rỗng và giá trị hợp lệ thông thường. Thêm kiểu sai và các mốc độ dài cần thiết. Ghi nhận cả phản hồi lẫn kết quả lưu, bởi endpoint có thể trả thành công nhưng âm thầm bỏ qua thao tác xóa mong muốn.

Lặp lại các trường hợp qua đúng đường tuần tự hóa của frontend. Biểu mẫu trình duyệt, ứng dụng di động và SDK có thể mã hóa giá trị tùy chọn theo những cách khác nhau. Schema dùng chung chỉ giúp được khi mỗi client sử dụng nó với cấu hình tương thích.

Giữ schema riêng cho tạo mới, thay thế toàn bộ và cập nhật một phần nếu quy tắc hiện diện khác nhau. Tái sử dụng một lớp với mọi trường đều tùy chọn có thể làm mã ngắn hơn nhưng khiến nó không thể diễn đạt những gì người gọi bắt buộc cung cấp cho từng thao tác.

Nguồn tham khảo & đọc thêm

  1. JSON Schema, object reference
  2. RFC 5789, PATCH method
  3. ECMAScript, JSON.stringify and JSON serialization
  4. JSON Schema, annotations and default
← Về trang bài viết

Hình minh họa

100%