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ản10 phút đọc

Phần tính năng backend đầu tiên cho người làm frontend

Theo một yêu cầu tạo ghi chú qua kiểm tra đầu vào, lưu trữ bền và giao diện, rồi thực hành xử lý một tình huống lỗi.

Tranh màu nước vẽ những cuốn sổ, một quyển sổ mở và bút chì trên nền màu kem

Với lập trình viên frontend học backend, một phần tính năng nhỏ xuyên suốt các tầng nên nối một hành động người dùng với kết quả được lưu bền và có cách xử lý một tình huống lỗi. Tôi thích phạm vi đó vì có thể theo toàn bộ yêu cầu khi hệ thống còn đủ nhỏ để giải thích. API lớn với nhiều endpoint có thể chỉ giấu cùng những câu hỏi chưa trả lời sau nhiều tệp hơn.

Dùng tính năng tạo ghi chú giả định. Bản đầu nhận tiêu đề và nội dung cho một tài khoản thực hành, lưu chúng rồi trả mã ghi chú. Chưa cần cộng tác, tìm kiếm hay công việc nền. Mục tiêu là hiểu thỏa thuận giữa biểu mẫu, endpoint và bản ghi lưu trữ.

Nêu hợp đồng trước khi viết hàm xử lý

Viết đầu vào được chấp nhận và kết quả hiển thị. Chẳng hạn, tiêu đề phải có ký tự ngoài khoảng trắng, nội dung có thể rỗng và máy chủ cấp mã. Chủ động chọn các quy tắc đó; sản phẩm khác có thể chọn khác.

Bài tổng quan HTTP của MDN mô tả cách máy khách và máy chủ trao đổi yêu cầu, phản hồi. Ứng dụng quyết định ý nghĩa của nội dung yêu cầu và kết quả. Kết nối thành công chưa xác lập ghi chú đáp ứng quy tắc sản phẩm hoặc đã được lưu bền.

Với bài này, định nghĩa các ca sau trước khi triển khai:

Đầu vào hoặc điều kiệnHành vi mong đợi
Tiêu đề và nội dung hợp lệTạo một ghi chú và trả mã của nó
Tiêu đề chỉ có khoảng trắngTừ chối, giải thích lỗi ở trường tương ứng
Trường ngoài dự kiếnÁp dụng chính sách từ chối hoặc bỏ qua đã nêu rõ
Không truy cập được nơi lưu trước khi ghiBáo lỗi, không khẳng định ghi chú đã lưu
Mất phản hồi sau khi ghi xongXem kết quả là chưa rõ cho tới khi máy khách xác định lại được

Dòng cuối đáng chú ý dù bản đầu mới chỉ ghi nhận nó. Nó tách phản hồi thất bại khỏi thao tác thất bại. Đừng cho giao diện nói chắc “không có gì được lưu” khi kết quả phía máy chủ vẫn chưa biết.

Giữ mô hình dữ liệu đầu tiên dễ kiểm tra

Bản ghi cần mã, tiêu đề, nội dung và chủ sở hữu. Thời điểm tạo có thể hữu ích, nhưng phải chọn ai cung cấp và nó có ý nghĩa gì. Đồng hồ máy khách có thể khác nhau, nên thời điểm do máy chủ cấp thường dễ dùng hơn để hiểu thứ tự tạo.

Lưu chủ sở hữu cùng bản ghi dù bài bắt đầu với một tài khoản. Như vậy câu hỏi kiểm tra quyền sau này vẫn hiện rõ. Bản thử cục bộ một tài khoản có thể để tích hợp xác thực sang sau; vẫn cần nói rõ giới hạn thay vì âm thầm coi mã người dùng cố định là thiết kế danh tính cho vận hành thật.

Nếu tạo ghi chú còn tạo bản ghi bắt buộc khác, như mục kiểm toán trong cùng cơ sở dữ liệu, quyết định các lần ghi có phải cùng thành công không. Hướng dẫn giao dịch của PostgreSQL giải thích nhóm thao tác theo quy tắc tất cả hoặc không có gì. Giao dịch cơ sở dữ liệu không tự bao gồm email ngoài hệ thống hay tải tệp, nên giữ phần đầu trong ranh giới bạn hiểu.

Biểu mẫu gửi yêu cầu có định nghĩa, endpoint kiểm tra, bản ghi được đối chiếu và giao diện hiển thị kết quả cùng mãMở ảnh kích thước đầy đủ ↗

Kiểm tra bản ghi là việc riêng với kiểm tra phản hồi. Hàm xử lý có thể vô tình trả mã hợp lý mà chưa ghi đúng giá trị. Dòng dữ liệu cũng có thể đã tồn tại trong khi giao diện hiển thị trạng thái thành công sai.

Xây một đường đi rồi kiểm tra từng ranh giới

Bắt đầu bằng gửi trực tiếp yêu cầu hợp lệ tới endpoint. Xem mã trả về và dùng nó đọc bản ghi đã lưu. So từng trường được chấp nhận với yêu cầu. Sau đó nối biểu mẫu và lặp lại kiểm tra qua giao diện.

Thứ tự này giúp khoanh vùng. Nếu gọi trực tiếp thành công nhưng biểu mẫu không được, xem cách chuyển dữ liệu thành nội dung yêu cầu, các header và đường xử lý sự kiện. Nếu cả hai lỗi giống nhau, xem kiểm tra đầu vào và lưu trữ phía máy chủ. Tránh sửa nhiều tầng cùng lúc mà chưa biết mỗi thay đổi giải thích quan sát nào.

Tiếp theo chạy ca tiêu đề sai. Kiểm tra cơ sở dữ liệu không tăng bản ghi, endpoint trả lỗi dự định và giao diện giải thích cách sửa. Phép thử chỉ xem có lỗi bất kỳ hay không sẽ bỏ qua sự thống nhất giữa các tầng.

Thêm một ca khôi phục trước tính năng khác

Tạm làm nơi lưu không truy cập được trong môi trường thực hành cô lập. Gửi ghi chú và quan sát. Giao diện nên giữ nội dung người dùng để xử lý tiếp, thay vì xóa sau lần lưu thất bại. Khôi phục nơi lưu và gửi lại theo quy tắc thử lại của thao tác.

Biến thể khó hơn làm mất phản hồi sau khi ghi. Có thể cần điểm can thiệp kiểm thử hoặc proxy có kiểm soát. Nếu chưa xây bài đó, giữ trong danh sách chưa giải quyết. Đừng nói đã kiểm chứng hành vi thử lại chỉ vì hai yêu cầu bình thường đều thành công.

Để review, gom bảng hợp đồng, một yêu cầu được chấp nhận, một yêu cầu bị từ chối và trạng thái lưu tương ứng. Giải thích danh tính đến từ đâu và lỗi nào chưa thử. Bộ bằng chứng đó giúp lập trình viên khác đánh giá phần tính năng mà không phải dựng lại ý định từ mã.

Khi giải thích được các phần đó, chọn tính năng tiếp theo đưa vào câu hỏi mới. Sửa ghi chú thêm xử lý đồng thời. Chia sẻ thêm thay đổi quyền. Xuất thêm công việc kéo dài. Mỗi phần bổ sung có lý do trong kế hoạch học ngoài việc làm demo lớn hơn.

Biến biểu mẫu thành hợp đồng đầu vào chính xác

Chọn một quy tắc chuẩn hóa trước khi so yêu cầu với giá trị lưu. Với bài này, bỏ khoảng trắng đầu và cuối tiêu đề nhưng giữ khoảng trắng trong nội dung. Tiêu đề và nội dung đều phải là chuỗi; nội dung rỗng hợp lệ. Từ chối trường ngoài cấu trúc đã định nghĩa, kể cả chủ sở hữu hoặc mã ghi chú do bên gọi gửi. Các giá trị đó thuộc quyết định danh tính và lưu trữ của máy chủ.

Phân biệt chuẩn hóa với kiểm tra hợp lệ hữu ích cho người làm frontend. Chuẩn hóa biến một cách biểu diễn được chấp nhận thành dạng sản phẩm muốn lưu. Kiểm tra hợp lệ quyết định đầu vào có thuộc miền được chấp nhận không. Âm thầm đổi mảng thành văn bản không phải phần hiển nhiên hay bắt buộc của hợp đồng tạo ghi chú.

Đầu vào gửi lênCách hiểu mong đợi
Tiêu đề Grocery, nội dung rỗngLưu Grocery và giữ nội dung rỗng
Tiêu đề chỉ có dấu cáchTừ chối sau khi cắt khoảng trắng; không tạo ghi chú
Nội dung là mảngTừ chối sai kiểu
Có trường ownerIdTừ chối trường ngoài cấu trúc theo chính sách đã chọn
JSON sai định dạngTừ chối cách biểu diễn trước khi kiểm tra từng trường

Cũng đưa giới hạn kích thước vào hợp đồng. Nêu đơn vị: byte yêu cầu đã mã hóa, điểm mã Unicode và độ dài chuỗi của ngôn ngữ có thể khác nhau. Bộ dữ liệu đầu chưa cần chính sách văn bản quốc tế phức tạp, nhưng người review không nên phải đoán “độ dài tối đa” là gì. Giới hạn ở biểu mẫu cần thống nhất với quy tắc có thẩm quyền trên máy chủ.

Để phản hồi thành công trỏ tới đối tượng đã tạo

Phản hồi thành công hữu ích chứa mã do máy chủ cấp và giá trị đã chuẩn hóa mà giao diện nên hiển thị. Với endpoint HTTP tạo tài nguyên, 201 Created cho biết việc tạo đã xảy ra; header Location có thể xác định tài nguyên mới. Chọn đường dẫn và dạng dữ liệu như một phần thiết kế API, thay vì sao chép mã trạng thái mà bỏ ý nghĩa của nó.

Chỉ gửi thành công sau khi thao tác lưu tới điểm hoàn tất ứng dụng đã hứa. Trạng thái HTTP thành công không tự chứng minh cấu hình cơ sở dữ liệu cung cấp độ bền bạn giả định. Trong bài cục bộ, kiểm tra dòng, khởi động lại tiến trình ứng dụng mà không đặt lại cơ sở dữ liệu, rồi đọc lại cùng mã. Việc đó phân biệt bộ nhớ tiến trình với đường lưu trữ bạn muốn học.

Phép kiểm tra cũng tách khởi động lại ứng dụng khỏi khôi phục cơ sở dữ liệu. Khởi động lại tiến trình API là bài nhỏ hơn mất điện hoặc phục hồi từ bản sao lưu. Giữ sự phân biệt khi mô tả phần tính năng chứng minh điều gì.

Hợp đồng tạo ghi chú cắt khoảng trắng tiêu đề, kiểm tra kiểu và trường do máy chủ quản lý, ghi dữ liệu rồi trả cùng mã để đọc lạiMở ảnh kích thước đầy đủ ↗

Lần theo sai lệch tới ranh giới tạo ra nó

Giả sử biểu mẫu hiển thị Grocery sau khi máy chủ lưu Grocery. Theo quy tắc chuẩn hóa đã chọn, đó có thể là vấn đề đồng bộ giao diện. Nếu máy chủ trả mã 92 nhưng đọc 92 không có ghi chú, điều tra đường lưu và phản hồi trước khi đổi biểu mẫu. Nếu yêu cầu hợp lệ trực tiếp thành công còn yêu cầu từ biểu mẫu sai kiểu, xem dữ liệu thực sự được gửi thay vì nới kiểm tra máy chủ.

Giữ quan sát đủ nhỏ để giải thích. Ghi cùng đầu vào được chấp nhận, mã trả về, trường đã lưu và trạng thái hiển thị bằng dữ liệu giả định. Tránh ghi toàn bộ ghi chú thật vào log chỉ để gỡ lỗi tiện hơn. Tên trường, nhóm lỗi và mã yêu cầu có thể đủ nối các bước của bài này.

Phần tính năng đầu hoàn thành khi các ranh giới thống nhất ở các ca hợp lệ, không hợp lệ và khôi phục đã chọn. Đó vẫn là hợp đồng ứng dụng nhỏ, không phải chứng nhận backend tổng quát. Tính năng tiếp theo nên thêm trách nhiệm mới cụ thể, đồng thời giữ hành vi phần đầu đã xác lập.

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

  1. MDN: overview of HTTP
  2. PostgreSQL tutorial: transactions
  3. MDN: 201 Created
← Về trang bài viết

Hình minh họa

100%