ExcelConfig 1.0.3.13

ExcelConfig

ExcelConfig Is a quick tool to operate Excel for arbitrary configuration.

ExcelConfig 是一个基于 .NET 的轻量级库，帮助您快速配置 .config.xlsx 格式配置文件的库。对 Excel 文件进行配置管理，它允许开发者将应用程序的配置信息存储在 Excel 表格中，并提供便捷的 API 来读取和写入这些配置。

📃 示例配置文件 Sample configuration file
🔗 配置存储中心 Configure storage center
🔗 配置存储中心 Storage center API Nuget库

Configuration

1. AppConfig

   public static string Text(string key)
   public static void WriteText(string key, string value)
   public static decimal Number(string key)
   public static string[] Array(string key)
   public static bool YesOrNo(string key)
   public static void WriteYesOrNo(string key, bool value)
   

2. AppConfigFile

   public AppConfigFile(string path = "", string name = "")
   

3. ExcelFile

   public static ExcelFile Load(string path, string sheet)
   public void ToSheet(string sheetname)
   public void SetKeyField(string fieldName)
   public void SetValueField(string fieldName)
   public string Text(string name)
   public decimal Number(string name)
   public bool YesOrNo(string name)
   public string[] Array(string name)
   public SheetLine ReadLine(string key)
   public IEnumerable<SheetLine> ReadAllLine()
   public CellObj Read(int rowno, int colno) // start 1 not 0
   public CellObj Read(string colname)
   

4. ExcelConfigFile

   public ExcelConfigFile(string filepath = "", string name = "", string suffix = "")
   

5. SheetLine

   public string Text(string name)
   public decimal Number(string name)
   public bool YesOrNo(string name)
   public string[] Array(string name)
   

6. GlobalSetting #参数定义

   public static string YES = "是的";
   public static string NO = "不是";
   /// <summary>
   /// 数组分割符
   /// </summary>
   public static char ArraySplitChar = ';';
   
   public static string SHEET_Global = "全局";
   public static string CONFIG_DEFAULT = "app";
   public static string CONFIG_SUFFIX = ".config.xlsx";
   public static string FIELD_ExtraConfigPath = "额外配置目录";
   public static string SHEET_ExtraConfig = "额外配置目录";
   public static string COLUMN_KEY = "名称";
   public static string COLUMN_VALUE = "值";
   /// <summary>
   /// 全局配置文件路径，，默认类库所在目录
   /// * 您需要确认配置的目录存在，不存在需要先行创建
   /// </summary>
   public static string CONFIG_PATH = string.Empty;
   

🍕 Template

xlsx template file related operations, the main function is to replace the specified cell and output the specified format table.

xlsx 模板文件相关操作， 主要功能为替换指定单元格 和 输出指定格式表格。

1. ExcelTemplateFile

   public void TemplateOut(object obj, string path)
   

📦 特性

• Excel 配置读取：支持从 Excel 文件中读取配置信息。
• 多配置支持：可以管理多个配置文件，并通过名称或键来访问。
• 类型安全读取：支持以类型安全的方式读取配置值（如字符串、数字、布尔值、数组等）。
• 全局配置与局部配置：支持全局配置项以及多个独立的配置块。
• 配置写入：支持将配置值写回 Excel 文件。
• 模板支持：提供基于 Excel 模板生成配置文件的功能。

📁 项目结构

• ExcelConfig：核心配置类，提供读写 Excel 配置的方法。
• ExcelFile：封装对 Excel 文件的操作，支持切换工作表和字段。
• AppConfig：提供静态方法访问默认配置。
• ExcelTemplateFile：支持通过 Excel 模板生成配置文件。
• ExcelRow 和 SheetLine：用于表示 Excel 中的行数据。
• ExcelRead：提供从 Excel 读取数据的功能。
• GlobalSetting：定义全局常量和配置参数。

本项目基于开源项目 MiniExcel 1.41.2 Apache License 2.0