最佳实践

Size: px

Start display at page:

Download "最佳实践"

侑滑
5 years ago
Views:

1 文档版本 03 发布日期华为技术有限公司

2 版权所有华为技术有限公司 2018 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品服务或特性可能不在您的购买或使用范围之内除非合同另有约定, 华为公司对本文档内容不做任何明示或默示的声明或保证由于产品版本升级或其他原因, 本文档内容会不定期进行更新除非另有约定, 本文档仅作为使用指导, 本文档中的所有陈述信息和建议不构成任何明示或暗示的担保华为技术有限公司地址 : 深圳市龙岗区坂田华为总部办公楼邮编 : 网址 : 客户服务邮箱 : support@huawei.com 客户服务电话 : 文档版本 03 ( ) 版权所有华为技术有限公司 i

3 目录目录 1 前提准备华为云账号 Git 客户端已创建好的项目相关名词解释 Web 项目 on ( 视频 ) Git on 目的 Git 概述 CodeHub 云端操作 Git 本地研发场景 Git 工作流 Git 工作流概述集中式工作流功能分支工作流 Gitflow 工作流 Forking 工作流 Docker on 目的 Docker 概述环境准备研发场景代码管理场景代码质量评估场景持续交付 (CI/CD) 场景 PHP on C# on Android on Cocos on node.js on 文档版本 03 ( ) 版权所有华为技术有限公司 ii

5 1 前提准备 1 前提准备 1.1 华为云账号 1.2 Git 客户端 1.3 已创建好的项目 1.4 相关名词解释 1.1 华为云账号背景信息操作步骤使用华为云软件开发服务 () 前, 需要注册一个华为云账号步骤 1 打开华为云网站步骤 2 单击页面右上方注册步骤 3 根据界面提示填写基本用户信息并完成注册已完成注册的账号即为企业管理员 ---- 结束 1.2 Git 客户端 Git 是一款开源的分布式版本控制系统 (Distributed Version Control System), 诞生于 2002 年, 由 Linux 之父 Linus Torvalds 带领 Linux 开源社区开发完成, 初衷是用其管理 Linux 内核的庞大的开源代码在当今敏捷开发成为主流, 研发周期短, 跨地域协同开发多的大形势下, 选择 Git 版本管理工具是大势所趋国内外有很多基于 Git 的云端代码托管服务, 代码托管服务就是其中之一代码托管 (CodeHub) 是面向软件开发者提供的基于 Git 的在线代码托管服务, 包括代码克隆 / 下载 / 提交 / 推送 / 比较 / 合并 / 分支等代码一键下载到本地, 基于本地 IDE 开发, 开发完毕一键推送云端, 实现线上线下协同开发文档版本 03 ( ) 版权所有华为技术有限公司 1

1 前提准备代码托管支持两种传输协议,SSH 和 HTTPS, 可以选择其中一种进行配置使用 Git 客户端使用流程如图 1-1 所示图 1-1 Git 客户端使用流程 Git Bash 下载安装配置个人信息 Git Bash 客户端软件是本地 PC 使用 Git 必须安装的软件, 如果本地没有安装, 请到 https://git-scm.

6 1 前提准备代码托管支持两种传输协议,SSH 和 HTTPS, 可以选择其中一种进行配置使用 Git 客户端使用流程如图 1-1 所示图 1-1 Git 客户端使用流程 Git Bash 下载安装配置个人信息 Git Bash 客户端软件是本地 PC 使用 Git 必须安装的软件, 如果本地没有安装, 请到下载安装成功以后, 在开始菜单中会增加 Git Bash 选项安装完成, 运行 Git Bash, 在弹出终端页面按照下面操作进行个人配置 $ git config --global user.name 您的名字 $ git config --global user. 您的邮箱生成密钥运行 Git Bash, 生成一对 SSH 密钥, 在弹出的终端中输入下面命令, 回车后会提示您输入一个密码, 建议不输入, 一路回车即可 $ ssh-keygen t rsa C 您的此时, 会在 ~/.ssh 文件夹下生成了一对密钥, 公钥 id_rsa.pub 和私钥 id_rsa, 私钥无需处理, 保存在本机就可以了, 公钥的内容需要拷贝到中说明如果使用 HTTPS 传输方式, 无需此操作 1.3 已创建好的项目步骤 1 进入华为云首页, 如图 1-2 所示文档版本 03 ( ) 版权所有华为技术有限公司 2

1 前提准备图 1-2 华为云首页步骤 2 单击产品 > 软件开发服务, 进入产品首页, 如图

8 1 前提准备图 1-4 首页步骤 4 单击右上角新建项目, 设置项目名称开发流程和项目描述, 默认以 Scrum 流程项目为例, 如图 1-5 所示图 1-5 新建项目步骤 5 单击新建按钮即完成了一个项目的创建 ---- 结束 1.4 相关名词解释表 1-1 名词解释名词华为云软件开发服务解释华为云软件开发服务 ( 以下简称 ) 是集华为近 30 年研发实践, 前沿研发理念, 先进研发工具为一体的一站式云端 DevOps 平台, 面向开发者提供包括项目管理代码托管流水线代码检查编译构建云测移动应用测试部署发布 CloudIDE 研发协同等基础功能的研发工具服务覆盖软件开发全生命周期, 支持多种主流研发场景, 让软件开发更高效小幺鸡小幺鸡项目是一个简单好用的在线文档管理工具, 支持 restapi websocket 在线测试, 支持 markdown 编辑器, 提升开发效率降低接口错误率文档版本 03 ( ) 版权所有华为技术有限公司 4

9 2 Web 项目 on ( 视频 ) 2 Web 项目 on ( 视频 ) 目的通过视频模拟演示如何从组件团队开始, 经过编码部署等过程, 完成一个 JavaWeb 项目的交付实操步骤 1. 使用创建交付团队 2min 拿到项目组成员名单后, 将项目组成员添加到项目中, 并分配角色 ( 没有账号的成员需要申请账号 ), 便于以后任务分配和协作 2. 将项目需求迁移到上进行项目规划, 任务分配 5min 将需求文档上传至文档或 wiki 中, 便于项目组成员查阅 ; 将需求细化拆分, 划分迭代, 开发人员认领任务, 践行 Scrum 3. 在开发过程中使用做版本控制器, 管理代码 5min 从代码广场下载开源项目, 使用 Devcloud 的代码仓库管理项目代码内容以及版本 4. 使用代码检查减少代码安全漏洞, 规范开发人员编码习惯 3min 使用代码检查检查代码漏洞和不规范书写, 优化代码质量, 规范开发人员编码习惯, 为项目的长期稳定打下良好基础 5. 使用云上构建并管理构建包, 为部署做准备 3min 使用编译构建对代码进行打包, 并通过软件发布库保存历代构建包, 为部署功能做准备 6. 使用体验云端一键部署 2min 将公网可达的云主机添加到中, 使用部署功能进行云端一键部署, 将项目部署到测试环境, 查看交付效果 7. 云测帮助开发团队进行双向追溯, 鞭策开发提高代码质量 2min 测试项目是否有 Bug, 记录产品 Bug 并关联需求, 鞭策开发提高代码质量 8. 解放运维力量, 使用流水线定时自动化运维 3min 项目交付频率提高, 项目组成员总加班怎么办, 流水线通过自动化定时执行各种指定功能, 实现 DevOps, 解放运维力量 9. 利用仪表盘的直观图表数据进行 Scrum 迭代会议 1min 文档版本 03 ( ) 版权所有华为技术有限公司 5

11 3 Git on 3 Git on 3.1 目的 3.2 Git 概述 3.3 CodeHub 云端操作 3.4 Git 本地研发场景 3.5 Git 工作流 3.1 目的基于实践所编写, 用于帮助已经掌握或想要掌握 Git 的开发者, 更好的应用 Git, 以及更好的将 Git 与结合应用 3.2 Git 概述集中式版本控制系统从狭义上来说, 版本控制系统是软件项目开发过程中管理代码所有修订版本的软件, 能够存储追踪文件的修改历史, 记录多个版本的开发和维护, 事实上我们可以将任何对项目有帮助的文档交付版本控制系统进行管理版本控制系统 (Version Control Systems) 主要分为两类, 集中式和分布式集中式版本控制系统的特点是只有一台中央服务器, 存放着所有研发数据, 而其它客户端机器上保存的是中央服务器最新版本的文件快照, 不包括项目文件的变更历史所以, 每个相关人员工作开始前, 都需要从这台中央服务器同步最新版本, 才能开始工作, 如图 3-1 所示文档版本 03 ( ) 版权所有华为技术有限公司 7

13 3 Git on 表 3-1 集中式版本控制系统描述优点操作简单, 使用没有难度, 可轻松上手文件夹级权限控制, 权限控制粒度小对客户端配置要求不高, 无需存储全套代码缺点网络环境要求高, 相关人员必须联网才能工作中央服务器的单点故障影响全局, 如果服务器宕机, 所有人都无法工作中央服务器在没有备份的情况下, 磁盘一旦被损坏, 将丢失所有数据分布式版本控制系统分布式版本控制系统的特点是每个客户端都是代码仓库的完整镜像, 包括项目文件的变更历史所有数据分布的存储在每个客户端, 不存在中央服务器可能有人会问, 我们公司使用 Git 分布式存储工具, 也有中央服务器啊? 其实, 这个所谓的中央服务器仅仅是用来方便管理多人协作, 任何一台客户端都可以胜任它的工作, 它和所有客户端没有本质区别, 如图 3-3 所示文档版本 03 ( ) 版权所有华为技术有限公司 9

3 Git on 图 3-4 常见的分布式版本控制系统分布式版本控制系统的优点与缺点如表 3-2 所示表 3-2 分布式版本控制系统描述优点版本库本地化, 版本库的完整克隆, 包括标签分支版本记录等支持离线提交, 适合跨地域协同开发分支切换快速高效, 创建和销毁分支廉价缺点学习成本高, 不容易上手只能针对整个仓库创建分支, 无法根据目录建立层次性的分支 3.

15 3 Git on 图 3-4 常见的分布式版本控制系统分布式版本控制系统的优点与缺点如表 3-2 所示表 3-2 分布式版本控制系统描述优点版本库本地化, 版本库的完整克隆, 包括标签分支版本记录等支持离线提交, 适合跨地域协同开发分支切换快速高效, 创建和销毁分支廉价缺点学习成本高, 不容易上手只能针对整个仓库创建分支, 无法根据目录建立层次性的分支 3.3 CodeHub 云端操作云端仓库功能云端仓库功能支持新建仓库仓库克隆分支管理标签管理提交代码拉取代码推送代码代码阅读在线修改仓库成员管理密钥管理等, 更多仓库功能介绍请参见代码托管产品介绍新建空仓库 1. 在代码托管服务中, 单击上方新建仓库按钮, 如图 3-5 所示文档版本 03 ( ) 版权所有华为技术有限公司 11

运行 Git Bash, 在终端执行如下命令, 会将.ssh 文件夹下的 id_rsa.

16 3 Git on 图 3-5 代码托管 2. 配置新仓库的详细信息, 如图 3-6 所示图 3-6 配置新仓库 3. 保存仓库信息后, 新建成功的仓库如图 3-7 所示图 3-7 新建好的仓库本地生成 SSH 密钥并粘贴公钥到云端 1. 运行 Git Bash, 在终端执行如下命令, 会将.ssh 文件夹下的 id_rsa.pub 公钥内容 ( 加粗的字符串 ) 打印到终端, 拷贝这些字符串, 注意不要有多余的空格 $ cd ~/.ssh $ cat id_rsa.pub 文档版本 03 ( ) 版权所有华为技术有限公司 12

JNzgWwKgHb+gIsehsu0T8kUEVzwTB5uf6m1pzbWHuMlTcst+7NJFSCgVp46KZ4cOLSydUIO8NdEw

RoeXOUIaXWyi1vbfy7+NsDyLPn4OC6OCn8XLSJQcCwh5EQaU5ZwQ/

17 3 Git on ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC92RfP46IkGCux5RGUt6vsXcFxTvvEFHi152JEjzV7iO9J0uKBofJcowIt4gC6l JNzgWwKgHb+gIsehsu0T8kUEVzwTB5uf6m1pzbWHuMlTcst+7NJFSCgVp46KZ4cOLSydUIO8NdEw +6fsmDJxpD3gyGnKJftxCoMl5aUtx0zC3cKI3+LDYqbYnsRMQzBvpEife/JdF2fQKVpmYn2Vqlc7yoM+jp/ RoeXOUIaXWyi1vbfy7+NsDyLPn4OC6OCn8XLSJQcCwh5EQaU5ZwQ/ uxwkcleknsevtif9wfyiujcygxfqm0u4fecnb08iyihgzscklgixvufrmyyhtnqxlyp 2. 在代码托管服务中, 单击右上角的设置 SSH 密钥, 如图 3-8 所示图 3-8 设置 SSH 密钥 3. 继续单击右上角的添加 SSH 密钥, 如图 3-9 所示图 3-9 添加 SSH 密钥 4. 粘贴拷贝的公钥字符串, 添加标题, 单击新建, 如图 3-10 所示图 3-10 设置公钥字符串文档版本 03 ( ) 版权所有华为技术有限公司 13

4 Git 本地研发场景在云端已经创建了一个只包含 README 文件的空仓库, 然后架构师或者项目负责人需要把本地框架代码推送到这个空仓库, 最后, 其他开发人员将云端架构代码克隆到本地, 进行增量应用开发说明 Git 代码传输支持 SSH

18 3 Git on 从云端下载 HTTPS 密码到本地 1. 在 HTTPS 密码管理页面单击修改, 如图 3-11 所示图 3-11 修改 HTTPS 密码 2. 单击重置, 下载包含了用户名 / 密码的 txt 文档, 再将初始密码修改成方便记住的新密码, 如图 3-12 所示图 3-12 获取密码 3.4 Git 本地研发场景在云端已经创建了一个只包含 README 文件的空仓库, 然后架构师或者项目负责人需要把本地框架代码推送到这个空仓库, 最后, 其他开发人员将云端架构代码克隆到本地, 进行增量应用开发说明 Git 代码传输支持 SSH 和 HTTPS 两种传输协议, 本节基于 SSH 传输协议 ( 密钥对配置请参见本地生成 SSH 密钥并粘贴公钥到云端 ) 进行的操作如果想使用 HTTPS 方式, 直接下载 HTTPS 密码 ( 密码下载请参见从云端下载 HTTPS 密码到本地 ), 当克隆推送代码时直接输入 HTTPS 用户名密码即可同一仓库 SSH 和 HTTPS 的地址不同文档版本 03 ( ) 版权所有华为技术有限公司 14

19 3 Git on 推送架构代码 1. 打开本地框架代码, 确保根目录名 () 与云端创建的代码仓库名一致, 在根目录下右键打开 Git bash 终端, 如图 3-13 所示图 3-13 打开 Git bash 终端 2. 推送本地代码到云端在当前 Git Bash 终端依次输入如下命令 : a. 初始化本地代码仓库, 执行该命令后, 在 D:/code// 下多了一个.git 文件夹 $ git init b. 关联云端代码仓库 $ git remote add origin CodeHubUrl # 仓库地址 CodeHubUrl 如图 3-14 所示方法获取图 3-14 获取 SSH 地址 c. 推送代码到云仓库 $ git add. $ git commit -m init project $ git branch --set-upstream-to=origin/master master 文档版本 03 ( ) 版权所有华为技术有限公司 15

克隆仓库,URL 地址获取方法如图 3-16 所示 $ git clone CodeHubUrl // 将代码从远端仓库 clone 到本地图 3-16 获取 URL 地址代码提交

20 3 Git on $ git pull --rebase $ git push 克隆代码开发人员在本地准备克隆云端架构代码 1. 在准备把代码克隆到的目标文件夹下, 右键打开 Git bash 终端, 如图 3-15 所示图 3-15 打开 Git bash 终端 2. 克隆仓库,URL 地址获取方法如图 3-16 所示 $ git clone CodeHubUrl // 将代码从远端仓库 clone 到本地图 3-16 获取 URL 地址代码提交一次修改被成功提交到远端仓库会历经四个阶段 : 1 本地工作区 > 2 缓存区 > 3 版本库 > 4 远端版本库通过执行相应的 Git 命令, 文件在这四个区域跳转, 并呈现不同的状态, 如图 3-17 所示文档版本 03 ( ) 版权所有华为技术有限公司 16

21 3 Git on 图 3-17 代码仓库主要涉及如下三步操作 : 1. #git add/rm filename // 将新增修改或者删除的文件增加到暂存区 2. #git commit m commit message // 将已暂存的文件提交到本地仓库 3. #git push // 将本地代码仓库修改推送到远端仓库分支操作新建分支 Git 新建分支的本质就是创建一个指向最后一次提交的可变指针, 所以,Git 分支的创建不是复制版本库的内容, 仅仅是新建了一个指针, 它以 40 个字符长度 SHA-1 字串形式保存在文件中 #git branch branchname commitid 基于 commitid 即某一个全球版本号拉出新分支, 如果没有 commitid 则基于当前分支的 HEAD 拉出新分支例如, 新建 feature 分支, 执行的命令为 git branch feature, 如图 3-18 所示图 3-18 新建分支文档版本 03 ( ) 版权所有华为技术有限公司 17

22 3 Git on 切换分支命令如下 #git checkout branchname 例如, 切换到 feature 分支, 执行的命令为 git checkout feature, 如图 3-19 所示图 3-19 切换分支分支合并无论哪种工作流都会涉及到分支合并 ( 把一个分支中的修改整合到当前分支 ), 主要有两种方法 : 三方合并 (merge) 和衍合 (rebase) 通过对同一种场景进行不同操作体会两种合并方法的区别场景 :master 分支新增了 C4 节点, hotfix 分支新增了 C3 节点, 现将 hotfix 分支合并到 master 分支 : a. 三方包括 hotfix 新增节点 C3,master 新增节点 C4, 以及两者的共同祖先节点 C2 这种合并操作简单, 但新增合并节点 C5, 形成了环形, 版本记录可读性差, 如图 3-20 所示 #git checkout master #git merge hotfix 图 3-20 三方合并结果 b. 衍合先将 master 分支新增节点 C4 以补丁形式保存在.git/rebase 目录中, 然后同步 hotfix 分支最新代码, 再应用补丁 C4, 如图 3-21 所示文档版本 03 ( ) 版权所有华为技术有限公司 18

确认哪个名字是正确的, 删除错误的 ii. 提交修改 3.5 Git 工作流 3.5.1 Git 工作流概述什么是 Git 工作流?

23 3 Git on #git checkout master #git rebase hotfix 图 3-21 衍合结果冲突解决 a. 场景一 : 两个合并分支修改了同一行代码解决方法 : i. 分析哪种修改方法正确, 手动合并 ii. 提交修改 b. 场景二 : 文件被重命名为不同的名字解决方法 : i. 确认哪个名字是正确的, 删除错误的 ii. 提交修改 3.5 Git 工作流 Git 工作流概述什么是 Git 工作流? 你可以理解为代码管理的分支策略, 它不仅仅是版本管理范畴, 更服务于项目流程管理和团队协同开发所以, 有必要制定适合自己研发场景的工作流下面介绍四种工作流的工作方式优缺点, 以及使用中的一些注意事项集中式工作流功能分支工作流文档版本 03 ( ) 版权所有华为技术有限公司 19

3 Git on Gitflow 工作流 (Devcloud 推荐 ) Forking 工作流 3.5.

24 3 Git on Gitflow 工作流 (Devcloud 推荐 ) Forking 工作流集中式工作流工作方式优点研发团队可以根据实际研发场景制定合理的工作流, 能有效提高项目管理水平和团队协同开发能力, 并通过华为软件开发云 CodeHub 平台, 高效安全的管理代码资产, 将更多的精力集中在业务开发上, 实现持续集成持续交付和快速迭代的目标集中式工作流适合 5 人左右小开发团队, 或是刚从 SVN 工具转型为 Git 的团队, 它只有一个默认的 maste 分支 ( 相当于 svn 的 trunk 主分支 ), 所有人的修改都是在 master 分支上进行的但是, 这种工作流无法充分发挥 git 优势和多人协同, 不推荐使用开发人员将 master 分支从中央仓库克隆到本地, 修改完成后再推送回中央仓库 master 分支不涉及分支交互操作缺点不适合人员较多的团队, 当人员 10+ 时, 解决开发人员之间的代码冲突会耗费很多时间 master 分支提交频繁 master 分支不稳定, 不利于集成测试 Tips: 如何尽量避免产生冲突和不合理的提交历史? 开发人员在开发一个新功能之前, 一定要在本地同步中央仓库最新代码, 使自己的工作基于最新的代码之上 ; 开发完成后, 在提交新功能到中央仓库前, 需要先 fetch 中央库的新增提交, 并 rebase 自己的提交这样做的目的是, 把自己的修改加到中央仓别人已经提交的修改之上, 使最终的提交记录是一个完美的线性历史, 而不是环形, 如图 3-22 所示图 3-22 工作流举例文档版本 03 ( ) 版权所有华为技术有限公司 20

3 Git on 3.5.3 功能分支工作流工作方式 1. 开发人员 A 和开发人员 B 同时在某个时间拉取了中央仓库的代码 2. 开发人员 A 先完成了自己的工作, 并提交到中央仓库 3. 开发人员 B 需要在本地执行 git pull rebase 中央仓库的新提交, 这时开发人员 B 的本地仓库就包含了开发人员 A 修改的内容, 并在 A 的基础上增加了自己的修改 4.

25 3 Git on 功能分支工作流工作方式 1. 开发人员 A 和开发人员 B 同时在某个时间拉取了中央仓库的代码 2. 开发人员 A 先完成了自己的工作, 并提交到中央仓库 3. 开发人员 B 需要在本地执行 git pull rebase 中央仓库的新提交, 这时开发人员 B 的本地仓库就包含了开发人员 A 修改的内容, 并在 A 的基础上增加了自己的修改 4. 开发人员 B 将代码推送到中央仓库通过新建几个功能分支, 增加开发者的交流和协作, 它的理念是所有的功能开发都应该在 master 分支外的一个独立分支进行, 这种方式隔离了开发者的工作空间不被互相干扰, 保证了 master 分支的稳定性开发人员每次在开始新功能开发前, 需要在 master 分支上拉取一个新分支, 并起个有描述性的名字, 比如 video-output 或 issue-#1061, 这样可以让分支用途明确功能分支不但存在开发人员本地仓库, 也应该推送到中央仓库, 这样就可以在代码不合入 master 分支的情况下与其他开发人员分享代码优点分支合并前可以使用 pull request 进行 code review 降低了 master 分支的提交频率缺点 Gitflow 工作流只有一个 master 分支作为集成, 仍然不是很稳定, 不适合大型开发 Gitflow 一般用于管理大型项目, 它为不同的分支分配一个很明确的工作角色, 并定义分支之间什么时候进行交互, 如图 3-23 所示图 3-23 Gitflow 工作流文档版本 03 ( ) 版权所有华为技术有限公司 21

3 Git on 工作方式 master 分支 : 生产分支, 最稳定的版本, 一直是 ready to deploy 状态不接受开发人员直接 commit, 只接受从其他分支 merge 操作在很多企业中, 这个分支被默认开启分支保护, 只有维护者可以操作 hotfix 分支 : 从 master 分支拉取的临时修复分支, 用于解决一线紧急 bug bug 解决后需要合入 master

26 3 Git on 工作方式 master 分支 : 生产分支, 最稳定的版本, 一直是 ready to deploy 状态不接受开发人员直接 commit, 只接受从其他分支 merge 操作在很多企业中, 这个分支被默认开启分支保护, 只有维护者可以操作 hotfix 分支 : 从 master 分支拉取的临时修复分支, 用于解决一线紧急 bug bug 解决后需要合入 master 分支并打上新的版本号, 这个修改也需要同时合入 develop 分支 develop 分支 : 从 master 分支拉取的开发分支, 用于功能集成包含所有要发布到下一个 Release 的代码用于开发集成系统测试 release 分支 : 临近既定的发布日, 就从 develop 分支上拉取一个 release 分支, 任何不在当前分支中的新功能都推到下个发布中 release 分支用于发布, 所以从当前时间点之后新的功能不能再加到这个分支上, 这个分支只做 Bug 修复文档生成和其它面向发布的任务当对外发布的工作都完成了,release 分支合并到 master 分支并分配一个版本号打好 Tag; 另外, 这些从 release 分支新做的修改要反向合并回 develop 分支 feature 分支 : 开发者使用的特性分支, 父分支是 develop 分支, 当新功能完成时, 合入 develop 分支新功能提交从不直接与 master 分支交互开发人员提交新功能的两种途径 : 团队有专人 review 审核新功能 a. 开发人员将 feature 分支推送到华为软件开发云代码托管平台 ( 中央仓库 ) b. 发起一个从 feature 分支合并到 develop 分支的合并请求, 并指给 review 专员说明代码托管中支持合并请求功能, 直接选择源和目的分支, 仓库管理员 ( 项目经理创建仓库的开发人员被给予仓库管理权限的开发人员 ) 有权限接受此合并请求 c. review 专员 ( 上图中的 developere) 审核如果通过, 将 feature 分支的新功能合并到 develop 分支, 并删除 feature 分支 ; 如果未通过, 拒绝该请求并注明拒绝原因文档版本 03 ( ) 版权所有华为技术有限公司 22

27 3 Git on 开发人员自审核新功能 a. 开发人员在本地仓库将 feature 分支合并到 develop 分支, 并删除 feature 分支 b. 将本地 develop 分支的修改推送到华为软件开发云代码托管平台 ( 中央仓库 ) 优点缺点使用一个用于发布准备的专门分支 (release 分支 ), 使得一个团队可以在完善当前的发布版本的同时, 可以在 develop 分支并行继续开发下个版本的功能这也打造了可视化的发布阶段, 团队成员都可以在仓库网状结构中可以看到发布状态使用紧急修复分支 (hotfix 分支 ) 让团队可以处理紧急问题的同时而不打断其它工作或是等待下一个发布再合入 hotfix 修改我们可以把 hotfix 分支想成是一个直接在 master 分支上处理的临时发布大型项目人员协作频繁, 流程较多, 合理的多角色分支帮助研发有条不紊进行更符合 devops 理念学习成本较高如果团队不遵守使用约定, 带来的影响更大 Forking 工作流 Forking 工作流区别于前三种工作流的最大特点是每个开发人员都有一个从公共仓库 fork 出来的属于自己的公共仓 Forking 工作流适合外包众包以及众创和开源场景接包方的开发人员从项目公共仓 fork 自己的公共仓库进行操作, 并不需要被项目公共仓直接授权, 如图 3-24 所示文档版本 03 ( ) 版权所有华为技术有限公司 23

3 Git on 图 3-24 Forking 工作流工作方式 1. 将项目公共仓 fork 出一个个人公共仓 2. 将个人公共仓 clone 到本地仓库 3. 操作本地仓库, 修改完成后提交到个人公共仓 4. 为个人公共仓提交一个 pull request 给项目维护者, 申请代码合入项目公共仓 5.

28 3 Git on 图 3-24 Forking 工作流工作方式 1. 将项目公共仓 fork 出一个个人公共仓 2. 将个人公共仓 clone 到本地仓库 3. 操作本地仓库, 修改完成后提交到个人公共仓 4. 为个人公共仓提交一个 pull request 给项目维护者, 申请代码合入项目公共仓 5. 项目维护者在本地 review 验证本地提交, 审核通过后 push 进入项目公共仓说明如果开发人员 A 的代码未被审核通过合入公共仓库, 而此代码对开发人员 B 有借鉴作用, 开发人员 B 可以直接从开发人员 A 的个人公共仓拉取代码优点开发人员之间若需要代码协作, 可以直接从其他人的个人公共仓拉取, 无需等到代码提交到项目公共仓项目公共仓无需为每个代码贡献者授权项目维护者通过审核 pull request 成为代码安全的重要防线仓库分支的选择可以根据项目实际情况综合使用前三种工作流缺点提交开发人员代码到最终版本库的周期较长, 步骤繁琐文档版本 03 ( ) 版权所有华为技术有限公司 24

29 4 Docker on 4 Docker on 4.1 目的 4.2 Docker 概述 4.3 环境准备 4.4 研发场景 4.5 代码管理场景 4.6 代码质量评估场景 4.7 持续交付 (CI/CD) 场景 4.1 目的基于实践所编写, 用于帮助想要或者正在使用容器部署服务的用户, 如何将他们的应用部署通过部署在华为云上 4.2 Docker 概述 Docker 是一个开源的引擎, 可以轻松的为任何应用创建一个轻量级的可移植的自给自足的容器开发者在笔记本上编译测试通过的容器可以批量地在生产环境中部署, 包括 VMs( 虚拟机 ) bare metal OpenStack 集群和其他的基础应用平台 Docker 相关服务介绍请参见 : 微服务云应用平台 (ServiceStage) 弹性云服务器 (Elastic Cloud Server) 4.3 环境准备工程初始化文件数据库以及数据初始化脚本 ( 本文是 mysql 和 bootdo.sql) 文档版本 03 ( ) 版权所有华为技术有限公司 25

30 4 Docker on 应用程序中间件以及工程源代码 ( 本文是 jdk 和 bootdo) 创建代码仓库 1. 进入项目后, 单击左侧菜单栏代码 > 代码仓库, 然后单击新建仓库, 进入新建代码仓库页面, 如图 4-1 所示图 4-1 新建代码仓库 2. 创建仓库后通过 git 客户端将工程源码上传到代码仓库中 Dockerfile Dockerfile 的作用是 : 根据业务需要将需要的运行环境与中间件以及程序包加入到镜像中 1. 首先制作 Dockerfile 文件, 本文用的是 ubuntu 官方镜像, 如下 : # 选择 ubuntu 最小镜像 FROM ubuntu # 制作者 MAINTAINER by lilong # 创建 jdk 路径 RUN mkdir -p /opt/jdk # 创建工程路径 RUN mkdir -p /opt/bootdo # 拷贝 jdk 到容器 COPY jdk-8u77-linux-x64.tar.gz /opt/jdk # 软件包到容器 COPY target/bootdo-docker jar /opt/bootdo # 拷贝启动脚本 COPY run.sh /opt/bootdo 文档版本 03 ( ) 版权所有华为技术有限公司 26

4 Docker on # 设置启动脚本可执行权限 RUN chmod 700 /opt/bootdo/run.sh # 安装 jdk RUN tar xzf /opt/jdk/jdk-8u77-linux-x64.tar.gz -C /opt/jdk && rm -rf /opt/jdk/jdk-8u77-linuxx64.tar.gz # 设置环境变量 ENV JAVA_HOME /opt/jdk/jdk1.

31 4 Docker on # 设置启动脚本可执行权限 RUN chmod 700 /opt/bootdo/run.sh # 安装 jdk RUN tar xzf /opt/jdk/jdk-8u77-linux-x64.tar.gz -C /opt/jdk && rm -rf /opt/jdk/jdk-8u77-linuxx64.tar.gz # 设置环境变量 ENV JAVA_HOME /opt/jdk/jdk1.8.0_77 ENV PATH $PATH:$JAVA_HOME/bin # 开放 8080 端口 EXPOSE 8080 # 设置容器启动时执行 CMD ["/opt/bootdo/run.sh"] 2. 然后将这个 Dockerfile 上传到工程的根目录下, 工程源码即准备完成, 如图 4-2 所示图 4-2 工程根目录 Servicestage 集群 1. 创建 Servicestage 集群, 在华为云官方网站产品列表中选择微服务云应用平台, 单击立即使用, 然后选择资源管理, 单击新建, 如图 4-3 所示文档版本 03 ( ) 版权所有华为技术有限公司 27

32 4 Docker on 图 4-3 创建集群 2. 设置好基本信息后单击下一步, 选择集群配置后单击立即购买, 如图 4-4 所示图 4-4 当前配置 3. 购买后等待 5 到 10 分钟即可创建完成, 至此即准备好了 servicestage 集群 Docker 镜像准备完 servicestage 集群后, 就可以上传基础镜像 ( 工程需要用的 mysql 数据库 ) ubuntu 的镜像, 上传方式如下 : sudo docker login -u cn-north-1@nmtsmjl7qbmm9iuaq9mq -p 85b1a ca ded6c5742e3f73ffbece85bb5acb87c5f3 swr.cnnorth-1.myhuaweicloud.com/ll-org/mysql sudo docker tag mysql swr.cn-north-1.myhuaweicloud.com/ll-org/mysql sudo docker push swr.cn-north-1.myhuaweicloud.com/ll-org/mysql 上传成功后, 已上传的镜像显示在如图 4-5 所示的位置文档版本 03 ( ) 版权所有华为技术有限公司 28

33 4 Docker on 图 4-5 我的镜像搭建数据库服务通过 servicestage 集群来创建数据库服务 1. 在 servicestage 控制台的左侧菜单中单击应用管理, 然后单击新建应用, 如所示图 4-6 选择部署方式 2. 选择容器应用后进入详情页面, 如图 4-7 所示图 4-7 创建容器应用 3. 设置完基本信息后单击下一步, 进入选择镜像弹出框, 如图 4-8 所示文档版本 03 ( ) 版权所有华为技术有限公司 29

34 4 Docker on 图 4-8 选择镜像 4. 选择之前上传的 mysql 镜像后, 单击确定, 进入下一项设置, 如图 4-9 所示根据需要选择容器的配置, 然后展开高级设置, 在环境变量页签添加 mysql 的 root 密码. 图 4-9 信息设置 5. 切换到存储页签, 根据需要设置 mysql 的数据文件在主机的存储位置, 如 /root/ update/mysql/datadir, 如图 4-10 所示图 4-10 存储 6. 也可以自行设置, 如图 4-11 所示文档版本 03 ( ) 版权所有华为技术有限公司 30

这个应用为数据库服务, 不需要外网访问, 所以访问类型可以选择内部服务 ( 后面的 jar 将要选择外部服务了 ) 配置好端口的映射关系后单击下一步服务即可在 1-5

35 4 Docker on 图 4-11 命令设置登录主机后创建需要的目录, 命令如下 : mkdir -p /root/update/mysql/datadir 7. 配置完成后单击下一步配置访问方式, 如图 4-12 所示图 4-12 创建 mysql 应用 8. 这个应用为数据库服务, 不需要外网访问, 所以访问类型可以选择内部服务 ( 后面的 jar 将要选择外部服务了 ) 配置好端口的映射关系后单击下一步服务即可在 1-5 分钟内创建完成, 如图 4-13 所示图 4-13 访问方式 9. 进入到主机的 mysql/datadir 目录下, 即可看到我们之前通过 docker push 上传的数据信息, 如图 4-14 所示文档版本 03 ( ) 版权所有华为技术有限公司 31

4 Docker on 图 4-14 datadir 目录 10. 验证一下数据库服务是否成功 Telnet 10.247.242.

项目简介 : 实现了博客论文的在线预览以及后台运维能工作 3. 项目类型 :Java+mysql+h5 的 B/S 架构的 web 项目 4. 开发环境 :IDEA,VSCODE 5. 部署环境 :ubuntu16.

36 4 Docker on 图 4-14 datadir 目录 10. 验证一下数据库服务是否成功 Telnet 至此, 数据库服务已经搭建完成, 可通过 servicestage 控制台进行快速的停起更新与扩容操作 4.4 研发场景示例项目 1. 项目名称 :bootdo blog 2. 项目简介 : 实现了博客论文的在线预览以及后台运维能工作 3. 项目类型 :Java+mysql+h5 的 B/S 架构的 web 项目 4. 开发环境 :IDEA,VSCODE 5. 部署环境 :ubuntu mysql 6. 部署方式 :docker 容器 +devcloud+servicestage 集群通用客户场景目前软件开发过程中会使用一些免费或者付费工具帮助我们更高效地进行软件开发, 如图 4-15 所示图 4-15 研发场景和工具文档版本 03 ( ) 版权所有华为技术有限公司 32

37 4 Docker on 华为云服务方案总览当前还存在以下缺点 : 每个项目参与者必须同时使用多种工具, 导致工作遗漏和不能及时更新安装类型的工具会面临版本更新升级的问题运维人员在系统发布时环境搭建难度大, 准备工作比较多, 容易出现纰漏导致系统不能顺利发布开发测试运维之间相互隔离, 发现问题不能及时定位为软件开发者提供即开即用的一站式云端 DevOps 平台, 包括项目管理代码托管代码检查云端构建发布部署流水线在内的端到端的软件开发工具, 从各个环节提升软件产品的交付质量和速度另外, 华为云还为您提供丰富多彩的云计算产品, 如图 4-16 所示图 4-16 华为云服务 4.5 代码管理场景提供基于 Git 的代码托管仓库, 仓库提供可视化的管理界面, 软件开发者可将自己的软件工程代码上传到此仓库中进行代码托管代码同步 1. 进入代码托管首页, 单击设置 SSH 密钥, 进入 SSH 密钥管理页面, 如图 4-17 所示文档版本 03 ( ) 版权所有华为技术有限公司 33

密钥帮助文档说明生成对应密钥输入标题, 将生成公钥粘贴到密钥文本框里, 单击新建, 即完成了 SSH 密钥的添加 3.

38 4 Docker on 图 4-17 SSH 密钥管理 2. 单击添加 SSH 密钥, 进入添加 SSH 密钥界面, 如图 4-18 所示图 4-18 添加 SSH 密钥说明根据界面下方 SSH 密钥帮助文档说明生成对应密钥输入标题, 将生成公钥粘贴到密钥文本框里, 单击新建, 即完成了 SSH 密钥的添加 3. 在代码托管首页, 单击新建仓库, 进入新建代码仓库界面, 如图 4-19 所示选择普通新建, 输入代码仓库名称及描述, 单击确认即创建了一个空的云端代码仓库文档版本 03 ( ) 版权所有华为技术有限公司 34

4 Docker on 图 4-19 新建代码仓库 4. 创建好的代码仓库展示在首页的代码仓库列表, 如图 4-20 所示图 4-20 仓库列表 5. 单击代码仓库对应的 SSH, 复制仓库 SSH 地址, 将代码仓库克隆岛本地 $ git clone git@codehub.devcloud.huaweicloud.

39 4 Docker on 图 4-19 新建代码仓库 4. 创建好的代码仓库展示在首页的代码仓库列表, 如图 4-20 所示图 4-20 仓库列表 5. 单击代码仓库对应的 SSH, 复制仓库 SSH 地址, 将代码仓库克隆岛本地 $ git clone git@codehub.devcloud.huaweicloud.com:00de687ca8da4a5d8bcf7f5b55969c30/bootdodocker.git 6. 然后进行项目代码的开发 ( 本文采用的是开源的 Demo 代码 ) 7. 将代码提交推送到云端仓库 $ git add * $ git commit -m "init" $ git push origin master 代码仓库在代码托管首页面单击创建的代码仓库, 可以进入到仓库详情页面, 支持文件在线编辑仓库提交记录代码贡献度统计等多种功能, 满足各类开发者的需求, 如图 4-21 所示文档版本 03 ( ) 版权所有华为技术有限公司 35

40 4 Docker on 图 4-21 仓库详情 4.6 代码质量评估场景在线进行代码静态检查代码架构检查代码安全检查编码问题检查质量评分代码缺陷改进趋势分析, 辅助用户管控代码质量代码质量检查方法如下 : 1. 进入代码检查首页, 在任务页面可以看到项目下的代码检查任务, 如图 4-22 所示图 4-22 任务 2. 单击新建任务, 进入新建代码检查任务页面, 如图 4-23 所示配置相关信息, 选择需要检查的代码仓库地址, 选择想要检查出的严重问题规则集等文档版本 03 ( ) 版权所有华为技术有限公司 36

41 4 Docker on 图 4-23 新建任务 3. 信息配置完成后单击确定, 任务创建完成 4. 单击创建好的任务名称, 进入代码检查详情页面单击启动任务, 任务进入检查中状态, 并动态显示检查进度, 如图 4-24 所示图 4-24 检查进度代码质量评估报告代码检查任务执行结束后, 会生成详细的代码质量报告, 评估代码质量, 如图 4-25 所示文档版本 03 ( ) 版权所有华为技术有限公司 37

修改完毕后, 再次执行代码检查任务, 查看任务执行结果, 形成代码质量改进闭环, 如图

43 4 Docker on 4.7 持续交付 (CI/CD) 场景编译构建步骤 1 在项目下单击左侧构建 & 发布 > 编译, 单击新建任务, 如图 4-27 所示图 4-27 编译构建步骤 2 进入新建任务基本信息页面, 根据需要配置相关信息, 如图 4-28 所示图 4-28 基本信息步骤 3 单击下一步, 进入代码配置页面, 如图 4-29 所示文档版本 03 ( ) 版权所有华为技术有限公司 39

45 4 Docker on 图 4-31 构建执行配置说明 dockerfile 位置 : 指的是我们之前在代码仓库中上传的 dockerfile 的相对路径./Dockerfile, devcloud 会根据这个文件创建出用户需要的 docker 镜像, 并且将工程包上传到用户在 dockerfile 中指定的位置步骤 6 步骤 7 单击下一步, 选择执行计划后开始编译编译成功后会在软件发布仓库下生成一个软件包, 可以手动下载, 还会在 servicestage 中的软件中心 - 镜像仓库下生成我们需要的 docker 镜像, 该镜像就是 devcloud 根据 dockerfile 以及代码编译后的程序包自动生成的镜像, 可用于容器部署, 如图 4-32 所示图 4-32 镜像仓库 ---- 结束发布软件仓库提供 4 种类型的发布仓库, 前两种是远程 Maven 私仓, 用于 Maven 类型构建过程中第三方依赖包的的管理第三个仓库是 mirror 镜像仓, 镜像了一些构建过程中经常以来的中央仓到后台, 提升构建速度, 体现云端构建的优势我们本次 demo 中应用最后一个编译构建仓库, 作为生成的软件包的版本归档管理仓库文档版本 03 ( ) 版权所有华为技术有限公司 41

部署, 进入部署任务页面, 如图 4-34 所示图 4-34 部署任务步骤 2 单击新建任务, 进入创建部署任务页面填写基本信息, 如图 4-35 所示图 4-35 基本信息步骤

46 4 Docker on 版本管理和下载由于在构建任务里配置了上传到发布仓库步骤, 每次构建结束后, 可以在发布仓库里就会新增一个本次构建生成的软件包, 实现软件版本的自动管理在配置部署任务时就可以在这里选择要部署的软件包文件了这里支持将某次构建的软件包下载到本地, 如图 4-33 所示图 4-33 发布仓库部署步骤 1 在项目下单击左侧构建 & 发布 > 部署, 进入部署任务页面, 如图 4-34 所示图 4-34 部署任务步骤 2 单击新建任务, 进入创建部署任务页面填写基本信息, 如图 4-35 所示图 4-35 基本信息步骤 3 选择容器部署, 选择已创建的 servicestage 集群, 根据需要填写实例的数量, 然后在下方选择已生成的镜像, 如图 4-36 所示文档版本 03 ( ) 版权所有华为技术有限公司 42

进入部署详情页面, 如图 4-38 所示图 4-38 部署详情页面展示了部署的步骤和时间等信息,

47 4 Docker on 图 4-36 容器配置步骤 4 选择访问方式 ( 发布为服务 ), 容器内端口映射为 8080 to 30000, 如图 4-37 所示图 4-37 设置访问方式步骤 5 单击确定后执行部署任务, 执行完成后, 进入部署详情页面, 如图 4-38 所示图 4-38 部署详情页面展示了部署的步骤和时间等信息, 可以通过浏览器访问应用验证路径验证应用是否正常响应, 如图 4-39 所示文档版本 03 ( ) 版权所有华为技术有限公司 43

4 Docker on 图 4-39 验证应用步骤 6 登录验证数据库是否正常响应, 如图

也是测试计划设计形成的一个过程, 测试环节就针对每个需求设计测试用例即可用例管理用例管理页面可以对已经创建的测试用例进行管理, 可以将用例关联到具体的需求或者针对需求设计测试用例, 提交

49 4 Docker on 图 4-41 一键执行流水线将需要的任务添加进流水线中, 并运行流水线, 如图 4-42 所示图 4-42 运行流水线测试云测 (CloudTest) 是面向软件开发者提供的一站式测试解决方案, 覆盖测试管理接口测试, 多维度评估产品质量, 帮助高效管理测试活动, 保障产品高质量交付测试计划在项目规划阶段将整个项目细化成一个个具体的需求, 也是测试计划设计形成的一个过程, 测试环节就针对每个需求设计测试用例即可用例管理用例管理页面可以对已经创建的测试用例进行管理, 可以将用例关联到具体的需求或者针对需求设计测试用例, 提交 bug 时就能够直接将 bug 指给需求负责人, 实现需求 - 用例 - 缺陷的双向追溯, 如图 4-43 所示图 4-43 用例管理文档版本 03 ( ) 版权所有华为技术有限公司 45

50 4 Docker on 设计与验收设计与验收界面, 可以在这里根据需求设计测试用例, 以及查看用例执行情况和验收报告, 如图 4-44 所示图 4-44 设计与验收测试总览包括需求覆盖率缺陷用例通过率用例完成率缺陷分布用例进展需求测试进度成员用例进展和缺陷等, 如图 4-45 所示图 4-45 测试总览至此, 软件开发云各服务已拉通, 完成了 docker 部署环境的搭建文档版本 03 ( ) 版权所有华为技术有限公司 46

57 11 附录 11 附录视频教程新手训练营几分钟教你掌握各个服务基本操作项目管理代码托管流水线代码检查编译构建云测部署发布云途进阶课场景化教学, 从实战中玩转 Web 应用场景开发一套 EHR 系统 : 规划阶段开发阶段交付阶段 App 应用场景打造一款趣味交友 App: 规划阶段开发阶段交付阶段迁移上云秘籍从 SVN 迁移到 GIT 最强指南为何选择 Git 版本控制系统 Git 的工作模式如何将本地代码提交到托管平台文档版本 03 ( ) 版权所有华为技术有限公司 53