代碼中的軟件工程

第 一篇 工欲善其事，必先利其器
第 1 章 編程“神器”Visual Studio Code 2
1．1 Visual Studio Code 的安裝和基本用法 2
1．1．1 下載和安裝Visual Studio Code 2
1．1．2 VS Code 界面概覽 2
1．1．3 VS Code 的基本配置 3
1．1．4 VS Code 的基本用法 3
1．2 VS Code 為什么能這么牛 4
1．2．1 簡(jiǎn)潔而聚焦的產(chǎn)品定位貫穿始終 4
1．2．2 進(jìn)程隔離的插件模型是“定海神針” 5
1．2．3 代碼理解和調(diào)試——LSP 和DAP 兩大協(xié)議“厥功至偉” 6
1．2．4 集大成的VS Code 遠(yuǎn)程開(kāi)發(fā)環(huán)境 8
1．3 基于VS Code 的C/C++開(kāi)發(fā)調(diào)試環(huán)境配置 9
1．3．1 安裝C/C++插件 9
1．3．2 安裝C/C++編譯器和調(diào)試器 10
1．3．3 配置Visual Studio Code 構(gòu)建任務(wù) 11
1．3．4 配置Visual Studio Code 調(diào)試環(huán)境 12
1．4 VS Code 遠(yuǎn)程開(kāi)發(fā)環(huán)境配置 13
1．4．1 VS Code 遠(yuǎn)程開(kāi)發(fā)環(huán)境概述 13
1．4．2 VS Code 遠(yuǎn)程開(kāi)發(fā)環(huán)境Remote-SSH 配置 15
1．4．3 VS Code 遠(yuǎn)程開(kāi)發(fā)環(huán)境Web Remote-code-server 配置 20
本章練習(xí) 21
第 2 章 五大場(chǎng)景玩轉(zhuǎn)Git 22
2．1 Git 分布式版本控制系統(tǒng) 22
2．1．1 版本控制概述 22
2．1．2 Git 的歷史 22
2．1．3 Git 的基本操作 23
2．2 場(chǎng)景一：Git 本地版本庫(kù)的基本用法 25
2．2．1 安裝Git 25
2．2．2 初始化一個(gè)本地版本庫(kù) 25
2．2．3 查看當(dāng)前工作區(qū)的狀態(tài) 26
2．2．4 暫存更改的文件 27
2．2．5 把暫存區(qū)里的文件提交到倉(cāng)庫(kù) 28
2．2．6 Git 本地版本庫(kù)的基本用法參考 30
2．3 場(chǎng)景二：Git 遠(yuǎn)程版本庫(kù)的基本用法 31
2．3．1 克隆遠(yuǎn)程版本庫(kù) 31
2．3．2 遠(yuǎn)程版本庫(kù)的基本命令簡(jiǎn)介 31
2．3．3 Git 遠(yuǎn)程版本庫(kù)的基本用法參考 32
2．4 Git 背后的設(shè)計(jì)理念 34
2．5 場(chǎng)景三：團(tuán)隊(duì)項(xiàng)目中的分叉合并 36
2．5．1 團(tuán)隊(duì)項(xiàng)目的一個(gè)參考工作流程 36
2．5．2 分支的基本用法 36
2．5．3 團(tuán)隊(duì)項(xiàng)目工作流程參考 39
2．6 場(chǎng)景四：Git Rebase 整理提交記錄 40
2．7 場(chǎng)景五：Fork + Pull request 開(kāi)發(fā)工作流程 43
本章練習(xí) 46
第3 章 正則表達(dá)式十步通關(guān) 48
3．1 為什么使用正則表達(dá)式 48
3．2 第 一關(guān)：基本的字符串搜索方法 49
3．3 第二關(guān)：同時(shí)搜索多個(gè)字符串的方法 50
3．4 第三關(guān)：在匹配字符串時(shí)的大小寫(xiě)問(wèn)題 50
3．5 第四關(guān)：通配符的基本用法 51
3．6 第五關(guān)：匹配具有多種可能性的字符集 52
3．7 第六關(guān)：貪婪匹配和懶惰匹配 53
3．8 第七關(guān)：一些特殊位置和特殊字符 53
3．9 第八關(guān)：使用捕獲組復(fù)用模式 54
3．10 第九關(guān)：基本的字符串搜索替換方法 54
3．11 第十關(guān)：在替換中使用捕獲組復(fù)用模式 55
本章練習(xí) 56

第二篇 工程化編程實(shí)戰(zhàn)
第4 章 簡(jiǎn)約而不簡(jiǎn)單——代碼規(guī)范和代碼風(fēng)格 58
4．1 實(shí)驗(yàn)項(xiàng)目介紹 58
4．2 代碼風(fēng)格的原則：簡(jiǎn)明、易讀、無(wú)二義性 61
4．3 編寫(xiě)高質(zhì)量代碼的基本方法 66
4．3．1 通過(guò)控制結(jié)構(gòu)簡(jiǎn)化代碼 66
4．3．2 通過(guò)數(shù)據(jù)結(jié)構(gòu)簡(jiǎn)化代碼 67
4．3．3 一定要有錯(cuò)誤處理 68
4．3．4 性能優(yōu)先策略背后隱藏的代價(jià) 68
4．3．5 拒絕修修補(bǔ)補(bǔ)，要不斷重構(gòu)代碼 69
4．3．6 編碼過(guò)程中的團(tuán)隊(duì)合作 69
本章練習(xí) 69
第5 章 模塊化軟件設(shè)計(jì) 71
5．1 模塊化思想背后的基本原理 71
5．2 模塊化代碼的基本寫(xiě)法舉例 72
5．3 傳統(tǒng)單體集中式架構(gòu)與微服務(wù)架構(gòu) 78
5．4 模塊化軟件設(shè)計(jì)中的基本方法 80
5．4．1 KISS 原則 80
5．4．2 使用本地化外部接口來(lái)提高代碼的適應(yīng)能力 80
5．4．3 保持設(shè)計(jì)結(jié)構(gòu)和代碼結(jié)構(gòu)的一致性 81
本章練習(xí) 81
第6 章 可復(fù)用軟件設(shè)計(jì) 83
6．1 消費(fèi)者復(fù)用和生產(chǎn)者復(fù)用 83
6．2 接口的基本概念 83
6．2．1 軟件模塊接口舉例 84
6．2．2 微服務(wù)接口舉例 86
6．2．3 接口與耦合度之間的關(guān)系 88
6．2．4 同步接口和異步接口 88
6．3 可復(fù)用軟件模塊的接口設(shè)計(jì)示例 89
6．3．1 通用LinkTable 模塊的接口設(shè)計(jì) 89
6．3．2 給LinkTable 增加Callback 方式的接口 95
6．3．3 進(jìn)一步改進(jìn)LinkTable 的Callback 方式的接口 97
6．4 通用接口定義的基本方法 99
6．4．1 參數(shù)化上下文 99
6．4．2 移除前置條件 99
6．4．3 簡(jiǎn)化后置條件 100
本章練習(xí) 100
第7 章 可重入函數(shù)與線程安全 103
7．1 線程的基本概念 103
7．2 函數(shù)調(diào)用堆棧 103
7．3 可重入函數(shù) 105
7．4 什么是線程安全 106
7．5 LinkTable 軟件模塊的線程安全分析 108
本章練習(xí) 112
第8 章 子系統(tǒng)的工程化 113
8．1 menu 子系統(tǒng)的可復(fù)用接口設(shè)計(jì) 113
8．2 Makefile 工程文件舉例 116
8．3 帶參數(shù)的復(fù)雜命令函數(shù)接口的寫(xiě)法 117
8．4 看待軟件質(zhì)量的幾個(gè)不同角度 118
8．5 編程的基本方法和原則 119
本章練習(xí) 120

第三篇 需求分析和軟件設(shè)計(jì)
第9 章 獲取需求的主要方法 122
9．1 什么是需求 122
9．2 為什么需求非常重要 122
9．3 有哪些類(lèi)型的需求 123
9．4 有哪些和需求相關(guān)的人員 123
9．5 獲取需求的主要方法 124
9．6 高質(zhì)量的需求是什么樣子 124
9．6．1 便于驗(yàn)證的需求是高質(zhì)量的 124
9．6．2 解決了內(nèi)在沖突的需求是高質(zhì)量的 124
9．6．3 高質(zhì)量需求的典型特征 125
9．7 繪圖工具VS Code 和draw．io 125
9．7．1 在線繪圖工具draw．io 125
9．7．2 安裝draw．io 插件 126
9．7．3 快速入門(mén)VS Code+draw．io 畫(huà)圖 127
本章練習(xí) 130
第 10 章 對(duì)需求進(jìn)行分析和建模 131
10．1 原型化方法和建模的方法 131
10．2 用例建模 131
10．2．1 什么是用例 131
10．2．2 用例的三個(gè)抽象層級(jí) 132
10．2．3 用例建模的基本步驟 133
10．2．4 準(zhǔn)確提取用例的基本方法 134
10．2．5 用例圖的基本畫(huà)法 135
10．3 業(yè)務(wù)領(lǐng)域建模 136
10．3．1 面向?qū)ο蠓治錾婕暗幕靖拍?136
10．3．2 業(yè)務(wù)領(lǐng)域建模的基本步驟 137
10．3．3 頭腦風(fēng)暴的具體做法 138
10．3．4 業(yè)務(wù)領(lǐng)域概念分類(lèi)的方法 139
10．4 關(guān)聯(lián)類(lèi)及其關(guān)系數(shù)據(jù)模型 140
10．4．1 關(guān)聯(lián)類(lèi)的基本概念及其UML 類(lèi)圖 140
10．4．2 關(guān)聯(lián)類(lèi)的面向?qū)ο笤O(shè)計(jì)與實(shí)現(xiàn) 141
10．4．3 關(guān)聯(lián)類(lèi)的關(guān)系數(shù)據(jù)模型 142
10．5 關(guān)系數(shù)據(jù)的MongoDB 數(shù)據(jù)建模 143
10．5．1 基于文檔的數(shù)據(jù)庫(kù)MongoDB 143
10．5．2 一對(duì)多關(guān)系建模的三種基礎(chǔ)方案 144
10．5．3 幾種反范式設(shè)計(jì)方法 147
10．5．4 MongoDB 數(shù)據(jù)建模總結(jié) 150
10．6 軟件業(yè)務(wù)概念的原型 150
本章練習(xí) 151
第 11 章 從需求分析向軟件設(shè)計(jì)的過(guò)渡 153
11．1 敏捷統(tǒng)一過(guò)程 153
11．1．1 瀑布模型 153
11．1．2 統(tǒng)一過(guò)程 153
11．1．3 敏捷統(tǒng)一過(guò)程的計(jì)劃階段 154
11．1．4 敏捷統(tǒng)一過(guò)程的增量階段 154
11．2 對(duì)象交互建模 155
11．2．1 對(duì)象交互建模的基本步驟 155
11．2．2 找出關(guān)鍵步驟進(jìn)行劇情描述 156
11．2．3 將劇情描述轉(zhuǎn)換成劇情描述表 158
11．2．4 將劇情描述表轉(zhuǎn)換成時(shí)序圖 158
11．2．5 從分析時(shí)序圖到設(shè)計(jì)時(shí)序圖 161
11．2．6 完整的“借書(shū)”用例對(duì)象交互建模 163
11．3 形成軟件設(shè)計(jì)方案 164
11．3．1 設(shè)計(jì)類(lèi)圖和分析類(lèi)圖 164
11．3．2 形成設(shè)計(jì)類(lèi)圖的基本步驟 165
11．3．3 形成軟件設(shè)計(jì)方案的整體思路 169
本章練習(xí) 170

第四篇 軟件科學(xué)基礎(chǔ)概論
第 12 章 軟件是什么 172
12．1 軟件的基本構(gòu)成元素 172
12．1．1 對(duì)象 172
12．1．2 函數(shù)和變量/常量 172
12．1．3 指令和操作數(shù) 173
12．1．4 0 和1 是什么 174
12．2 軟件的基本結(jié)構(gòu) 176
12．2．1 順序結(jié)構(gòu) 176
12．2．2 分支結(jié)構(gòu) 176
12．2．3 循環(huán)結(jié)構(gòu) 178
12．2．4 函數(shù)調(diào)用框架 179
12．2．5 繼承和對(duì)象組合 180
12．3 軟件中的一些特殊機(jī)制 181
12．3．1 回調(diào)函數(shù) 181
12．3．2 多態(tài) 182
12．3．3 閉包 183
12．3．4 異步調(diào)用 184
12．3．5 匿名函數(shù) 185
12．4 軟件的內(nèi)在特性 186
12．4．1 前所未有的復(fù)雜度 186
12．4．2 抽象思維和邏輯思維 186
12．4．3 唯一不變的就是變化本身 187
12．4．4 難以達(dá)成的概念完整性和一致性 188
本章練習(xí) 188
第 13 章 軟件設(shè)計(jì)模式 190
13．1 什么是設(shè)計(jì)模式 190
13．1．1 軟件設(shè)計(jì)模式的優(yōu)點(diǎn) 190
13．1．2 軟件設(shè)計(jì)模式的含義和構(gòu)成 191
13．2 軟件設(shè)計(jì)模式的分類(lèi) 191
13．3 常用的軟件設(shè)計(jì)模式 192
13．4 觀察者模式舉例 196
13．5 軟件設(shè)計(jì)模式背后的設(shè)計(jì)原則 200
13．5．1 開(kāi)閉原則 200
13．5．2 麗斯科夫替換原則 200
13．5．3 依賴(lài)倒置原則 200
13．5．4 單一職責(zé)原則 201
13．5．5 德米特法則 201
13．5．6 合成復(fù)用原則 201
13．5．7 反思軟件設(shè)計(jì)模式的根基 202
本章練習(xí) 202
第 14 章 軟件架構(gòu)舉例 204
14．1 三層架構(gòu) 204
14．2 MVC 架構(gòu) 204
14．2．1 什么是MVC 204
14．2．2 MVC 模式 205
14．2．3 MVC 架構(gòu) 207
14．3 MVVM 架構(gòu) 208
14．3．1 什么是MVVM 208
14．3．2 Vue．js 的基本用法 209
14．3．3 Vue．js 背后的MVVM 211
本章練習(xí) 216
第 15 章 軟件架構(gòu)風(fēng)格與描述方法 217
15．1 構(gòu)建軟件架構(gòu)的基本方法 217
15．2 軟件架構(gòu)風(fēng)格與策略 218
15．2．1 管道-過(guò)濾器 218
15．2．2 客戶-服務(wù)器 219
15．2．3 P2P 219
15．2．4 發(fā)布/訂閱 219
15．2．5 CRUD 220
15．2．6 層次化 221
15．3 軟件架構(gòu)的描述方法 221
15．3．1 分解視圖 221
15．3．2 依賴(lài)視圖 222
15．3．3 泛化視圖 222
15．3．4 執(zhí)行視圖 223
15．3．5 實(shí)現(xiàn)視圖 223
15．3．6 部署視圖 223
15．3．7 工作分配視圖 223
本章練習(xí) 224
第 16 章 什么是高質(zhì)量軟件 225
16．1 軟件質(zhì)量的3 種視角 225
16．1．1 軟件質(zhì)量的含義 225
16．1．2 產(chǎn)品視角下的軟件質(zhì)量 225
16．1．3 過(guò)程視角下的軟件質(zhì)量 228
16．1．4 價(jià)值視角下的軟件質(zhì)量 229
16．2 幾種重要的軟件質(zhì)量屬性 230
16．2．1 易于修改維護(hù) 230
16．2．2 良好的性能表現(xiàn) 231
16．2．3 安全性 231
16．2．4 可靠性 231
16．2．5 健壯性 232
16．2．6 易用性 232
16．2．7 商業(yè)目標(biāo) 232
本章練習(xí) 234

第五篇 軟件危機(jī)的前生后世
第 17 章 軟件危機(jī)概述 236
17．1 軟件危機(jī)產(chǎn)生的背景 236
17．2 軟件危機(jī)的主要表現(xiàn)及根源 237
17．3 有關(guān)軟件危機(jī)的爭(zhēng)論 238
本章練習(xí) 239
第 18 章 軟件過(guò)程模型 240
18．1 軟件的生命周期概述 240
18．2 瀑布模型 241
18．3 原型化的瀑布模型 242
18．4 V 模型 243
18．5 分階段的增量和迭代開(kāi)發(fā)過(guò)程 243
18．6 螺旋模型 244
本章練習(xí) 245
第 19 章 PSP 和TSP 246
19．1 個(gè)體和團(tuán)隊(duì) 246
19．2 個(gè)體軟件過(guò)程 246
19．2．1 PSP 0 247
19．2．2 PSP 0．1 247
19．2．3 PSP 1 247
19．2．4 PSP 1．1 248
19．2．5 PSP 2 248
19．2．6 PSP 2．1 249
19．2．7 PSP 3 250
19．3 團(tuán)隊(duì)軟件過(guò)程 250
19．3．1 團(tuán)隊(duì)概述 250
19．3．2 TSP 概述 251
19．3．3 TSP 的基本原理 251
19．3．4 TSP 的基本工作方法 252
本章練習(xí) 253
第 20 章 CMM/CMMI 254
20．1 CMM/CMMI 簡(jiǎn)介 254
20．2 CMM/CMMI 的作用 255
20．3 CMM/CMMI 的主要內(nèi)容 256
20．4 CMMI 的評(píng)估過(guò)程 257
本章練習(xí) 257
第 21 章 敏捷方法 258
21．1 敏捷方法產(chǎn)生的背景 258
21．2 敏捷軟件開(kāi)發(fā)宣言及所遵循的原則 258
21．3 Scrum 敏捷開(kāi)發(fā)方法 259
本章練習(xí) 263
第 22 章 DevOps 265
22．1 什么是DevOps ． 265
22．2 DevOps 和敏捷方法 266
22．3 DevOps 和精益原則 266
22．4 DevOps 和全棧自動(dòng)化 267
本章練習(xí) 269
測(cè)驗(yàn)題 270