Hướng dẫn thực tế

Trình tạo lớp C# từ JSON — Hướng dẫn sử dụng và nguyên lý kỹ thuật

Chuyển đổi payload JSON thành lớp C# kiểu mạnh với thuộc tính JsonPropertyName, hỗ trợ nullable và mã nguồn gọn gàng.

Mở công cụ

Tổng quan

REST API, sự kiện cloud, cấu hình và telemetry đều dùng JSON. Sinh lớp C# kiểu mạnh giúp an toàn ở thời điểm biên dịch, IntelliSense rõ ràng và refactor dễ dàng. JsonPropertyName giữ nguyên khoá gốc, thuận tiện chia sẻ hợp đồng dữ liệu giữa các nhóm.

Khái niệm chính

Mapping JSON → C#

Chuỗi thành string hoặc DateTime, số nguyên thành long, số thập phân thành double, boolean thành bool, object thành lớp riêng và mảng thành Danh sách<T>. Nếu mẫu có null, thuộc tính được đánh dấu nullable và khi bật tuỳ chọn sẽ thêm ?. Mảng hỗn hợp chuyển thành Danh sách<object> để giữ trọn cấu trúc.

Pipeline sinh lớp

Trình chuyển đổi duyệt JSON đệ quy, chuẩn hoá tên thuộc tính sang PascalCase và tránh từ khoá C#. Các cấu trúc giống nhau dùng chung một lớp, còn mảng tái sử dụng kiểu phần tử suy ra. Sau khi chuyển đổi, bảng thống kê hiển thị số lớp, thuộc tính và mảng để đánh giá độ phức tạp.

JsonPropertyName và tuần tự hoá

System.Text.Json dựa vào JsonPropertyName nên bạn có thể gắn thêm thuộc tính để giữ nguyên snake_case nhưng truy cập bằng PascalCase. Các lớp được sinh ở dạng partial nên dễ bổ sung validator hoặc converter trong Tệp riêng mà không sửa mã sinh.

Chiến lược nullable

Khi bật nullable reference, mọi giá trị có thể null (bool, long, double, string, Danh sách<T>, lớp con…) sẽ nhận thêm ?. Nhờ vậy compiler cảnh báo sớm và giảm mạnh lỗi NullReferenceException.

Tính năng

Kiểu mạnh

Suy luận chính xác kiểu C#, tạo lớp lồng nhau và giữ nguyên khoá JSON ban đầu.

JsonPropertyName

Đảm bảo tương thích System.Text.Json cho cả payload snake_case nhờ các thuộc tính JsonPropertyName.

Hiểu nullable

Tự thêm ? khi trường có thể null, giúp tài liệu hoá hợp đồng dữ liệu rõ ràng.

Thống kê tức thì

Hiển thị số lớp, thuộc tính và mảng ngay sau khi chuyển đổi.

Câu hỏi thường gặp

Tạo lớp C# từ JSON là gì và tại sao nó hữu ích?

Tạo lớp C# từ JSON tự động tạo các lớp C# được gõ mạnh từ cấu trúc dữ liệu JSON. Điều này rất cần thiết khi làm việc với API, tệp cấu hình hoặc tuần tự hóa dữ liệu trong ứng dụng .NET. Thay vì viết lớp thủ công hoặc sử dụng kiểu động, trình tạo tạo các lớp C# phù hợp với kiểu chính xác, hỗ trợ nullable và thuộc tính JsonPropertyName, tiết kiệm hàng giờ phát triển và giảm lỗi.

Trình tạo xử lý các kiểu dữ liệu JSON khác nhau như thế nào?

Trình tạo ánh xạ các kiểu JSON sang kiểu C# phù hợp: chuỗi trở thành string hoặc DateTime (cho ngày ISO-8601), số nguyên ánh xạ sang long, số dấu phẩy động sang double, boolean sang bool, đối tượng trở thành lớp chuyên dụng và mảng trở thành Danh sách<T>. Giá trị null đánh dấu thuộc tính là nullable (với hậu tố ? khi tham chiếu nullable được bật). Mảng hỗn hợp sử dụng Danh sách<object> để bảo toàn dữ liệu không đồng nhất.

Thuộc tính JsonPropertyName là gì và khi nào tôi nên sử dụng chúng?

Thuộc tính JsonPropertyName cho phép thuộc tính C# sử dụng đặt tên PascalCase (quy ước C#) trong khi JSON sử dụng đặt tên khác (như snake_case hoặc camelCase). Thuộc tính bảo toàn tên khóa JSON gốc trong quá trình tuần tự hóa/giải tuần tự hóa. Bật tùy chọn này khi JSON của bạn sử dụng khóa không phải PascalCase nhưng bạn muốn tên thuộc tính C# theo ngữ cảnh trong mã của mình.

Hỗ trợ tham chiếu nullable là gì và tại sao bật nó?

Kiểu tham chiếu nullable (C# 8.0+) thêm ? vào kiểu tham chiếu khi chúng có thể là null, bật kiểm tra null tại thời gian biên dịch. Khi được bật, trình tạo thêm ? vào thuộc tính khi mẫu JSON chứa giá trị null. Điều này giúp ngăn chặn lỗi NullReferenceException, làm cho trường tùy chọn rõ ràng và tuân theo các phương pháp hay nhất hiện đại của C# cho an toàn null.

Tôi có thể sửa đổi các lớp đã tạo sau khi tạo không?

Có, trình tạo tạo các lớp một phần theo mặc định (hoặc khi được bật), cho phép bạn mở rộng chúng trong các tệp riêng biệt mà không cần sửa đổi mã đã tạo. Bạn có thể thêm phương thức tùy chỉnh, logic xác thực, thuộc tính cụ thể cho miền hoặc triển khai giao diện. Sự tách biệt này giữ cho mã đã tạo sạch sẽ và cho phép tạo lại các lớp một cách an toàn khi cấu trúc JSON thay đổi.

Tài liệu liên quan

Trình tạo lớp C# từ JSON

Mở công cụ để trải nghiệm các tính năng này.

Mở công cụ