简明现代魔法 -> 编程思想 -> 什么样的代码才称得上健壮

什么样的代码才称得上健壮

2011-07-15

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

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. 考虑代码的可读性,遵循代码规范。

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

随机文章推荐
网站分类


注:如需转载本文,请注明出处(原文链接),谢谢。更多精彩内容,请进入简明现代魔法首页。

进入新博客
喜欢本文,就分享它吧
给我留言
您的名字:
您的邮件:
您的网站:


 

copyright © 2009 简明现代魔法    学习、分享、进步

power by Gonn 感谢所有关心和支持本站的朋友们