Thoạt nghe qua thì việc đọc file CSV không có vẻ gì là khó khăn, nhưng thực tế thì mọi thứ không đơn giản như vậy. Đúng là code để đọc dữ liệu từ file CSV không quá phức tạp. Nhưng việc đảm bảo rằng đoạn code đó type-safe, nhanh, và dễ tùy biến thì lại không hề dễ dàng. Đó là lý do vì sao ta nên sử dụng những thư viện có sẵn như CsvHelper.

Các bạn có thể tải code ví dụ trong bài này từ link dưới đây. https://github.com/duongntbk/CsvHelperDemo

CSVHelper là một thư viện .NET mã nguồn mở để đọc và ghi các tệp CSV. Nó nhanh chóng, linh hoạt và dễ sử dụng. Chúng tôi có thể đọc và ghi các tệp CSV bằng lớp mô hình. Ngoài ra, một số cấu hình có thể ánh xạ lớp mô hình với các tiêu đề của tệp CSV, nếu được yêu cầu.

Cài đặt CsvHelper

Chạy lệnh dưới đây để cài CsvHelper.

dotnet add package CsvHelper --version 30.0.1

Đọc file CSV bằng CsvHelper

Ta sẽ dùng file CSV dưới đây làm ví dụ. File này có 3 cột với dạng chữ và 1 cột với dạng số.

FirstName,LastName,Age,IsActive
John,Doe,30,Yes
Jane,Doe,31,No
Duong,Nguyen,31,Yes

Ta sẽ map từng dòng trong file đó với object thuộc lớp Person.

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int? Age { get; set; }
    public string IsActive { get; set; }
}

Dưới đây là code đọc file CSV sử dụng CsvHelper.

var fileName = @"<đường dẫn tới file CSV>";
var configuration = new CsvConfiguration(CultureInfo.InvariantCulture)
{
    Encoding = Encoding.UTF8, // File của ta dùng encoding UTF-8.
    Delimiter = "," // Ký tự phân cách giữa các trường là dấu phẩy.
};

using (var fs = File.Open(fileName, FileMode.Open, FileAccess.Read, FileShare.Read))
{
    using (var textReader = new StreamReader(fs, Encoding.UTF8))
    using (var csv = new CsvReader(textReader, configuration))
    {
        var data = csv.GetRecords<Person>();
        
        foreach (var person in data)
        {
            // Xử lý dữ liệu trong từng dòng
        }
    }
}

Biến data sẽ có kiểu là IEnumerable<Person>. CsvHelper sẽ tự động map từng cột trong file CSV với property cùng tên trong lớp Person. Ví dụ: giá trị trong cột FirstName sẽ được map với Person.FirstName. Ta có thể duyệt qua các phần tử trong data để đọc dữ liệu của từng dòng trong file CSV.

Các tùy biến khi đọc file

Lớp CsvConfiguration có chứa nhiều tùy biến cho việc đọc file CSV. Dưới đây là một số tùy biến quan trọng.

• HasHeaderRecord: nếu giá trị này là true thì dòng đầu tiên sẽ được coi là dòng tên cột. Giá trị mặc định của tùy biến này là true. Có thể các bạn sẽ nghĩ tất nhiên phải có dòng tên cột, nếu không thì làm sao CsvHelper map được cột với property? Câu trả lời sẽ có ở phần sau.
• Quote: ký tự quote trong file CSV file. Giá trị mặc định là “.
• IgnoreBlankLines: nếu giá trị này là true thì các dòng trống sẽ bị bỏ qua. Giá trị mặc định là true.
• Delimiter: ký tự phân cách giữa các trường. Giá trị mặc định là, (vì CSV là viết tắt của COMMA-separated values).
• DetectDelimiter: nếu giá trị này là true thì CsvHelper sẽ tự động phát hiện ký tự phân tách mà không dùng giá trị của Delimiter. Giá trị mặc định là false.
• Encoding: kiểu encoding mà file CSV sử dụng.

Map cột trong file CSV với property trong lớp Person một cách thủ công

Map cột bằng tên

Trong quá trình làm việc ở Nhật, tôi thường xuyên phải xử lý file CSV với tên cột bằng Tiếng Nhật, ví dụ như file dưới đây.

姓,名,年齢,アクティブ
Doe,John,30,Yes
Doe,Jane,31,No
Nguyen,Duong,31,Yes

Như đã nói trong phần trước, trong trường hợp đơn giản nhất thì CsvHelper sẽ tự động map cột trong file CSV với property cùng tên. Nhưng ta không nên dùng Tiếng Nhật để đặt tên cho property trong lớp Person. Vậy ta phải làm thế nào? Lớp ClassMap sẽ giúp ta giải quyết vấn đề này. Ta cần tạo một lớp mới kế thừa từ ClassMap và dùng nó để bảo CsvHelper map cột nào với property nào.

public class PersonMapByName : ClassMap<Person>
{
    public PersonMapByName()
    {
        Map(p => p.FirstName).Name("名");
        Map(p => p.LastName).Name("姓");
        Map(p => p.Age).Name("年齢");
        Map(p => p.IsActive).Name("アクティブ");
    }
}

Sau đó ta chỉ cần đăng ký PersonMapByName với CsvHelper trước khi gọi hàm csv.GetRecords.

csv.Context.RegisterClassMap<PersonMapByName>();
var data = csv.GetRecords<Person>();

Ta cũng có thể bỏ qua không map một hay nhiều cột của file CSV. Ví dụ: lớp dưới đây chỉ map cột 姓 và 名 mà không map cột 年齢 và アクティブ.

public class PersonMapByName : ClassMap<Person>
{
    public PersonMapByName()
    {
        Map(p => p.FirstName).Name("名");
        Map(p => p.LastName).Name("姓");
    }
}

Map cột bằng số thứ tự

Để dùng được cách ở trên, tên của các cột trong file CSV phải không trùng nhau. Nếu có 2 hay nhiều cột trùng tên thì giá trị của cột đầu tiên sẽ được map với property. Ví dụ: file dưới đây có 2 cột cùng tên là IsActive, lúc này giá trị Yes/No sẽ được dùng thay vì True/False.

FirstName,LastName,Age,IsActive,IsActive
John,Doe,30,Yes,True
Jane,Doe,31,No,False
Duong,Nguyen,31,Yes,True

Nếu muốn dùng giá trị True/False thì ta cần map cột bằng số thứ tự. Cách map cột bằng số thứ tự rất giống cách map cột bằng tên, điểm khác biệt duy nhất là ta gọi hàm nào sau hàm Map. Hãy xem đoạn code dưới đây.

public class PersonMapByIndex : ClassMap<Person>
{
    public PersonMapByName()
    {
        Map(p => p.FirstName).Index(0); // Số thứ tự các cột bắt đầu từ 0
        Map(p => p.LastName).Index(1);
        Map(p => p.Age).Index(2);
        Map(p => p.IsActive).Index(4); // Số thứ tự của cột IsActive với giá trị True/False là 4
    }
}

Hơn nữa, ta có thể dùng lẫn cách map cột bằng thứ tự và bằng tên. Nhưng nhớ là nếu đã map thủ công thì ta phải map tất cả các cột, nếu cột nào ta không map thì CsvHelper sẽ bỏ qua cột đó.

public class PersonMapByIndex : ClassMap<Person>
{
    public PersonMapByName()
    {
        Map(p => p.FirstName).Name("FirstName"); // Map bằng tên
        Map(p => p.LastName); // Map tự động với property cùng tên
        Map(p => p.Age).Index(2); // Map bằng số thứ tự
        Map(p => p.IsActive).Index(4); // Map bằng số thứ tự
    }
}

Chú ý: nếu file CSV của ta không có dòng tên cột thì bắt buộc ta phải dùng cách map cột bằng số thứ tự. Lúc này, ta cần phải đặt giá trị HasHeaderRecord là false.

Chuyển giá trị trong file CSV từ kiểu này sang kiểu khác

Có lẽ các bạn cũng để ý là propery Age trong lớp Person có kiểu là Integer, nhưng file CSV lại chỉ có thể chứa dữ liệu dạng chữ. CsvHelper có thể chuyển dữ liệu từ kiểu string sang các kiểu cơ bản trong .NET (Boolean, Int32, Int64, Enum,…). Các bạn có thể xem danh sách các converter được CsvHelper hỗ trợ tại link này.

Nếu như kiểu ta muốn chuyển đổi không phải là kiểu cơ bản thì sao? Hoặc giả sử nó là kiểu cơ bản, nhưng giá trị trong file CSV lại không đúng theo chuẩn thì sao? Lúc này, ta cần tự mình viết lớp converter. Ta sẽ dùng lại file CSV ví dụ của phần trước.

FirstName,LastName,Age,IsActive
John,Doe,30,Yes
Jane,Doe,31,No
Duong,Nguyen,31,Yes

Lần này ta sẽ map nó với lớp dưới đây, để ý là IsActive bây giờ có kiểu là bool.

public class PersonV2
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int? Age { get; set; }
    public bool IsActive { get; set; }
}

A custom type converter

Tuy bool là kiểu cơ bản trong .NET nhưng converter mặc định của CsvHelper chỉ xử lý được giá trị True/False. Trong khi đó file CSV của ta lại chứa Yes/No. Vì thế ta phải kế thừa lớp DefaultTypeConverter và định nghĩa lại hàm ConvertFromString.

public class CustomBooleanConverter : DefaultTypeConverter
{
    public override object ConvertFromString(string text, IReaderRow row, MemberMapData memberMapData)
    {
        return text.Equals("Yes", StringComparison.OrdinalIgnoreCase);
    }
}

Nếu như ta muốn ghi dữ liệu vào file CSV thì ta còn phải định nghĩa lại cả hàm ConvertToString. Dưới đây là cách để chuyển giá trị từ kiểu boolean về lại thành Yes/No (giá trị không phải là boolean sẽ gây là lỗi).

public override string ConvertToString(object value, IWriterRow row, MemberMapData memberMapData)
{
    if (value is bool boolVal)
    {
        return boolVal ? "Yes" : "No";
    }

    throw new ArgumentException("Giá trị phải có kiểu là boolean");
}

Đăng ký converter của ta với CsvHelper

Như đã thấy, converter của ta sẽ chuyển giá trị Yes (không phân biệt chữ hoa chữ thường) thành true; còn tất cả các giá trị khác sẽ được chuyển thành false. Bước tiếp theo là sử dụng converter này bằng cách gọi hàm TypeConverter.

public class PersonMapWithConverter : ClassMap<PersonV2>
{
    public PersonMapWithConverter()
    {
        Map(p => p.FirstName);
        Map(p => p.LastName);
        Map(p => p.Age);
        Map(p => p.IsActive).TypeConverter<CustomBooleanConverter>();
    }
}

Lưu ý là ta cũng có thể gọi hàm TypeConverter sau khi map cột bằng tên hoặc số thứ tự.

Map(p => p.IsActive).Name("IsActive").TypeConverter<CustomBooleanConverter>();

Hoặc

Map(p => p.IsActive).Index(3).TypeConverter<CustomBooleanConverter>();

Sau đó ta có thể đăng ký PersonMapWithConverter với CsvHelper một cách bình thường.

csv.Context.RegisterClassMap<PersonMapWithConverter>();
var data = csv.GetRecords<PersonV2>();

Đọc file CSV một cách không đồng bộ

CsvHelper cũng cho phép ta đọc file CSV một cách không đồng bộ. Thay vì dùng hàm GetRecords, ta có thể dùng hàm GetRecordsAsync. Giá trị trả về sẽ có kiểu là IAsyncEnumerable<T>.

var fileName = @"<đường dẫn tới file CSV>";
var configuration = new CsvConfiguration(CultureInfo.InvariantCulture)
{
    Encoding = Encoding.UTF8, // File của ta dùng encoding UTF-8.
    Delimiter = "," // Ký tự phân cách giữa các trường là dấu phẩy.
};

using (var fs = File.Open(fileName, FileMode.Open, FileAccess.Read, FileShare.Read))
{
    using (var textReader = new StreamReader(fs, Encoding.UTF8))
    using (var csv = new CsvReader(textReader, configuration))
    {
        var data = csv.GetRecordsAsync<Person>();
        
        await foreach (var person in data) // Duyệt phần tử của data một cách không đồng bộ
        {
            // Xử lý dữ liệu trong từng dòng
        }
    }
}

Khi dùng IAsyncEnumerable và await foreach, vòng lặp của ta sẽ không block trong khi đợi đọc phần tử tiếp theo từ data.

Đọc tệp CSV bằng CSVHelper với bất kỳ lớp mô hình nào

Bây giờ, hãy tạo một lớp mô hình có tên là Employee. Lớp này được sử dụng để đọc và ghi tệp CSV.

Lưu ý: Chúng tôi đã tạo lớp mô hình Nhân viên chỉ cho mục đích trình diễn. Bạn có thể sử dụng bất kỳ lớp mô hình nào bạn cần cho dự án của mình.

Bây giờ, chúng tôi tạo một dịch vụ để đọc các tệp CSV bằng gói CSVHelper NuGet. Đối với điều này, hãy tạo một thư mục có tên Services trong thư mục gốc. Sau đó, tạo giao diện có tên ICSVService, tương tự như mẫu tiếp theo.

public interface ICSVService
{
   public IEnumerable<T> ReadCSV<T>(Stream file);
}

Tạo một lớp có tên là CSVService, kế thừa từ ICSVService.

public class CSVService : ICSVService
{
    public IEnumerable<T> ReadCSV<T>(Stream file)
    {
        var reader = new StreamReader(file);
        var csv = new CsvReader(reader, CultureInfo.InvariantCulture);

        var records = csv.GetRecords<T>();
        return records;
    }
}

Chúng tôi đã sử dụng một chung cấp phương thức để xử lý lớp mô hình. Chúng tôi có thể sử dụng phương pháp này với bất kỳ lớp mô hình nào để đọc tệp CSV. Chúng tôi cũng đã chuyển luồng tệp dưới dạng tham số cho phương thức ReadCSV. StreamReader đọc văn bản và ký tự từ luồng tệp. Sau đó, chúng tôi đã sử dụng CsvReader để chuyển nội dung đã đọc từ StreamReader vào bộ nhớ. Sau đó, phương thức GetRecords trả về dữ liệu của tệp CSV. Chúng tôi không cần bất kỳ cấu hình nào nếu tên thuộc tính lớp của chúng tôi khớp với tiêu đề của tệp CSV.

Sau tất cả những điều này, hãy đăng ký dịch vụ CSV trong Program.cs, như được hiển thị trong mã tiếp theo.

builder.Services.AddScoped<ICSVService, CSVService>();

Tiếp theo, tạo một lớp trình điều khiển có tên là EmployeeController bên trong thư mục Controllers. Sau đó, tạo yêu cầu HttpPost để đọc tệp CSV bằng ICSVService.

[ApiController]
[Route("[controller]")]
public class EmployeeController : Controller
{
   private readonly ICSVService _csvService;

   public EmployeeController(ICSVService csvService)
   {
       _csvService = csvService;
   }

   [HttpPost("read-employees-csv")]
   public async Task<IActionResult> GetEmployeeCSV([FromForm] IFormFileCollection file)
    {
        var employees = _csvService.ReadCSV<Employee>(file[0].OpenReadStream());

        return Ok(employees);
    }
}

Chúng tôi đã thêm ICSVService để sử dụng thao tác đọc cho các tệp CSV. Ngoài ra, EmployeeController sử dụng thuộc tính ApiController để triển khai bộ điều khiển API Web trong ASP.NET Core. Sau đó, chúng tôi đã sử dụng phương thức ReadCSV của CSVService để lấy dữ liệu của tệp CSV sau khi đọc.

Đầu tiên, hãy chạy ứng dụng. Sau đây là ảnh chụp màn hình của tệp CSV mà chúng tôi sử dụng để đọc dữ liệu.

Sau đó, chạy điểm cuối read-employees-csv để đọc tệp CSV như trong hình dưới đây.

Ở đây chúng tôi đã đính kèm tệp CSV mà chúng tôi sử dụng để chạy tệp đọc.

Chúng tôi đã nhận được phản hồi sau khi chạy API thành công.

Viết tệp CSV bằng CSVHelper

Chúng tôi sử dụng CSVService để tạo phương thức ghi CSV bằng CSVHelper. Đối với điều này, hãy thêm một phương thức trừu tượng có tên là WriteCSV trong giao diện ICSVService.

public interface ICSVService
{
    public IEnumerable<T> ReadCSV<T>(Stream file);
    void WriteCSV<T>(List<T> records);
}

Sau đó, triển khai phương thức WriteCSV trong lớp CSVService như trong đoạn mã sau.

public class CSVService : ICSVService
{
    public IEnumerable<T> ReadCSV<T>(Stream file)
    {
        var reader = new StreamReader(file);
        var csv = new CsvReader(reader, CultureInfo.InvariantCulture);

        var records = csv.GetRecords<T>();
        return records;
    }

    public void WriteCSV<T>(List<T> records)
    {
        using (var writer = new StreamWriter("D:\\file.csv"))
        using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
        {
            csv.WriteRecords(records);
        }
    }
}

Trong phương thức WriteCSV, StreamWriter được sử dụng để tạo và ghi tệp theo đường dẫn được chỉ định trong tham số. CsvWriter được sử dụng để tạo các tệp CSV thực bằng cách sử dụng phiên bản StreamWriter đã tạo. Phương thức WriteRecords ghi tất cả dữ liệu vào tệp.

Bây giờ, hãy sử dụng EmployeeController để tạo yêu cầu HttpPost để tạo và ghi tệp CSV.

[ApiController]
[Route("[controller]")]
public class EmployeeController : Controller
{
    private readonly ICSVService _csvService;

    public EmployeeController(ICSVService csvService)
    {
        _csvService = csvService;
    }

    [HttpPost("write-employee-csv")]
    public async Task<IActionResult> WriteEmployeeCSV([FromBody] List<Employee> employees)
    {
        _csvService.WriteCSV<Employee>(employees);

        return Ok();
    }

    [HttpPost("read-employees-csv")]
    public async Task<IActionResult> GetEmployeeCSV([FromForm] IFormFileCollection file)
    {
        var employees = _csvService.ReadCSV<Employee>(file[0].OpenReadStream());

        return Ok(employees);
    }
}

Chúng tôi đã triển khai yêu cầu HttpPost mới để ghi tệp CSV bằng phương thức WriteCSV của CSVService.

Hãy chạy ứng dụng Web API. Sau đó, chúng tôi chạy điểm cuối write-employee-csv để kiểm tra dịch vụ.

Chúng tôi đã sử dụng Swagger để chạy và kiểm tra API để viết CSV. Chúng tôi đã thông qua một danh sách với hai đối tượng nhân viên.

Và như vậy là chúng ta đã tạo thành công một file CSV trong đường dẫn thư mục. Dữ liệu nhân viên nằm trong tệp CSV, như trong hình tiếp theo.

Kết thúc

Tôi đã dùng CsvHelper trong nhiều dự án thực tế, và thư viện này có thể xử lý nhưng file CSV với hàng chục ngàn dòng một cách dễ dàng. Nếu file của bạn có tới vài triệu dòng thì có thể bạn sẽ gặp vấn đề về bộ nhớ. Nhưng trước lúc đó thì CsvHelper với sự đơn giản của nó vẫn là một lựa chọn khả thi.

---

Tham khảo:

• Đọc file CSV bằng C# với CsvHelper
• Handling CSV Files in ASP.NET Core Web APIs
• Writing to CSV-file from multiple threads
• Xem trước nội dung file CSV với papaparse
• Jordan Parses Large CSVs
• Building a Generic CSV Writer/Reader Using Reflection
• Reading a CSV File
• The fastest CSV parser in .NET

---

• ← Previous Post
• Next Post →