读书人

怎么设计接口的参数以减少对接口的修改

发布时间: 2013-03-21 10:08:17 作者: rapoo

如何设计接口的参数以减少对接口的修改

或许说这个东西的时候,最好能依托一个背景。


在稍大型一点的项目中,总会有一个base层,我们认为它封装了最最底层和基础的一些列功能,因为底层的东西追求稳定和运行效率,所以90%是用C/C++写的,一般以头文件+DLL的方式给上层使用(不考虑它是基于COM的,如果是COM,VARIANT的参数类型就不在讨论范围内了)。头文件中定义了一些列导出函数或者导出类,这些导出函数或类的成员函数,都会有一些列参数,由于C/C++是强类型语言,所有强类型语言对类型转换都是极其严格的,不能像javascript里那样用var j = ... 的形式搞定一切。所以,底层接口中函数的参数如何设计是非常重要的。

假设有一个接口void A(int a),就只能接受一个int类型作为参数。

1、当需求变了,需要处理string类型时,就要修改A或者增加新的接口A1;

void A(int a);

void A(const string& str);

或void A1(const string& str);

2、当参数个数变了,需要接受两个int时,仍然需要修改;

void A(int a, int b);

如果两天后上层又提需求,说需要三个int参数...好吧,再改

void A(int a, int b, int c);

如果确实修改了这个接口A的参数类型或者参数个数或者增加新的接口A1,则必然导致至少两中问题:

1、所有引用这个头文件的cpp文件重编,而一个底层模块在整个项目中使用的普遍性是非常高的,那么最严重的情况就是,修改了一个头文件,造成整个项目重编;

2、所有调用过这个接口的上层代码都需要重新修改,更悲剧的是,还需要重新测试。


所以,如何才能涉及出具有很强适应力和扩展性的接口及参数类型,对于底层的接口是很重要的,也是必须的。


大概总结了一些,目测有这么几种方案,有些是坑爹的,有些在某些场合特定场合比较使用,有些比较通用。

1. void*

void*做参数在纯C语言写的代码里还是挺常见的,比如一个接口void A(void* p);

那如果你在A里对p进行某些类型转换,比如double *pd = (double*)p; 而传入的p原先是int* pn,那就惨了,多半*pd 不是原来的*pn,这就是用void*做参数的悲剧之处,它不携带原来的类型信息,对于使用者来说不知道应该怎么转,而且转了就有风险。这种void*参数现在几乎是绝对不允许使用的。

2.联合体类型

貌似设计模式里的开放封闭原则套到函数参数的设计上也是适用的吧,提高参数扩展性,尽量不修改。

读书人网 >编程

热点推荐