这个问题可能与语言无关,但我将重点关注指定的语言。
在处理一些遗留代码时,我经常看到函数示例,(显然在我看来)在其中做了太多工作。我不是在谈论 5000 个 LoC 怪物,而是在谈论在其中实现先决条件检查的函数。
这是一个小例子:
void WorriedFunction(...) {
// Of course, this is a bit exaggerated, but I guess this helps
// to understand the idea.
if (argument1 != null) return;
if (argument2 + argument3 < 0) return;
if (stateManager.currentlyDrawing()) return;
// Actual function implementation starts here.
// do_what_the_function_is_used_for
}
现在,当调用这种函数时,调用者不必担心要满足的所有先决条件,只需说:
// Call the function.
WorriedFunction(...);
现在 - 应该如何处理以下问题?
一般来说 - 这个函数是否应该只执行它所要求的并将“先决条件检查”移至调用方:
if (argument1 != null && argument2 + argument3 < 0 && ...) {
// Now all the checks inside can be removed.
NotWorriedFunction();
}
或者 - 它应该简单地针对每个先决条件不匹配抛出异常吗?
if (argument1 != null) throw NullArgumentException;
我不确定这个问题是否可以普遍化,但我仍然想在这里了解您对此的想法 - 可能有一些我可以重新考虑的事情。
如果您有其他解决方案,请随时告诉我它们:)
谢谢。
最佳答案
每个函数/方法/代码块都应该有一个 precondition ,这是它设计工作的确切环境,以及一个后置条件,函数返回时的世界状态。这些可以帮助您的程序员同事了解您的意图。
根据定义,如果前置条件为假,则代码预计不会运行,如果后置条件为假,则认为代码有问题。
无论您是在脑海中、在纸上的设计文档中、在注释中,还是在实际的代码检查中写下这些,都取决于您的品味。
但是,如果您将前置条件和后置条件编码为显式检查,那么从长远来看,实际问题会更容易。如果您对此类检查进行编码,因为该代码预计无法正常工作 如果前置条件错误,或者后置条件错误,则前置条件和后置条件检查应使程序以易于发现故障点的方式报告错误。正如您的示例所示,代码不应该做的只是“返回”什么也没做,因为这意味着它已以某种方式正确执行。 (代码当然可以定义什么都不做就退出,但如果是这种情况,前置条件和后置条件应该反射(reflect)这一点。)
您显然可以使用 if 语句编写此类检查(您的示例危险地接近):
if (!precondition) die("Precondition failure in WorriedFunction"); // die never comes back
但通常通过为称为断言的语言定义特殊函数/宏/语句来指示代码中前置条件或后置条件的存在,以及这种特殊构造当断言为假时,通常会导致程序中止和回溯。
代码应该是这样写的:
void WorriedFunction(...)
{ assert(argument1 != null); // fail/abort if false [I think your example had the test backwards]
assert(argument2 + argument3 >= 0);
assert(!stateManager.currentlyDrawing());
/* body of function goes here */
}
复杂的功能可能愿意告诉调用者某些条件已失败。这就是异常的真正目的。如果存在异常,从技术上讲,后置条件应该说明“函数可能在条件 xyz 下异常退出”。
关于c# - 一般函数题(C++/Java/C#),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5318868/
我的瘦服务器配置了nginx,我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例,但找不到好的解决方案。有没有人能做到这一点? 最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器,例如server{listen80;server
我想在一个没有Sass引擎的类中使用Sass颜色函数。我已经在项目中使用了sassgem,所以我认为搭载会像以下一样简单:classRectangleincludeSass::Script::FunctionsdefcolorSass::Script::Color.new([0x82,0x39,0x06])enddefrender#hamlengineexecutedwithcontextofself#sothatwithintemlateicouldcall#%stop{offset:'0%',stop:{color:lighten(color)}}endend更新:参见上面的#re
我真的很习惯使用Ruby编写以下代码:my_hash={}my_hash['test']=1Java中对应的数据结构是什么? 最佳答案 HashMapmap=newHashMap();map.put("test",1);我假设? 关于java-等价于Java中的RubyHash,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/22737685/
我正在尝试用ruby中的gsub函数替换字符串中的某些单词,但有时效果很好,在某些情况下会出现此错误?这种格式有什么问题吗NoMethodError(undefinedmethod`gsub!'fornil:NilClass):模型.rbclassTest"replacethisID1",WAY=>"replacethisID2andID3",DELTA=>"replacethisID4"}end另一个模型.rbclassCheck 最佳答案 啊,我找到了!gsub!是一个非常奇怪的方法。首先,它替换了字符串,所以它实际上修改了
我有一些代码在几个不同的位置之一运行:作为具有调试输出的命令行工具,作为不接受任何输出的更大程序的一部分,以及在Rails环境中。有时我需要根据代码的位置对代码进行细微的更改,我意识到以下样式似乎可行:print"Testingnestedfunctionsdefined\n"CLI=trueifCLIdeftest_printprint"CommandLineVersion\n"endelsedeftest_printprint"ReleaseVersion\n"endendtest_print()这导致:TestingnestedfunctionsdefinedCommandLin
如何在ruby中调用C#dll? 最佳答案 我能想到几种可能性:为您的DLL编写(或找人编写)一个COM包装器,如果它还没有,则使用Ruby的WIN32OLE库来调用它;看看RubyCLR,其中一位作者是JohnLam,他继续在Microsoft从事IronRuby方面的工作。(估计不会再维护了,可能不支持.Net2.0以上的版本);正如其他地方已经提到的,看看使用IronRuby,如果这是您的技术选择。有一个主题是here.请注意,最后一篇文章实际上来自JohnLam(看起来像是2009年3月),他似乎很自在地断言RubyCL
我正在尝试在Ruby中复制Convert.ToBase64String()行为。这是我的C#代码:varsha1=newSHA1CryptoServiceProvider();varpasswordBytes=Encoding.UTF8.GetBytes("password");varpasswordHash=sha1.ComputeHash(passwordBytes);returnConvert.ToBase64String(passwordHash);//returns"W6ph5Mm5Pz8GgiULbPgzG37mj9g="当我在Ruby中尝试同样的事情时,我得到了相同sha
我正在尝试使用boilerpipe来自JRuby。我看过guide从JRuby调用Java,并成功地将它与另一个Java包一起使用,但无法弄清楚为什么同样的东西不能用于boilerpipe。我正在尝试基本上从JRuby中执行与此Java等效的操作:URLurl=newURL("http://www.example.com/some-location/index.html");Stringtext=ArticleExtractor.INSTANCE.getText(url);在JRuby中试过这个:require'java'url=java.net.URL.new("http://www
我只想对我一直在思考的这个问题有其他意见,例如我有classuser_controller和classuserclassUserattr_accessor:name,:usernameendclassUserController//dosomethingaboutanythingaboutusersend问题是我的User类中是否应该有逻辑user=User.newuser.do_something(user1)oritshouldbeuser_controller=UserController.newuser_controller.do_something(user1,user2)我
什么是ruby的rack或python的Java的wsgi?还有一个路由库。 最佳答案 来自Python标准PEP333:Bycontrast,althoughJavahasjustasmanywebapplicationframeworksavailable,Java's"servlet"APImakesitpossibleforapplicationswrittenwithanyJavawebapplicationframeworktoruninanywebserverthatsupportstheservletAPI.ht