信息技术应用创新工程建设规范第10部分-应用开发通用技术要求(DB43-T 2259-2021).pdf

信息技术应用创新工程建设规范第10部分：应用开发通用技术要求Engineering specification for the Application Innovation Project of Information TechnologyPart 10:General technical requirements of application developing43湖南省地方标准ICSCCS 01.140.20L 70DB43/T 22592021 发 布湖南省市场监督管理局2021-12发布-292022-03实施-29DB43/T 22592021 I 目 次 前言 引言 1 范围 1 2 规范性引用文件 1 3 术语和定义 1 4 缩略语 2 5 编码要求 2 5.1 编程语言要求 2 5.2 函数命名要求 2 5.3 变量命名要求 2 5.4 国际化要求 3 5.5 变更日志要求 3 6 存储位置要求 3 6.1 可执行文件存储位置 3 6.2 动态库存储位置 3 6.3 配置文件存储位置 3 6.4 数据文件存储位置 4 6.5 缓存文件存储位置 4 7 日志要求 4 7.1 系统日志 4 7.2 应用日志 4 8 安全管理要求 4 9 软件包要求 5 9.1 软件打包要求 5 9.2 deb 包具体要求 5 9.3 RPM 包具体要求 6 10 桌面应用配置要求 7 10.1 desktop 文件 7 10.2 icon 文件 7 10.3 系统及应用服务要求 7 11 单进程要求 7 11.1 多用户单进程 7 11.2 单用户单进程 8 DB43/T 22592021 II 11.3 特殊访问单进程 8 12 多进程要求 8 12.1 进程间通信要求 8 12.2 系统资源限制要求 8 13 兼容性要求 8 附录 A（资料性）变更日志 changelog 文件格式 9 附录 B（资料性）desktop 文件格式示例 10 参考文献 11 DB43/T 22592021 III 前 言 本文件按照 GB/T 1.12020标准化工作导则 第 1 部分：标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。信息技术应用创新工程建设规范分为以下几个部分：第 1 部分：台式微型计算机通用技术要求；第 2 部分：便携式微型计算机通用技术要求；第 3 部分：服务器通用技术要求；第 4 部分：操作系统通用技术要求；第 5 部分：操作系统硬件兼容性通用技术要求；第 6 部分：操作系统软件兼容性通用技术要求；第 7 部分：办公套件通用技术要求；第 8 部分：电子公文通用技术要求；第 9 部分：驱动开发通用技术要求；第 10 部分：应用开发通用技术要求；第 11 部分：迁移适配通用技术要求；第 12 部分：国产化信息系统建设质量管理规范；第 13 部分：国产化信息系统运行维护规范；第 14 部分：国产化信息系统建设验收规范；第 15 部分：云计算通用技术要求。本部分为第 10 部分。本部分由湖南省国家密码管理局提出。本部分由湖南省工业和信息化厅归口。本部分起草单位：银河麒麟软件(长沙)有限公司、中国人民解放军国防科技大学、飞腾信息技术有限公司、湖南湘江鲲鹏信息科技有限责任公司、湖南中软信息系统有限公司、湖南长城科技信息有限公司、珠海金山办公软件有限公司、鹏城实验室。本部分主要起草人：蒋林轩、吴庆波、彭欢、战茅、齐璇、韩光、王晓川、秦莹、王静、蔡威、张月、孙洪桥、付志鹏。DB43/T 22592021 IV DB43/T 22592021 V 引 言 湖南省为深入贯彻国家网络强国战略，全面落实中央有关文件精神，部署开展湖南省信息技术应用创新工程建设，保障全省各级党政机关关键信息基础设施信息安全和信息系统安全可靠运行。针对自主可控产品体系初具规模，但相关产品和工程实施标准规范还很缺乏的现状，为了规范工程建设，加速工程进度，扩大建设结果，同时有力提升自主可控产业发展水平，确保信息安全，由湖南省国家密码管理局作为业务主管单位、湖南省工业和信息化厅作为技术归口单位，由中国人民解放军国防科技大学、中国电子信息产业集团有限公司等单位与湖南省合作制定了 信息技术应用创新工程建设规范 地方标准。信息技术应用创新工程建设规范主要由自主可控核心产品、典型应用、工程管理等方面的规范组成，重点解决应用创新工程建设当中产品选型、应用开发、工程实施等基础环节的实际问题，可为应用创新工程的用户使用单位、集成建设单位和相关产品研制单位，在产品和应用规范化、软硬件兼容适配、工程实施标准等方面提供一般性指引。信息技术应用创新工程建设规范 未来将根据自主可控产业和应用创新工程的发展变化进行相应的必要调整和补充。DB43/T 22592021 VI DB43/T 22592021 1 信息技术应用创新工程建设规范 第 10 部分：应用开发通用技术要求 1 范围 本文件针对国产操作系统上应用开发的编码、软件配置及打包、日志、安全管理、软件包、桌面应用配置、单进程、多进程、兼容性等提出具体要求，有利于提高应用软件的兼容性。本文件适用于国产操作系统上第三方应用程序的开发，也为第三方应用程序的调试验证提供指导。2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 152721994 程序设计语言 C DB43/T 1777.62020 信息技术应用创新工程建设规范 第 6 部分：操作系统软件兼容性通用技术要求 3 术语和定义 下列术语和定义适用于本文件。3.1 驼峰命名法 camel case 命名原则为第一个单词以小写字母开始，从第二个单词开始以后的每个单词的首字母都采用大写字母。3.2 匈牙利命名法 Hungarian notation 命名原则是变量名=属性+类型+对象描述。3.3 帕斯卡命名法 Pascal case 命名原则是由二个或二个以上单词连结在一起，每个单词首字母大写，单字之间不以空格断开或连接号（-）、底线（_）连结，第一个单词首字母采用大写字母，后续单词的首字母亦用大写字母。3.4 下划线命名法 underscore case 命名原则是由二个或二个以上单词连结在一起，每个单词用下划线隔开并且单词都是小写。3.5 动态库 dynamic link library 一种不可执行的二进制程序文件，允许程序共享执行特殊任务所必需的代码和其他资源。DB43/T 22592021 2 3.6 环境变量 environment variables 指在操作系统中用来指定操作系统运行环境的一些参数，如临时文件夹位置和系统文件夹位置等。3.7 系统日志 system log 记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。3.8 软件包 software package 指具有特定的功能，用来完成特定任务的一个程序或一组程序。3.9 变更日志 changelog 是对项目所作更改的详细记录，通常包括修复和新功能。4 缩略语 下列缩略语适用于本文件：PNG：可移植的网络图形（Portable Network Graphics）SVG：可缩放的矢量图形（Scalable Vector Graphics）UTF：通用字符组/编码转换格式（Universal Character Set/Unicode Transformation Format）5 编码要求 5.1 编程语言要求 应用软件开发应使用符合 GB/T 152721994 要求的 C 语言，宜使用 C+、Java、Python 等语言实现。5.2 函数命名要求 开发人员在同一项目中应使用同一种命名规范命名函数，命名规范可采用驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法中任意一种。5.3 变量命名要求 开发人员在同一项目中应使用同一种命名规范命名变量，命名规范可采用驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法中任意一种。变量命名还应遵守以下规则：a）在单独的代码行中声明每个变量；b）尽量避免使用简短或无意义的名称，例如“a”，“rbarr”；c）单字符变量名称只在临时变量或循环的计数中使用；d）在真正使用变量的时候定义变量；e）变量名称中的每个连续单词均以大写字母开头；f）避免使用缩写；g）类名以大写开头，公有类以 Q 开头，公有函数通常以 q 开头；DB43/T 22592021 3 h）含首字母缩写的变量使用驼峰命名法，例如“QUkuiWindowManager”。5.4 国际化要求 编码中应遵守以下国际化规则：a）应支持 BIG5、UTF-8 编码格式的字符集；b）宜在源码中标识需要翻译的文本信息，使用 lupdate 生成.ts 文件，使用翻译工具 Linguist对.ts 文件进行翻译，发布生成.qm 二进制文件，通过在源码中加载.qm 文件实现国际化。5.5 变更日志要求 每个版本应对应一条变更日志，变更日志中记录当前版本基于上一个版本改动的内容，变更日志changelog 文件的格式应符合附录 A 的规定。6 存储位置要求 6.1 可执行文件存储位置 可执行文件的存储位置应符合以下要求：a）系统的可执行文件放在“/bin”目录下；b）系统软件的可执行文件放在“/usr/bin/”目录下；c）用户的可执行文件放在“/usr/local/bin”目录下；d）应用软件的可执行程序放在“/opt/应用名/bin/”目录下。6.2 动态库存储位置 动态库的存储位置应符合以下要求：a）系统软件的动态库放在“/usr/lib”目录下；b）应用软件的动态库放在“/opt/应用名/lib”目录下：1）二进制编译时（包含可执行程序与动态链接库），加入链接器参数，将指定目录“/opt/应用名/lib”加入到 rpath 或 runpath 中；2）应用软件不应在运行时添加环境变量 LD_LIBRARY_PATH 来指定自定义的搜索路径。c）“/lib”和“/usr/lib”两个目录作为默认的库搜索路径，使用其目录中的库时不需要设置搜索路径，其他处于默认库搜索路径之外的库，需要将库的位置添加到库的搜索路径中，设置库的搜索路径通过以下两种方式：1）在“/etc/ld.so.conf”文件中添加库的搜索路径,添加路径后运行/sbin/ldconfig 命令更新“/etc/ld.so.cache”文件来设置库的搜索路径；2）在环境变量 LD_LIBRARY_PATH 中指明库的搜索路径。6.3 配置文件存储位置 配置文件的存储位置应符合以下要求:a）应用软件的全局配置文件放在“/etc/”目录下，如果一个应用软件有多个配置文件，则应建立“/etc/应用名/目录”，并将配置文件放入该目录；b）应用软件的用户配置文件应统一放在“/home/用户名/.config/应用名/目录”下；c）应用软件不得直接修改系统配置，而应按照系统提供的方法新建自己的子配置，包括但不限于以下配置：DB43/T 22592021 4 1）登录后的环境变量配置，应放在“/etc/profile.d/”目录下，以“应用名.sh”命名；2）bash 补全脚本，应放在“/etc/bash_completion.d/”目录下，以“应用名”命名；3）新建用户时的模板文件，应放在“/etc/skel/”目录下；4）AppArmor 的配置文件，应放在“/etc/apparmor.d”目录下；5）cron 定时配置，应放在“/etc/cron.d/”目录下，以“应用名”命名，如果应用开发提供多个定时配置，则按照“应用名-功能名”命名。6.4 数据文件存储位置 数据文件的存储位置应符合以下要求：a）系统软件的数据文件存储路径应为“/var/lib/软件名”；b）应用软件的数据文件存储路径应为“/opt/应用名/”及其子目录，具体路径不做强制要求，可为“/opt/应用名/data/”。6.5 缓存文件存储位置 软件运行过程中产生的保存状态的缓存文件，应符合以下要求：a）系统软件的缓存文件存储路径应为“/var/cache/软件名/”；b）如果应用软件安装路径为“/opt/应用名/”，则应用软件的缓存文件存储路径应为“/opt/应用名/”目录及其子目录，具体路径不做强制要求，可为“/opt/应用名/cache/”；c）如果应用软件安装路径为“/usr/share/应用名/”，则应用软件的缓存文件存储路径应为“/var/cache/应用名”目录及其子目录。7 日志要求 7.1 系统日志 系统日志应符合以下要求：a）日志输出不应影响系统正常运行；b）日志输出不应产生安全问题，不应输出敏感信息；c）日志使用应符合安全审计要求，支持备份和保密机制；d）日志可供系统开发和运维人员定位问题的原因；e）日志分为普通级、调试级、警告级、错误级和警报级 5 类。7.2 应用日志 应用日志应符合以下要求：a）循环体内不打印 Info 日志；b）打印日志打码，不应发生异常；c）不应使用字符串拼接，宜使用占位符；d）日志文件至少保存 15 天。8 安全管理要求 应用开发的安全管理应符合以下要求：DB43/T 22592021 5 a）具有前端交互逻辑的应用可执行程序，一般应以普通用户权限运行，不应使用 sudo、pkexec等命令直接提权运行；b）如果应用需要特权态执行某些操作，应使用前后端分离的方式实现，前端含有交互逻辑的二进制程序使用普通用户权限运行，通过 dbus 等技术与后端具有管理员权限的服务端通讯，实现相关功能；c）如果前端应用使用 dbus 等技术与后端具有管理员权限的服务端通讯，应进行身份鉴别，用于确定用户是否具备该项行为的权限。9 软件包要求 9.1 软件打包要求 应用软件的打包方式，应按照 DB43/T 1777.62020 中 6.5 节要求执行。9.2 deb 包具体要求 9.2.1 版本号要求 版本号的唯一性应适用于源码包和二进制包，在任何源码包下，二进制包不能重复使用。9.2.2 控制文件 包管理系统将控制数据存储在控制文件（control 文件）中，控制文件应使用 UTF-8 编码，由一个或多个字段段落组成，每个段落中包含多个数据字段，每个字段由字段名、紧跟着的冒号和该字段的数据/值组成。一个段落不应出现一个字段有多个实例的情况。9.2.3 软件包描述 每个 deb 包的 control 文件中包括 Description 字段，该字段应包含软件包的概要和扩展描述，还应描述关键依赖和其它软件包的冲突信息。Description 字段不应包含配置或使用软件包的说明（即安装脚本、手册页、信息文件等），以及版权说明。9.2.4 包变更日志 每个源码包中均应包含变更日志文件（changelog 文件），包变更日志文件使用 UTF-8 编码，deb包的变更应在 changelog 文件中作出简短说明，包括新的软件包对于上游软件包作出的修改、其它变更以及软件包的更新信息，变更日志 changelog 文件格式应符合附录 A 的规定。9.2.5 编译脚本 编译脚本是一个可执行的 makefile 文件，应以#!/usr/bin/make-f 开头，便于使用名称调用而不是直接调用 make。9.2.6 重复构建要求 为了实现重复构建，源码包的构建应符合以下要求：a）在指定路径解压源码包；DB43/T 22592021 6 b）已安装的构建依赖项版本；c）指定的环境参数值；d）确定构建架构；e）确定主机的 CPU 指令架构。9.2.7 软件包维护者 除了孤立软件包外，每个软件包都应有维护者，软件包的维护者应符合以下要求：a）维护者信息应在 control 文件的 Maintainer 字段中给出，包括名称和邮件地址；b）如果一个人或者一个团队维护几个软件包，则维护者的名称和邮箱应在这些软件包的Maintainer 字段中统一格式；c）如果一个软件包的维护者是一个团队，并且使用一个共享的邮箱，则control 文件中的Uploader字段应指定至少一个人的私人邮箱地址；d）如果软件包不再使用或者不可维护，则应将软件包删除。9.2.8 维护者脚本 维护者脚本文件应以#!符号开头，这些脚本应是可读的、可被任何人执行的且不能是全局可写的。维护者脚本调用的程序不应在其前面添加路径，这些程序的路径应在 PATH 环境变量中。维护者脚本执行过程中，应符合以下要求：a）幂等性要求，一次或多次请求调用，确保不会因为崩溃而导致调用没有完成；b）如果维护者脚本与控制终端没有一起运行，则维护者脚本应回退到无交互行为状态；c）维护者脚本运行成功应返回 0，运行失败应返回一个非零值；d）安装、升级和移除到新版本软件包中的脚本名称以 new-开头，升级和移除的旧版本软件包中的脚本名称以 old-开头。9.3 RPM 包具体要求 9.3.1 版本号要求 版本号的唯一性应适用于源码包和二进制包，在任何源码包下，二进制包不能重复使用。命名应符合 Name-Version-Release.arch 类型.rpm 规范，Name 为软件包名称，Version 为软件版本号，Release 为发布序列号。版本号一般有如下要求：a）仅当软件包比以前有较大改动时才增加 Version 号；b）软件开发者对软件包打补丁时应将 Release 号加 1；c）不要在 Source 语句中包含任何路径。9.3.2 SPEC 文件 SPEC 文件应满足如下要求：a）使用 UTF-8 编码，各段落之间应空一行；b）文档开头以 Summary 开始，说明软件包基本信息等内容；c）每个不同段落之间都以作为开头；d）包括 Summary、Name、Version、Release、Vendor、Group,Source 等必要信息。9.3.3 包变更日志 源码包的变更日志在 changelog 文件中加以说明，包括日期、维护者姓名、维护者联系方式、修改DB43/T 22592021 7 的具体内容等。changelog 文件的格式应符合以下要求：a）星期、月份均用英文形式的前 3 个字母，不应使用中文；b）每个 changlog 之间应有一空行。变更日志 changelog 文件格式应符合附录 A 的规定。9.3.4 源码包构建原则 源码包构建应遵循以下规则：a）只要存在 spec 文件，开发者应在系统现有的 spec 文件上修改更新；b）任何人无权删除其他人的 changelog 和原始打包者的信息，但可追加自己的信息；c）spec 文件应使用系统标准的宏定义；d）任何人都不应直接提供修改后的源代码，而应以补丁形式发布修改，在 spec 里完成打补丁操作，一个补丁只解决一个问题，任何补丁的授权方式应和被修改源代码保持一致。10 桌面应用配置要求 10.1 desktop 文件 桌面应用开发应使用 desktop 文件，用于在开始菜单、办公桌面等启动应用，desktop 文件应符合以下要求：a）应以应用安装后软件包管理工具可查询的软件名为 desktop 文件名，以.desktop 为文件后缀；b）应符合 Linux 启动器 desktop 文件编写格式，desktop 文件格式示例见附录 B；c）应用安装时，应将 desktop 文件放在“/usr/share/applications”目录下。10.2 icon 文件 桌面应用开发应使用 icon 文件用于在开始菜单、任务栏等位置显示所需图标，icon 文件应符合以下要求：a）icon 文件名应为应用标识，图标文件格式为 PNG/SVG，其中 PNG 图标大小要求 128x128px 及以上或全尺寸；b）icon 若为 PNG 格式，在应用安装时应将 icon 文件放在“/usr/share/icons/hicolor”对应尺寸的目录下；c）icon 若为 SVG 格式，在应用安装时应将 icon 文件放在“/usr/share/icons/hicolor/scalable/mimetypes/”目录下。10.3 系统及应用服务要求 系统及应用服务应符合以下要求：a）系统级服务应提供 systemd 的服务配置文件，并将其放在“/lib/systemd/system/”目录下；b）用户级服务应提供 systemd 的服务配置文件，并将其放在“/usr/lib/systemd/user/”目录下。11 单进程要求 11.1 多用户单进程 多用户单进程情况下，应用宜使用文件锁的形式实现单进程，文件锁放到“/run/”目录下，并使DB43/T 22592021 8 用“应用名.pid”方式命名，文件锁内容为应用的进程号。11.2 单用户单进程 单用户单进程情况下，应用宜使用文件锁的形式实现单进程，文件锁放到“/run/user/用户 ID/”目录下，并使用“应用名.pid”方式命名，文件锁内容为应用的进程号。11.3 特殊访问单进程 特殊访问单进程情况下，应用宜使用文件锁的形式实现单进程，文件锁放到“/run/”目录或者“/run/user/用户 ID/”目录下，并使用“应用名-特殊条件.pid”方式命名，文件锁内容为应用的进程号。12 多进程要求 12.1 进程间通信要求 进程间可使用信号、管道、套接字、消息队列、信号量、共享内存等方式实现通信。12.2 系统资源限制要求 系统在文件中设置默认的应用资源限制，每个进程都有一组资源限值。每个资源都有软限制和硬限制 2 种关联限制，软限制规定了进程能够消耗的资源数量，进程可以将软限制设置为 0 到硬限制之间的值；硬限制为软限制设定上限，只有特权进程能够增大或者缩小硬限制。进程可使用 getrlimit()函数读取自身的资源限制，可使用 setrlimit()函数修改自身的资源限制。13 兼容性要求 除基础 C 库以外，应用不应依赖操作系统提供的任何动态链接库。应用不应直接修改操作系统提供的配置文件，宜通过操作系统提供的接口来修改，可以通过新增高优先级配置文件来进行配置覆盖，新增的配置文件以“两位数字-应用名.conf”的形式命名。DB43/T 22592021 9 附 录 A（资料性）变更日志 changelog 文件格式 1、deb 包变更日志 changelog 文件的格式定义如下：package(version）distribution(s);urgency=*change details more change details *even more change details -maintainer name two spaces date 其中，package(version)是安装包的名字和版本号；distribution(s)代表要发行的软件版本在上传时需要安装在哪里；urgency 是为了表示这个版本比上一个版本的重要程度，它的选项有low,medium,high,emergency,critical；change details，至少要有 2 个空格开始，而且要以*号和分隔符一般是空格开始，下一行要和上一行对齐，建议这里不要写太多；maintainer name，是安装包的维护人员的名字；Email，邮箱地址；Date，day-of-week,dd month yyyy hh:mm:ss+zzzz，其他的时间格式在本文件中不再介绍。2、变更细节 change details 可记录的选项包括：1）新增(Features)：新增功能；2）修复(Fixed)：修复 bug；3）变更(Changed)：对某些已存在功能所发生的逻辑变化；4）优化(Refactored)：性能或结构上的优化，并带来功能的逻辑变化；5）即将删除(Deprecated)：不建议试用或在后续版本中即将删除的功能；6）删除(Removed)：已删除的功能。3、RPM 包变更日志 changelog 文件的格式定义如下：第一行：*星期 月 日 年 修改人电子信箱 修改后的版本号 第二行：-对哪些内容进行了修改，可写多行，一般以减号开始，便于后续的查阅。例如：*Tue Feb 9 2006 KanKer -update 2.3beta1 DB43/T 22592021 10 附 录 B（资料性）desktop 文件格式示例 desktop 文件的参考格式如下：Desktop Entry Version=1.31.38.0#版本 Name=AnXinTong#英文名称 Namezh_CN=即时通讯#中文名称 Comment=AnXinTong#软件英文注解 Commentzh_CN=即时通讯#软件中文注解 Icon=cpk.akey.chat#icon 名，不带路径需要将 icon 安装至系统默认图标路径下，否则需绝对路径 Exec=/opt/AnXinTong.sh#软件运行文件绝对路径 Terminal=false#是否使用终端 Type=Application#启动器类型 Categories=Application#应用类型 DB43/T 22592021 11 参 考 文 献 1 银河麒麟高级服务器操作系统 V10 开发指南 2 银河麒麟桌面操作系统 V10 程序员开发指南 3 UNIX 环境高级编程（第 3 版）人民邮电出版社 4 Qt5 开发实战 人民邮电出版社 5 C Primer Plus（第 6 版）人民邮电出版社 6 C+Primer Plus（第 6 版）人民邮电出版社 7 Debian 开发者文档 https:/www.debian.org/doc/manuals/developers-reference/index.en.html