《XX市XX应用软件开发技术规范》由会员分享，可在线阅读，更多相关《XX市XX应用软件开发技术规范（29页珍藏版）》请在金锄头文库上搜索。
1、11 应用软件技术规范应用软件技术规范一、一、 实施技术规范的目的与适用范围实施技术规范的目的与适用范围通过实施应用软件技术规范使苏州交通系统各类新建和已建的应用软件能够有效地实现资源共享和数据交换，为应用软件可持续、可扩展的开发建设奠定基础，为今后的应用整合做好准备。本规范适用范围：2010 年后新建的应用软件必须实现本规范定义的技术要求，2009 年底以前建成的应用软件在今后的升级改造中要实现本规范定义的技术要求，目前在建的软件系统要有条件的实现本规范定义的技术要求。二、 实施技术规范的目标本规范实施之后开发的应用软件必须能够实现本方案定义的系统接口、编制本方案规定的数据规范和应用本方案提
2、出的组织结构管理要求。通过实现统一的接口技术规范，使所有应用软件可以实施统一的管理，使应用软件之间可以进行数据交互；通过使用特定的 XML 格式设计的数据规范，使应用软件能够开放数据资源，做到数据内容、服务方式和实现技术的无关性，增强了应用软件开发和组合的灵活性；通过应用统一的组织结构管理要求执行身份验证和角色分配操作，降低了应用软件建设的复杂性，简化了用户身份的管理工作。通过实现数据流转功能实现不同应用软件之间的数据共享，实现办事信息通知的发送。三、 接口技术规范所有应用软件在底层都可以细分为对数据的增加、删除、修改和查询四项操作，为此对应用软件制定了统一的接口技术规范，明确了写入、读取和查
3、询三项操作。1.接口的功能说明通过调用写入操作让应用软件执行元数据的增加、删除和修改操作。元数据是指应用软件中的最基本数据，如果一个数据被拆开后在整个应用软件中不再具备其他意义，那么这个数据就叫做元数据。元数据以外的其他数据是不会调用写入操作的。通过调用读取操作获取应用软件中的具体数据。读取操作可以获取元数据或具有固定2数据标识和类型的单项数据。通过调用查询操作检索应用软件中的相关数据。查询操作可以包含大量的查询条件，应用软件将系统中符合条件的数据检索出来后返回给调用方。2.接口的参数和返回值说明写入操作主要参数有：用户标识、应用标识、数据标识、数据类型、符合数据规范格式的 XML 数据。参数
4、含义如下：用户标识用 UserID 表示，使用应用软件接口时首先提供身份验证信息，通过认证后将获取用户标识，在以后的访问中使用 UserID 表示访问接口的用户身份，结束接口使用必须执行用户标识注销操作。用户标识获取和注销操作参见第五节“身份认证和管理规范” 。应用标识用 TaskGuid 表示，随着系统整合的实施今后一个应用软件可以包含多项专业应用，通过 TaskGuid 参数值可以让接口在被调用时能够区分出不同的应用。TaskGuid 采用标准的 GUID 格式，TaskGuid 的值由系统建设主管单位统一定义，在数据规范文档中描述，一项应用只能定义一个应用标识。数据标识用 DataGui
5、d 表示。每个唯一的数据必须具备一个唯一的标识，使用该标识区分不同的数据。由于数据的增加、删除和修改操作都是以 DataGuid 作为关键字的，不同的系统都要按照 GUID 标准统一生成 DataGuid，以保证数据在不同的系统和平台中不被其他数据覆盖。数据类型用 DataType 表示。每一项数据规范都要定义一个唯一的数据类型，应用软件是按照 DataType 对应的数据规范解析写入的数据，不同应用的数据类型可以重复。符合数据规范格式的 XML 数据用 XmlData 表示。表示写入的具体数据，如果与数据类型对应的数据标识的元数据不存在，就执行数据增加操作；如果与数据类型对应的数据标识的元数
6、据已存在，就执行数据更新操作；如果 XmlData 是空值或是没有子节点的 XML 数据，就将数据标识对应的元数据删除； 写入操作的返回结果表示数据在软件中的写入情况。返回 0 表示数据写入操作成功，返回-1 表示数据格式不符合要求，返回-2 表示写入数据的逻辑不对，表示返回-3 表示没有数据写入权限，返回其它值可以查询“数据写入操作错误信息”来获取具体含义，查询时使用读取操作，其中 TaskGuid 参数为应用标识，DataGuid 参数固定为“c61ed474-e8b1-4fb4-8975-74b356caa22b“，DataType 参数为“ErrorList“。返回数据格式统一为：3错
7、误信息描述错误信息描述错误信息描述错误代码要求大于 100 或小于负 100，正负 100 之间的错误码作为保留值不能使用。读取操作主要参数有：用户标识、应用标识、数据标识和数据类型。参数含义如下：用户标识用 UserID 表示，具体含义与写入操作参数相同。应用标识用 TaskGuid 表示，具体含义与写入操作参数相同。数据标识用 DataGuid 表示，每个唯一的数据必须具备一个唯一的标识，使用该标识区分不同的数据。读取操作中数据标识表示需要读取的唯一数据。数据类型用 DataType 表示。每一项数据规范都要定义一个唯一的数据类型，应用软件是按照 DataType 对应的数据规范生成读取的
8、数据，不同应用的数据类型可以重复。读取操作的返回结果是符合数据规范格式的 XML 数据。如果对应的数据不存在也必须返回符合数据规范格式并包含所有节点的空数据。返回空值表示无对应数据的读取权限或者是应用软件不支持该类型的数据。查询操作主要参数有：用户标识、应用标识、符合数据规范格式的 XML 查询命令。参数含义如下：用户标识用 UserID 表示，具体含义与写入操作参数相同。应用标识用 TaskGuid 表示，具体含义与写入操作参数相同。符合数据规范格式的 XML 查询命令用 XmlTransform 表示。在查询操作中包含需要查询的条件。查询操作的返回结果是符合查询条件的具体数据。大批量数据的
9、返回要实现数据分页的查询操作。即使查询结果没有符合条件的数据也必须返回符合格式的数据，返回空值表示无对应数据的查询权限或者是应用软件不支持对应的查询操作。3.接口的实现方式考虑到不同层面的对接要求系统接口的实现定义了网页、Web 服务和 Socket 三种方式，应用软件至少需要实现其中一种接口方式，具体实现哪几种接口方式，将由建设单位明确。网页方式。该方式是专供 JaveScript 调用的一种方式，使用浏览器的XMLHttpRequest 对象向对应的网页发出请求或发送数据可以调用应用软件的写入、读取和4查询操作。写入操作使用 “POST”方式将符合数据规范格式的 XML 字符串发送到提供写
10、入操作的网页上。用户标识、应用标识、数据标识、数据类型等参数通过在网页后面跟上字符串：?UserID=&TaskGuid=&DataGuid=&DataType=的方式传递，返回值为数值型的字符串。读取操作使用“GET”方法调用提供读取操作的网页。用户标识、应用标识、数据标识和数据类型，等参数通过在网页后面跟上字符串：? UserID=&TaskGuid=&DataGuid=&DataType=的方式传递，返回值为符合数据规范格式的 XML 字符串。查询操作使用“POST”方式将符合数据规范格式的 XML 查询命令发送到提供查询操作的网页上。用户标识、应用标识等参数通过在网页后面跟上字符串：?
11、UserID=&TaskGuid=的方式传递，返回值为符合数据规范格式的查询结果字符串。提供写入、读取和查询操作的网页可以通过一个网页文件来完成对应的功能。Web 服务方式。该方式是提供给函数方式调用的一种接口，凡是能够支持 Web 服务调用的软件都可以使用这种接口调用应用软件的写入、读取和查询操作。Web 服务必须遵循附件一的 WSDL 定义，实现下面三个函数：写入操作调用 Web 服务的 SetData 函数，参数按照函数的方式传递，返回值为数值型。函数原型如下：SetData ( UserID As string , TaskGuid As string , DataGuid As st
12、ring , DataType As string , XmlData As string ) As int读取操作调用 Web 服务的 GetData 函数，参数按照函数的方式传递，返回值为符合数据规范格式的 XML 字符串。函数原型如下：GetData ( UserID As string , TaskGuid As string , DataGuid As string , DataType As string ) As string查询操作调用 Web 服务的 TransformData 函数，参数按照函数的方式传递，返回值为符合数据规范格式的查询结果字符串。函数原型如下：Transf
13、ormData ( UserID As string , TaskGuid As string , XmlTransform As string ) As stringSocket 方式。该方式是采用通讯端口方式进行操作的接口。通过向通讯端口发送指定格式的数据实现对应用软件的写入、读取和查询操作。写入操作发送如下格式的数据到通讯端口：5用户标识应用标识数据标识数据类型/符合数据规范格式的XML数据返回值是数值型的字符串。读取操作发送如下格式的数据到通讯端口：用户标识应用标识数据标识数据类型返回值是符合数据规范格式的字符串。查询操作发送如下格式的数据到通讯端口：用户标识应用标识/符合数据规范格式
14、的XML查询命令返回值是符合数据规范格式的查询结果字符串。4.批量数据处理由于系统接口采用 XML 作为传输数据的格式，在实际应用中发现传输数据的时间要比处理数据的时间大很多，在大数据交互应用中如果每个写入、读取和查询操作只写入或反馈一个数据将会大大影响系统效率，为此定义了批量数据处理方式来满足大数据量应用的要求。批量数据以 Documents 作为根节点，内含一组符合数据规范的 Document 子节点。数据格式如下：6写入操作中使用批量数据表示对数据中的每个 Document 都执行一次独立的写入操作，写入每个 Document 时使用其包含的应用标识、数据标识和数据类型代替TaskGui
15、d、DataGuid 和 DataType 参数，批量写入操作中提供的这三个参数忽略。读取和查询操作中使用批量数据可以根据实际逻辑定义批量数据反馈格式。四、 数据格式规范要想让同一种数据在不同的软件接口中使用，必须让数据遵循共同的描述方式，为了让数据通俗易懂便于计算机处理和人理解特采用 XML 格式作为所有数据的标准格式，按照特定的 XML 格式定义的数据描述称做数据规范。采用数据规范后应用软件的功能实现就具备一定的灵活性数据规范在应用软件接口中涉及写入和读取操作中的“XML 数据” ，查询操作中的“XML 查询命令”和“XML 查询结果” 。大型应用软件的数据规范聘请专业单位进行独立设计，小
16、型应用软件的数据规范由软件开发单位负责设计。1.数据规范的基本结构基本的数据规范必须符合下面的基本格式：属性值 根节点命名为 Document 表示这是一个按本文数据规范定义的数据。应用标识表示数据规范与哪一个应用有关。在某项应用的数据规范设计中必须首先明确应用标识采用的值。例如：“0690f841-7773-445c-9f48-a7a0427686d5“就表示是组织结构管理功能的数据。一个应用软件可以包含多个应用，不同应用具备独立的应用标识，可以独立开发。数据标识表示数据的唯一值，对于元数据应用软件就是依靠该值执行增加、删除和修改操作。在数据规范设计中该值不要明确具体的内容，在实际数据生成时必需按照 GUID 的标准生成具体值，这样可以保证不同的系统生成的数据不会重复。数据类型表示数据对应哪一个类型，一个应用可以包含多个数据类型，相同类型的数据必须遵守相同的格式。调用系统接口的软件和系统接口实现的软件都依靠数据类型来确7定数据的分析和生成方法。文档根节点还可以叠加与整个文档有关的其他属性，具体可以根据
