接口开发注意事项.docx

《接口开发注意事项.docx》由会员分享，可在线阅读，更多相关《接口开发注意事项.docx（8页珍藏版）》请在三一办公上搜索。

1、接口开发注意事项第一：接口开发的流程问题。 接口开发的大致流程： 1.和第三方讨论需要实现哪些接口。 重点是要确定每个接口的具体功能。接口参数在开发过程中常常会有变动，所以讨论中一般不会明确定义。 2.编写详细设计文档。 文档包括接口名，参数名，参数类型，返回消息格式等，并提供给合作方。 3.编码 接口根据实际需要进行调整，同时更新详细设计文档，保持接口详细设计的可追溯性。 4.测试 包括接口内部测试、修改，和第三方的联调。 5.上线 接口正式上线，测试通过则上线成功，失败则回退,并从第4步开始新一轮的测试，直到系统上线成功。 常见问题： 1.详细设计文档应付了事，甚至不写设计文档。 实际的开

2、发过程中，由于时间的原因，或者开发团队对设计文档的不重视，造成有的开发者忽视接口设计文档的作用，甚至不写设计文档。 设计文档的缺失，往往会造成：人员流动时，系统无法顺利交接；会给接口的升级，带来重重困难。 2.不按合作双方的接口定义，私下决定不实现某些接口。 这种情况不一定每个人都会遇到，但我确实遇到过这种事情。某一次和一个比较有名的体育社区的合作过程中，由于我们的平台是类电子商务的，所以要给用户建立财务账户，如果我们系统中不保存用户的基本信息，就没法为用户创建账户。 所以我方提供的接口文档中，有一个注册接口，需要用户在体育社区的注册时，同时把信息传递到我们的平台，这样我们就会为这个用户创建财

3、务账户，否则，用户登录时就会有问题。 合作方对接口文档没有提出异议，但双方接口上线一段时间后，一次偶然的聊天过程中，对方开发人员透露，他们根本没有调用注册接口。吓了我一大跳，多亏我们前期的设计和编码中考虑得比较完善，否则，接口上线后，不堪设想。 所以，大家一定要遵守事先的约定，不要违背事先的约定，否则会出大乱子。 第二：接口开发过程中，发现原有功能设计有不合理的地方，应该对系统重构，还是仅仅实现功能了事？ 以我的经验而言，总的来说大多因为原有接口缺乏可扩展性，导致添加新功能或者接口更改后代码冗余的问题。究其原因，有下面几种情况的原因： 1.开发周期比较紧张，来不及对原有代码重构。 2.开发人员

4、懒得去重构，或者不具备重构的能力。 个人认为，这些问题归根结底要由开发流程来约束和控制。 开发周期紧张的情况下，技术负责人一方面要争取尽量多的开发时间，另一方面要根据开发任务的难度安排水平尽量高的人员来做；如果高水平的人员有了，时间还是紧张，可以考虑在以后某个合适的时间来重构这部分代码,千万不要让这部分待重构的代码永远的等待下去。应该制定合理的重构时间表，作为正常的开发流程的一部分。 第三：技术负责人在系统构建过程中应该担负哪些责任？ 无论系统对外接口，还是系统内部功能，都是整个系统的一部分，都是技术负责人的控制范围。 个人认为技术负责人应该对开发流程的建立、系统质量负主要责任。能否建立合理的

5、开发流程，能否领导开发人员产出高质量的软件系统，是一个技术负责人是否合格的很重要的判断标准。 就算开发团队中，开发人员数量充足，水平够高，但是开发流程不完善，缺乏合理的约束，往往会导致一部分人滋生得过且过的心态，编码完了基本上就算了事。有的人争取尽量多的空闲时间来学习新技术，为将来谋划；有的人刚接了私活，人家催的比较急，需要上班时抽空做呢；这种情况并不少见，怎样在这中恶劣的情况下保证开发工作在规定的时间内、高质量的完成？没有严谨的、合理的开发流程根本不可能领导这些各怀心腹事的开发人员研发出高质量的系统。 个人认为，技术负责人一定要抓住软件开发过程中的三个关键点：测试、代码复查、模块重构，一定要

6、重视再重视，程序员和老板讲解它们的重要性，他很可能不明白其重要性，但是技术负责人千万不能不重视这三个环节，如果您都不懂或者不重视，那最终产出的是什么样的系统，大家可想而知了。 以下是面向接口编程的一个简单例子，主要说明了设计过程中的一种思路： 原始需求： 系统提供和其他相关系统的调用接口，能够方便的将其他系统的文档导入到文档管理系统(java编写)中。 / 定义接口 import java.io.FileOutputStream; public interface OperateFile / 导入文件 public boolean importFile(String path,String n

7、ame); / 导出文件 public FileOutputStream exportFile(String path); / 实现子类 import java.io.FileOutputStream; public class OperateFileImp implements OperateFile public boolean importFile(String path, String name) / File file = new File(path,name). / 在此实现方法 return false; public FileOutputStream exportFile(St

8、ring path) /. return null; /. /.给外部提供接口. public class Factory private static OperateFile op = null; public static final int OPERATE_FILE= 1001; private Factory / 实现给外部的接口调用 public OperateFile getInstance(int classType) if(classType=1001) op = new OperateFileImp; return op; else throw new RuntimeExce

9、ption(要产生的子类没有定义！); 初探ERP系统与PDM系统接口技术 ERP系统需要PDM系统提供的信息分为兰类：物料信息，产品结构信息，加工工艺信息，这三类信息是ERP系统所需的基础数据，也是其进行生产管理、成本管理等的依据，这三类信息都是PDM系统管理的内容的，ERP系统以什么样的接口方式从PDM中获得以上的数据是本文讨论的重点。 1 ERP系统与PDM系统简述 PDM(产品数据管理)是一门管理所有与产品相关的信息(包括电子文档、数字化文件、数据库记录)和所有与产品有关的过程(工作流程、更改流程、项目管理)的技术，他提供了产品全生命周期的信息管理，并可在企业范围内为产品设计与制造建立

10、一个并行化的协作环境。 ERP(企业资源计划)将企业内部各个部门，包括财务、会计、生产、物料管理、品质管理、销售与分销、人力资源管理、供应链管理等，利用信息技术整合，连接在一起。不同管理人员在一定的权限范围内，通过自己专门的帐号、密码，可以从网上轻易获得与自身管理职责相关的其它部门的数据。 2 接口问题存在的现实问题 ERP系统中的制造BOM，来源于PDM系统，PDM系统管理的信息有CAD系统产生的产品信息，包括如零件属性、产品结构关系等，也管理从CAPP系统产生的工艺加工信息，包括加工的工序、工号、工时、消耗的材料等，这些信息是企业的生产管理的基础数据，是ERP系统的输入数据。在两系统没有连

11、接之前，要靠人工来重新输入和修改，难以确保正确无误，但这也是没有办法的事，ERP系统是基于sqlserver数据库的，而Pdm是基于oracle数据库的，由于设计思想不同，数据格式也不同，还有权限等问题，所以两系统需要有一个接口来负责数据的更新。 PDM系统与ERP系统中都管理与产品有关的信息，只是管理的目的和作用不同。PDM与ERP的关系，有嵌入式和非嵌入式，现在国内ERP厂商基本都没有做接口，企业上ERP系统的时候。总是会遇到数据接口问题，有时不得不等到PDM系统上好之后再作数据接口处理，非常麻烦。因为与产品相关的数据是在产品的设计和加工过程中产生的，即在PDM管理下产生的，而在ERP系统

12、中这些信息只是作为基础数据输入系统，据此编制主生产计划、物料需求计划、能力计划、采购计划等。为了保证企业里ERP，PDM系统的有效合理运行，需要在PDM与ERP系统中开发接口，保证两个系统中与产品有关的数据的一致。 3 ERP系统与PDM系统接口问题的解决方法 3.1 主动式接口 PDM将ERP所需的信息直接写入ERP系统的数据库中。这种方式要求详细了解ERP系统内部的数据库结构，并且ERP系统允许PDM系统往里写数据(即有写的权限)。一般来说，主动式接口形式一般用在定制开发或自行开发的ERP系统中。这种情况下，ERP系统的数据库结构很清楚，在ERP系统中录入数据时要进行哪些数据校验也很清楚，

13、当PDM系统往ERP系统中写数据时，也遵循ERP系统的数据校验规范，将其所需的物料信息、产品信息、加工信息等一一写入ERP系统中，保证数据的准确性和有效性。 采用主动式接口形式，在PDM系统与ERP系统中信息的同步性较好；但在安全性方面存在一定问题，如出现写数据冲突，即PDM系统写数据到ERP系统的同时，ERP系统也在往里写数据。一般对于大型的ERP系统如BAAN，ORACLE，SAP等建议不采用此种方式。 3.2 被动式接口 被动式接口中，ERP系统从PDM系统中读取所需的数据，将其写入自已的数据库中。对于被动式又有两种方式：(1)全被动式：即PDM系统完全公开其表达和存储信息的数据库结构。

14、ERP系统读取信息时自行判断哪些信息是增加的，哪些是修改的，哪些已删除了。(2)半被动式：即PDM系统除公开其数据库结构外，还提供一些握手信号单独存入握手信号表中，握手信息说明哪些信息作了更新，这样ERP系统在读取PDM系统中的信息(如某零件工艺更改的版本信息、某产品结构中产品节点的更改信息)时，根据握手信号表来读取PDM系统中己经发生更改的部分信息，不需要全部读一遍，这样可以提高接口处理的速度。 采用被动式接口形式，PDM系统与ERP系统的同步性也做得比较好，安全性方面也比主动式要强。一般由ERP软件提供商来完成接口工作比较合适，适合于自行开发的ERP系统。 3.3 中间式接口 中间式接口方

15、式中，PDM系统将ERP系统所需的信息生成中间文件或中间数据表，ERP系统直接读取中间文件或中间表中的信息写入数据库中，这种方式要求PDM和ERP两方都做一些开发工作。 需要特别提出的是：采用中间式如何保证PDM和ERP信息一致性。常用的有两种方式，一种是由ERP系统来保证。即PDM系统将ERP系统所需的三类信息定期写在中间文件或数据表中，ERP系统读取该信息时与ERP系统中已有的信息进行分析比较，判断哪是新增的、哪是修改的、哪些删除了，最后把更新的信息写入ERP系统中。另一种是，在PDM系统在生成中间文件或数据表时，与ERP系统中己有的数据进行比较，判断哪些数据进行了更新，并将更新的数据写入

16、中间文件或数据表：ERP系统读取中间文件或数据表中的数据直接写入自己的数据库中。这种方式要求在PDM系统写中间文件之前ERP系统将其数据库中的数据导出，以供PDM系统进行比较用。 中间式接口是比较常用的一种方式，这种方式PDM系统和ERP系统相对独立，接口不涉及双方内部的结构，而且接口的责任也很明确。数据的安全性也得到了保证；存在的问题是两个系统的数据同步性稍差一些，但只要合理地规定读写中间文件或数据表的时间，数据的同步性是不会影响使用的。 通过以上三种简单方式的接口，解决了客户在不同系统之间的数据交换问题，对合作各方也是一个很好的启示，随着企业信息化的不断深入，各系统之间的数据交换会越来越多，因此系统间的接口问题会一直存在。