首页
学习
活动
专区
工具
TVP
发布

怎样设计接口

怎样设计接口? 众所周知,接口是提供给其它模块或者系统使用的一种约定或者规范。因此接口必需要保 证足够的稳定性和易用性。这是设计接口的基本要求。...这是一种糟糕的接口设计。既不便于使用又不便于编译器优化(待确认)。...3.怎样设计接口? 採用OOD思想,即面向对象的思想,提供类接口或者COM接口。 对于C函数接口怎样设计呢?...事实上和C++接口设计原则一样,也採用面向对象的思想,仅仅是 将类设计成结构,公共的成员函数变为全局的函数,私有的成员函数变为static函数就可以。...函数接口的第一參数就相当于C++中的this指针就可以。 4.接口设计的其它要求 * 规范性:主要是接口设计的代码规范,这是最主要的要求。

85830
您找到你想要的搜索结果了吗?
是的
没有找到

面向接口设计与角色接口

标签 | 软件设计 字数 | 1876字 阅读 | 5分钟 问题:在做项目的时候,是不是所有包含非静态方法的类,都要写一个接口?是因为这样的目的是为了解耦,然后通过DI注入实现吗?...此外,如果你的接口永远都只有一个实现类,并没有任何可能的需求变化,那么还有必要解耦吗? 所以说,不能死板的将类的方法提取接口,然后美其名曰为面向接口设计。...我们不能误解“面向接口设计”原则,该原则所指的“接口”并非Java语言中的interface类型,而是指面向调用者对外暴露的接口,代表一种交互与协作,是对信息的隐藏和封装,而不是具体的interface...即使是普通的java方法仍然满足隐藏细节的原则,如果是public的,就可以认为该方法是“面向接口设计”中的接口,也就是说:不要针对实现细节编程,而是针对接口编程。...如果你先定义了一个类叫EmailService,然后因为你需要定义接口对其抽象,然后就简单地将这个类的所有公有方法都提取到抽象的接口中,这样设计接口,被Martin Fowler称为Header Interface

65510

SDK设计心得之接口设计

由于SDK的特殊性,所以对于SDK的开发来说,一开始对于SDK的一些通用的整体的元素的设计至关重要。因为SDK(尤其很多平台SDK,使用的应用成百上千)一个及其细微的调整都会影响很多开发者的版本周期。...因此前期的设计显得尤为重要。关于这部分内容,我会分两篇来介绍,这篇重点介绍具体接口设计。另一篇SDK设计心得之架构和资源将重点介绍SDK的架构和一些资源的使用方式。...关于接口设计 设计原则 接口名称、参数名称要足够清晰 一个牛逼的接口名称可以替代无数的注释 一个接口只做一件事 一个接口只做一件事。...我们有个功能有两个接口:一个是需要传参数,另一个不需要传参,两者的逻辑完全是独立的。本来是根据第一个原则设计了两个信、达也算雅的接口来实现。...其实这里游戏反映接入成本高,我们应该是去分析什么原因引起的接口成本身高,能不能优化。不能直观的认为一个功能要两个接口接口太多了接入成本就高,就要删接口

6.2K90

接口用例设计

背景说明 一个系统可为其他系统提供能力或者直接为UI层提供数据,在设计系统测试方案时应考虑上游调用的各种场景,不仅考虑顺利且正向思维操作的场景,还应逆向的场景。...换句话来说,使用契约式设计的方式,运行前条件必须满足,参数不正确不可运行;运行中内部状态必须不变;运行后结果必须保持一致。...在设计接口用例设计时,除实现功能外,应关注:幂等性、空校验、流程节点限制、异常校验。 ? 01 幂等性 何为幂等性? 幂等为一数学概念,指使用相同参数重复执行,能获取相同结果。...对非空参数依次传空,观察接口调用情况。 当然,首先需明白业务逻辑,从而进行用例设计。尤其对于参数复杂的接口,当某一条调用规则下 某些非空参数就需要作为必传了。...明确系统的状态流转,一个系统设计初期就需明确功能及状态流转,会依据产品对系统的定义及依赖的下游或三方产品的功能。 测试正常流程节点。按照正向流程依次调用,观察调用结果及生成状态。

1.6K31

API接口TOKEN设计

API(Application Programming Interface)即应用程序接口。你可以认为 API 是一个软件组件或是一个 Web 服务与外界进行的交互的接口。...; 针对以上特点,移动端与服务端的通信就需要两种不同的TOKEN,一种针对接口的api_token,一种针对用户的user_token; 一.api_token 它的职责是保持接口访问的隐蔽性和有效性...加密密钥'为私有的加密密钥,手机端需要在服务端注册一个“接口使用者”账号后,系统会分配一个账号及密码,数据表设计参考如下: 字段名及字段类型 client_id varchar(20) 客户端ID client_secret...= md5('用户的uid' + 'Unix时间戳') = etye0fgkgk4ca2ttdsl0ae9a5dd77471fgf 服务端用数据表维护user_token的状态,表设计如下: 字段名及字段类型如下...; 接口用例如下:添加测试接口 URL: http://www.api.com/demo/index/add-demo?

1.3K30

API接口TOKEN设计

API(Application Programming Interface)即应用程序接口。你可以认为 API 是一个软件组件或是一个 Web 服务与外界进行的交互的接口。...; 针对以上特点,移动端与服务端的通信就需要两种不同的TOKEN,一种针对接口的api_token,一种针对用户的user_token; 一.api_token 它的职责是保持接口访问的隐蔽性和有效性...加密密钥'为私有的加密密钥,手机端需要在服务端注册一个“接口使用者”账号后,系统会分配一个账号及密码,数据表设计参考如下: 字段名及字段类型 client_id varchar(20) 客户端ID client_secret...= md5('用户的uid' + 'Unix时间戳') = etye0fgkgk4ca2ttdsl0ae9a5dd77471fgf 服务端用数据表维护user_token的状态,表设计如下: 字段名及字段类型如下...; 接口用例如下:添加测试接口 URL: http://www.api.com/demo/index/add-demo?

5.1K140

如何设计api接口

随着前后端的分离,api 接口变得越来越重要,作为前后端通信的接口,api 变得非常重要,而且它的设计也是非常难以掌握。不仅要考虑安全性,还要考虑可维护性,以及今后的升级等等。...如何才能设计出更好的 api 接口,我认为以下几点需要注意。 接口一致性 这里说的一致性指的是编码规范要统一,不能各个接口使用不一样的编码风格。...接口健康性检查 我们应该设计一个监控系统或者一个接口来实时监控我们的服务,如果接口出现了问题,我们应该能够第一时间发现,同样,对于每个接口的访问请求我们都要有日志记录的存储。...尽量采用restful风格 虽然restful风格被一些人质疑,但是目前来看,它还是最好的接口设计风格,通过采用restful风格,可以让接口语义更加明确 ,规范,优雅省去了大部分 无意义的沟通,通过使用不同的...提供完整详细的api文档 无论我们的接口设计的多么规范,多么易懂,我们都需要提供一份完整的api文档,同时我们还需要提供一些请求范例,这样用户在使用的时候才会更加清楚,也能避免一些错误的请求。

80450

关于接口设计,还有 Fluent Interface,这种有趣的接口设计风格

这个故事是从下面这样一个对外暴露接口的调用开始的。...QueryUserEvent.SEX_MALE); …… List userList = userService.query(event); 我想做的事情其实很简单,我想查询一个用户列表,可是接口参数的拼装让我感到头疼...sex : User.SEX_MALE }, UserService.QUERY_TYPE_NORMAL); 不过,他接着说,在 Java 里面好像还没有类似简洁的表示方法…… 万幸的是,有一种接口连续调用的风格...greaterThan(new User().setAge(18)).setSex(User.SEX_MALE).query(UserService.QUERY_TYPE_NORMAL); 我想,这样的设计如果在数学计算的时候...对于 Fluent Interface 而言,它的接口调用既改变了对象的状态,又返回了对象(this 或其他),并不属于上面的两种类型。

28320

架构设计 - 日志管理接口设计

在后端代码中,日志无处不在,设计一套自己的日志管理代码,给框架提供一套好用的日志接口将大大方便代码的开发。...接口设计: 1.提供三类日志打印形式:1)控制台打印信息,类似printf的接口封装             2)函数追踪接口,打印当前代码的文件名,函数名及行,以及一些设定的输出参数             ...提供打印级别控制,且打印内容输出到日志文件中 2.提供日志级别控制:1)在打印日志时提供当前日志级别,代码依据级别进行控制打印           2)日志打印级别控制暂时使用配置文件,后续可以通过通信接口进行实时修改

60240

架构设计 - 日志管理接口设计

在后端代码中,日志无处不在,设计一套自己的日志管理代码,给框架提供一套好用的日志接口将大大方便代码的开发。...接口设计: 1.提供三类日志打印形式:1)控制台打印信息,类似printf的接口封装             2)函数追踪接口,打印当前代码的文件名,函数名及行,以及一些设定的输出参数             ...提供打印级别控制,且打印内容输出到日志文件中 2.提供日志级别控制:1)在打印日志时提供当前日志级别,代码依据级别进行控制打印           2)日志打印级别控制暂时使用配置文件,后续可以通过通信接口进行实时修改

60780

如何设计高并发接口

在请求预处理阶段,由于我们的系统入队需求要远大于出队需求,一般不会出现队空的情况,所以我们可以选择ConcurrentLinkedQueue来作为我们的请求队列实现 请求接口的合理设计 一个秒杀或者抢购页面...,通常分为2个部分,一个是静态的HTML等内容,另一个就是参与秒杀的Web后台请求接口。...通常静态HTML等内容,是通过CDN的部署,一般压力不大,核心瓶颈实际上在后台请求接口上。...这个后端接口,必须能够支持高并发请求,同时,非常重要的一点,必须尽可能“快”,在最短的时间里返回用户的请求结果。为了实现尽可能快这一点,接口的后端存储使用内存级别的操作会更好一点。...或者设计一个极大的内存队列,也是一种方案,但是,系统处理完一个队列内请求的速度根本无法和疯狂涌入队列中的数目相比。

1.2K30

微服务接口设计原则

有时一个服务会有很多接口,每个接口所要实现的功能可能会有关联,那么这就非常考验设计服务接口的功底,让服务变得简单可靠。 业界已经有很多比较成熟的实践原则,可以帮助我们设计实现出一个可靠易维护的服务。...服务接口设计原则并没有严格的规范,下面介绍个人认为最为重要的几个原则。 1.单一职责 每个API接口应该只专注一件事。...这句话怎么理解呢,也就是说,我们在设计一个接口的时候,应当使这个接口可以在不被修改的前提下被扩展,换句话说就是,应当可以在不修改源代码的情况下改变这个接口的行为。...这个原则同样适用于软件的设计和构建。API设计是这个规则应该被遵循的一个清晰的例子。书写一个明确的、简单的API是接口可靠的保证。我们向API消费者提供的方法和参数越少,这些API就越容易理解。...---- 参考文献 [1] CSDN.服务API设计 之 API设计原则 [2] 知乎.怎么理解软件设计中的开闭原则? [3] 微服务的4个设计原则和19个解决方案

3.4K20

接口测试用例设计

接口测试用例设计 目录 1、通用信息校验 2、接口参数校验 3、其他补充项 1、通用信息校验 1、URL校验 填写正确的URL - 可以正确访问接口地址 错误的URL - 访问不到,返回404...2、请求方法校验 正确的请求方法 - 发送post请求可以成功发送接口数据 错误的请求方法 - 如发送get请求,无法成功发送接口数据,会被服务端拒绝 3、请求头 正确传递请求头 - 键:Content-Type...值:application/json 错误传递请求头 - 键:Content-Type 值:application/x-www-from-urlencoded 4、接口鉴权 token或session...- 传递正确的认证信息、传递错误的认证信息、不传认证信息、认证信息失效 2、接口参数校验 1、参数的必填项校验 传递所有必填项参数,并且值合法 参数项不传 - 如不传out_trade_no 参数值为空...,网络中断-是否扣款 3、服务架构 分布式系统-能否正确同步数据 - nginx配置模拟 4、接口风格 检查是否符合restful风格 5、敏感信息加密 比如登录接口用户信息应该被密文传输

62920

这才叫 API 接口设计

大家好,我是鱼皮,前段时间在 星球 里看到了一位小伙伴分享的文章《API 接口设计最佳实践》,我也读了一遍,写的确实好,给大家分享一下,相信对后端开发的小伙伴会很有帮助。...API 接口设计 作者:InfoQ Man Token 设计 Token 是服务端生成的一串字符串,以作客户端进行请求的一个令牌,当第一次登录后,服务器生成一个 Token 便将此 Token 返回给客户端...API 接口设计原则 1、明确协议规范 在设计初期需要明确双方的通讯协议是 TCP、HTTP、RPC,一般针对比较敏感的交易或者行业(如金融业),建议使用 HTTPS 协议以确保数据交互的安全。...token 机制、分布式锁、状态机等方案;这里引用一下之前看到的一篇文章,写得比较详细:https://blog.csdn.net/u011635492/article/details/81058153 8、接口设计的一些最佳实践...同时前端也需做好这类情况的容错处理; 针对单页面的多接口请求,为避免扩大攻击面,建议把多接口逻辑整合到一个接口,一个页面直接调用该接口,以避免绕过部分接口进行攻击; 接口最好支持分页;分页一般有电梯式分页

2.3K30
领券