C#使用Linq to csv讀取.csv文件數據3_源碼改造_支持設置標題行&標題映射&自動打印並忽略錯誤行數據&定義數據格式

時間 2020-10-04

標籤 html 數組 app ide post this 編碼 url spa 欄目 C# 简体版

原文原文鏈接

　　使用csv文件存儲數據比excel更加輕量級，支持的場景更加豐富，能夠徹底自定義，不受excel約束。可是對csv文件的解析和讀取，網上的資料又不是不少，這裏經過拿來linq to csv的源碼並在其基礎上進行擴展，以支持遇到的一些問題。html

　　主要擴展的功能點：數組

　　　　1-支持設置標題行（源碼僅支持設置首行是否爲標題行）app

　　　　2-支持設置標題跟數據的映射關係（源碼經過下標設置數據關係，這一點若是標題行過多時，數位置是很頭疼的，尤爲是在多列中再插入一列...而經過標題跟數據映射就很簡單了，自動尋找下標）ide

　　　　2-自動打印錯誤行數據並忽略錯誤行數據（這點和源碼差很少）post

　　　　3-定義數據格式（和源碼一致）ui

　　個人前兩篇關於csv的幫助文章也能夠參考下：this

　　C#使用Linq to csv讀取.csv文件數據編碼

　　C#使用Linq to csv讀取.csv文件數據2_處理含有非列名數據的方法（說明信息等）url

改造完整代碼以下：spa

　　1-Csv文件類特性標記：

/// <summary>
    /// Csv文件類特性標記
    /// </summary>
    [System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple = false)]
    public class CsvColumnAttribute : System.Attribute
    {
        /// <summary>
        /// 標題
        /// </summary>
        public string Title { get; set; }
        /// <summary>
        /// 字符輸出格式（數字和日期類型須要）
        /// </summary>
        public string OutputFormat { get; set; }

        public CsvColumnAttribute()
        {
            Title = "";
            OutputFormat = "";
        }

        public CsvColumnAttribute(string title, string outputFormat)
        {
            Title = title;
            OutputFormat = outputFormat;
        }
    }

CsvColumnAttribute

　　2-CsvFileDescription：

public class CsvFileDescription
    {
        public CsvFileDescription() : this(1)
        {
        }
        public CsvFileDescription(int titleRawIndex) : this(',', titleRawIndex, Encoding.UTF8)
        {
        }
        public CsvFileDescription(char separatorChar, int titleRawIndex, Encoding encoding)
        {
            this.SeparatorChar = separatorChar;
            this.TitleRawIndex = titleRawIndex;
            this.Encoding = encoding;
        }

        /// <summary>
        /// CSV文件字符編碼
        /// </summary>
        public Encoding Encoding { get; set; }

        /// <summary>
        /// 分隔符（默認爲（,）,也能夠是其餘分隔符如(\t)）
        /// </summary>
        public char SeparatorChar { get; set; }
        /// <summary>
        /// 標題所在行位置（默認爲1，沒有標題填0）
        /// </summary>
        public int TitleRawIndex { get; set; }

    }

CsvFileDescription

　　3-字段映射類：

/// <summary>
    /// 字段映射類
    /// </summary>
    public class FieldMapper
    {
        /// <summary>
        /// 屬性信息
        /// </summary>
        public PropertyInfo PropertyInfo { get; set; }
        /// <summary>
        /// 標題
        /// </summary>
        public string CSVTitle { get; set; }
        /// <summary>
        /// 標題下標位置
        /// </summary>
        public int CSVTitleIndex { get; set; }
        /// <summary>
        /// 字符輸出格式（數字和日期類型須要）
        /// </summary>
        public string OutputFormat { get; set; }

        public static List<FieldMapper> GetModelFieldMapper<T>()
        {
            List<FieldMapper> fieldMapperList = new List<FieldMapper>(100);

            List<PropertyInfo> tPropertyInfoList = typeof(T).GetProperties().ToList();
            CsvColumnAttribute csvColumnAttribute = null;
            int beginTitleIndex = 1;
            foreach (var tPropertyInfo in tPropertyInfoList)
            {
                csvColumnAttribute = (CsvColumnAttribute)tPropertyInfo.GetCustomAttribute(typeof(CsvColumnAttribute));
                if (csvColumnAttribute != null)
                {
                    fieldMapperList.Add(new FieldMapper
                    {
                        PropertyInfo = tPropertyInfo,
                        CSVTitle = csvColumnAttribute.Title,
                        CSVTitleIndex = beginTitleIndex,
                        OutputFormat = csvColumnAttribute.OutputFormat
                    });
                    beginTitleIndex++;
                }
            }
            return fieldMapperList;
        }

    }

FieldMapper

　　4-CsvHelper幫助類：

public class CsvHelper
    {
        /// <summary>
        /// 日誌
        /// </summary>
        private ILogger _Logger { get; set; }

        public CsvHelper(ILogger<CsvHelper> logger)
        {
            this._Logger = logger;
        }

        public List<T> Read<T>(string filePath, CsvFileDescription fileDescription) where T : class, new()
        {
            List<T> tList = new List<T>(50 * 10000);

            T t = null;
            int currentRawIndex = 1;

            if (File.Exists(filePath))
            {
                using (StreamReader streamReader = new StreamReader(filePath, fileDescription.Encoding))
                {
                    Dictionary<int, FieldMapper> fieldMapperDic = FieldMapper.GetModelFieldMapper<T>().ToDictionary(m => m.CSVTitleIndex);
                    string rawValue = null;
                    string[] rawValueArray = null;
                    PropertyInfo propertyInfo = null;
                    string propertyValue = null;
                    bool rawReadEnd = false;

                    bool isExistSplitChart = false;
                    do
                    {
                        rawValue = streamReader.ReadLine();

                        //標題行
                        if (currentRawIndex > fileDescription.TitleRawIndex)
                        {
                            if (!string.IsNullOrEmpty(rawValue))
                            {
                                //替換字符串含有分隔符爲{分隔符}，最後再替換回來
                                if (rawValue.Contains("\""))
                                {
                                    isExistSplitChart = true;

                                    int yhBeginIndex = 0;
                                    int yhEndIndex = 0;
                                    string yhText = null;
                                    do
                                    {
                                        yhBeginIndex = StringHelper.GetIndexOfStr(rawValue, "\"", 1);
                                        yhEndIndex = StringHelper.GetIndexOfStr(rawValue, "\"", 2);
                                        yhText = rawValue.Substring(yhBeginIndex, (yhEndIndex - yhBeginIndex + 1));
                                        string newYHText = yhText.Replace("\"", "").Replace(fileDescription.SeparatorChar.ToString(), "{分隔符}");
                                        rawValue = rawValue.Replace(yhText, newYHText);
                                    } while (rawValue.Contains("\""));
                                }

                                rawValueArray = rawValue.Split(fileDescription.SeparatorChar);

                                t = new T();
                                bool isExistException = false;
                                foreach (var fieldMapper in fieldMapperDic)
                                {
                                    try
                                    {
                                        propertyInfo = fieldMapper.Value.PropertyInfo;
                                        propertyValue = rawValueArray[fieldMapper.Key - 1];
                                        if (!string.IsNullOrEmpty(propertyValue))
                                        {
                                            if (isExistSplitChart && propertyValue.Contains("{分隔符}"))
                                            {
                                                propertyValue = propertyValue.Replace("{分隔符}", fileDescription.SeparatorChar.ToString());
                                            }

                                            TypeHelper.SetPropertyValue(t, propertyInfo.Name, propertyValue);
                                        }
                                    }
                                    catch (Exception e)
                                    {
                                        isExistException = true;
                                        this._Logger.LogWarning(e, $"第{currentRawIndex}行數據{propertyValue}轉換屬性{propertyInfo.Name}-{propertyInfo.PropertyType.Name}失敗！文件路徑：{filePath}");
                                        break;
                                    }
                                }
                                if (isExistException == false)
                                {
                                    tList.Add(t);
                                }
                            }
                            else
                            {
                                rawReadEnd = true;
                            }
                        }
                        currentRawIndex++;
                    } while (rawReadEnd == false);
                }
            }


            return tList;
        }

        public void WriteFile<T>(string path, List<T> tList, CsvFileDescription fileDescription) where T : class, new()
        {
            if (!string.IsNullOrEmpty(path))
            {
                string fileDirectoryPath = null;
                if (path.Contains("\\"))
                {
                    fileDirectoryPath = path.Substring(0, path.LastIndexOf('\\'));
                }
                else
                {
                    fileDirectoryPath = path.Substring(0, path.LastIndexOf('/'));
                }
                if (!Directory.Exists(fileDirectoryPath))
                {
                    Directory.CreateDirectory(fileDirectoryPath);
                }

                int dataCount = tList.Count;
                Dictionary<int, FieldMapper> fieldMapperDic = FieldMapper.GetModelFieldMapper<T>().ToDictionary(m => m.CSVTitleIndex);
                int titleCount = fieldMapperDic.Keys.Max();
                string[] rawValueArray = new string[titleCount];
                StringBuilder rawValueBuilder = new StringBuilder();
                string rawValue = null;
                T t = null;
                PropertyInfo propertyInfo = null;
                int currentRawIndex = 1;
                int tIndex = 0;

                using (StreamWriter streamWriter = new StreamWriter(path, false, fileDescription.Encoding))
                {
                    do
                    {
                        try
                        {
                            rawValue = "";

#if DEBUG
                            if (currentRawIndex % 10000 == 0)
                            {
                                this._Logger.LogInformation($"已寫入文件：{path}，數據量：{currentRawIndex}");
                            }
#endif

                            if (currentRawIndex >= fileDescription.TitleRawIndex)
                            {
                                //清空數組數據
                                for (int i = 0; i < titleCount; i++)
                                {
                                    rawValueArray[i] = "";
                                }

                                if (currentRawIndex > fileDescription.TitleRawIndex)
                                {
                                    t = tList[tIndex];
                                    tIndex++;
                                }
                                foreach (var fieldMapperItem in fieldMapperDic)
                                {
                                    //寫入標題行
                                    if (currentRawIndex == fileDescription.TitleRawIndex)
                                    {
                                        rawValueArray[fieldMapperItem.Key - 1] = fieldMapperItem.Value.CSVTitle;
                                    }
                                    //真正的數據從標題行下一行開始寫
                                    else
                                    {
                                        propertyInfo = fieldMapperItem.Value.PropertyInfo;
                                        object propertyValue = propertyInfo.GetValue(t);
                                        string formatValue = null;
                                        if (propertyValue != null)
                                        {
                                            if (propertyInfo.PropertyType is IFormattable && !string.IsNullOrEmpty(fieldMapperItem.Value.OutputFormat))
                                            {
                                                formatValue = ((IFormattable)propertyValue).ToString(fieldMapperItem.Value.OutputFormat, null);
                                            }
                                            else
                                            {
                                                formatValue = propertyValue.ToString();
                                            }

                                            //若是屬性值含有分隔符，則使用雙引號包裹
                                            if (formatValue.Contains(fileDescription.SeparatorChar.ToString()))
                                            {
                                                formatValue = $"\"{formatValue}\"";
                                            }
                                            rawValueArray[fieldMapperItem.Key - 1] = formatValue;
                                        }
                                    }
                                }
                                rawValue = string.Join(fileDescription.SeparatorChar, rawValueArray);
                            }
                            rawValueBuilder.Append(rawValue + "\r\n");
                        }
                        catch (Exception e)
                        {
                            this._Logger.LogWarning(e, $"(異常)Excel第{currentRawIndex}行，數據列表第{tIndex + 1}個數據寫入失敗！rawValue：{rawValue}");
                            throw;
                        }

                        currentRawIndex++;
                    } while (tIndex < dataCount);
                    streamWriter.Write(rawValueBuilder.ToString());

                    streamWriter.Close();
                    streamWriter.Dispose();
                }
            }
        }

    }

CsvHelper

　　示例：

　　使用類：

/// <summary>
/// CSV文件數據
/// </summary>
public class CSVModel
{
    /// <summary>
    /// 公司帳號
    /// </summary>
    [CsvColumn(Title = "Company Account")]
    public string CompanyAccount { get; set; }
    /// <summary>
    /// 支付帳號商家代碼
    /// </summary>
    [CsvColumn(Title = "Merchant Account")]
    public string MerchantAccount { get; set; }
}

CsvFileDescription csvFileDescription = new CsvFileDescription(3);
List<CSVModel> item1List = new CsvHelper().Read<OrderTransaction.Adyen.CSVModel>("/test.csv", csvFileDescription);