WeihanLi.Npoi 支持 ShadowProperty 了

時間 2019-12-16

標籤 weihanli.npoi weihanli npoi 支持 shadowproperty 欄目 Java開源简体版

原文原文鏈接

WeihanLi.Npoi 支持 `ShadowProperty` 了

Intro

在 EF 裏有個 ShadowProperty (陰影屬性/影子屬性)的概念，你能夠經過 FluentAPI 的方式來定義一個不在 .NET model 裏定義的屬性，只能經過 EF 裏的 Change Tracker 來操做這種屬性。git

在導出 Excel 的時候，可能但願導出的列並非都定義好在咱們的 model 中的，有的可能只是想增長一列導出某個屬性中的嵌套屬性之中的某一個屬性值，或者我就是單純的想多定義一列，而這個時候可能 model 是別的地方寫死的，不方便改。github

因而 WeihanLi.Npoi 從 1.6.0 版本開始支持 ShadowProperty ，將 EF 裏的 ShadowProperty 引入到 excel 導出裏，目前來講 ShadowProperty 是不可寫的，讀取的話也只是返回一個類型的默認值，不支持 ChangeTracker，不支持改。spa

使用示例

來看一個簡單使用示例：(示例來源於網友提出的這個issue： https://github.com/WeihanLi/WeihanLi.Npoi/issues/51)3d

using System;
using System.Collections.Generic;
using System.IO;
using WeihanLi.Npoi;

namespace NpoiTest
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var settings = ExcelHelper.SettingFor<TestEntity>();
            settings.Property(x => x.Name)
                .HasColumnIndex(0);
            // settings.Property(x => x.UserFields)
            //     .HasOutputFormatter((entity, value) => $"{value[0].Value},{value[2].Value}")
            //     .HasColumnTitle("姓名,工號")
            //     .HasColumnIndex(1);
            settings.Property(x=>x.UserFields).Ignored();
            settings.Property("工號")
                .HasOutputFormatter((entity,val)=> $"{entity.UserFields[2].Value}")
                 ;
            settings.Property("部門")
                .HasOutputFormatter((entity,val)=> $"{entity.UserFields[1].Value}")
                 ;

            var data = new List<TestEntity>()
            {
                new TestEntity()
                {
                    Name = "xiaoming",
                    TotalScore = 100,
                    UserFields = new UserField[]
                    {
                        new UserField()
                        {
                            Name = "姓名",
                            Value = "xaioming",
                        },
                        new UserField()
                        {
                            Name = "部門",
                            Value = "1212"
                        },
                        new UserField()
                        {
                            Name = "工號",
                            Value = "121213131"
                        },
                    }
                }
            };
            data.ToExcelFile($@"{Directory.GetCurrentDirectory()}\output.xls");
            Console.WriteLine("complete.");
        }

        private class TestEntity
        {
            public string Name { get; set; }

            public UserField[] UserFields { get; set; }

            public int TotalScore { get; set; }
        }

        private class UserField
        {
            public string Fid { get; set; }
            public string Name { get; set; }
            public string Value { get; set; }
        }
    }
}

導出效果以下：excel