什么是模块化代码?如何写?
扫描二维码
随时随地手机看文章
ID:技术让梦想更伟大
作者:李肖遥
随着我们工程化经验的增加,不知不觉的我们就会关心到这个问题,模块化,模块设计就显现出来,那到底什么是模块化呢?
这不叫模块化
我相信在很多时候,我们刚开始从零开始接手一个项目的时候,编码之前总想着要实现什么的功能需要的模块,然后要程序模块化,这种思想是值得认同的,但往往我们并没有做到真正的模块化。
例如在一个需要很多外设接口,一般需要硬件初始化,相关配置,中断服务程序,输入输出,逻辑处理等功能,我们的做法可能就是把代码分布到多个文件和目录里面,然后把这些目录或者文件取名xxxModule。
甚至把这些目录分放在不同的仓库目录里面,结果随着编码的增加,发现好多小功能都重复了,或者本可以写在一起的函数并没有放在一起,导致我们的代码思想不是很流畅,这样做会误导我们,甚至整个项目实现的思路。
究其原因这是因为我们其实并不理解什么叫做模块,而仅仅是肤浅的把代码切割开来,分放在不同的位置,虽然这确实达到了部分模块化的目的,但是也会制造一些不必要的麻烦。
什么是真正的模块化?
真正的模块化,并不是简单文本意义上的,而是与逻辑相关的有逻辑意义的。一个模块应该像一个集成电路芯片,我们能见到能使用的都很清晰,它定义了良好的输入和输出。
模块是可能分开地被编写的单位。这使他们可再用和允许广泛人员同时协作、编写及研究不同的模块。
实际上,编程语言已经为我们提供了一种很好的模块化方法,它的名字叫做函数。每一个函数都有明确的输入(参数)和输出(返回值),同一个文件里可以包含多个函数,所以你其实根本不需要把代码分开在多个文件或者目录里面,同样可以完成代码的模块化。
按照函数这个原则,我可以把代码全都写在同一个文件里,却仍然是非常模块化的代码,是不是觉得与之前的想法不一样?
是的,软件编程模块是一套一致而互相有紧密关联的软件组织,每个模块完成一个特定的子功能,所有的模块按某种方法组装起来,成为一个整体,完成整个系统所要求的功能,这就是真正的模块化。
怎么模块化?
我们知道了模块化的原则与道理之后,就可以按照这个思路去开发项目了,想要达到很好的模块化,你需要做到以下几点。我们从实现角度来说。
避免写太长的函数
一眼望去,如果一个函数的代码你电脑一页都看不完,那肯定是冗长了或者不符合模块化编程了。不需要滚屏就可以看得到全部的函数内容,那对我们的理解也有帮助。
一般来说一个函数最好不要超过40行代码(当然这个不是死规定,只是一个经验建议而已),如果写的函数太大了,就应该把它拆分成几个更小的函数。
也许你会说到,这很难办到,逻辑很多或者很多判断条件的时候,40行往往不够吧,那么其实我们也需要考虑到函数里面一些复杂的部分,是不是可以提取出来,单独写一个小函数,再从原来的函数里面调用。
另外函数层级也不要太多,比如一个函数长成这样:
1void function(void* para) 2{ 3 if (getOS().equals("MacOS")) { 4 a(); 5 if(getOS().equals("AndroidOS")){ 6 b(); 7 if(getOS().equals("flymeOS")){ 8 c(); 9 } 10 } 11 } 12}
我们看到这个函数由于很多的判断,函数层级已经超过4层了,这其实对我们的理解很不利,另一方面,一些逻辑变化也会导致我们的更改很麻烦,费脑子。
每个函数只做一件简单的事情
有些人喜欢写一些通用函数,一般我都放在publicModule里面,既可以实现这个工又可以实现那个功能,它的内部依据某些变量或者是某些条件,来选择这个函数所要实现的小功能。
比如,写出这样的函数:
1void function() { 2 if (getOS().equals("MacOS")) { 3 a(); 4 } else { 5 b(); 6 } 7 8 c(); 9 10 if (getOS().equals("MacOS")) { 11 d(); 12 } else { 13 e(); 14 } 15}
这个函数,是想表达根据系统是否为MacOS,从而来做不同的事情。从这个函数可以很容易的看出,其实只有函数c()是两种系统共有的,而其它的函数a(), b(), d(), e()都属于不同的分支。
但是这种复用的写法其实是很不利的。如果一个函数可能实现2个功能,并且它们之间共同点少于它们的不同点,那我们最好就写两个不同的函数,否则这个函数的逻辑就不会很清晰,容易出现错误。
不要害怕,函数简单点不丢人,我们不需要炫技。
好了,根据上面的说法,这个函数可以改写成两个函数:
1void funMacOS() { 2 a(); 3 c(); 4 d(); 5}
和
1void funOther() { 2 b(); 3 c(); 4 e(); 5}
如果我们发现两件事情大部分内容相同,只有少数不同,也就是说共同点大于它们的不同点,那就更简单了,我们可以把相同的部分提取出去,做成一个辅助函数。
比如,如果有个函数是这样:
1void function() { 2 3 a(); 4 b() 5 c(); 6 7 if (getOS().equals("MacOS")) { 8 d(); 9 } else { 10 e(); 11 } 12}
其中函数a(),b(),c()都是一样的,只有函数d()、e()根据系统有所不同。那么你可以把函数a(),b(),c()提取出去,代码如下:
1void preFun() { 2 a(); 3 b() 4 c(); 5}
然后分别写两个函数:
1void funMacOS() { 2 preFun(); 3 d(); 4}
和
1void funOther() { 2 preFun(); 3 e(); 4}
这样更改之后,是不是清晰了很多,我们既共享了代码,避免冗余,又做到了每个函数只做一件简单的事情。这样的代码,逻辑就更加清晰了。
工具函数
是的,我再说一遍,每个函数只做一件简单的事情。但是有些时候在我们的工程代码中,我们可能会发现其实里面有很多的重复。
所以一些常用的代码,不管它有多短或者多么的简单,都可以提取出去做成函数,例如有些帮助函数也许就只有2行,但是我们把它封装成一个函数的话,就能大大简化主要函数里面的逻辑。
也许你可能会说,这些函数调用会增加代码开销,但随着硬件发展以及技术变革,这已经是一种过时的观念了。
现代的很多编译器都能自动的把小的函数内联(inline)到调用它的地方,所以根本不会产生函数调用,也就不会产生任何多余的开销。
那么我可以使用宏来代替工具函数?一行代码搞定了,比如
1#define FillAndSendTxOptions( TRANSSEQ, ADDR, ID, LEN, TxO ) { \ 2afStatus_t stat; \ 3ZDP_TxOptions = (TxO); \ 4stat = fillAndSend( (TRANSSEQ), (ADDR), (ID), (LEN) ); \ 5ZDP_TxOptions = AF_TX_OPTIONS_NONE; \ 6return stat; \ 7}
同样,这也许也过时了,我不想让宏(macro)来背这个锅,在早期的C语言编译器里,只有宏是静态内联的,所以使用宏是为了达到内联的目的。
然而能否内联,其实并不是宏与函数的根本区别,这里我不细说了,只要记住:应该尽量避免使用宏。如果想了解可以参考避免这7个误区,才能让【宏】削铁如泥
为了内联而使用宏,其实是滥用了宏,这会引起各种各样的麻烦,比如使程序难以理解,难以调试,容易出错等等。
尽量使用局部变量和参数
我们应该尽量避免使用全局变量和类成员(class member)来传递信息,举个例子:
1class A { 2 String x; 3 4 void findX() { 5 ... 6 x = ...; 7 } 8 9 void fun() { 10 findX(); 11 ... 12 print(x); 13 } 14}
首先,使用函数findX(),把一个值写入成员x。然后,调用x的值。这样,x就变成了findX和print之间的数据通道。
由于x属于class A,这样程序就失去了模块化的结构,与我们所说的模块化意义不符了。两个函数依赖于成员x,就不再有明确的输入和输出,而是依赖全局的数据。
函数findX和fun不再能够离开class A而存在,具有依赖性,并且由于类成员还有可能被其他代码改变,这样就会导致代码变得复杂难以理解,函数的正确性也难以保证。
如果使用局部变量和参数来传递信息,那么这两个函数就不需要依赖于某一个class,不易出错,代码如下:
1String findX() { 2 ... 3 x = ...; 4 return x; 5 } 6 void foo() { 7 String x = findX(); 8 print(x); 9 }
总结
模块化是指解决一个复杂问题时,自顶向下,逐层把系统划分成若干模块的过程,深入理解模块化,什么是真正的模块化,那么我们才能够事半功倍。
如果你喜欢我的文章表达的思维,转发分享是对我的厚爱,期待您的点赞在看,下一期,再见!
免责声明:本文内容由21ic获得授权后发布,版权归原作者所有,本平台仅提供信息存储服务。文章仅代表作者个人观点,不代表本平台立场,如有问题,请联系我们,谢谢!