dotnet 一些代码审查套路

本文记录一些代码审查套路，在看到小伙伴写出某些代码的时候可以告诉他这样写有锅

我在各个项目里面进行代码审查，我维护了很多个项目

这是我截图某一天的一个核心项目的在 Gitlab 上的 MR 情况，我觉得头像应该是不用保密的，这样知道的小伙伴自然就知道了。对了，那些挂了超过3天的都是标记 WIP 还在开发中的

回到主题，代码审查时有哪些套路？

多语言

如果写了固定的在界面显示的字符串，请询问是否需要使用多语言

魔数的处理

啥是魔数？写固定的一些数值等

魔数尽量不要出现，抽成常量，便于修改，一定避免不了使用魔数的话添加详细注释

如以下代码，后续维护难度几乎等于无穷

Foo(1, 200, 15, 16, 20);

注释说的是不是和代码做的相同

有时候改动的时候忘记改注释了，此时注释说的和代码做的不是一回事，因此代码审查不要跳过注释写的

变量名拼写语法规范

变量名拼写是否符合语法，符合规范

这部分其实用机器人不错，如 GitHub 的代码风格自动审查机器人 CodeFactor 可以自动审查代码风格

该加单位的属性是否明确了单位

用的最多的就是时间单位，请问如下属性表示的是秒还是毫秒

public double Foo { get; }

要么让类型可以表示时间的单位，要么在属性命名上区分，请看程序猿修养给属性一个单位

函数的参数个数不要太多

太多的参数调用起来也不方便，代码可读性也比较渣

public void CubeAdsorb(Point start, Point end, Point topLeft, List<Point> points, double theta, Matrix backMatrix, Vector vector, Cube cube)

太多的参数建议定义一个新的类用来包装

判断逻辑判断方法不要随意倒换

其实只要固定下来，可读性会比较好，如以下反例

        internal FontStyle(int style){Debug.Assert(0 <= style && style <= 2);_style = style;}

这是 WPF 框架源代码的 FontStyle 类的代码，可读性比较渣的代码是 0 <= style && style <= 2 因为判断方法存在一次倒换。第一次判断是使用常量和变量判断，第二次反过来

当然，适应之后也会发现其实上面的写法也是有一些可读的，因为可以和数学一样表示一个区间

注意外部属性或字段的变更

有很多代码写的时候需要考虑多线程访问，多线程的时候可能其他线程会变更外部的属性或字段，因此如下面代码是不安全的

            if (s_providers == null)return null;EncodingProvider[] providers = s_providers;

上面代码的 s_providers 的定义是一个静态字段，上面代码在判断 s_providers == null 时，此时 s_providers 是存在值的。但是后续获取 providers = s_providers 时，可能此时的 s_providers 的值就被改为 null 此时的逻辑是不对的

推荐的写法如下

            EncodingProvider[] providers = s_providers;if (providers == null)return null;

先获取外部字段放在局部变量，再判断局部变量。这样能解决两次访问外部字段的时候，访问的对象不是相同的对象

属性的获取应该是轻量的

从 C# 的设计上，使用属性可以做到对字段或内存空间的封装，可以在获取之前进行一些运算。但是咱默认的约定应该是属性的获取应该是轻量的运算，最好不要做 IO 或重计算，如下面代码

public string Foo
{get{// 访问数据库// 读写文件return xx;}
}

因为大部分小伙伴在使用属性的时候都是不期望去看 get 的代码，都是认为有这个属性可以获取，也许会写入如下面代码

for (int i = 0; i < n; i++)
{F1(Foo);
}

也就是在循环里面不断获取属性，而这个属性获取的性能又比较差

如果属性的获取的性能比较差，推荐修改为方法，如 GetFoo 这样小伙伴看到方法也有预期

通过局部变量简化获取属性的属性的写法

如看到以下的代码，会觉得代码很复杂

var f1 = Axxx.Bxxxxx.Cxxxxx;
var f2 = F3(f1, Axxx.Bxxxxx.Dxxxxx);
F4(f2, Axxx.Bxxxxx.Exxxxx);

如果此时将 Axxx.Bxxxxx 提取出来，相对来说代码看起来就没有那么多

var bxx = Axxx.Bxxxxx;var f1 = bxx.Cxxxxx;
var f2 = F3(f1, bxx.Dxxxxx);
F4(f2, bxx.Exxxxx);

小心属性的属性的属性的写法中途存在空值

尽可能不要太多层的属性的属性的写法，如下面代码，听说下面这行代码抛了一个空异常，请问哪个是空

var foo = A.B.C.D.E.F.G;

事件的加等

推荐存在重入的方法对事件加等之前使用减等，至少多余的减等没啥坏处，但是可以解决某些事件被添加多次

public void Foo()
{F1Event += F2;
}

此时如果存在多次的加等，那么 F1Event 触发一次将会调用两次 F2 方法。而这个逻辑在开始写的时候应该是没锅，但是后续小伙伴改动的时候也许会多调用一次 Foo 方法，此时就炸了

修改后的代码如下

public void Foo()
{F1Event -= F2;F1Event += F2;
}

第一次进入的时候，假设 F1Event 是空，此时 F1Event -= F2 没有任何作用，也不会出错。但是如果是第二次进入的时候，就可以做到干掉之前监听的事件

好，第二个问题就是应该让减等跟随加等，放在相邻的两句代码。如果不遵守会如何，如下面的故事。逗 A 说德熙说要先减等然后再加等，好我写了下面的代码

public void Foo()
{F1Event -= F2;// 其他的业务F1Event += F2;
}

然后逗 B 就改了上面的逻辑，中间加了有趣的逻辑，例如再次调用自身

public void Foo()
{F1Event -= F2;// 其他的业务Foo();F1Event += F2;
}

请问上面代码会有什么坑？第一次调用 F1Event 的减等，此时 F1Event 没有被 F2 监听。而第二次调用 Foo 方法，此时 F1Event 没有被 F2 监听。然后在 Foo 里面调用了 F1Event += F2 加等一次，接着再来一次加等，最后也就是会加等两次

因此推荐上面的规则，让减等和加等放在相邻的代码，如下面代码

public void Foo()
{F1Event -= F2;F1Event += F2;
}

此时没有在加等和减等插入逻辑，基本上除非是多线程，那么最终只是监听一次

字典性能相关

字典的时候需要关注的是两次获取的问题

字典获取值

如需要判断如果字典存在就获取，有下面两个写法

    if (Dictionary.TryGetValue(xx, out var foo)){}

第二个写法如下

if(Dictionary.ContainsKey(xx))
{var foo = Dictionary[xx];
}

这两个方法哪个性能好？其实 TryGetValue 只需要获取一次，性能比较好，测试请看下面博客

C# 字典 Dictionary 的 TryGetValue 与先判断 ContainsKey 然后 Get 的性能对比

字典添加值

想要判断如果字典不存在值的时候才添加，也有两个写法

if(!Dictionary.ContainsKey(xx))
{Dictionary[xx] = foo;
}

另一个写法是采用 .NET Core 2.0 和 .NET Standard 2.1 添加的 TryAdd 方法添加值

使用 TryAdd 方法的性能会更好，不过这个方法是最近才添加的，也许很多小伙伴不知道

Dictionary.TryAdd(TKey, TValue) Method (System.Collections.Generic)

dotnet 字典类找不到 TryAdd 方法

数组列表集合的初始化

如果在此上下文中能够明确知道数组列表集合将要分配的大小，那么推荐给定一个指定的大小，如下面代码

var foo = new List<int>(10);

此规则不仅适用于 List 同时也适用于 Dictionary 等集合类

给定明确的大小可以减少后续的集合分配内存，提升性能。可以提升内存性能和 CPU 性能。原因是大部分集合类底层分配是两倍两倍分配，重新分配的内存需要将原有的拷贝过去。而因为是两倍两倍分配，所以大部分时候都会比需要的多一些

因此给定明确的分配大小可以减少内存分配和拷贝，提升性能

详细请看 List的扩容机制，你真的明白吗？ - 一线码农 - 博客园

字符串的大量拼接使用 StringBuilder 代替

根据字符串的原理，如果进行不断的拼接，将会带来一点性能损耗。原因是每次拼接都会创建新的字符串对象

for (int i = 0; i < n; i++)
{str += i.ToString();
}

如上面代码将会创建大量中间的字符串对象，而最终需要的对象仅仅只有一个字符串。一个优化的方法就是使用 StringBuilder 代替 string 此时能提升不少的性能

条件分支的合并

对于同一对象非白即黑的判断，用if……else if……，而不是if……if……两次判断

如以下代码

if (n > 10)
{// 业务
}
if (n < 10)
{// 业务
}

明显此时的 n 如果大于 10 那么进入上面分支，此时就不可能进入下面分支。因此使用 else if 可以减少一次判断逻辑

if (n > 10)
{// 业务
}
else if (n < 10)
{// 业务
}

Task

如果一个 Task 在做耗时任务，需要看这个任务是不是会使用很长的时间，如果会就需要设置为长时间线程

设置异步方法返回值为 void 不等待

如果设置了异步方法，而且设置了方法的返回值为 void ，那么需要确认是否会出现重入的情况。也就是这个函数可能被多次调用，而且因为没有等待，相同的逻辑被进入多次

锁的对象应该是不变的对象

看到使用 lock 时，请关注 lock 的对象。按照 lock 的工作原理，应该 lock 一个多线程访问的时候为共同的对象。根据这一点可以了解到有以下需要注意的套路

是否 lock 了一个局部创建的变量
是否 lock 了一个本业务外的对象
是否 lock 了一个被复制结构体

咱一条条过一下

如下面代码，咱在代码里面 lock 了一个局部创建的变量。那么此时这个变量不能代表多线程进来的时候能访问的相同的对象，因此这段逻辑的 lock 和没有使用 lock 是等价的

public void Foo(A a)
{var b = new object();lock (b){// 业务}
}

稍微改一下上面代码，咱 lock 的是传入的参数，请问此时是否是安全的

public void Foo(A a)
{lock (a){// 业务}
}

此时代码是挖坑代码，为什么？在写的时候，也许大部分进入 Foo 的线程能拿到相同的 a 对象，此时的lock就能生效。但是如果后续小伙伴改动了上层业务逻辑，传入的 a 不是相同的对象，那么就 gg 了。相信后续也需要用比较多的精力才能调试出来这里的坑

好，下一条，是否 lock 了一个本业务外的对象

这个问题是也许会出现相互等待的锁，因为很难了解到本业务外的对象是否也会被其他业务拿来作为锁的对象。此时就可能出现了某个线程获取了 A 对象的锁，然后等待本线程执行完成。但是本线程又想要获取 A 对象的锁，此时就挖了一个大坑

不经意会写出的坑还有如下代码

lock ("林德熙是逗比")

所有字符串常量只要字面值相同，就是相同对象。敲黑板，这一点很重要，尽量不要将字符串作为锁对象

最后一条，根据 lock 的定义，和第一条相同的坑，因为结构体每次获取都是复制新的值，此时是不安全的，也就是两次结构体虽然代码看起来是相同的对象，但是实际上存在了结构体的复制。虽然一般小伙伴写不出这样的代码，但是写出来就是挖坑

代码审查到锁要求第一个注意的是是否使用了相同的对象，以及使用用的对象是共享的，会被其他业务拿来作为锁的对象

延迟的目的要说明清楚

如图

看到 await Task.Delay(TimeSpan.FromSeconds(2)); 的代码需要留意一下，也许这是逗比代码

Obsolete 标记建议告知新的方法

咱可以给不适用的属性或方法或类表示 Obsolete 特性，这就能告诉开发者不建议使用此方法或属性等。此时既然建议了不要使用，那么有啥可以代替，或者应该如何做？此时推荐写在 Obsolete 里面，告诉开发者推荐的做法

因此如果代码审查看到仅有 [Obsolete] 就需要提示添加告诉开发者推荐的做法

是否吃掉异常

如果运行某个业务，然后这个业务没有按照预期执行，也没有什么日志输出。那么此时的调试就坑了。也就是说业务吃掉了异常，会让调用业务的上层觉得很诡异，因为异常没有抛出，上层业务不知道存在异常。如果此时也没有做日志，那么小伙伴想想可以如何调试

try
{// 业务
}
catch
{}

在代码审查看到吃掉全部异常的，就需要问问小伙伴是否必要，另外需要问问他是否可以记一下日志

最后再附加小笑话

谁删了我的代码

德熙看到了胡承评论了代码的变量名不好理解，因为德熙觉得这个变量名修改是很快的事情，于是就点了以解决。这时德熙在本地修改了变量名，出去和小伙伴聊天，回来就上传代码。过了几分钟，发现dev上没有自己的代码，而且MegerRequest合并了。是谁删了我的代码？

实际上在德熙提交之前，胡承已经把代码合并到dev了，如果一个分支在合并到dev之后的提交是不会自动合并到dev，需要再次提交请求才会合并。

如果要避免再次发生这个事情，那么在解决完之后提交再点击以解决

我搭建了自己的博客 https://blog.lindexi.com/ 欢迎大家访问，里面有很多新的博客。只有在我看到博客写成熟之后才会放在csdn或博客园，但是一旦发布了就不再更新

如果在博客看到有任何不懂的，欢迎交流，我搭建了 dotnet 职业技术学院欢迎大家加入

如有不方便在博客评论的问题，可以加我 QQ 2844808902 交流

知识共享许可协议
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。欢迎转载、使用、重新发布，但务必保留文章署名林德熙(包含链接:http://blog.csdn.net/lindexi_gd )，不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请与我联系。

查看全文
如若内容造成侵权/违法违规/事实不符，请联系编程学习网邮箱：809451989@qq.com进行投诉反馈，一经查实，立即删除！

PyQt5开发环境搭建
1 下载安装文件链接 https://quqi.gblhgk.com/s/768375/ymosm5tjkkteg165 查阅码 CGZWMN2 安装软件2.1 PyCharm安装配置点击pycharm-professional-2017.1.exe安装，按默认选项安装。2.1.1 破解选中破解文件中的resource.cn.jar，右击复制。打开安装文件夹PyCharm 2017里的lib文…...
2024/4/24 11:32:35
分割网络，FCN、UNet、SegNet、DeepLab 等等
内容较多，可以传送门直达。新网络待更…文章目录介绍网络架构Fully Convolution Networks (FCNs) 全卷积网络SegNetU-NetDeepLab v1DeepLab v2DeepLab v3Fully Convolutional DenseNetE-Net 和 Link-NetMask R-CNNPSPNetRefineNetG-FRNet半监督语义分割DecoupledNet基于GAN的方…...
2024/4/24 11:32:33
前端学习（1369）:中间件应用
const express = require(express);const app = express(); app.use((req, res, next) {res.send(网站维护中); }) app.use(/admin, (req, res, next) => {let isLogin = false;if (isLogin) {next()} else {res.send(你还没有登录);} }) app.get(/admin, (req, res) => …...
2024/4/24 11:32:32
AAC音频格式详解和实战解析
AAC音频格式详解和实战解析一.基本概念AAC：即MPEG-2 Advanced Audio Coding，分为流格式和文件格式。文件格式主要用于文件存储和文件播放，流格式主要用于流媒体在线播放。文件格式：adif格式adif格式该格式特点：只有开头有一个头部信息，后面都是AAC裸数据。适应磁盘存储和…...
2024/4/24 11:32:31
区块链的简单介绍（一）
区块链的简单介绍（一） ps：文字有点多，请耐心观看。区块链是什么实际上，区块链就是互联网的一部分。平时某宝购物、某团外卖等这些基础就是互联网数据与数据间的传输方式。区块链是一个集合了密码学、分布式储存、智能合约、共识算法等多种新型技术的数据传输方式。并对现…...
2024/4/24 11:32:30
Docker部署web端vscode
准备纯净的centos7云服务器由于疫情的原因，阿里云为大学生准备了免费的ECS云服务器，我在寒假时就领取了，而且在服创比赛中将我们的网页部署上去了，当时使用的nginx+wsgi+flask。还记得那时安装nginx时非常费劲，因为yum里没有。后来即使部署成功了，但重启了一次服务，之后…...
2024/4/24 11:32:32
设计模式 | 策略模式介绍、使用案例、开源框架应用
目录策略模式概念策略模式使用案例策略模式在开源框架中的应用策略模式概念定义：定义了算法家族，分别封装起来，让他们之间可以相互调用，此模式让算法的变化不会影响到使用算法的用户。可以消除大量的if-else代码适用场景：系统有很多类，而它们的区别仅仅在于他们的行为不同…...
2024/4/25 17:20:17
初识HDFS（快速了解了解HDFS、NameNode和DataNode）
概览首先我们来认识一下HDFS， HDFS（Hadoop Distributed File System ）Hadoop分布式文件系统。它其实是将一个大文件分成若干块保存在不同服务器的多个节点中。通过联网让用户感觉像是在本地一样查看文件，为了降低文件丢失造成的错误，它会为每个小文件复制多个副本（默认为…...
2024/4/24 11:32:28
浅谈QUIC协议原理与性能分析及部署方案
之前写过《http1.0 与 http1.1的区别》与《再谈HTTP2性能提升之背后原理—HTTP2历史解剖》，QUIC协议，现在nginx官方也即将支持。所以还是得跟上时代脚步。QUIC简史QUIC(Quick UDP Internet Connection)是谷歌推出的一套基于UDP的传输协议，它实现了TCP + HTTPS + HTTP/2的功…...
2024/4/24 11:32:27
YOLOv3论文解读
YOLOv3论文解读论文地址： https://arxiv.org/pdf/1804.02767.pdf 代码实现：作者本人： https://pjreddie.com/darknet/yolo/ github：pytorch 简易版：https://github.com/eriklindernoren/PyTorch-YOLOv3 github：keras版：https://github.com/qqwweee/keras-yolo3 一、概…...
2024/4/24 11:32:27
V2Ray macOS安装，配置与使用
这里写自定义目录标题下载与安装配置使用下载与安装下载地址 https://github.com/Cenmrev/V2RayX/releases 按照引导程序安装即可配置 1.选择下图中的Configure，2.配置服务器，点击红圈圈出的加号，按照自己购买的服务器地址，一般需要填写下图中红线圈出的空格。我是在just…...
2024/4/24 11:32:25
诈骗电话识别
这几天偶然参加了这个比赛项目，分享一下个人的想法，能力有限欢迎大家来讨论学习！数据来源“数字四川创新大赛-诈骗电话识别” 数据训练集由如下4个部分组成： user：用户的一些基础资料voc：8个月内的通话数据SMS和APP：8个月的短信和上网数据测试集和训练集组成类似，但手…...
2024/4/24 11:32:24
使用Hadoop的优势
高扩展性，可伸缩高可靠性多副本机制，容错高低成本无共享架构灵活，可存储任意类型数据开源，社区活跃...
2024/4/24 11:55:05
SQL基础索引与视图的建立
什么是索引？SQL Server中的数据也是按页（一页是4kb）存放。索引：是SQL Sever 编排数据的内部方法。它为SQL提供一种方法来编排查询数据索引页：数据库中存储索引的数据页；索引页类似于汉语字典中按拼音或笔画排序成的目录页索引的作用：通过使用索引，可以大大提高数据库…...
2024/4/22 3:20:12
win10实现多个屏幕共享办公
win10如何实现多个屏幕共享办公（一边看文档，一边写代码） 1、外部屏幕连接电源，先使用连接线连接HDML或者VGA接口，使外部屏幕可以连接到电脑主机上。 PS：连接成功主机会弹出提示，两个屏幕会操作一致。 2、打开wIn10的显示设置，在多显示器设置选项中，选择扩展这些显示器…...
2024/4/20 20:32:44
如何实现对象的深拷贝
如何实现一个对象的深拷贝利用JSON方法实现 let obj1 = {name: "11",age: "22" } let obj2 = JSON.parse(JSON.stringify(obj1)); obj2.name = "2222220" console.log("obj1", obj1);// {name: "11", age: "22"}…...
2024/4/19 11:50:10
通过DOM来获取某个节点的子节点
有的时候需要获取某个节点的子节点，但是又不能使用jQuery，那么就使用下面的方法即可。var node = document.getElementById(div_for_tableDemo1).querySelector(.layui-table-box);DOM也可以像JQuery一样使用“.”或者“#”，如下所示： <div class="first">…...
2024/4/17 0:26:53
ubuntu如何避免每次都使用sudo
默认没有启用sudo，首先应该是对sudo进行设置。 sudo的作用就是使当前非root用户在使用没有权限的命令时，直接在命令前加入sudo，在输入自己当前用户的密码就可以完成root用户的功能，而不必在每次使用su -来回切换用户了。 sudo的配置文件位于/etc/sudoers，需要root权限才可…...
2024/4/20 21:30:05
node中cookie与session
cookie：浏览器在电脑硬盘中开辟的一块空间，主要供服务器端存储数据。 cookie中的数据是以域名的形式进行区分的。 cookie中的数据是有过期时间的，超过时间数据会被浏览器自动删除。如果不设置过期时间则在浏览器关闭的时候删除 cookie中的数据会随着请求被自动发送到服务器…...
2024/4/19 12:20:08
linux系统设置免密登录
在linux系统下设置本机免密登录首先，生成A主机的公私钥:(以下操作均在A主机上)ssh-keygen -t rsa -P 连续按3次空格使用默认设置，此时会将A主机的公私钥生成在~/.ssh这个路径下，这个路径下会有两个文件id_rsa id_rsa.pub其中id_rsa保存的是A主机的私钥，is_rsa.pub保存的是…...
2024/4/26 9:43:09

dotnet 一些代码审查套路

多语言

魔数的处理

注释说的是不是和代码做的相同

变量名拼写语法规范

该加单位的属性是否明确了单位

函数的参数个数不要太多

判断逻辑判断方法不要随意倒换

注意外部属性或字段的变更

属性的获取应该是轻量的

通过局部变量简化获取属性的属性的写法

小心属性的属性的属性的写法中途存在空值

事件的加等

字典性能相关

字典获取值

字典添加值

数组列表集合的初始化

字符串的大量拼接使用 StringBuilder 代替

条件分支的合并

Task

设置异步方法返回值为 void 不等待

锁的对象应该是不变的对象

延迟的目的要说明清楚

Obsolete 标记建议告知新的方法

是否吃掉异常

最后再附加小笑话

谁删了我的代码

相关文章

最新文章

dotnet 一些代码审查套路

多语言

魔数的处理

注释说的是不是和代码做的相同

变量名拼写 语法规范

该加单位的属性是否明确了单位

函数的参数个数不要太多

判断逻辑判断方法不要随意倒换

注意外部属性或字段的变更

属性的获取应该是轻量的

通过局部变量简化获取属性的属性的写法

小心属性的属性的属性的写法中途存在空值

事件的加等

字典性能相关

字典获取值

字典添加值

数组 列表 集合的初始化

字符串的大量拼接使用 StringBuilder 代替

条件分支的合并

Task

设置异步方法返回值为 void 不等待

锁的对象应该是不变的对象

延迟的目的要说明清楚

Obsolete 标记建议告知新的方法

是否吃掉异常

最后再附加小笑话

谁删了我的代码

相关文章

最新文章

变量名拼写语法规范

数组列表集合的初始化