怎样的代码才是健壮的?

我们必须谨记的三个原则
服务器君一共花费了224.826 ms进行了5次数据库查询,努力地为您提供了这个页面。
试试阅读模式?希望听取您的建议

不管是在面向过程时代,还是在面向对象时代,任何一个功能都是由若干函数协作来实现的。一个函数由输入、处理和输出组成。实现这个函数的代码段都假定了输入的参数已经满足了若干规则,在执行这个函数时,函数的代码会拿到输入的参数然后执行代理逻辑。下面我们就来看一个函数的代码。

private static void ParseArgs(string[] arguments) 
{ 
	if (_parsedArgs) 
	{ 
		return; 
	} 
	if (arguments == null) 
	{ 
		arguments = CommandLineArgs; 
	} 
	//命令行格式: 
	const string usage = "[-initial 5] [-level 2]"; 
	for (int i = 0; i < arguments.Length; i++) 
	{ 
		//匹配前导符 
		if (arguments[i].CompareTo(InitialStartLevelLead) == 0) 
		{ 
			//step forward 
			if (++i < arguments.Length) 
			{ 
				//取值 
            	_initialBundleStartLevel = Convert.ToInt32(arguments[i]); 
             	continue; 
    		} 
         	else 
            { 
          		goto fail; 
			}      
		} 
		if (arguments[i].CompareTo(StartLevelLead) == 0) 
		{ 
			//step forward 
			if (++i < arguments.Length) 
			{ 
				//取值 
				_startLevel = Convert.ToInt32(arguments[i]); 
				continue; 
			} 
			else 
			{ 
				goto fail; 
			}
		} 
	} 
	_parsedArgs = true; 
	return; 
	fail: 
		throw new Exception("Invalid args,usage:"+ usage); 
}

这个函数大致的用意是使得一个程序启动时,允许用户在启动程序时可以带上类似“-initial 5 -level 2”这样的参数来改变程序的行为。估计我们经常会写出类似以上的程序,有时候可能是因为经验不足,有时候可能是偷懒。你可以找出这段小程序有哪些问题吗?

下面我使用注释的方式把函数中每一个小细节问题标记一下。

private static void ParseArgs(string[] arguments) 
{ 
    if (_parsedArgs)  //1 这个参数的命名不符合规则,正确的命名应该是_isArgsParsed,如果想让参数可读性更强,可以再将参数的限定词声明一下,变成_is××ArgsParsed。 
    { 
        return; 
    } 
    if (arguments == null) 
    { 
        arguments = GetCommandLineArgs(); 
    } 
    //命令行格式: 
    const string usage = "[-initial 5] [-level 2]"; //2 硬编码的字符串。
    for (int i = 0; i < arguments.Length; i++)  //3 如果GetCommandLineArgs的返回值为空,则这行代码会出现NullReferenceException;此外,如果arguments.Length大于4个,我们需要给用户提示;如果参数出现重复或者不符合要求,我们也需要给用户提示。 
    { 
        //匹配前导符 
        if (arguments[i].CompareTo(InitialStartLevelLead) == 0) //4 如果arguments[i]允许带空格,则这行代码会产生错误的执行结果 
        { 
            //step forward 
            if (++i < arguments.Length) 
            { 
                //取值 
                _initialBundleStartLevel = Convert.ToInt32(arguments[i]);  //5 如果arguments[i]不是合法的整数,则这行代码会产生转换失败的异常。 
                continue; 
            } 
            else 
            { 
                goto fail; 
            } 
                
        } 
        if (arguments[i].CompareTo(StartLevelLead) == 0) //6 问题同3 
        { 
            //step forward 
            if (++i < arguments.Length) 
            { 
                //取值 
                _startLevel = Convert.ToInt32(arguments[i]);  //7 问题同4 
                continue; 
            } 
            else 
            { 
                goto fail; 
            }
        } 
     } 
    _parsedArgs = true; 
    return; 
fail: 
    throw new Exception("Invalid args,usage:"+ usage); //8 异常信息不友好,没有清楚告诉用户是哪一个参数输入有问题,此外在英文文法中,“args”和“usage”中间要空格,另外,给用户的信息不能够随便使用缩写,必须使用完整的词语;硬编码字符串需要放在一个统一的资源文件,并考虑I18N和L10N支持;问题2中的字符串可以直接和这个Exception的字符串直接合并;如果有必要的话,最好重新定义个Exception类型。
}

一个健壮的函数,需要考虑的问题不仅仅只是正确的功能。上面的这段代码仅仅是考虑了用户输入是正确的情况。当用户输入错误时,以上代码要么出现没有任何友好提示的异常,要么仅给出一个不友好的错误信息。使一个函数达到健壮,在编码时,我们必须谨记:

  1. 不能假定函数的输入参数是正确,必须检查函数的输入参数是否符合规则;
  2. 当函数的输入不符合规则时,必须告诉用户错在哪,并告诉用户如何输入正确的参数;
  3. 考虑代码的可读性,遵循代码规范。

另外,测试时需要确定输入参数的边界,将处于边界内和边界外的参数都测试,以保证函数的参数不正确时函数能给出一个友好的提示。

本文地址:http://www.nowamagic.net/librarys/veda/detail/1685,欢迎访问原出处。

不打个分吗?

转载随意,但请带上本文地址:

http://www.nowamagic.net/librarys/veda/detail/1685

如果你认为这篇文章值得更多人阅读,欢迎使用下面的分享功能。
小提示:您可以按快捷键 Ctrl + D,或点此 加入收藏

大家都在看

阅读一百本计算机著作吧,少年

很多人觉得自己技术进步很慢,学习效率低,我觉得一个重要原因是看的书少了。多少是多呢?起码得看3、4、5、6米吧。给个具体的数量,那就100本书吧。很多人知识结构不好而且不系统,因为在特定领域有一个足够量的知识量+足够良好的知识结构,系统化以后就足以应对大量未曾遇到过的问题。

奉劝自学者:构建特定领域的知识结构体系的路径中再也没有比学习该专业的专业课程更好的了。如果我的知识结构体系足以囊括面试官的大部分甚至吞并他的知识结构体系的话,读到他言语中的一个词我们就已经知道他要表达什么,我们可以让他坐“上位”毕竟他是面试官,但是在知识结构体系以及心理上我们就居高临下。

所以,阅读一百本计算机著作吧,少年!

《代码之美》 聂雪军 (译者)

《代码之美》介绍了人类在一个奋斗领域中的创造性和灵活性:计算机系统的开发领域。在每章中的漂亮代码都是来自独特解决方案的发现,而这种发现是来源于作者超越既定边界的远见卓识,并且识别出被多数人忽视的需求以及找出令人叹为观止的问题解决方案。《代码之美》33章,有38位作者,每位作者贡献一章。每位作者都将自己心目中对于“美丽的代码”的认识浓缩在一章当中,张力十足。38位大牛,每个人对代码之美都有自己独特的认识,现在一览无余的放在一起,对于热爱程序的每个人都不啻一场盛宴。 虽然《代码之美》的涉猎范围很广,但也只能代表一小部分在这个软件开发这个最令人兴奋领域所发生的事情。

更多计算机宝库...