Rèn trách nhiệm qua một nhiệm vụ kỹ thuật có phạm vi rõ
Biến yêu cầu sửa xuất CSV thành phạm vi, ví dụ lỗi, kiểm tra dữ liệu và bàn giao rõ ràng; phân biệt tuần tự hóa đúng với truyền và nhập tệp thành công.

Chịu trách nhiệm cho một nhiệm vụ kỹ thuật có phạm vi rõ nghĩa là theo sát kết quả, các phụ thuộc và việc bàn giao của nó. Bạn không cần thiết kế lại cả phân hệ để rèn kỹ năng này. Một sửa đổi nhỏ vẫn có thể đòi hỏi cân nhắc kỹ kỳ vọng của người dùng, bằng chứng cần có và những quyết định thuộc về người khác.
Tiêu chuẩn của tôi là một kỹ sư khác có thể hiểu điều gì đã đổi, vì sao như vậy là đủ và phần nào còn chưa giải quyết mà không phải làm lại quá trình điều tra. Bài này dành cho lập trình viên ở giai đoạn đầu sự nghiệp, có thể đọc một hàm ngắn và chạy kiểm tra cục bộ. Chúng ta sẽ biến yêu cầu hư cấu “sửa xuất danh mục” thành một phần việc hoàn chỉnh nhưng có giới hạn.
Thay yêu cầu mơ hồ bằng một lỗi quan sát được
Giả sử danh mục xuất hai cột văn bản là item_id và label. Hiện thực hiện tại nối các giá trị bằng dấu phẩy, rồi nối các bản ghi bằng ký tự xuống dòng. Vì thế, nhãn như Red, blue trông như có thêm một cột. Nhãn chứa ký tự xuống dòng có thể bị hiểu là bắt đầu một bản ghi mới.
Mô tả vấn đề theo quy trình của bên nhận: trình đọc dùng định dạng CSV đã thống nhất phải khôi phục được hai trường ban đầu của mỗi mục đã chọn. “Làm cho tải xuống hoạt động” chưa xác định lỗi đó. “Dùng thư viện CSV” lại chọn hiện thực trước khi làm rõ nhu cầu người dùng.
Giữ một ví dụ tái hiện nhỏ, gồm nhãn thông thường, dấu phẩy, dấu ngoặc kép, ký tự xuống dòng nằm trong trường và văn bản ngoài ASCII. Thêm mã có số 0 đầu như 007, vì đây là mã văn bản chứ không phải số bảy. Những trường hợp này kiểm tra các yêu cầu định dạng khác nhau; năm bản sao của một từ bình thường không bổ sung được nhiều bằng chứng.
Kết quả ban đầu là một mô tả lỗi ngắn với đầu vào, các bản ghi mong đợi sau khi phân tích và khác biệt quan sát được. Nhờ vậy, nhiệm vụ có thể được duyệt ngay cả trước khi có bản sửa. Người duyệt cũng có cơ hội chỉ ra giả định sai về phần mềm nhận hoặc cấu trúc dữ liệu xuất.
Thống nhất cam kết hành vi nhỏ
Trong bài tập này, định dạng là CSV mã hóa UTF-8, có dòng tiêu đề, các trường ngăn bằng dấu phẩy, thoát ký tự bằng dấu ngoặc kép và dùng CRLF giữa các bản ghi. Giữ thứ tự mục được truyền vào và nguyên nội dung chuỗi. Mỗi mục được chọn tạo một bản ghi dữ liệu có hai trường; không chọn mục nào thì chỉ có dòng tiêu đề. Bên gọi hiện có cung cấp một tập hữu hạn các bản ghi đã được kiểm tra, mỗi bản ghi gồm hai chuỗi mã hóa được bằng UTF-8.
RFC 4180 mô tả việc đặt trường có dấu phẩy, ngoặc kép hoặc ký tự xuống dòng trong cặp ngoặc kép, và nhân đôi dấu ngoặc kép bên trong trường đã được bao. Đây là tài liệu thông tin, không bảo đảm mọi bảng tính đều dùng quy ước giống nhau. Bài tập chọn định dạng rõ ràng để bên tạo và bên nhận dự kiến có cơ sở cụ thể mà thống nhất.
Phạm vi công việc gồm tuần tự hóa dữ liệu và bằng chứng kiểm tra hồi quy. Nó không quyết định bên gọi chọn mục nào, ai được quyền xuất hoặc lựa chọn đó có phản ánh một thời điểm nhất quán của cơ sở dữ liệu hay không. Những trách nhiệm hiện có vẫn quan trọng. Trước khi coi việc đã hoàn tất, xác định nơi thực thi chúng và bảo đảm bản sửa giữ đúng hành vi dự kiến xung quanh.
Ranh giới mô tả trách nhiệm của thay đổi này. Nó không loại bỏ nhu cầu kiểm tra luồng yêu cầu xung quanh.
Nếu vấn đề thực tế đòi hỏi xuất hàng triệu bản ghi, hiện thực giữ kết quả trong bộ nhớ dưới đây có thể không phải phần việc phù hợp. Nếu bên nhận cần tệp bảng tính có kiểu dữ liệu, chỉ bao trường CSV bằng ngoặc kép không cung cấp được hành vi đó. Nêu phát hiện cùng hệ quả và đề xuất sửa phạm vi. Âm thầm mở rộng nhiệm vụ làm việc duyệt khó hơn; bỏ qua phát hiện có thể khiến người dùng nhận một bản sửa chưa giải quyết được vấn đề thật.
Biến ví dụ định dạng thành mã chạy được
Tài liệu CSV của Python mô tả cách điều khiển việc bao trường của bộ ghi và kết quả chuỗi mà bộ đọc trả về. Tài liệu cũng giải thích vì sao xử lý xuống dòng quan trọng. Dùng bộ tuần tự hóa đã có thay vì bổ sung dần các quy tắc thay dấu phẩy tự viết.
Hàm sau làm việc với các bản ghi đã được kiểm tra như mô tả ở trên. Nó chủ ý dựng một kết quả nhỏ trong bộ nhớ rồi trả về byte. Các phép kiểm tra phân tích số byte ấy ngược lại thành bản ghi, qua đó kiểm tra cam kết dữ liệu thay vì nhìn xem tệp có thẳng hàng trong trình soạn thảo văn bản hay không.
import csv
import io
def render_catalog_csv(records):
# records: finite iterable of validated, UTF-8-encodable
# (item_id, label) string pairs in the intended export order.
output = io.StringIO(newline="")
writer = csv.writer(output, lineterminator="\r\n")
writer.writerow(("item_id", "label"))
writer.writerows(records)
return output.getvalue().encode("utf-8")
records = (
("007", "Plain"),
("008", "Red, blue"),
("009", 'He said "ready"'),
("010", "Line one\nLine two"),
("011", "Cà phê"),
)
expected = [["item_id", "label"], *map(list, records)]
payload = render_catalog_csv(iter(records))
parsed = list(csv.reader(io.StringIO(payload.decode("utf-8"), newline="")))
assert parsed == expected
assert len(parsed) == 6 and all(len(row) == 2 for row in parsed)
assert parsed[1][0] == "007"
assert render_catalog_csv(()) == b"item_id,label\r\n"
broken = "\r\n".join(
",".join(row) for row in [("item_id", "label"), *records]
) + "\r\n"
broken_rows = list(csv.reader(io.StringIO(broken, newline="")))
assert broken_rows != expected
assert broken_rows[2] == ["008", "Red", " blue"]
print(f"{len(parsed) - 1} data records; {len(parsed)} records with header")
Đầu ra báo năm bản ghi dữ liệu và sáu bản ghi nếu tính dòng tiêu đề. Ký tự xuống dòng bên trong một nhãn vẫn thuộc trường đó. Đếm các dòng văn bản nhìn thấy sẽ trả lời một câu hỏi khác. Phiên bản nối bằng dấu phẩy tái hiện lỗi ban đầu: nhãn có dấu phẩy trở thành ba trường thay vì hai.
Ngoặc kép tạo cấu trúc cho bản ghi được tuần tự hóa. Chúng không trở thành ký tự ngoặc kép thêm vào nhãn sau khi đọc.
Kiểm tra cục bộ này xác lập hành vi tuần tự hóa cho các đầu vào trên. Nó không xác lập rằng phản hồi HTTP chứa đúng các byte ấy, các bản ghi đã chọn được phép truy cập hay cách nhập vào một bảng tính cụ thể sẽ giữ nguyên mã văn bản. Bảng tính có thể hiểu 007 là số dù trình đọc CSV trả lại chuỗi không đổi. Hãy kiểm tra quy trình nhập dự kiến nếu đó là một phần của tiêu chí chấp nhận.
Giữ bản sửa nhỏ và bằng chứng đầy đủ
Hướng dẫn về thay đổi nhỏ của Google coi một đơn vị hữu ích là thay đổi hoàn chỉnh về ý nghĩa và gồm cả các kiểm tra liên quan. Ranh giới quan trọng nằm ở nội dung. Tách bản sửa tuần tự hóa khỏi kiểm tra làm lộ lỗi không tự động khiến việc duyệt rõ hơn.
Bản sửa được đề xuất có thể thay logic nối chuỗi, thêm trường hợp hồi quy dựa trên bộ đọc CSV và ghi rõ mã hóa cùng quy ước định dạng tại giao diện. Nó không cần đổi tên mọi hàm xuất hay chuyển toàn bộ API danh mục sang kiến trúc khác. Nếu cần tái cấu trúc trước, giải thích vai trò của bước đó và giữ cho hệ thống dùng được ở mỗi trạng thái trung gian.
Sau đó kiểm tra bên gọi thực tế. Xác nhận nó truyền đúng hai trường theo đúng thứ tự và phần xử lý phản hồi giữ nguyên các byte trả về. Với nhiệm vụ trong một repository, điều đó nghĩa là đọc mã liên quan và chạy kiểm tra tích hợp có phạm vi phù hợp. Hàm độc lập ở trên không thay thế được bằng chứng từ một luồng yêu cầu mà nó chưa thực thi.
| Bằng chứng | Câu hỏi được trả lời |
|---|---|
| Dữ liệu tái hiện lỗi ban đầu | Kiểm tra hồi quy có làm lộ đúng lỗi được báo không? |
| Kết quả sửa đã được phân tích | Các trường văn bản và ranh giới bản ghi đã thống nhất có được giữ nguyên không? |
| Kiểm tra bên gọi và phản hồi | Luồng xuất thật có dùng bản sửa và truyền đúng byte của nó không? |
| Kiểm tra phần mềm nhận dự kiến | Quy trình nhập được hỗ trợ có hiểu tệp đúng yêu cầu không? |
Đừng biến bảng này thành bốn dấu tích sao chép từ nhiệm vụ khác. Ghi đúng phần đã đọc hoặc chạy. Nếu chưa dùng được phần mềm nhận, phân biệt bằng chứng tuần tự hóa đã hoàn thành với kiểm tra nhập còn chờ, đồng thời xác định ai có thể thực hiện phần đó. Bàn giao rõ ràng hữu ích hơn lời khẳng định thiếu cơ sở rằng tệp xuất đã tương thích với mọi nơi.
Xử lý phát hiện mới mà vẫn giữ rõ nhiệm vụ
Giả sử bên gọi bắt đầu truyền luồng đầu ra trước khi kiểm tra xong mọi bản ghi. Một bản ghi không hợp lệ ở phía sau có thể để lại tệp chỉ tải được một phần. Phát hiện này liên quan đến phản hồi và kiểm tra dữ liệu, vượt ra ngoài việc thay hàm định dạng. Lưu ví dụ cụ thể và trao đổi xem nó có ngăn việc hoàn tất yêu cầu hiện tại hay cần một thay đổi riêng. Mức ưu tiên phụ thuộc vào cam kết sản phẩm hiện có và hậu quả.
Hàm dùng bộ nhớ chỉ trả về sau khi tuần tự hóa và mã hóa thành công, nhưng quan sát đó không chứng minh truyền qua mạng là thao tác tất cả hoặc không có gì. Máy khách vẫn có thể ngắt kết nối hoặc luồng phản hồi gặp lỗi. Giữ phạm vi mỗi kết luận khớp với phần hệ thống đã kiểm tra.
Kết thúc nhiệm vụ bằng hành vi trước và sau đã quan sát, phạm vi chính xác, kết quả kiểm tra và phụ thuộc chưa giải quyết. Nếu có việc tiếp theo, giao người phụ trách và nêu câu hỏi rõ ràng thay vì để lời nhắc “cải thiện xuất dữ liệu” không ai nhận. Người duyệt cần chấp nhận được phần sửa đã hoàn tất mà không vô tình duyệt cả công việc để sau.
Để luyện tập, chọn một vấn đề mơ hồ và chuẩn bị cùng bộ thông tin: ví dụ lỗi, cam kết hành vi nhỏ, ranh giới hiện thực đề xuất và bảng nối kết luận với bằng chứng. Xác định dữ kiện mới nào sẽ khiến phạm vi ấy không còn đủ. Dùng câu trả lời để điều chỉnh nhiệm vụ trước khi gọi nó là hoàn tất.