web-dev-qa-db-ja.com

EPPlusを使用してExcelの行を解析して型に戻す方法

EPPlusには便利なLoadFromCollection<T>メソッドを使用して、自分のタイプのデータをワークシートに取り込みます。

たとえば、クラスがある場合:

public class Customer
{
    public int Id { get; set; }
    public string Firstname { get; set; }
    public string Surname { get; set; }
    public DateTime Birthdate { get; set; }
}

次に、次のコード:

var package = new ExcelPackage();
var sheet = package.Workbook.Worksheets.Add("Customers");
var customers = new List<Customer>{
    new Customer{
        Id = 1,
        Firstname = "John",
        Surname = "Doe",
        Birthdate = new DateTime(2000, 1, 1)
    },
    new Customer{
        Id = 2,
        Firstname = "Mary",
        Surname = "Moe",
        Birthdate = new DateTime(2001, 2, 2)
    }
};
sheet.Cells[1, 1].LoadFromCollection(customers);
package.Save();

...「Customers」というワークシートに2行追加します。

私の質問は、Excelから行を抽出して(たとえば、いくつかの変更が行われた後)タイプに戻す便利な対応物があるかどうかです。

何かのようなもの:

var package = new ExcelPackage(inputStream);
var customers = sheet.Dimension.SaveToCollection<Customer>() ??

私が持っています

  • ePPlusコードベースを調べている
  • saving の質問を検索しました
  • 解析 質問を検索
  • 見られる this 単一セルの読み取りに関する質問

...しかし、単純に行を私のタイプに解析する方法については何も見つかりませんでした。

18
Philip Bijker

上記に触発されて、私はわずかに異なるルートを取りました。

  1. 属性を作成し、各プロパティを列にマップしました。
  2. DTOタイプを使用して、各列の期待値を定義します
  3. 列を要求しないようにする
  4. EPPlusを使用して型を変換する

そうすることで、従来のモデル検証を使用し、列ヘッダーの変更を受け入れることができます

- 使用法:

using(FileStream fileStream = new FileStream(_fileName, FileMode.Open)){
      ExcelPackage Excel = new ExcelPackage(fileStream);
      var workSheet = Excel.Workbook.Worksheets[RESOURCES_WORKSHEET];

      IEnumerable<ExcelResourceDto> newcollection = workSheet.ConvertSheetToObjects<ExcelResourceDto>();
      newcollection.ToList().ForEach(x => Console.WriteLine(x.Title));
 }

ExcelにマップするDto

public class ExcelResourceDto
{
    [Column(1)]
    [Required]
    public string Title { get; set; }

    [Column(2)]
    [Required]
    public string SearchTags { get; set; }
}

これは属性の定義です

[AttributeUsage(AttributeTargets.All)]
public class Column : System.Attribute
{
    public int ColumnIndex { get; set; }


    public Column(int column) 
    {
        ColumnIndex = column;
    }
} 

DTOへの行のマッピングを処理する拡張クラス

public static class EPPLusExtensions
{
   public static IEnumerable<T> ConvertSheetToObjects<T>(this ExcelWorksheet worksheet) where T : new()
    {

        Func<CustomAttributeData, bool> columnOnly = y => y.AttributeType == typeof(Column);

        var columns = typeof(T)
                .GetProperties()
                .Where(x => x.CustomAttributes.Any(columnOnly))
        .Select(p => new
        {
            Property = p,
            Column = p.GetCustomAttributes<Column>().First().ColumnIndex //safe because if where above
        }).ToList();


        var rows= worksheet.Cells
            .Select(cell => cell.Start.Row)
            .Distinct()
            .OrderBy(x=>x);


        //Create the collection container
        var collection = rows.Skip(1)
            .Select(row =>
            {
                var tnew = new T();
                columns.ForEach(col =>
                {
                    //This is the real wrinkle to using reflection - Excel stores all numbers as double including int
                    var val = worksheet.Cells[row, col.Column];
                    //If it is numeric it is a double since that is how Excel stores all numbers
                    if (val.Value == null)
                    {
                        col.Property.SetValue(tnew, null);
                        return;
                    }
                    if (col.Property.PropertyType == typeof(Int32))
                    {
                        col.Property.SetValue(tnew, val.GetValue<int>());
                        return;
                    }
                    if (col.Property.PropertyType == typeof(double))
                    {
                        col.Property.SetValue(tnew, val.GetValue<double>());
                        return;
                    }
                    if (col.Property.PropertyType == typeof(DateTime))
                    {
                        col.Property.SetValue(tnew, val.GetValue<DateTime>());
                        return;
                    }
                    //Its a string
                    col.Property.SetValue(tnew, val.GetValue<string>());
                });

                return tnew;
            });


        //Send it back
        return collection;
    }
}
32
Nix

残念ながらEPPlusにネイティブなそのようなメソッドはありません。本当にジェネリックにしたい場合はリフレクションを使用する必要があるため、クラックするのは難しいナットです。また、Excelはすべての数値と日付を2倍として保存するため、多くのボックス化解除と型チェックに対処する必要があります。

これは私が取り組んできたものです。 Genericsを介してそれを行う拡張メソッド。機能しますが、限られたテストの下でのみですので、自分で確認してください。私はそれが(まだ)最も最適化されていることを保証することはできませんが、彼の点ではかなりまともです。次のように使用します。

IEnumerable<TestObject> newcollection = worksheet.ConvertSheetToObjects<TestObject>();

拡張子:

public static IEnumerable<T> ConvertSheetToObjects<T>(this ExcelWorksheet worksheet) where T:new()
{
    //DateTime Conversion
    var convertDateTime = new Func<double, DateTime>(excelDate =>
    {
        if (excelDate < 1)
            throw new ArgumentException("Excel dates cannot be smaller than 0.");

        var dateOfReference = new DateTime(1900, 1, 1);

        if (excelDate > 60d)
            excelDate = excelDate - 2;
        else
            excelDate = excelDate - 1;
        return dateOfReference.AddDays(excelDate);
    });

    //Get the properties of T
    var tprops = (new T())
        .GetType()
        .GetProperties()
        .ToList();

    //Cells only contains references to cells with actual data
    var groups = worksheet.Cells
        .GroupBy(cell => cell.Start.Row)
        .ToList();

    //Assume the second row represents column data types (big assumption!)
    var types = groups
        .Skip(1)
        .First()
        .Select(rcell => rcell.Value.GetType())
        .ToList();

    //Assume first row has the column names
    var colnames = groups
        .First()
        .Select((hcell, idx) => new { Name = hcell.Value.ToString(), index = idx })
        .Where(o => tprops.Select(p => p.Name).Contains(o.Name))
        .ToList();

    //Everything after the header is data
    var rowvalues = groups
        .Skip(1) //Exclude header
        .Select(cg => cg.Select(c => c.Value).ToList());


    //Create the collection container
    var collection = rowvalues
        .Select(row =>
        {
            var tnew = new T();
            colnames.ForEach(colname =>
            {
                //This is the real wrinkle to using reflection - Excel stores all numbers as double including int
                var val = row[colname.index];
                var type = types[colname.index];
                var prop = tprops.First(p => p.Name == colname.Name);

                //If it is numeric it is a double since that is how Excel stores all numbers
                if (type == typeof (double))
                {
                    //Unbox it
                    var unboxedVal = (double) val;

                    //FAR FROM A COMPLETE LIST!!!
                    if (prop.PropertyType == typeof (Int32))
                        prop.SetValue(tnew, (int) unboxedVal);
                    else if (prop.PropertyType == typeof (double))
                        prop.SetValue(tnew, unboxedVal);
                    else if (prop.PropertyType == typeof (DateTime))
                        prop.SetValue(tnew, convertDateTime(unboxedVal));
                    else
                        throw new NotImplementedException(String.Format("Type '{0}' not implemented yet!", prop.PropertyType.Name));
                }
                else
                {
                    //Its a string
                    prop.SetValue(tnew, val);
                }
            });

            return tnew;
        });


    //Send it back
    return collection;
}

完全な例:

[TestMethod]
public void Read_To_Collection_Test()
{   
    //A collection to Test
    var objectcollection = new List<TestObject>();

    for (var i = 0; i < 10; i++)
        objectcollection.Add(new TestObject {Col1 = i, Col2 = i*10, Col3 = Path.GetRandomFileName(), Col4 = DateTime.Now.AddDays(i)});

    //Create a test file to convert back
    byte[] bytes;
    using (var pck = new ExcelPackage())
    {
        //Load the random data
        var workbook = pck.Workbook;
        var worksheet = workbook.Worksheets.Add("data");
        worksheet.Cells.LoadFromCollection(objectcollection, true);
        bytes = pck.GetAsByteArray();
    }


    //*********************************
    //Convert from Excel to a collection
    using (var pck = new ExcelPackage(new MemoryStream(bytes)))
    {
        var workbook = pck.Workbook;
        var worksheet = workbook.Worksheets["data"];

        var newcollection = worksheet.ConvertSheetToObjects<TestObject>();
        newcollection.ToList().ForEach(to => Console.WriteLine("{{ Col1:{0}, Col2: {1}, Col3: \"{2}\", Col4: {3} }}", to.Col1, to.Col2, to.Col3, to.Col4.ToShortDateString()));
    }
}

//test object class
public class TestObject
{
    public int Col1 { get; set; }
    public int Col2 { get; set; }
    public string Col3 { get; set; }
    public DateTime Col4 { get; set; }
}

コンソール出力:

{ Col1:0, Col2: 0, Col3: "wrulvxbx.wdv", Col4: 10/30/2015 }
{ Col1:1, Col2: 10, Col3: "wflh34yu.0pu", Col4: 10/31/2015 }
{ Col1:2, Col2: 20, Col3: "ps0f1jg0.121", Col4: 11/1/2015 }
{ Col1:3, Col2: 30, Col3: "skoc2gx1.2xs", Col4: 11/2/2015 }
{ Col1:4, Col2: 40, Col3: "urs3jnbb.ob1", Col4: 11/3/2015 }
{ Col1:5, Col2: 50, Col3: "m4l2fese.4yz", Col4: 11/4/2015 }
{ Col1:6, Col2: 60, Col3: "v3dselpn.rqq", Col4: 11/5/2015 }
{ Col1:7, Col2: 70, Col3: "v2ggbaar.r31", Col4: 11/6/2015 }
{ Col1:8, Col2: 80, Col3: "da4vd35p.msl", Col4: 11/7/2015 }
{ Col1:9, Col2: 90, Col3: "v5dtpuad.2ao", Col4: 11/8/2015 }
12
Ernie S