Công Cụ Chuyển Đổi C# List sang JSON

List<T> trong C# và vai trò của JSON Serialization

List<T>: Là một kiểu tập hợp generic trong C#, biểu diễn một danh sách các đối tượng của một kiểu `T` cụ thể. Nó có khả năng co giãn động, cho phép thêm, xóa, truy cập các phần tử theo chỉ mục. Ví dụ: `List` là một danh sách các đối tượng `User`.

JSON (JavaScript Object Notation): Là định dạng trao đổi dữ liệu văn bản phổ biến, dễ đọc cho người và máy. Trong bối cảnh C# và phát triển web, JSON đóng vai trò cầu nối quan trọng vì:

• API RESTful: Hầu hết các API .NET Core/ASP.NET Core sử dụng JSON để gửi và nhận dữ liệu từ các client (ứng dụng web, mobile, desktop).
• Frontend Development: JavaScript trên frontend dễ dàng parse và thao tác với dữ liệu JSON.
• Lưu trữ và Cấu hình: JSON cũng được dùng để lưu trữ dữ liệu hoặc cấu hình theo định dạng file dễ đọc.
• Giao tiếp Microservices: Trong kiến trúc microservices, các dịch vụ thường trao đổi dữ liệu qua lại dưới dạng JSON.

Việc chuyển đổi `List` sang JSON (Serialization) là cần thiết để chuẩn bị dữ liệu C# cho các mục đích này.

Hướng dẫn sử dụng công cụ C# List to JSON Converter

Để tạo mã JSON mẫu từ định nghĩa lớp và dữ liệu `List` C# của bạn, hãy thực hiện theo các bước sau:

• Bước 1: Cung cấp định nghĩa Class C# và dữ liệu mẫu:
  • Trong khung "Định nghĩa lớp (Class) C# và dữ liệu List<T> mẫu", dán định nghĩa lớp C# của bạn (ví dụ: `public class User { ... }`).
  • Ngay bên dưới định nghĩa lớp, cung cấp một đoạn code C# để khởi tạo một đối tượng `List` từ lớp đó với dữ liệu mẫu (ví dụ: `new List { new User { ... }, new User { ... } }`). Công cụ sẽ cố gắng đọc các giá trị này.
• Bước 2: Chọn tùy chọn Serialization:
  • "Định dạng đẹp (Pretty Print)": Đánh dấu vào tùy chọn này để chuỗi JSON có thụt lề, dễ đọc hơn. Nếu không, JSON sẽ hiển thị trên một dòng.
  • "Keys dùng camelCase": Nếu bạn muốn các tên thuộc tính trong JSON bắt đầu bằng chữ thường (ví dụ: `userName` thay vì `UserName`), hãy chọn tùy chọn này. Đây là quy ước phổ biến trong JavaScript và API RESTful.
• Bước 3: Sinh JSON mẫu: Nhấn nút "SINH JSON MẪU". Công cụ sẽ phân tích dữ liệu C# của bạn và tạo ra chuỗi JSON tương ứng, kèm theo đoạn code C# để thực hiện serialization.
• Bước 4: Sao chép kết quả: Sử dụng nút "Copy" để lưu mã JSON và code C# mẫu vào bộ nhớ tạm.
• Xử lý lỗi: Nếu có lỗi cú pháp trong định nghĩa lớp C# hoặc dữ liệu mẫu, công cụ sẽ hiển thị thông báo lỗi.

Nguyên lý hoạt động và các thư viện Serialization C#

Quá trình chuyển đổi từ `List` C# sang JSON được gọi là serialization. Trong .NET, có hai thư viện chính được sử dụng:

1. `System.Text.Json` (tích hợp sẵn từ .NET Core 3.1 trở lên):

• Ưu điểm: Hiệu suất cao, nhẹ, được tích hợp sẵn, hỗ trợ tốt cho các dự án .NET hiện đại.
• Code mẫu:

  using System.Text.Json;
  using System.Collections.Generic; // For List
  // ...
  var users = new List { /* ... data ... */ };
  var options = new JsonSerializerOptions
  {
      WriteIndented = true, // ${document.getElementById('pretty-print').checked ? 'true' : 'false'}
      PropertyNamingPolicy = ${document.getElementById('camel-case').checked ? 'JsonNamingPolicy.CamelCase' : 'null'} // ${document.getElementById('camel-case').checked ? '' : 'Nếu không dùng camelCase'}
  };
  string jsonString = JsonSerializer.Serialize(users, options);
  Console.WriteLine(jsonString);
                  

2. `Newtonsoft.Json` (hay Json.NET - thư viện của bên thứ ba):

• Ưu điểm: Rất mạnh mẽ, linh hoạt, nhiều tùy chọn cấu hình, được sử dụng rộng rãi trong các dự án .NET Framework cũ hơn và cả .NET Core.
• Code mẫu:

  using Newtonsoft.Json;
  using Newtonsoft.Json.Serialization; // For CamelCasePropertyNamesContractResolver
  using System.Collections.Generic; // For List
  // ...
  var users = new List { /* ... data ... */ };
  var settings = new JsonSerializerSettings
  {
      Formatting = ${document.getElementById('pretty-print').checked ? 'Formatting.Indented' : 'Formatting.None'}, // ${document.getElementById('pretty-print').checked ? '' : 'Nếu không định dạng đẹp'}
      ContractResolver = ${document.getElementById('camel-case').checked ? 'new CamelCasePropertyNamesContractResolver()' : 'null'} // ${document.getElementById('camel-case').checked ? '' : 'Nếu không dùng camelCase'}
  };
  string jsonString = JsonConvert.SerializeObject(users, settings);
  Console.WriteLine(jsonString);
                  

Công cụ của chúng tôi mô phỏng hành vi của các thư viện này bằng cách phân tích cú pháp C# cơ bản và ánh xạ các thuộc tính sang JSON.

Ví dụ thực tế khi serialize một danh sách sản phẩm

Giả sử bạn có lớp `Product` và một `List` muốn chuyển thành JSON:

public class Product
{
    public int ProductId { get; set; }
    public string ProductName { get; set; }
    public decimal UnitPrice { get; set; }
}

new List
{
    new Product { ProductId = 1, ProductName = "Laptop", UnitPrice = 1200.00m },
    new Product { ProductId = 2, ProductName = "Mouse", UnitPrice = 25.50m }
}
        

Với tùy chọn "Pretty Print" và "camelCase", bạn sẽ nhận được JSON tương tự:

[
  {
    "productId": 1,
    "productName": "Laptop",
    "unitPrice": 1200.00
  },
  {
    "productId": 2,
    "productName": "Mouse",
    "unitPrice": 25.50
  }
]
        

Ví dụ này minh họa cách danh sách đối tượng C# được ánh xạ sang một mảng JSON.

Lưu ý về các kiểu dữ liệu phức tạp và hiệu suất

Công cụ này hỗ trợ các kiểu dữ liệu cơ bản như `int`, `string`, `decimal`, `bool`, `DateTime`. Đối với các kiểu dữ liệu phức tạp hơn như Dictionary, Nested Lists, Custom Converters, hoặc khi cần xử lý các vấn đề về vòng lặp tham chiếu, bạn sẽ cần cấu hình sâu hơn các thư viện serialization trong C#. Luôn cân nhắc hiệu suất khi serialize các danh sách rất lớn.

Các công cụ hỗ trợ C# và JSON khác