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

作者&投稿:栾泉 (若有异议请与网页底部的电邮联系)
页面中的接口数据如何支持方便的修改,比如 我需要修改某个接口中的参数的解释内容~

这个参数是设置另加通讯模块的参数的!如485,232等,与你PLC的编程口没关系的! 你跟电脑通讯,用的是本体的422接口!这个接口的参数是无法修改的!你改的D8120的系统模块的通讯参数!这个参数改了以后,如果跟原有通讯器件不匹配,当然无法通讯了!

对于接口测试,首先测试人员要懂代码,你只需要知道接口的作用是什么就可以了(有文档更好,但大部分都没有);其次,自己去读开发的代码;然后,根据该接口功能及代码写测试用例;
用例设计:
1:写一个程序去调用该接口,看是否能够达到该接口所定义的功能
2:根据该接口参数,构造不同的用例,测试接口在参数合法及非法情况下能否达到预期效果
3:根据该接口中的逻辑,设计不同条件的用例,测试该接口实现代码的逻辑
4:进行容错及健壮性测试
5:静态检测代码,看是否有内存泄露、或永远走不到的分支、代码规范及逻辑是否合理。
6:对于一些接口,需要进行多线程测试

在稍大型一点的项目中,总会有一个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.联合体类型

[html] view plain copy
struct param
{
int id;
union BaseArg
{
struct CommonEventArg
{
RECT rcItem;
}CommonEventArgs;
struct RightMenuArg
{
BOOL bShowDesk;
BOOL bWndMoved;
int nIconSize;
}RightMenuArgs;
struct ItemDragArg
{
RECT rcBegin;
RECT rcEnd;
}ItemDragArgs;
struct ItemSelectArg
{
BOOL isSelected;
}ItemSelectArgs;
struct BoxItemUpdateArg
{
RECT rcBegin;
}BoxItemUpdateArgs;
struct BoxRenameArg
{
wchar_t *pszName;
}BoxRenameArgs;
struct FileChangeArg
{
LPITEMIDLIST pItem;
LPITEMIDLIST pAdditionItem;
}FileChangeArgs;
struct RightMenuResponseArg
{
int nX;
int nY;
}MenuResponse;
struct StringArg
{
const wchar_t *pszName;
}StringArgs;
}Data;
};
比如这样一个结构体参数param,它包了一个联合体,这样做的思路也很清晰,接口这么定义:void A(const param& p);当需要变时,就去改param里面的结构就好,外头不用动。里面增加了联合体的包装,其实是把这种思路优化了一把,因为如果param使用场合很多,用到N多种结构体,那么一个param对象就占用很多内存,而我们知道联合体并不会给它的每一个成员分配内存,而是用它内存需要最多的那个成员的内存长度作为整个联合体的内存长度,这样,就着实省了一把内存。

这样的涉及,比较常见的应用场合貌似是消息的响应,似乎MFC里的消息响应就是这么涉及的,Mouse消息、LBtn消息等等各自有不同的子struct包在联合体内。
3.json做参数
json做为一种小巧轻便易解析,最重要的强大的可修改性和可扩展性(这点有上面第二点struct+union的意思,但更强大)的玩意,不做参数实在是有点可惜,貌似我知道的的比较早的使用在网络传输,以及客户端和web方通信上比较多,其实网络传输也可以看成是一次函数调用嘛,那json就可以理解成这个函数调用的参数了。
4.模版
模版生来就是为了泛化的,经典的 int Add(int a, int b)经过模版化后就可以处理所有数值类型的加法操作了,但问题是什么呢?问题就是模版函数或模板类不适合作为模块接口,如果是在模块内用模版那是完美的设计,但如果在模块接口一级用模版,那就悲催了。因为上面说了,模块一般是以头文件+DLL的方式提供,而模版的一个特点就是不支持分离编译(这个不清楚的自行google),就是说,模版的实例化是要在编译时才决定的,你把模版函数的声明和实现分别放在头文件和cpp中,那是不行滴,必须都放在头文件中,那这样也就不叫模块话了,直接全给头文件就行了,boost大部分是这么搞的。
5.boost::any
这个东西是boost提供的又一牛逼东西,实现了类似于var j = ...的傻瓜式参数类型,相当于把本身强类型的C/C++中的参数封装成javascript中的弱类型。

[html] view plain copy
void my_func(boost::any a)
{
if(a.type() == typeid(int))
{
//int类型
}
else if(a.type() == typeid(string))
{
//string类型
}
//...
}
my_func(10);
my_func("123");
class custom
{
int b;
double d;
};
custom cus;
my_func(cus);
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">
</span>
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">或</span>
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">
</span>
[html] view plain copy
typedef std::list<boost::any> list_any;
list_any.push_back(10);
list_any.push_back("123");
class custom
{
int b;
double c;
char *p;
};
custom cus;
list_any.push_back(cus);
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">
</span>
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">一个python中的列表就诞生了。</span>
[html] view plain copy
<span style="font-family: Arial, Helvetica, sans-serif;">貌似设计模式里的开放封闭原则套到函数参数的设计上也是适用的吧,提高参数扩展性,尽量不修改。</span>


在线接口设计-如何正确合理的设计一个接口项目
1.接口调用者先申请分配一个clientid,clientsecret,并提供给接口提供者(服务器)一个可访问的callbackURL(用于接口access_token)。 2.接口调用者使用clientid,clientsecret作为参数,向接口提供者发送请求。 接口提供者访问callbackURL发送access_token(有时间限制,超时后重新获取)。 3.接口调用者使用access_token作为参...

请求接口 大部分参数都一致 怎么设计
对于接口测试,首先测试人员要懂代码,你只需要知道接口的作用是什么就可以了(有文档更好,但大部分都没有);其次,自己去读开发的代码;然后,根据该接口功能及代码写测试用例;用例设计:1:写一个程序去调用该接口,看是否能够达到该接口所定义的功能 2:根据该接口参数,构造不同的用例,测试接口...

接口用例设计
用例设计重点:通常情况下主要测试最外层的两类接口:数据进入系统接口(调用外部系统的参数为本系统使用)和数据流出系统接口(验证系          统处理后的数据是否正常);输入参数主要从以下几各方面设计:a 必填项校验 接口文档中有是否必填的说明。参考接口文档即可。...

(转)对外接口设计规范
private String enforceFlag;4、接口参数涉及取值范围选择的(比如交易码,渠道类型,身份标识),需提供对应的常量给客户端使用,谨慎使用枚举做入参 唯一性控制属性:a)如接口请求参数包含业务唯一性控制字段,需要对相关字段以及唯一性控制方式进行特别说明 b)若在唯一性控制基础之上,涉及相关业务幂等控...

[转]如何设计接口测试用例
2)接口测试测试数据分为接口参数数据和用例执行所需系统数据 。数据的设计学问大,不要在设计、准备测试用例的数据上偷懒。要通过好的测试数据使用例查错的功能充分发挥。接口参数数据需对每个参数根据测试接口的实际的功能进行分析,在符合业务逻辑的情况下进行逻辑组合排列,不要遗漏了某些边界值和错误点...

接口设计评审规范
而应该设计为获取用户的会员等级接口,\/user\/level\/get,这样保证接口的通用性和扩展性 分页相关接口参数命名统一:pageSize:每页记录条数 pageNum:当前页数 totalPageNum:总共页数 统一以分为单位进行传递 建议统一以时间毫秒数进行传递,避免前后端或者各种场景下日期格式不统一 ...

日立HCP-4060X接口参数
日立HCP-4060X的接口设计提供了多样化的连接选项,以满足不同的视频和音频需求。在输入端子部分,它配置有1个15针微型D-sub端子,用于模拟RGB信号的输入。此外,还有5个BNC端子,分别对应G\/Y、B\/Cb\/Pb、R\/Cr\/Pr、H和V通道,支持RGB2的连接。HDMI端子也是一大亮点,方便高清信号的传输。对于分量视频...

松下PT-UX260接口参数
松下PT-UX260的接口设计提供了丰富的连接选项,以满足不同设备的连接需求。在输入端,设备配备了1个D-sub HD 15-pin接口,这是一种常见的高清视频输入端口,适用于高清设备的连接。此外,它还包含1个RGB\/YPBPR\/YCBCR\/S-视频接口,支持多种颜色空间的视频输入,以及2个RCA pin,适合音频信号的接入。...

java中使用接口作为方法的参数,这说明什么?能传什么参数进去?谢谢!
接口的作用有两个:约定功能和隐藏实现 一个方法声明以接口作为参数,那么这个方法只能接受这个接口的实现类。这样做的好处是提高代码复用性,简化逻辑编写,降低耦合度。编写该方法是,只需关注接口提供的功能,而不用关系接口如何实现。这种设计模式对于大规模的软件项目的设计、编写、管理、维护是有利的。

爱普生EB-C1900接口参数
爱普生EB-C1900的接口设计包含多种类型,以满足用户多样化的连接需求。首先,它配备了一个D-sub 15-pin接口,用于输入,这是视频信号的标准接口,支持复合视频,可通过RCA(黄)插头连接,确保了与多种设备的兼容性。此外,设备还提供了一个Mini DIN接口,用于S-视频输入,这适用于需要更高清晰度的用户...

陆良县19438109003: 举例说明硬件接口的防差错设计 -
荆忠利肝: 普通电源的D型插头,SATA硬盘的L型插头.都是无法插反的.

陆良县19438109003: 如何设计接口 -
荆忠利肝: 每一个大的系统都是有许多模块系统组成的,系统的开发是一个很大的工程,开发起来得难度也是比较大.因此任何一个有一定规模系统,通常会把系统做一定分解降低分析设计开发的难度,模块划分是一个比较常见的方式,而模块与模块之间...

陆良县19438109003: 接口设计需要注意什么? -
荆忠利肝: 1 降低无关性和减少依赖 2 文档清晰,要求明确 3 搭建测试环境,并明确各自测试标准 4 对边界及有效性判断做出详细和力所能及的描述 5 对后续有验证的使用也必需考虑验证是否也包括本接口的一部分,如果是,对使用也做出明确依赖性标示

陆良县19438109003: 如何正确合理的设计一个接口项目 -
荆忠利肝: 了解原型,其实更多是为了帮助你设计接口时需要提供的数据和结构.但有时当你设计时并没有原型,所以此条并不是必须要求的.但假如设计完接口后原型出来了,我们也可以拿原型还验证接口设计是否正确、合理.

陆良县19438109003: 设计接口电路主要要解决什么问题? -
荆忠利肝: 设计接口电路主要要解决如下问题:一是电平兼性容问题;二是信号隔离问题;三是抗浪涌电流的问题;四是信号传输协议的问题;五是信号传输速率问题;六是抗干扰的问题;七是物理尺寸规范化的问题.供参考!

陆良县19438109003: 如何更好的设计RESTful API -
荆忠利肝: 1.接口命名规则 http://ip:端口/v1/接口名 IP:服务器IP地址 端口:Restful端口号 V1:版本号(1) 接口名:命名规则:现有接口方法去第一个单词后,全小写命名,如:城市信息查询, 原接口名:queryCityId (String id) Restful接口:http://ip:端...

陆良县19438109003: 接口测试流程是怎样的? -
荆忠利肝: 我们在做接口测试的时候需要根据流程进行,否则就达不到预期的效果,那下面我们就从测试前、测试中、测试后讲下接口测试的流程 ①测试前 1.接口测试计划制定 2.接口测试用例和数据的准备 3.接口测试环境准备 4.编写接口测试脚本 5.测试前准备操作 6.测试脚本调试 7.接口测试内容制定 ②测试中 1.接口测试的执行策略(包括执行轮次和顺序) 2.接口测试执行过程监控到失败后的重试 3.线上只读接口的测试 ③测试后 1.测试后产生垃圾数据的清除 2.测试失败原因分析 3.接口测试bug的提交和回归验证 4.线上监控到紧急bug的验证 5.接口测试后复盘总结 我朋友当初在黑马程序员学习时候就直接整理文档给了我一份,这些也都有.

陆良县19438109003: 如何保证接口测试的覆盖率 -
荆忠利肝: 对于接口测试来说,项目测试用例的重复运行首先是表现在单个测试用例的独立性方面的,也就是说,每一个测试用例的运行除了依赖被测对象和对应的数据库环境外,是不依赖于其他任何测试用例的,并且这个测试用例执行完毕后,对系统来...

陆良县19438109003: 如何避免职能部门之间的接口出现问题 -
荆忠利肝: 书面规定将职责明确化、作业标准化将有助于避免职能部门之间的接口出现问题 (1)组织架构设计科学,有助于关键活动的职责与流程的清晰界定. (2)职责分工明确合理,明确规定各部门之间的职责和权限.根据“减少部门接口,指挥脉络畅通,事事有人做”的原则,划定各职能部门的工作职责. (3)理顺各部门之间的工作流程,使流程顺畅,执行力度高. (4)建立清晰的部门之间的接口或减少部门之间的接口. (5)加强沟通、协调、每个部门都设立接口界面的联系人. (6)业务流程上下游部门间的工作接口进行清楚界定. (7)由管理层定期主持评审,判定各部门之间是否存在接口问题并加以解决.

陆良县19438109003: 怎样设计计算机接口电路 -
荆忠利肝: 电脑的接口一般在主板上面.主板是安装在主机中最大的一块印刷电路板,是一台电脑的核心部分,它是中央处理器、内存、各种控制芯片、输入输出控制和各种扩展槽卡的基本依托.主板性能直接影响主板上其它部件性能的发挥,不同的中央...

本站内容来自于网友发表,不代表本站立场,仅表示其个人看法,不对其真实性、正确性、有效性作任何的担保
相关事宜请发邮件给我们
© 星空见康网