对外接口设计（外部接口设计）

本篇文章给大家谈谈对外接口设计，以及外部接口设计对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享对外接口设计的知识，其中也会对外部接口设计进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、（转）对外接口设计规范
• 2、接口设计怎么写？
• 3、如何设计模块接口 模块接口设计技巧
• 4、java里的对外接口
• 5、工程零件对外接口技术资料要求
• 6、接口设计是什么

（转）对外接口设计规范

1、接口禁止方法重载，重载会在做服务SLA控制，日志监控等方面带来不便

2、接口注释必须清晰地表达如何使用，接口是同步还是异步，服务内容，参数校验规则（精度、长度、取值范围等），返回值信息，异常情况；使用场景有要求的需要重点这几个方面描述

a)不同使用场景，在注释中区分描述

b)特定使用场景下的业务规则描述

c)特定使用场景下的注意事项描述

格式上参照注释规范{*}

3、接口返回值中属性禁止使用枚举，如果返回值属性是枚举类型，会为后期升级埋下隐患(由于枚举序列化的特性导致

删除枚举值和增加枚举值都可能导致客户端反序列化失败)，建议提供String类型，取值范围可以通过枚举来告诉客户端

禁止声明方式

建议声明方式

/** 强制还款标志，取值范围见{@link EnforceFlagEnum}*/

private String enforceFlag;

4、接口参数涉及取值范围选择的（比如交易码，渠道类型，身份标识），需提供对应的常量给客户端使用，谨慎使用枚举做入参

唯一性控制属性：a)如接口请求参数包含业务唯一性控制字段，需要对相关字段以及唯一性控制方式进行特别说明

b)若在唯一性控制基础之上，涉及相关业务幂等控制处理，需要进行相关详细描述

5、接口方法确保不对外抛出异常，异常情况需要通过错误码通知客户端，处理失败也需要有返回值，返回值实现可参考EcBaseResult及其子类实现

POM依赖

9、接口返回值中的方法尽量只提供基本属性的get set方法，不要提供有业务规则含义的方法（因为业务逻辑的变化会要求客户端升级jar包版本)

10、操作类的接口务必考虑幂等性控制，因为网络重发，客户端异常等都可能会引起重复调用，严重的可能会引起资损

根据业务约定的部分唯一性字段，对多次请求的数据判断是否重复提交的判断依据，比如通过外部订单号outOrderNo做唯一性控制，在唯一性控制的基础上，对请求中的其他字段进行判断，

如果全部业务数据（或关键业务数据）和已经落库的数据一致，则请求一次和请求多次都不会对业务处理产生影响，返回结果不变，

如果outOrderNo关联的其他信息与系统已经持久化的数据不一致则提示XXX参数与原先的数据不一致。

11、接口命名统一以Facade结尾，个别的SPI接口可以使用别的结尾词以便更好地表达SPI的要求，SOFA框架系统对外接口统一存放在xxx-common-service-facade

这个bundle下

12、接口必须提供有效的监控日志，配置监控报警规则监控日志输出见日志规范

13、敏感信息：接口返回对象属性字段包含敏感信息，需要做好标识，进行相关提示避免客户端打印到日志中去

金额：接口返回对象属性涉及到金额，需要描述金额的单位以及对应的币种 统一使用支付宝金额类com.iwallet.biz.common.util.money.Money

Money所在jar坐标

接口设计怎么写？

接口设计包括三个方面：一、用户接口用来说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。二、外部接口用来说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。三、内部接口用来说明本系统之内的各个系统元素之间的接口的安排

如何设计模块接口 模块接口设计技巧

每一个大的系统都是有许多模块系统组成的，系统的开发是一个很大的工程，开发起来得难度也是比较大。因此任何一个有一定规模系统，通常会把系统做一定分解降低分析设计开发的难度，模块划分是一个比较常见的方式，而模块与模块之间则是通过接口设计将它们整合在一起的。 实践中，极有可能出现两种状况：接口维护失控或者过严而死板（而影响开发）。接口失控是因为接口的维护太过随意，因为A模块的需要就轻易在B模块中添加一个接口（方法），导致该接口（方法）非独立性（基本上只给模块A的这个功能点使用），或者是接口的控制过严，导致或者工作效率不高，或者接口的易用性不好。 原因在于：接口是两个模块间的耦合，而发生的种种问题在于模块耦合太过紧密；同时实践中，把模块对外提供的接口，与模块需要实现的外部模块的接口混为一谈。 根据指导原则：为了降低耦合只有在中间加一层。一种可行的实践是：不轻易为模块设计对外提供的接口（方法），除非是通过重构得来的；模块对外提供两种类：一个是需要外部模块实现的接口（接口设计从本模块需要出发，当然每个接口尽管是为某个功能点服务，但也要注意其在模块内通用性），另一个是其它模块要求本模块实现的接口的实现类。 即：A模块拥有一些需要B模块实现的接口（A模块对B模块的要求），而B模块中也有要求A模块实现的接口，因而A有这些接口的实现类。 这种实践方式的好处在于：模块的接口就多了一层隔离降低了耦合，把接口的通用性和接口的适应性分离，又明确了模块的边界，使得接口在日后的优化和调整有了缓冲。接口设计的关键是能够将系统的每一个模块能够很好的整合在一起，而且能够让系统能够更好的运行。模块接口设计也是实现系统功能实现整体化的手段，而且是有益于系统拆分、整合等手段所必备的。

java里的对外接口

这个要结合面向对象设计思想去思考。
首先实例化的类作为一个角色，你可以把他理解为一个人。那么这个人肯定有与其他人（其他对象）交互的方法。那么这个方法也就别叫做接口。其实这算一种翻译上的过度强调。至少我理解的类的接口和方法是一回事。而interface定义的接口也算一种等待实现的方法。interface独特之处在于，任何实现了这个接口的类所产生的实例。都可以看作是这个interface的一个实例

所以说在设计接口和写对外方法（public）时一定要注意。这个方法（行为)是不是应该这个类（人）他应该具有的。否则就要考虑增加角色

工程零件对外接口技术资料要求

工程零件对外接口技术资料要求（转）对外接口设计规范-简书
1、接口禁止方法重载，重载会在做服务SLA控制，日志监控等方面带来不便 2、接口注释必须清晰地表达如何使用，接口是同步还是异步，服务内容，参数校验规则（精度、长度、取值范围等），返回值...
简书2019-08-13
接口(6)关于接口的技术资料_规范图纸下载_工程学习网
工程学习网 资料 技术 文库 教程 百科 图纸 您的位置:工程学习网-有关 ...GA560-2005 互联网上网服务营业场所 信息安全管理系统营业场所端与营业场所 经营管理系统接口技术要求[GA公共安全]...
工程学习网
铁路轨道延长线工程信号系统招标文件接口技术要求资料
共46页评分:2分
国内公开招标文件XXXX信号系统工程项目城市轨道交通信号系统项目国内公开招标文件第二册技术册（第三分册：接口技术要求）项目名称：xxxx铁路（轨道延长线）尖顶xxxxx工程信号系统项目招标编号...
道客巴巴2020-07-15
其他人还搜了
工程制图零件图符号大全
工程制图绘制齿轮零件图
工程制图零件名称
零件图的要求
零件工程图技术要求
图纸技术要求
国标-接口技术要求
101页 · ￥10 · 热度3
。《国标-接口技术要求》由会员笛音分享可在线阅读更多相关《国标-接口技术要求》请在金锄头文库上搜索。点击阅读更多内容functionshowmore2(){$(".readmore2").hide();$(".detail-article").css({"height":"auto","overflow":"hidden"});}$(document).ready(function(){vardh=$(".detail-article").height();if(dh200){$(".detail-article").css({"height":"200px","overflow":"hidden"});}else{$(".readmore2").hide();}});vardt='1、金锄头文库是“C2C”交易模式即卖家上传的文档直接由买家下载本站只是中间服务平台本站所有文档下载所得的收益全部归上传人卖家所有作为网络服务商若您的权利被侵害请及时联系右侧客服<br/'+'2、如你看到网页展示的文档有jinchutou.co
夸克文档2018-05-29
工程制图-零件图上的技术要求.doc 全文免费
共16页
申明敬告：本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己完全接受本...
原创力文档2019-12-14
各类零件的技术要求_文档之家
各类零件的技术要求的内容摘要：培训资料产品图设计中的技术要求编写方法及内容一、丁腈橡胶汽油管：（材料：NBR+PVC）（用于汽油箱和汽油供油回路的油管和密封橡胶垫圈）技术要求：1、无裂纹、...
文档之家
机械工程制图教程7-4零件图的技术要求_装配图网
号 的 注 法 配 合 尺 寸 应 尽量 标 注 在 两 零件 的 配 合 面 上标注配合代号 标注极限偏差数值 标 注 标 准 件 与 零 件（轴 或 孔）的 配合 代 号 时，可 以 仅 标 注 出 相 配 零 件的 公...
装配图网2021-04-25
工程制图与识图7-4：零件的技术要求.ppt
工程制图与识图7-4：零件的技术要求.ppt,2)公差值用线性数值表示，如公差带是圆形或圆柱形的，则在 公差值前加注“φ”(见图7-40a、b、c)；如是球形，则加注“Sφ”(见图7-40d)；根据需要，可用...
原创力文档2019-08-03
工程制图ppt资料 装配图的尺寸标注和技术要求
共4页评分:1分
零件之间的配合尺寸及影响其性能的重要相对位零件之间的配合尺寸及影响其性能的重要相对位置尺寸。例如：球阀的阀体与阀盖的配合尺寸50H113安装尺寸4外形尺寸将部件安装到机座上所需要的尺寸...
道客巴巴2015-01-21
工程接口管理措施_百度文库
总工程师负责技术方面的对外接口。工机具及其文件资料（合格证，产地证书，零件目录，维修说明书及工 具清单等。以及随机备品备件一起交付工机具仓库。到货后的检查验收及入库登记 工机具到达仓库后由工程管理科组织有关部门对...
百度文库
相关搜索
工程制图零件图入门
零件工程图
工程资料整理
一套完整的工程资料
工程图技术要求
零件图的技术要求
对外承包工程有哪些条件
工程资料软件
工程制图支承杆零件图
检测技术在对外承包工程中的应用
11-20条
工程图学：零件图上的技术要求
共42页评分:4.8分
1 工程图学零件图 相关文档约135万篇 2 零件图的技术要求 相关文档约119万篇 3 零件图的基本技术要求 相关文档约242万篇 4 零件图技术要求 相关文档约181万篇 搜索文档 新客立减9元 ...
百度文库2019-06-29
工程图常见技术要求_百度文库
一般技术要求 1。零件去除氧化皮。2。零件加工表面上，不应有划痕、擦伤等损伤零件表面的缺陷.3.去除毛刺飞边。热处理要求 1。经调质处理，HRC50~55.2.零件进行高频淬火，350~370℃回火，HRC40~...
百度文库
机械工程制图答案 N6零件的技术要求
共15页评分:3分
机械工程制图答案 N6零件的技术要求 1/15 六、零件的技术要求 总目录 退出 6.1 极限与配合 ∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙ ∙∙∙∙∙∙∙∙∙∙ ∙∙ ∙∙...
百度文库2013-10-30
零件技术要求与分析
共33页评分:3.2分
零件技术要求与分析   1.1 零件的作用 最终传动壳体，是一种支承和包容各种传动机构的箱体零件。一般由外墙、内支承墙、 轴承座、凸台、法兰及肋等构件组成。最终传动壳体具有密封、防尘、隔热...
百度文库2019-12-20
CAD制图中零件图的技术要求大全_百度文库
读零件图的目的是为了弄清零件图所 表达零件的结构样子、尺寸和技术要求，以便指导生产和解决有关的技 术问题，这就要求工程技术人员必需具有娴熟阅读零件图的能力。一、读零件图的基本要求 1....
百度文库
其他人还搜了
积极主动上线参与活动发言叫什么名称
不同意学校封闭管理证明怎么写
工程图常见技术要求(工程部)
共3页评分:3.7分
一般技术要求 零件去除氧化皮。零件加工表面上，不应有划痕、擦伤等损伤零件表面的缺陷。去除毛刺飞边。热处理要求 经调质处理，～。零件进行高频淬火，～℃回火，～。渗碳深度。进行高温时效...
百度文库2019-05-23
零件图的技术要求_百度文库
工程制图 零件图的技术要求 一、表面结构要求 1.表面结构的概念 表面结构是指出自几何体表面的重复或偶 然的偏差所形成的该表面的三维形貌。一般 是表面粗糙度、表面波纹度、表面缺陷、表 面...
百度文库
各类工程图技术要求_百度文库
各类工程图技术要求 一、一般技术要求 制件去除表面氧化皮；制件不得有划痕、擦伤等损伤零件表面的缺陷；去除毛刺飞边;锐角倒钝；未注倒角均为 0.5×45％d；未注越程槽均为 1。2×0.3;表面平整...
百度文库
有史最全-工程图技术要求(适用于工厂出图)百度文库
各类工程图技术要求 一、一般技术要求 制件去除表面氧化皮；制件不得有划痕、擦伤等损伤零件表面的缺陷；去除毛刺飞边；锐角倒钝；未注倒角均为 0.5×45%d；未注越程槽均为 1.2×0.3；表面平整...
百度文库
工程图常见技术要求_百度知道
回答:1
去百度文库，查看完整内容内容来自用户:wangyh1103 一般技术要求 1.零件去除氧化皮。2.零件加工表面上，不应有划痕、擦伤等损伤零件表面的缺陷。3.去除毛刺飞边。热处理要求 1.经调质处理，HRC50～55。2.零件进行高频淬火，350～370℃回火，HRC40～45。3.渗碳深度0.3mm。4.进行高温时效处理。公差要求...
百度知道2020-09-10
相关搜索
钦差杨贵森遭茅山道士暗害是那部电视剧
对外工程承包
对外发包工程
对外承包工程公司
对外工程承包资质
对外承包工程企业名录
中原对外工程有限公司
十五冶对外工程有限公司
中国中原对外工程有限公司
中国对外工程承包商会网站

接口设计是什么

接口设计一般出现在软件开发的概要设计阶段,概要设计要根据需求划分模块,而模块之间的联系就是通过定义接口实现的。例如有模块A,B。A,B互相不知道对方实现的细节,当A要用到B中的功能时,就要使用模块B提供的外部接口,接口可以理解为一些功能函数的原型,包括函数名,参数列表和返回值。 关于对外接口设计和外部接口设计的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 对外接口设计的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于外部接口设计、对外接口设计的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。