文件编码 文件密级 最新发布日期 当前版本 XX软件股份有限公司 公共代码及组件管理规范 郑重声明：XX软件股份有限公司版权所有。本文档中任何部分未经XX软件股份有限公司 书面授权，不得将材料泄露给第三方，不得以任何手段、任何形式进行复制与传播。 变更履历 版本 1.0 1.0 1.0 日期 变更理由/变更内容 变更人 备注 创建管理规范框架 根据研发中心公共代码管理规定对组件管理规 范文档进行修改 增加了组件评审等流程以及对于跨部门代码复 用目的的相关阐述 1.0 根据吴家仲等人的想法进行了修改 1.0 根据与sun的沟通结果进行了修改 目录 1 总则3 1.1 宗旨..............................................................................................................3 1.2 原则..............................................................................................................3 1.3 适用对象........................................................................................................3 2 术语定义..............................................................................................................4 3 组件开发过程........................................................................................................4 3.1 通用组件开发.................................................................................................4 3.2 第三方组件采购..............................................................................................5 4 组件提交过程........................................................................................................6 4.1 组件提交流程.................................................................................................6 4.2 组件入库标准.................................................................................................6 5 4.2.1 组件库组件的纳入标准.........................................................................6 4.2.2 评审通过的必要准备............................................................................7 组件维护升级过程..................................................................................................7 5.1 组件维护管理的几种情况..................................................................................7 5.1.1 组件部维护的组件...............................................................................7 5.1.2 其他部门维护的组件............................................................................8 5.2 组件升级........................................................................................................8 6 组件取用过程........................................................................................................8 6.1 组件的取用流程..............................................................................................8 6.2 组件取用情况统计规定.....................................................................................9 7 组件撤销过程........................................................................................................9 总则 宗旨 1. 代码的复用水平是体现软件企业研发管理水平高低的重要标志。而组件的定义 管理则可以看作是代码复用的一个具体表现。 2. 随着公司组织结构的日益壮大，研发部门的数量也日趋增多，方向性（技术、 业务）也趋向明朗化，而或多或少的重复性开发也屡见不鲜，此时，跨部门代码复用 的重要性和艰巨性也就日渐突显。 3. 为提高公司内部跨部门代码复用水平、促进各技术人员加强技术交流、分享开 发经验，特制定此组件管理规范。 原则 1. 组件管理的原则（目的）是：提高公司内部跨部门代码复用水平、促进各技术 人员加强技术交流、分享开发经验。 2. 按照组件在公司内可维护的能力，将组件分成三类： 1） 通用型组件 2） 业务型组件 3） 第三方组件 3. 研究院组件部是组件库归口管理部门，研究院组件部负责人是组件库主管人， 组件库主管人必须作好组件代码的登记、整理、统计和分发工作，并定期将组件代码 库的有关信息发布到公司内部的portal上供其他员工查询 4. 配置基线库是组件代码存放地，配置管理员要定期作好组件代码库的备份工作 5. 组件代码的管理由以下几个过程来控制： 1） 组件开发过程 2） 组件提交过程 3） 组件维护升级过程 4） 组件取用过程 5） 组件撤销过程 适用对象 组件部成员、公司其他研发人员以及配置管理员等。 术语定义 No. 术语 定义 1 公共代码 具有完整功能逻辑、能被应用于两个或两个以上的软件产品或项目 No. 术语 定义 的程序片段及其附属资料。 公共代码可以是用某种程序开发语言书写的源代码及其的设计文 档、使用说明资料，也可以是以二进制形式存在的、能被复用的程 序组件及相关的设计文档、使用说明资料、演示程序等。 为了解决功能或机制层面相较于类更大粒度复用的问题，引入了组 件的概念。 简而言之，我们可以把组件理解为对于一组具有某种或某些通性 2 组件 （如某种功能或某种机制等等）的公共代码的封装，对外暴露一个 或多个接口，供外界调用。 在本规定中，组件包括三种类型：通用型组件和业务型组件以及第 三方工具组件。 与业务无关、能够被专人进行升级、维护的组件。通用型组件通常 3 通用型组件 4 业务型组件 与业务有关、在某一业务领域或多个业务领域有普遍意义的组件。 是支持一些公共控件、通用算法等。 从第三方厂商购买或从网上的开放源码团队中获得的公共代码，根 5 第三方组件 据公司研发实际需要进行再次封装，形成组件。这类组件通常核心 部分在公司内不能维护升级，只有再次封装部分可以进行维护升 级。 组件开发过程 组件的功能开发过程应符合公司的软件开发规范，具体这里就不进行描述了，主 要对通用组件开发申请及第三方组件采购的一些过程进行规定。 通用组件开发 是 提交申请 讨论协商 同意开 发 功能实现 否 通用组件开发流程的说明如下： 1. 决定开发某个组件之前首先需要提交某组件的开发申请至组件部（申请方式可 以为口头申请，申请部门可以是组件部也可以是其他部门） 2. 收到申请后组件部组织讨论协商，如果经讨论认为可以进行该组件开发，原则 上开发部门以组件部为主（如果组件部处于精力不足等状态可以组织协商来决定开发 承担部门） 3. 组件开发申请通过后，根据协商结果来组织相关人员进行功能实现 第三方组件采购 提交申请 组件部核实 否 存在类似组 件 是 评审 组件取用 评审通过 组件部购买 组件入库 第三方组件购买流程说明如下： 1. 该流程主要针对其他部门发起的第三方组件购买申请 2. 组件部负责对申请的组件进行核实，核实内容主要包括查找组件库中是否已经 存在类似的组件，如果发现有类似组件则走组件取用过程 3. 如果组件库中不存在类似组件，则组织采购申请评审，如果评审不通过则退出 该流程 4. 如果评审通过，组件部负责进行组件的采购相关事宜 5. 采购成功后，组件部负责入库相关事宜，参见组件提交过程 6. 新采购的组件提交入库之后，组件部负责通知相关申请部门进行组件取用过程 组件提交过程 组件提交流程 是 提交 评审 修改 是否通 过 入库 否 组件的提交过程说明如下： 1. 组件提交流程主要包括：提交、评审、入库 2. 提交过程主要包含两种方式： 1） 其他兄弟部门同事推荐 2） 组件部主动收集（代码及需求） 3. 提交评审由组件部来进行组织，评审遵循的组件入库标准请参见2.1组件入库 标准。 4. 评审人员包括：组件部相关