面向对象编程的方式
我感触最深的一点就是,每个人的代码组织形式都不一样。在不同的语言之间,唯一公认的实践就是要有一个公共的接口用来测试。公共接口指的是针对内部细节进行大量抽象的接口。它可以是类的公有方法、也可以是Facade或Factory设计模式,也可以是模块中的函数。这三者都会使用许多内部函数,但只会公开一个调用的函数。有时这种做法可以确保在添加功能和修复bug后,消费者在更新到最新代码时无需更改代码。当然,副作用仍然会对此产生负面影响。
单一类模块
可以说,至少在Node中,面向对象的方式通常包含两个基本设计模式。第一种方法是创建一个类,然后作为默认导出公开:
导出多个东西
第二种方法是从同一模块中公开许多东西,包括类、函数、事件变量等:
而在这两种导出代码的基本方法之外,情况就会因各个项目以及各个团队而异了。有些项目或团队会使用不同的框架,例如使用Express与使用Nest的团队的代码截然不同。即使使用同一个Express框架,两个团队的使用方式也有所不同。有时,同一个团队在新项目中组织Express的方式也不一定与以往的项目相同。
函数式编程的方式
函数式编程组织代码的方式,至少在Node中,也有两种模式。
导出一个函数
第二种方式是从一个模块中导出一个函数:
导出多个函数
第二种方式是从一个模块中导出多个函数:
有些人们会把变量与函数用同样的方式导出,而有些更喜欢纯函数的人或者倡导延迟计算的人会导出函数:
示例
我们针对上述代码创建几个示例,向你演示如何使用单个和多个导出。我们将为面向对象和函数式编程构建一个公共的接口,并暂且忽略两者的副作用(即HTTP调用),假设单元测试将使用这个公共接口来调用内部的私有方法。两者都将加载并解析同一个文本。
这两个示例都将解析以下JSON字符串:
示例:面向对象编程
我们需要三个类:一个类通过默认编码读取文件,一个类负责解析文件的类,一个单例类将它们组合到一个公共接口。
readfile.js
首先,这段读文件的代码实现了将文件读取到Promise中,支持可选的编码参数:
parser.js
接下来,我们需要一个解析器类,从读取文件中获取原始的String数据,并解析到Array中:
index.js
最后,我们需要一个单例将它们组合成一个静态的方法:
调用PeopleParser的静态方法
调用方式如下:
最后的文件夹结构如下:
最后,你可以使用文件系统对PeopleParser进行单元测试。
示例:函数式编程
对于函数式编程的示例,你可以参考这篇文章(http://jessewarden.com/2019/01/four-ways-to-compose-synchronous-functions-in-javascript.html)。我们只需要一系列函数:
默认编码的函数
读取文件的函数
解析文件的函数
从People对象中过滤Human的函数
从列表的Human中格式化字符串名称的函数
从列表中修正名称大小写以及映射的函数
提供公共接口的函数
调用getPeople
调用该函数的方式如下所示:
最后文件夹结构如下:
最后,你可以使用fs的桩测试getPeople。
总结
如上所示,无论是面向对象编程还是函数式编程,你都可以使用CommonJS和ES6的方式实现默认导出,也可以实现多重导出。只要你导出的是隐藏实现细节的公共接口,那么就可以确保在更新时不会破坏使用代码的人,而且还可以确保在更改私有类方法/函数中的实现细节时,无需重构一堆单元测试。
尽管本文中的函数式编程的示例比面向对象的代码少,但是请不要误解,函数式编程中也可以包含很多函数,而且你可以使用相同的方式——从一个模块/文件或一系列函数中导出一个函数。通常,你可以将文件夹中的index.js作为实际导出的公共接口。
中城投丝路核心团队为打造互联网、数字城市优质平台汇聚全球行业精英,孵化创建了福建鹏枫智能科技(关注数字城市细分行业应用,如:交通、水利环保等)、181科技(物联网传感平台),为促进数字文化交流还成立了鑫智会联盟中心(在数字六年经验以上的行业先驱组成的智库)。我们为每一位合作伙伴、更为加入团队的每位人才精英提供更为广阔的施展舞台、职业能力锻炼机遇。
查看更多