最近,我遇到了代码可读性的问题。
我有一个函数,它执行一个操作,并返回一个表示该操作ID的字符串,以供将来参考(有点像Windows中的OpenFile,返回一个句柄)。用户稍后将使用此ID启动操作并监视其完成情况。
由于互操作性问题,ID必须是随机字符串。这创建了一个具有非常不明确签名的方法,如下所示:
public string CreateNewThing()这使得返回类型的意图不明确。我想用另一种类型来包装这个字符串,这样可以使它的含义更清晰:
public OperationIdentifier CreateNewThing()该类型将只包含该字符串,并在使用此字符串时使用。
很明显,这种操作方式的优点是类型更安全,意图更清晰,但它也创造了更多的代码和代码,而这些代码和代码并不是很地道的。一方面,我喜欢增加安全性,但它也造成了很多杂乱。
出于安全考虑,您认为在类中包装简单类型是一种好做法吗?
发布于 2015-05-03 17:15:39
我将使用该范围作为经验规则:生成和使用此类values的范围越窄,您创建表示该值的对象的可能性就越小。
假设您有以下伪码
id = generateProcessId();
doFancyOtherstuff();
job.do(id);然后,范围是非常有限的,我认为没有必要把它作为一种类型。但是,假设您在一个层中生成这个值并将其传递给另一个层(甚至另一个对象),那么为该层创建一个类型将是非常有意义的。
发布于 2015-05-03 23:31:46
静态类型系统都是为了防止数据的不正确使用。
这样做的类型有明显的例子:
有更微妙的例子
我们可能会尝试使用double作为价格和长度,或者使用string作为名称和URL。但是,这样做会颠覆我们令人敬畏的类型系统,并允许这些错误使用通过语言的静态检查。
把磅秒和牛顿秒混为一谈可能会产生运行时的不良结果.
这尤其是字符串的问题。它们经常成为“通用数据类型”。
我们主要是使用计算机的文本接口,我们通常将这些人工接口(UI)扩展到编程接口(API)。我们认为34.25就是34.25。我们认为日期是05-03-2015的角色。我们认为UUID是字符75e945ee-f1e9-11e4-b9b2-1697f925ec7b。
但是这个心理模型损害了API的抽象。
文字或语言,如文字或语言,似乎在我的思维机制中没有任何作用。阿尔伯特·爱因斯坦
类似地,文本表示不应该在设计类型和API中扮演任何角色。小心string!(以及其他过于通用的“基元”类型)
。
例如,我曾经在的客户端上工作。REST正确地使用超媒体实体,超媒体实体具有指向相关实体的超链接。在这个客户端中,不仅键入了实体(例如用户、帐户、订阅),而且还键入了指向这些实体的链接(UserLink、AccountLink、SubscriptionLink)。这些链接只不过是围绕Uri的包装器,但是不同的类型使得无法尝试使用AccountLink来获取用户。如果一切都是普通的,Uris --或者更糟糕的是,string --这些错误只能在运行时被发现。
同样,在您的情况下,您的数据只用于一个目的:标识Operation。它不应该被用于其他任何东西,我们也不应该试图用随机字符串来识别Operations。创建一个单独的类会增加代码的可读性和安全性。
当然,所有的好东西都可以过度使用。考虑一下
如果数据的“类型”(抽象意义上的)被频繁地使用,用于不同的目的,并且在代码接口之间使用,那么它是一个很好的独立类的候选对象,而代价是冗长的。
发布于 2015-05-03 16:41:41
出于安全考虑,您认为在类中包装简单类型是一种好做法吗?
在这种情况下,您需要权衡使用string而不是更具体的OperationIdentifier可能出现的问题。他们有多严重?他们有什么相貌?
然后,您需要考虑使用其他类型的成本。用起来有多痛苦?要做多少工作?
在某些情况下,您将节省自己的时间和精力,有一个好的混凝土类型的工作。在其他情况下,这是不值得的麻烦。
总的来说,我认为这类事情应该比今天做得更多。如果您有一个实体在您的领域中意味着什么,那么将其作为自己的类型是很好的,因为该实体更有可能随着业务的发展而改变/增长。
https://softwareengineering.stackexchange.com/questions/281827
复制相似问题