编写优雅程序的一点小小心得

初的程序

现在,为了突出我们的主题,这里给出一个简化版本的只有 17 行的 CUI 程序 ConsoleColorCuiTester.cs:

01:  using System;
02:  using System.Drawing;
03:  
04:  namespace Skyiv.Tester
05:  {
06:    static class ConsoleColorCuiTester
07:    {
08:      static void Main()
09:      {
10:        foreach (var consoleColor in Enum.GetValues(typeof(ConsoleColor)))
11:        {
12:          var color = Color.FromName(consoleColor.ToString());
13:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
14:        }
15:      }
16:    }
17:  }

这个程序的运行结果如下所示:

Black       Black       FF000000
DarkBlue    DarkBlue    FF00008B
DarkGreen   DarkGreen   FF006400
DarkCyan    DarkCyan    FF008B8B
DarkRed     DarkRed     FF8B0000
DarkMagenta DarkMagenta FF8B008B
DarkYellow  DarkYellow  00000000
Gray        Gray        FF808080
DarkGray    DarkGray    FFA9A9A9
Blue        Blue        FF0000FF
Green       Green       FF008000
Cyan        Cyan        FF00FFFF
Red         Red         FFFF0000
Magenta     Magenta     FFFF00FF
Yellow      Yellow      FFFFFF00
White       White       FFFFFFFF

后来发现 ConsoleColor.DarkYellow 不对劲,怎么 ARGB 值全为零呢?经过分析,不能简单地通过枚举元素的名称把 ConsoleColor 和 KnownColor 枚举对应起来。那么,我们需要一个转换函数。

增加转换函数后的程序

现在,新的 ConsoleColorCuiTester2.cs 如下所示:

01:  using System;
02:  using System.Drawing;
03:  
04:  namespace Skyiv.Tester
05:  {
06:    static class ConsoleColorCuiTester
07:    {
08:      static void Main()
09:      {
10:        foreach (var consoleColor in Enum.GetValues(typeof(ConsoleColor)))
11:        {
12:          var color = Color.FromName(GetKnownColorName(consoleColor.ToString()));
13:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
14:        }
15:      }
16:  
17:      static string GetKnownColorName(string name)
18:      {
19:        if (name == "DarkBlue") return "Navy";
20:        if (name == "DarkGreen") return "Green";
21:        if (name == "DarkCyan") return "Teal";
22:        if (name == "DarkRed") return "Maroon";
23:        if (name == "DarkMagenta") return "Purple";
24:        if (name == "DarkYellow") return "Olive";
25:        if (name == "Green") return "Lime";
26:        return name;
27:      }
28:    }
29:  }

在上述程序中,第 17 行到第 27 行的 GetKnownColorName 就是我们的转换函数,在第 12 行调用这个函数。这个程序的运行结果如下所示:

Black       Black       FF000000
DarkBlue    Navy        FF000080
DarkGreen   Green       FF008000
DarkCyan    Teal        FF008080
DarkRed     Maroon      FF800000
DarkMagenta Purple      FF800080
DarkYellow  Olive       FF808000
Gray        Gray        FF808080
DarkGray    DarkGray    FFA9A9A9
Blue        Blue        FF0000FF
Green       Lime        FF00FF00
Cyan        Cyan        FF00FFFF
Red         Red         FFFF0000
Magenta     Magenta     FFFF00FF
Yellow      Yellow      FFFFFF00
White       White       FFFFFFFF

看起来一切正常,不是吗?

上述程序的缺点

现在让我们来看看下面的 ConsoleColorCuiTester3.cs:

01:  using System;
02:  using System.Drawing;
03:  
04:  namespace Skyiv.Tester
05:  {
06:    static class ConsoleColorCuiTester
07:    {
08:      static void Main()
09:      {
10:        foreach (var consoleColor in Enum.GetValues(typeof(ConsoleColor)))
11:        {
12:          var color = Color.FromName(GetKnownColorName(consoleColor.ToString()));
13:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
14:        }
15:      }
16:  
17:      static string GetKnownColorName(string name)
18:      {
19:        if (name == "DarkBlue") return "Navy";
20:        if (name == "DarkGrean") return "Green";
21:        if (name == "DarkCyan") return "Teal";
22:        if (name == "DarkRed") return "Maron";
23:        if (name == "DarkMagenta") return "Purple";
24:        if (name == "DarkYellow") return "Olive";
25:        if (name == "Green") return "Lime";
26:        return name;
27:      }
28:    }
29:  }

上述程序第 20 行中将 "DarkGreen" 误拼为 "DarkGrean",第 22 行中将 "Maroon" 误拼为 "Maron"。但是因为这些内容是字符串的值,所以这个程序照样可以通过编译。这个程序的运行时也不抛出异常,运行结果如下所示:

Black       Black       FF000000
DarkBlue    Navy        FF000080
DarkGreen   DarkGreen   FF006400
DarkCyan    Teal        FF008080
DarkRed     Maron       00000000
DarkMagenta Purple      FF800080
DarkYellow  Olive       FF808000
Gray        Gray        FF808080
DarkGray    DarkGray    FFA9A9A9
Blue        Blue        FF0000FF
Green       Lime        FF00FF00
Cyan        Cyan        FF00FFFF
Red         Red         FFFF0000
Magenta     Magenta     FFFF00FF
Yellow      Yellow      FFFFFF00
White       White       FFFFFFFF

这是因为第 20 行的拼写错误,就没有把 ConsoleColor.DarkGreen 正确地转换为 KnownColor.Green,而是错误地转换为 KnownColor.DarkGreen 了。由于第 22 行的拼写错误,Color.FromName 方法发现参数"Maron" 不是预定义颜色的有效名称,它也不抛出异常,而是创建一个 ARGB 值为零的 Color 结构。

正确的做法

下面就是 ConsoleColorCuiTester4.cs:

01:  using System;
02:  using System.Drawing;
03:  
04:  namespace Skyiv.Tester
05:  {
06:    static class ConsoleColorCuiTester
07:    {
08:      static void Main()
09:      {
10:        foreach (ConsoleColor consoleColor in Enum.GetValues(typeof(ConsoleColor)))
11:        {
12:          var color = GetKnownColor(consoleColor);
13:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
14:        }
15:      }
16:  
17:      static Color GetKnownColor(ConsoleColor color)
18:      {
19:        if (color == ConsoleColor.DarkBlue) return Color.Navy;
20:        if (color == ConsoleColor.DarkGreen) return Color.Green;
21:        if (color == ConsoleColor.DarkCyan) return Color.Teal;
22:        if (color == ConsoleColor.DarkRed) return Color.Maroon;
23:        if (color == ConsoleColor.DarkMagenta) return Color.Purple;
24:        if (color == ConsoleColor.DarkYellow) return Color.Olive;
25:        if (color == ConsoleColor.Green) return Color.Lime;
26:        return Color.FromName(color.ToString());
27:      }
28:    }
29:  }

上述程序中,第 17 行到第 27 行的转换函数 GetKnownColor 不再从字符串转换到字符串,而是从 ConsoleColor 枚举直接转换为 Color 结构。第 12 行的调用也简单了一些。这个程序的运行结果和 ConsoleColorCuiTester2.cs 的运行结果完全一样。

出现编译错误

我们来看看下面的 ConsoleColorCuiTester5.cs:

01:  using System;
02:  using System.Drawing;
03:  
04:  namespace Skyiv.Tester
05:  {
06:    static class ConsoleColorCuiTester
07:    {
08:      static void Main()
09:      {
10:        foreach (ConsoleColor consoleColor in Enum.GetValues(typeof(ConsoleColor)))
11:        {
12:          var color = GetKnownColor(consoleColor);
13:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
14:        }
15:      }
16:  
17:      static Color GetKnownColor(ConsoleColor color)
18:      {
19:        if (color == ConsoleColor.DarkBlue) return Color.Navy;
20:        if (color == ConsoleColor.DarkGrean) return Color.Green;
21:        if (color == ConsoleColor.DarkCyan) return Color.Teal;
22:        if (color == ConsoleColor.DarkRed) return Color.Maron;
23:        if (color == ConsoleColor.DarkMagenta) return Color.Purple;
24:        if (color == ConsoleColor.DarkYellow) return Color.Olive;
25:        if (color == ConsoleColor.Green) return Color.Lime;
26:        return Color.FromName(color.ToString());
27:      }
28:    }
29:  }

上述程序同 ConsoleColorCuiTester3.cs 一样,在第 20 行和第 22 行各出现了一个拼写错误。但是这次 C# 编译器就会报错了:

E:\CS\ConsoleColorCuiTester> csc ConsoleColorCuiTester.cs
Microsoft(R) Visual C# 2010 编译器 4.0.30319.1 版
版权所有(C) Microsoft Corporation。保留所有权利。

ConsoleColorCuiTester.cs(20,33): error CS0117: “System.ConsoleColor”并不包含“DarkGrean”的定义
ConsoleColorCuiTester.cs(22,55): error CS0117: “System.Drawing.Color”并不包含“Maron”的定义
E:\CS\ConsoleColorCuiTester>

这样,我们就可以及早发现错误,不会程序有了 BUG 还茫然无知。

利用 IDE 的智能感知

其实,我们经常在集成开发环境中编写程序,现代的 IDE 都有智能感知功能,如下所示:

ConsoleColorCui02

ConsoleColorCui01

ConsoleColorCui03

这样一来,我们在编写程序时就避免了拼写错误。当然,如果象 ConsoleColorCuiTester2.cs 那样转换字符串,IDE 就无法帮助你避免拼写错误了。

过度设计

我们来看看下面的 ConsoleColorCuiTester6.cs:

01:  using System;
02:  using System.Drawing;
03:  using System.Collections.Generic;
04:  
05:  namespace Skyiv.Tester
06:  {
07:    static class ConsoleColorCuiTester
08:    {
09:      static Dictionary<ConsoleColor, Color> dict = new Dictionary<ConsoleColor, Color>();
10:  
11:      static ConsoleColorCuiTester()
12:      {
13:        dict.Add(ConsoleColor.DarkBlue, Color.Navy);
14:        dict.Add(ConsoleColor.DarkGreen, Color.Green);
15:        dict.Add(ConsoleColor.DarkCyan, Color.Teal);
16:        dict.Add(ConsoleColor.DarkRed, Color.Maroon);
17:        dict.Add(ConsoleColor.DarkMagenta, Color.Purple);
18:        dict.Add(ConsoleColor.DarkYellow, Color.Olive);
19:        dict.Add(ConsoleColor.Green, Color.Lime);
20:      }
21:  
22:      static void Main()
23:      {
24:        foreach (ConsoleColor consoleColor in Enum.GetValues(typeof(ConsoleColor)))
25:        {
26:          var color = GetKnownColor(consoleColor);
27:          Console.WriteLine("{0,-11} {1,-11} {2:X8}", consoleColor, color.Name, color.ToArgb());
28:        }
29:      }
30:  
31:      static Color GetKnownColor(ConsoleColor color)
32:      {
33:        Color color2;
34:        if (dict.TryGetValue(color, out color2)) return color2;
35:        return Color.FromName(color.ToString());
36:      }
37:    }
38:  }

上述程序的运行结果和 ConsoleColorCuiTester4.cs 的运行结果完全一样。它的意图是要避免以前程序中的一大堆 if 语句,而改用数据来驱动程序的流程。通过在 ConsoleColorCuiTester 类第 11 行到第 20 行的静态构造函数中初始化一个对照表,然后第 31 行到第 36 行的 GetKnownColor 方法通过查表就可以完成转换任务。

虽然使用查表的方法,在数据量比较大的时候会比使用一大堆 if 语句要快些。但是我认为不适用我们这个小小的程序中,这是过度设计了。首先我们程序的 GetKnownColor 方法才七个 if 语句,不算太多。其次,这个 GetKnownColor 方法总共也只被主程序在 foreach 循环中调用十六次,被调用的次数也不算太多。所以没有必要搞得这么复杂。

Python网络爬虫与推荐算法新闻推荐平台:网络爬虫:通过Python实现新浪新闻的爬取,可爬取新闻页面上的标题、文本、图片、视频链接(保留排版) 推荐算法:权重衰减+标签推荐+区域推荐+热点推荐.zip项目工程资源经过严格测试可直接运行成功且功能正常的情况才上传,可轻松复刻,拿到资料包后可轻松复现出一样的项目,本人系统开发经验充足(全领域),有任何使用问题欢迎随时与我联系,我会及时为您解惑,提供帮助。 【资源内容】:包含完整源码+工程文件+说明(如有)等。答辩评审平均分达到96分,放心下载使用!可轻松复现,设计报告也可借鉴此项目,该资源内项目代码都经过测试运行成功,功能ok的情况下才上传的。 【提供帮助】:有任何使用问题欢迎随时与我联系,我会及时解答解惑,提供帮助 【附带帮助】:若还需要相关开发工具、学习资料等,我会提供帮助,提供资料,鼓励学习进步 【项目价值】:可用在相关项目设计中,皆可应用在项目、毕业设计、课程设计、期末/期中/大作业、工程实训、大创等学科竞赛比赛、初期项目立项、学习/练手等方面,可借鉴此优质项目实现复刻,设计报告也可借鉴此项目,也可基于此项目来扩展开发出更多功能 下载后请首先打开README文件(如有),项目工程可直接复现复刻,如果基础还行,也可在此程序基础上进行修改,以实现其它功能。供开源学习/技术交流/学习参考,勿用于商业用途。质量优质,放心下载使用。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值