Nukepayload2.Csv

Nukepayload2.Csv is a cross-platform Csv String <==> .NET Object converter. Commonly Used members: Nukepayload2.Csv.CsvConvert.SerializeObject Nukepayload2.Csv.CsvConvert.DeserializeObject Supported types in csv columns: System.String System.DateTime System.Int32 System.Int64 System.Single System.Double System.Boolean NOTE: Please don't forget to add the "Code Generation" capability if you are using this package in a UWP project. If JIT is not allowed, both serialization and deserialization could be much slower than expected.


Keywords
csv, tsv, formatter, serializer, converter, vb, netstandard
License
Apache-2.0
Install
Install-Package Nukepayload2.Csv -Version 1.4.1

Documentation

Nukepayload2.Csv

Nukepayload2.Csv is a cross-platform Csv String <==> .NET Object converter.

Supported types in csv columns:

  • System.String
  • System.DateTime
  • System.DateTime?
  • System.Int32
  • System.Int32?
  • System.Int64
  • System.Int64?
  • System.Single
  • System.Single?
  • System.Double
  • System.Double?
  • System.Boolean
  • System.Boolean?

Feature status

Feature IsSupported
Custom line separator True
Custom column separator True
Custom csv layout True
Csv String to Objects True
Objects to Csv String True
Escape characters True
Custom format string for output True
Read-only properties True
Opt-in and Opt-out columns True
Run in multi-threaded code True
Custom format string for input False
Csv UTF-8 Stream to Objects False
Objects to UTF-8 Stream False
Column oriented and Sparse storage False
Excel number parser compatibility Partial
Excel formula compatibility False

Get on Nuget

https://www.nuget.org/packages/Nukepayload2.Csv

如果你需要中文介绍,请向下滚动页面。

Sample Code

Convert Csv string to .NET Object

Goal: convert the following csv string to .NET Object.

Id,Rate,Name,Date,IsUsed
-233,12345.12,test string,2018-05-09,True
0,-12345.12,,2018-09-09,False

1. Create a model class

VB

Public Class MyCsvModel
    Public Property Id As Integer
    Public Property Rate As Double
    Public Property Name As String
    Public Property [Date] As Date
    Public Property IsUsed As Boolean
End Class

C#

public class MyCsvModel
{
    public int Id { get; set; }
    public double Rate { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
    public bool IsUsed { get; set; }
}

2. Convert csv to IReadOnlyList of MyCsvModel

Assume that csv is a System.String that contains csv.

VB

Dim converted = CsvConvert.DeserializeObject(Of MyCsvModel)(csv)

C#

var converted = CsvConvert.DeserializeObject<MyCsvModel>(csv);

Convert .NET Object back to Csv string

VB

csv = CsvConvert.SerializeObject(converted)

C#

csv = CsvConvert.SerializeObject(converted);

VB and C# model Code generator (Preview)

  1. Clone this repo.
  2. Make sure .NET Core 2.x or higher SDK is installed.
  3. Open cmd or bash in cloned code's root directory.
  4. Go the ModelGenerator directory cd Nukepayload2.Csv.ModelGenerator
  5. Build the project dotnet build Nukepayload2.Csv.ModelGenerator.vbproj
  6. To see help, execute dotnet run Nukepayload2.Csv.ModelGenerator.dll (Change \ to / on Linux) .

What is next?

  • [Prototyping] Column-oriented storage for loading huge csv file.
  • [Pending] Lower allocation (waiting for ref struct support in VB) https://github.com/dotnet/vblang/issues/297 .
  • [Pending] Optimize getter and setter for Int32, Int64, Single and Double since they are frequently used in csv.

Nukepayload2.Csv 中文介绍

Nukepayload2.Csv 是一个跨平台的 Csv 字符串 <==> .NET 对象转换器。

在 csv 每一列中支持的数据类型:

  • System.String
  • System.DateTime
  • System.DateTime?
  • System.Int32
  • System.Int32?
  • System.Int64
  • System.Int64?
  • System.Single
  • System.Single?
  • System.Double
  • System.Double?
  • System.Boolean
  • System.Boolean?

功能状态

功能 是否支持
自定义行分隔符
自定义列分隔符
自定义 CSV 布局
字符串到对象转换
对象到字符串转换
转义字符
自定义输出格式字符串
只读属性支持
选入和排除的 csv 列选择模式
执行在多线程代码中
自定义输入格式字符串
UTF-8 流到对象
对象 to UTF-8 流
列式存储和稀疏存储
Excel 数字转换器兼容 部分
Excel 公式兼容

在 Nuget 下载

https://www.nuget.org/packages/Nukepayload2.Csv

示例代码

将 Csv 字符串转换为 .NET 对象

目标: 把下面的 csv 字符串转换为 .NET 对象

Id,Rate,Name,Date,IsUsed
-233,12345.12,test string,2018-05-09,True
0,-12345.12,,2018-09-09,False

1. 创建模型类

VB

Public Class MyCsvModel
    Public Property Id As Integer
    Public Property Rate As Double
    Public Property Name As String
    Public Property [Date] As Date
    Public Property IsUsed As Boolean
End Class

C#

public class MyCsvModel
{
    public int Id { get; set; }
    public double Rate { get; set; }
    public string Name { get; set; }
    public DateTime Date { get; set; }
    public bool IsUsed { get; set; }
}

2. 将 csv 转换为 MyCsvModelIReadOnlyList

假定 csv 是包含 csv 的 System.String

VB

Dim converted = CsvConvert.DeserializeObject(Of MyCsvModel)(csv)

C#

var converted = CsvConvert.DeserializeObject<MyCsvModel>(csv);

将 .NET 对象转换为 Csv 字符串

VB

csv = CsvConvert.SerializeObject(converted)

C#

csv = CsvConvert.SerializeObject(converted);

VB 和 C# 模型代码生成器(预览)

  1. 克隆此仓库.
  2. 确保 .NET Core 2.x SDK 安装了.
  3. 在克隆后的代码根目录打开 cmd 或者 bash.
  4. 进入生成器的目录 cd Nukepayload2.Csv.ModelGenerator
  5. 编译 dotnet build Nukepayload2.Csv.ModelGenerator.vbproj
  6. 执行命令查看查看帮助 dotnet run Nukepayload2.Csv.ModelGenerator.dll (Linux 上把 \ 改成 /) .

下一步的计划?

  • [做原型] 为大型 Csv 准备的列式存储。
  • [挂起] 减少内存分配 (等 ref struct 在 VB 能用了再说) https://github.com/dotnet/vblang/issues/297
  • [挂起] 为常用的 Int32, Int64, Single 和 Double 提供读写性能优化。