Enum引发的血案,反思

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

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

 1 public enum PeergroupRanks
 2 {
 3     VSBenchmark,
 4     VSBenchmark2,
 5     CalBenchmark,
 6     PeersBeaten,
 7     NumPeergroupBeaten,
 8     PeergroupRank,
 9     NumPeergrouprank,
10     PeergroupPercentile,
11     PeergroupDecile,
12     PeergroupQuintile,
13     PeergroupQuartile,
14 
15     PeergroupRankOfCount,
16 }

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

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

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

 1 public enum DisplayBenchmark
 2 {
 3     None,
 4     Benchmark1,
 5     Benchmark2,
 6     CategoryAverage,
 7     CalcBenchmarkId,
 8     CalcBenchmarkType,
 9     CalcBenchmarkCdp,
10 }
11 
12 public static class DisplayBenchmarkCode
13 {
14     const string BENCHMARK1 = "bm1";
15     const string BENCHMARK2 = "bm2";
16     const string CATEGORY = "ca";
17 
18     public static DisplayBenchmark Parse(string code)
19     {
20         switch (code)
21         {
22             case BENCHMARK1:
23                 return DisplayBenchmark.Benchmark1;
24             case BENCHMARK2:
25                 return DisplayBenchmark.Benchmark2;
26             case CATEGORY:
27                 return DisplayBenchmark.CategoryAverage;
28         }
29         return DisplayBenchmark.Benchmark1;
30     }
31 
32     public static string Convert(this DisplayBenchmark type)
33     {
34         switch (type)
35         {
36             case DisplayBenchmark.Benchmark1:
37                 return BENCHMARK1;
38             case DisplayBenchmark.Benchmark2:
39                 return BENCHMARK2;
40             case DisplayBenchmark.CategoryAverage:
41                 return CATEGORY;
42         }
43         return BENCHMARK1;
44     }
45 }

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

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

1 public enum PeergroupRanks
2 {
3     VSBenchmark=0,
4     VSBenchmark2=1,
5     CalBenchmark=2,
6     PeersBeaten=3,
7 }

还有人觉得直接用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风格也会积极影响所有成员。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏逍遥剑客的游戏开发

溶解效果

1327
来自专栏移动开发面面观

JNI处理图片——黑白滤镜

1322
来自专栏简书专栏

Pyechart入门

pyecharts是一个用于生成echarts图表的类库。echarts是百度开源的一个数据可视化库,用echarts生成的图可视化效果非常棒。使用pyecha...

1503
来自专栏我的博客

领域专用语言(DSL)和通用编程语言(GPL)

DSL解释 领域专用语言(Domain Specific Language/DSL) DSL 通过在表达能力上做的妥协换取在某一领域内的高效(世界级软件开发...

35513
来自专栏小狼的世界

使用Python读取Mp3的标签信息

MP3是音频文件最流行的格式,它的全称是 MPEG layer III。但是这种格式不支持对于音频内容的描述信息,包括歌曲名称、演唱者、专辑等等。

1013
来自专栏CodingToDie

Python学习(十):有趣的字符串

第10 章 Python 字符串 学的到东西的事情是锻炼,学不到的是磨练 Table of Contents 字符串更新 转义字符 原始字符串 运算 连接 重复...

3497
来自专栏小灰灰

cocos2dx-v3.5 2048 (二): GameTool的设计与实现

前言 ---- 前一篇博文讲述了项目的架构,从中也可以看出GameTool 的主要功能是显示并随时更新分数和最高分数,其中主要用到的是Label ? ...

1765
来自专栏吴小龙同學

Android 从 Web 唤起 APP

前言 ? 知乎在手机浏览器打开,会有个 App 内打开的按钮,点击直接打开且跳转到该详情页,是不是有点神奇,是如何做到的呢? 效果预览 ? Uri Sche...

31511
来自专栏胡力的专栏

高斯模糊效果的几种实现方案及性能对比

现在越来越多的 app 在背景图中使用高斯模糊效果,如 yahoo 天气,效果做得很炫。 我们5.2个性资料卡的标签模版也需要使用高斯模糊,这里就用一个 dem...

1.3K0
来自专栏企鹅号快讯

前端开发工程师有必须重视的几个性能指标

前端开发工程师有有必要重视的几个功用方针 关于页面相应时间,有一条闻名的“2-5-8准则”。当用户访问一个页面: 在2秒内得到照应时,会感觉系统照应很快; 在2...

1677

扫码关注云+社区