使用工具自动化配置读取

 

     当你知道使用配置代替HardCode说明你从新手变成了一名初级程序，当有一天你意识到你的配置是需要使用工具去驱动的，这时候你已经走在了进阶为行家的路上了。我之前看有些朋友写的配置读取工具类是针对一个一个Model去写，每个Model都翻一种花样去写，我想说这代码看起来就像是喝醉酒之后写的。好了，现在该醒醒酒了，下文讲一个胡乱编造的故事权当娱乐

     

      小明在开发一款游戏，由于游戏中需要调整的参数太多，于是小明把各个人物的属性都序列化在Unity的Inspect中显示。开发了几天之后小明发现自己需要配置的参数太多了，于是决定用一个配置来集中存放这些游戏中数据。然后小明用Json保存了游戏的数据，并且将配置移交给策划配去了，这份配置看起来就像是这样：

{
    1: {
        "ID": 1,
        "Name": "keyle1",
        "Power": 123,
        "RangeType": 12,
        "ShotRange": 101.5
    },
    2: {
        "ID": 2,
        "Name": "keyle2",
        "Power": 123,
        "RangeType": 13,
        "ShotRange": 101.8
    },
    3: {
        "ID": 3,
        "Name": "keyle3",
        "Power": 123,
        "RangeType": 14,
        "ShotRange": 102.1
    },
    4: {
        "ID": 4,
        "Name": "keyle4",
        "Power": 123,
        "RangeType": 15,
        "ShotRange": 102.4
    },
    5: {
        "ID": 5,
        "Name": "keyle5",
        "Power": 123,
        "RangeType": 16,
        "ShotRange": 102.7
    },
    6: {
        "ID": 6,
        "Name": "keyle6",
        "Power": 123,
        "RangeType": 17,
        "ShotRange": 103
    },
    7: {
        "ID": 7,
        "Name": "keyle7",
        "Power": 123,
        "RangeType": 18,
        "ShotRange": 103.3
    },

   ...
}

     

然后写了如下的Model代码

internal class Hero 
    {

        [JsonProperty("ID")]
        public int ID { get; set; }

        [JsonProperty("Name")]
        public string Name { get; set; }

        [JsonProperty("Power")]
        public int Power { get; set; }

        [JsonProperty("RangeType")]
        public int RangeType { get; set; }

        [JsonProperty("ShotRange")]
        public float ShotRange { get; set; }
    }

现在这样做貌似还能解决配置的需求，策划同学天天瞅着Json文件一个一个字段修改，时不时改错几个数值，小明回过头来还要帮策划君改Json配置的格式。

又过了一阵子，小明不断的开发出游戏中新的功能同时伴随着新的Json配置出来，小明要花时间与策划协商不同的Model然后根据策划的需求不断的改动Model，慢慢的策划君不乐意了，改的文件太多了，经常由于格式问题导致双方都耗时间在上面。

于是就有了这个

1

策划君很开心从此以后就欢乐的使用工具生成了Json配置与小明使用的代码。俩人过上了幸福的生活…

接下来如何读取？

     如何写配置自动化读取，假设你已经自动生成了配置文件，现在你已经完成一大半。

     在Unity下将配置置于Resource内，使用如下代码读取

public class ConfigReader
    {
        private static ConfigReader instance;
        public static ConfigReader Instance { get { return instance ?? (instance = new ConfigReader()); } }
        private ConfigReader() { }

        /// <summary>
        /// 非Untiy环境可以使用如下代码
        /// </summary>
        public Dictionary<int, T> LoadConfig<T>() where T : class
        {
            string path = Directory.GetCurrentDirectory();
            path = Path.Combine(path, string.Format("{0}Config.json", typeof(T).Name));
            string str = File.ReadAllText(path);
            return JsonConvert.DeserializeObject<Dictionary<int, T>>(str);
        }

        //Unity数据读取使用此代码
        //public Dictionary<int, T> LoadConfig<T>() where T : class
        //{
        //    return JsonConvert.DeserializeObject<Dictionary<int, T>>(Resources.Load<TextAsset>(string.Format("Config/{0}Config", typeof(T).Name)).ToString());
        //}

至此自动化的读取完成，当然架构上层面仍然需要设计，比如使用泛型约束去做抽象层面上的数据查询 等等。本章只是为后续的博文做铺垫，另外需要此工具的可以留言哟。

本项目为开源项目，代码正在重构中 如有兴趣可以加到群里一起聊聊

http://git.oschina.net/keyle/UnityExcel2JsonGenCSharper