企业内部系统接口设计规范（系统集成接口规范）

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

本文目录一览：

• 1、系统接口设计的原则（续）
• 2、接口设计怎么写？
• 3、（转）对外接口设计规范
• 4、多终端 为什么采用restful的接口设计规范
• 5、java为什么要设计接口规范
• 6、论文dblink系统接口设计 怎么写

系统接口设计的原则（续）

昨天写到系统接口设计最重要的原则是：

很开心的是大家选了黎叔和Richardson的方案，因为这个方案是最 简单直观 的，并且满足了数据在两个系统的一致性。

还是举昨天的例子，数据在客户系统是这样的：

到我们系统也会生成一样的数据：

我们系统为了生成这条数据，还需要生成一些基础数据：

这个方案的唯一问题是一个正常的SR(一装一卸)被分成了两个SR，一个是提货SR，一个是卸货SR，和我们之前对SR的认知十分不同，除了心里有些小担心之外，暂时也想不出这样会有什么问题。

抛开这个问题，我想用三个词来评价这个解决方案：

接口设计怎么写？

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

（转）对外接口设计规范

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坐标

多终端 为什么采用restful的接口设计规范

REST（REpresentationStateTransfer）描述了一个架构样式的网络系统，比如web应用程序。
它首次出现在2000年RoyFielding的博士论文中，他是HTTP规范的主要编写者之一。
REST指的是一组架构约束条件和原则。
满足这些约束条件和原则的应用程序或设计就是RESTful。
Web应用程序最重要的REST原则是，客户端和服务器之间的交互在请求之间是无状态的。
从客户端到服务器的每个请求都必须包含理解请求所必需的信息。
如果服务器在请求之间的任何时间点重启，客户端不会得到通知。
此外，无状态请求可以由任何可用服务器回答，这十分适合云计算之类的环境。
客户端可以缓存数据以改进性能。
在服务器端，应用程序状态和功能可以分为各种资源。
资源是一个有趣的概念实体，它向客户端公开。
资源的例子有：应用程序对象、数据库记录、算法等等。
每个资源都使用URI（UniversalResourceIdentifier）得到一个惟一的地址。
所有资源都共享统一的界面，以便在客户端和服务器之间传输状态。
使用的是标准的HTTP方法，比如GET、PUT、POST和DELETE。
Hypermedia是应用程序状态的引擎，资源表示通过超链接互联。
另一个重要的REST原则是分层系统，这表示组件无法了解它与之交互的中间层以外的组件。
通过将系统知识限制在单个层，可以限制整个系统的复杂性，促进了底层的独立性。
当REST架构的约束条件作为一个整体应用时，将生成一个可以扩展到大量客户端的应用程序。
它还降低了客户端和服务器之间的交互延迟。
统一界面简化了整个系统架构，改进了子系统之间交互的可见性。
REST简化了客户端和服务器的实现。
RESTful的实现：RESTfulWeb服务与RPC样式的Web服务了解了什么是什么是REST，再看看RESTful的实现。
最近，使用RPC样式架构构建的基于SOAP的Web服务成为实现SOA最常用的方法。
RPC样式的Web服务客户端将一个装满数据的信封（包括方法和参数信息）通过HTTP发送到服务器。

java为什么要设计接口规范

抽象类和接口
什么是接口：接口就是一些方法特征的集合------接口是对抽象的抽象。
什么是抽象类：抽象类对某具体类型的部分实现------抽象类是对具体的抽象。
方法特征包括：方法的名字、参数的数目、参数的类型。不包括：返回类型、参数名字、和抛出的异常。
接口是类型转换的前提、是动态调用的保证。实现某一接口就完成了类型的转换（多重继承）；动态调用只关心类型，不关心具体类。
       --------------------------------------------------------------------------------------------------------------------------------------
       JAVA接口（抽象类）用来声明一个新的类型。
JAVA设计师应当主要使用接口和抽象类将软件单位与内部和外部耦合起来。
换言之，应当使用JAVA接口和抽象类而不是具体类进行变量的类型声明、参数的类型声明、方法的返回类型声明、以及数据类型的转换等。
当然一个更好的做法是仅仅使用接口，而不是抽象类来做上面这些事情。
在理想的情况下，一个具体类应当只实现接口和抽象类中声明的方法，而不应当给出多余的方法！
接口和抽象类一般作为一个类型等级结构的起点。
接口比抽象类更为抽象所以优先使用接口声明抽象类型！
--------------------------------------------------------------------------------------------------------------------------------------
抽象类和接口
       抽象类仅提供一个类的部分实现。抽象类可以有实例变量、以及一个或多个构造函数。抽象类可以同时又抽象方法和具体方法。
       一个抽象类不会有实例，它的构造函数不能被客户端用来创建实例。一个抽象类的构造函数可以被其子类调用，从而使一个抽象类的所有子类可以有一些共同的实现，而不同的子类可以在此基础上有不同的实现。
接口比抽象类更为抽象所以有线使用接口声明抽象类！
抽象类是用来继承的。（具体类不是用来继承的，“只要有可能不要从具体类继承---SCOTT MERYES”）。
抽象类设计原则：
1.          抽象类应当拥有尽可能多的代码！（公用方法）。代码集中于抽象的方向。
2.          抽象类应当拥有尽可能少的数据！（公共属性）。数据集中于具体的方向。
继承复用的使用条件------- PETER COAD条件
1.        子类是超类的一个特殊种类而不是超类的一个角色！正确区分“HAS-A”“IS-A”的关系。
2.        子类之间不应发生替换！？
3.        子类具有扩展超类的责任，而不是置换（OVERRIDE）掉或注销（NULLIFY）掉的责任。
4.        只有在分类学角度上有意义时才可以使用继承，不要从具体类继承。
接口和抽象类的区别：
    1.       抽象类可以提供某些方法的实现。如果向抽象类中加入一个新的具体的方法，那么所有的子类一下子就得到了这个方法。接口做不到这一点！（这也许是抽象类的唯一优点）。
2.      因JAVA的单根结构限制，只类只能实现一个抽象类类型，而接口类型这无此限制。这使抽象类作为类型定义工具的效能落后于接口。接口是定义混合类型（实现多从继承）的理想工具：用一个
3.      从代码重构的角度上讲，将一个具体类重构成一个接口的实现是很容易的。

文章来自 haoyu1566的网易博客

论文dblink系统接口设计 怎么写

1、标准接口表2、标准API前者例如AP的发票接口表，供应商、客户接口表，具体实现方式是，将数据按照接口表规格准备到接口表中，然后运行标准的import程序将接口表数据导入到Oracle EBS中（即各接口表对应的正式table中）。而例如银行、分行、银行帐户相关API，一般通过客户化程序，调用此类API实现将数据导入系统，此时一般也会新建一些客户化staging table，先将外部数据准备到staging table后，再使用客户化程序，调用API将资料导入Oracle EBS中。 关于企业内部系统接口设计规范和系统集成接口规范的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 企业内部系统接口设计规范的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于系统集成接口规范、企业内部系统接口设计规范的信息别忘了在本站进行查找喔。

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