模块间接口设计的原则
模块接口是模块之间进行对接交互的门户,我们在设计时至少应该遵循以下四个原则:
一,简单原则。所谓简单,主要体现在模块接口的使用方法 上,模块的使用者在不借助或借助很少的文档的情况下,就可以轻松使用模块所提供的功能。这首先要求接口方法的命名要规范,每个对外提供的方法名都应该有意 义,让使用者可以通过名称猜测到方法的主要用途;其次要求接口中的相关参数的数据类型要尽可能的简单,尽量少使用嵌套层次多的数据结构,必要时可以构建全局应用的内存环境来保存模块间共同使用的数据,同时在这个内存环境之上提供不同数据的操作方法,从而减少模块间直接性的复杂数据的传递;其三,模块接口的方法尽可能单一,设计模式中的工厂模式是一种不错的选择。
二,封闭原则。封闭原则要求的的是,模块功能的实现细节要完全对外封闭,而且在对模块内部的处理逻辑进行修改时,不会影响模块使用者的调用逻辑。
三,完整性原则。做为功能模块,它所提供的功能应该是一个全面的整体,一些具有细微差别的功能应该被集中到一个模块中,这样我们可以方便利用继承、重载、覆写等技术手段来提高代码复用率,同时也可以提升模块使用的灵活度。
四,可置换原则。我们很难保证一个功能模块所提供的功能会永不过时,因此在接口设计时应该尽可能的应用接口编程思想,为接口提供标准的接口规范,这样将来可以轻松的用遵循接口规范的新的模块置换原有的模块,而不会影响其到他相关模块的调用方式。
一,简单原则。所谓简单,主要体现在模块接口的使用方法 上,模块的使用者在不借助或借助很少的文档的情况下,就可以轻松使用模块所提供的功能。这首先要求接口方法的命名要规范,每个对外提供的方法名都应该有意 义,让使用者可以通过名称猜测到方法的主要用途;其次要求接口中的相关参数的数据类型要尽可能的简单,尽量少使用嵌套层次多的数据结构,必要时可以构建全局应用的内存环境来保存模块间共同使用的数据,同时在这个内存环境之上提供不同数据的操作方法,从而减少模块间直接性的复杂数据的传递;其三,模块接口的方法尽可能单一,设计模式中的工厂模式是一种不错的选择。
二,封闭原则。封闭原则要求的的是,模块功能的实现细节要完全对外封闭,而且在对模块内部的处理逻辑进行修改时,不会影响模块使用者的调用逻辑。
三,完整性原则。做为功能模块,它所提供的功能应该是一个全面的整体,一些具有细微差别的功能应该被集中到一个模块中,这样我们可以方便利用继承、重载、覆写等技术手段来提高代码复用率,同时也可以提升模块使用的灵活度。
四,可置换原则。我们很难保证一个功能模块所提供的功能会永不过时,因此在接口设计时应该尽可能的应用接口编程思想,为接口提供标准的接口规范,这样将来可以轻松的用遵循接口规范的新的模块置换原有的模块,而不会影响其到他相关模块的调用方式。