11# 你的代码 ——— 味儿不对
22
3+ > 看过《重构》的程序员,都知道 “bad smell ——坏味道”,书里列出了 22 项代码坏味道
4+ >
5+ > 其实最早时候,我很 “普信”,我写的代码,不管是命名和结构都很好,没有什么坏味道,后来项目组有 CR 之后,才发现好多问题
6+
7+ ![ ] ( https://tva1.sinaimg.cn/large/e6c9d24ely1h0hifxh3igj20fg0igabu.jpg )
8+
39“写代码”有两个维度:正确性和可维护性,不要只关注正确性。能把代码写对,是每个程序员的必备技能,但能够把代码写得更具可维护性,这是一个程序员从业余迈向职业的第一步。
410
511
612
713![ http://www.osnews.com/images/comics/wtfm.jpg ] ( http://www.osnews.com/images/comics/wtfm.jpg )
814
9- ## 命名
1015
11- 命名要有意义,只是不再用 int a ,b ,c 这样的东西,然后来了个 xxx
16+
17+ ## 起名有意义
18+
19+ 先说下命名吧,其实我也知道命名要有意义,我也不会去用 int a ,b ,c 这样的东西,然后来了个 xxx
1220
1321![ ] (/Users/apple/Desktop/screenshot/截屏2022-03-18 下午8.03.46.png)
1422
1523
1624
17- 除了查词典,我们可以把我们想到的词去 github 搜一搜,看下别人怎么用的,https://unbug.github.io/codelf/ 可以试试这个
25+ ``` java
26+ public void processData(){
27+
28+ }
29+ ```
30+
31+ 命名最好有业务含义,符合英语语法,我第一份工作做的都是海外产品,有对应的“词库”,很顺利成章的写代码也直接查就行了
32+
33+ ![ ] ( )
34+
35+
36+
37+ 那时候有词库,没有词库呢,我们写代码还是得查词,除了查词典,我们可以把我们想到的词去 github 搜一搜,看下别人怎么用的,https://unbug.github.io/codelf/ 可以试试这个
38+
39+ > 类名是一个名词,表示一个对象,而方法名则是一个动词,或者是一个动宾短语,表示一个动作
40+
41+ 这个说个我遇到的错误,Service 和 Server 用错之后被无情嘲笑
42+
43+
44+
45+ 当然,取好名字前提是问题分解的干净合理,如果你的代码整个处理流程就 1 个方法,叫个 processData 没问题吧? 这有属于其他范畴了(下文的代码太长)
46+
47+
48+
49+
1850
1951有些命名,可能一个词会对应好多单词,如果是不同的人负责不同模块,有些同学会不管3721,各自用各自的命名,然后又会出现各种
2052
2153convertUtils 进去发现这玩意就是个转换的
2254
2355
2456
25- ## 重复代码
57+ ## 减少 Ctrl C + Ctrl V
2658
27- 开发中,其实会有各种问题,现在的互联网,迭代周期快,我们作为程序员的角色一般都是维护,迭代项目,最简单粗暴的办法就是直接 Ctrl C + Ctrl V,改叭改叭,能写个单测就不错了,哪有时间去改写之前的烂代码,
59+ 还有就是重复代码
60+
61+ 开发中,其实会有各种问题,现在的互联网,迭代周期快,当接到迭代需求的时候,最简单粗暴的办法就是找个类似的逻辑,直接 Ctrl C + Ctrl V(idea 都不需要 Ctrl S),改叭改叭,能写个单测就不错了,哪有时间去改写之前的烂代码,
2862
2963> 这个我想说个题外话,互联网中我感觉感触最深的就是搜狗同学,刚被腾讯收购并入pcg epc 规范,每天就是改各种规范
3064
65+ 这个最大的问题,其实就是重复代码,我们会复制很多结构或功能相似的代码到各个业务逻辑中
66+
67+
3168
69+ ## 代码别太长
3270
71+ 写代码其实不止是为了让程序读代码,更重要的应该是让程序员读代码,
3372
73+ 所以代码别太长,其实就是想让我们看起来更方便一些,这里也说下 3 种
3474
35- ## 代码太长
75+ - 类行数太长
76+ - 方法行数太长
77+ - 参数列表太长
78+ - 注释别啰里啰嗦
3679
3780### 类太大
3881
@@ -42,9 +85,53 @@ convertUtils 进去发现这玩意就是个转换的
4285
4386
4487
45- ## 过长参数列
88+ 多少行算长,有人说 80,有人说 100 ,还有人说要一屏幕放的下
89+
90+ 写代码,如果“平铺直叙”的话,很容易写出“面条型代码”,好多逻辑都在一个大方法
91+
92+ ### 过长参数列
93+
94+
95+
96+
97+
98+ ## 圈复杂度
99+
100+ > 在软件开发中,有一个衡量代码复杂度常用的标准,叫做「圈复杂度」(Cyclomatic complexity,简称 CC),圈复杂度越高,代码越复杂,理解和维护成本就越高。
101+
102+ ## 语句
103+
104+ 使用嵌套 for 循环,更扯淡的是在 for 循环里加了个 update sql
105+
106+ 是否else
107+
108+ 是否有重复的 switch
109+
110+ 变量申明后是否立即赋值
111+
112+ 返回值是否可以用 Optional
113+
114+
115+
116+
117+
118+
119+
120+ 知道自己的代码味道不对,那接着我再说说改味道的方法
121+
122+
123+
124+ >
125+ >
126+ > 可读性
127+ >
128+ > 适当的注释,方法内适当的拆分以保证方法内主流程简洁,减少多层嵌套判断,规避复杂判断条件,采用公司统一编码风格等等
129+
130+
46131
132+ ## 重构的手法
47133
134+ Idea 中可以直接全局改名,提取方法(Extrat Method),我们 Javaer 现在大部分都用 Idea,这玩意很多强大的功能我们却没用到,其实好多重构可以通过 Idea 自动化
48135
49136
50137
@@ -69,6 +156,7 @@ https://cloud.tencent.com/developer/article/1371896
69156
70157
71158- 《重构》
159+ - https://refactoring.guru/refactoring
72160- 《代码整洁之道》
73161- https://mp.weixin.qq.com/s/AjubL4vVhFa_FIlaopLVCA
74162
0 commit comments