Enum引发的血案，反思

前几天公司产品更新版本，更新完后不少用户反应原先保存的report的一些表在新版本打开后设置突然变了，本来选的第六个，现在打开变成第四个了。领导要求赶紧查出原因修改好，发紧急补丁。啊啊。。发紧急补丁可是影响team的performance的，年终奖要打折扣了。。

问题是很容易就查到了，那些设置是用Enum表示的，如下：

 public enum PeergroupRanks
 {
     VSBenchmark,
     VSBenchmark2,
     CalBenchmark,
     PeersBeaten,
     NumPeergroupBeaten,
     PeergroupRank,
     NumPeergrouprank,
     PeergroupPercentile,
     PeergroupDecile,
     PeergroupQuintile,
     PeergroupQuartile,

     PeergroupRankOfCount,
 }

一位同事做新feature时加了上面红色的两个，由于存report的时候对于这个Enum只是简单的转成int存起来，大家都知道Enum默认是从0开始，按顺序来，原先存的第6个是PeergroupPercentile，report里存的就是数字5，新加了两个在上面后，数字5就解析成PeergroupRank了。

分析这个问题，觉得这个应该算是代码本身有漏洞，同事不小心踩到了，因为这位同事想法也不能说错，把同一个类型的放到一起，都是Benchmark，代码可读性强。

其实项目里大部分代码对Enum是有所防范的，如：

 public enum DisplayBenchmark
 {
     None,
     Benchmark1,
     Benchmark2,
     CategoryAverage,
     CalcBenchmarkId,
     CalcBenchmarkType,
     CalcBenchmarkCdp,
 }

 public static class DisplayBenchmarkCode
 {
     const string BENCHMARK1 = "bm1";
     const string BENCHMARK2 = "bm2";
     const string CATEGORY = "ca";

     public static DisplayBenchmark Parse(string code)
     {
         switch (code)
         {
             case BENCHMARK1:
                 return DisplayBenchmark.Benchmark1;
             case BENCHMARK2:
                 return DisplayBenchmark.Benchmark2;
             case CATEGORY:
                 return DisplayBenchmark.CategoryAverage;
         }
         return DisplayBenchmark.Benchmark1;
     }

     public static string Convert(this DisplayBenchmark type)
     {
         switch (type)
         {
             case DisplayBenchmark.Benchmark1:
                 return BENCHMARK1;
             case DisplayBenchmark.Benchmark2:
                 return BENCHMARK2;
             case DisplayBenchmark.CategoryAverage:
                 return CATEGORY;
         }
         return BENCHMARK1;
     }
 }

在report里存的是DsiplayBenchmarkType.Convert成的字符串，解析时再Parse，这样更安全，增加Type的同时也要增加相应的Code，一一对应。

当然，在Enum里写上具体值也是可行的，如：

 public enum PeergroupRanks
 {
     VSBenchmark=,
     VSBenchmark2=,
     CalBenchmark=,
     PeersBeaten=,
 }

还有人觉得直接用const string就好，个人以为Enum的强类型还是比string好，string的可能性比较多，直接用字符串比较也行，用其他同样string的变量比较也行，没有唯一性，而Enum只能是相同的Type进行比较。

类似的问题的还有hashcode，hashcode会不会变也是依赖于.net framework的算法，谁也不能保证以后算法不会变，所以hashcode也不要做为key存起来，否则后期要改会变得很困难，因为还需要兼容以前存的档案。

另外多语言下的数字也是值得注意的，欧洲那边很多国家的小数点是用逗号表示，分隔符用点号，和我们正好相反，如: 123.456,78  ，这种情况就需要以固定格式存下来，比如ToString时用CultureInfo.InvariantCulture，这样跟区域语言无关，解析时也一样是固定格式解析，double.Parse(value, CultureInfo.InvariantCulture)。显示在界面时就需要用当前的语言格式来显示，总不能给西班牙人看我们常用的小数格式，CultureInfo.CurrentCulture这是当前线程的语言格式，用这个就可以了。

总结起来，要持久化存起来并且需要解析还原的东西是不能变的，保存前是什么状态解析后也要还原这个状态，所以Enum一定要写上值或做转换再存，同样还有hashcode，情愿存长一些的字符串也不要存hashcode（自定义的算法无所谓哈），多语言应用下的小数也需要注意保存和显示的区别。

然后就是上面看到的，同样的项目中绝大部分Enum都做了防范，小部分因为代码规范问题，没能保持一致才出了问题，所以个人觉得这些问题属于基本代码规范问题，在项目设计时就决定好了，每个人不管是老同事还是新进来的同事都需要遵守规范，这样的项目代码更安全，可持续性也更好。

规范的目标是让项目的代码看起来像是一个人写的，团队好的coding风格也会积极影响所有成员。