C#代码规范

时间 2019-11-22

标签 c# 代码规范栏目 C# 繁體版

原文原文链接

1、编程规约

（一）命名规范

代码中的命名严禁使用拼音与英文混合的方式，更不容许直接使用中文。
说明：正确的英语拼写和语法可让阅读者易于理解，避免歧义。注意即便纯拼音命名的方式也要避免采用。
正例：name / order / baidu / alibaba 等国际通用的名称可视为英文。
反例：zhekou(折扣)/Shuliang(数量)/ int 变量=1
类名使用Pascal风格，某些状况例外：DTO/UID等模块功能缩写。
正例： UserDTO / XmlService / TFlowInfo /TTouchInfo
反例： userDto / XMLService / tflowInfo / ttouchInfo
方法名、参数名、成员变量、局部变量都统一使用Camel风格，必须听从驼峰形式。
正例： name / getUserInfo() / userId
常量的命名所有大写，单词间用下划线隔开，力求语义表达要完整，不要嫌名字长。
正例：MAX_STOCK_COUNT
反例：Max_Count
抽象类命名使用Abstract或Base开头，异常类命名使用Exception结尾，测试类命名以它要测试的类的名称开始，以Test结尾。
杜毫不规范的缩写，避免望文不知义。
反例：AbstractClass 缩写命名为 AbsClass
为了达到代码自解释的目标，任何自定义编程元素在命名时，尽可能使用完整的单词组合来表达其意思。
反例：int a的随意命名方式
若是模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。将设计模式体如今名字中，有利于阅读者快速理解架构设计理念。
正例：public class OrderFactory / public class LoginProxy
接口和实现类的命名须遵循如下两点规则：
（1）对于Service和DAO类，暴露出来的服务必定是接口，内部的实现类用Impl的后缀与接口区分。
正例：CacheServiceImpl实现ICacheService接口。
（2）若是形容能力的接口名称，取对应的形容词为接口名（通常为-able）
正例：AbstractTranslator 实现ITranstable接口。
枚举类名建议带上Enum后缀，枚举成员名称须要全大写，单词间用下划线隔开。枚举为特殊的类，成员均为常量。
正例：枚举名字为ProcessStatusEnum成员名称：SUCCESS/UNKNOWN_REASON
各层命名规约：
A) Service/DAO 层方法命名规约
1）获取单个对象的方法用 get 作前缀。
2）获取多个对象的方法用list作前缀，复数形式结尾如：listObjects。
3）获取统计值的方法用 count 作前缀。
4）插入的方法用 save/insert 作前缀。
5）删除的方法用 remove/delete 作前缀。
6）修改的方法用 update 作前缀。
B) 领域模型命名规约
1）数据对象：xxxDO，xxx 即为数据表名。
2）数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3）展现对象：xxxVO，xxx 通常为网页名称。

（二）常量定义

不容许任何魔法值（即未经预先定义的常量）直接出如今代码中。
反例：string name =”tflow” + userId;
在long 或者 float赋值时，数值后使用大写L或者F，特别是L不能写成小写的l，小写的l容易跟数字1混淆，形成误解。
不要使用一个常量类维护全部常量，要按常量功能进行归类，分开维护。由于大而全的常量类，杂乱无章，使用查找才能定位到常量，不利于理解和维护。
正例：缓存相关的常量放在类CacheConsts下；系统配置常量放ConfigConsts下。
若是变量值仅在一个固定范围内变化用 enum 类型来定义。
正例：

public enum SeasonEnum {
 SPRING=1, SUMMER=2, AUTUMN=3, WINTER=4;
 }
复制代码

（三）代码格式

大括号的使用约定，在代码中垂直对齐左括号和右括号。
正例：

if (x == 0)
{
Response.Write("用户编号必须输入！");
}
复制代码

反例：程序员

if(x == 0) {
Response.Write("用户编号必须输入！");
}
复制代码

或者：数据库

if(x == 0){ Response.Write("用户编号必须输入！"); }
复制代码

if/for/while/switch/do 等保留字与括号之间都必须加空格。
采用Tab缩进代码，禁止使用空格。
适当的增长空行，来增长代码的可读性。
单行字符数限制不超过 120 个，超出须要换行，换行时遵循以下原则：
1）第二行相对第一行缩进 4 个空格，从第三行开始，再也不继续缩进，参考示例。
2）运算符与下文一块儿换行。
3）方法调用的点符号与下文一块儿换行。
4）方法调用中的多个参数须要换行时，在逗号后进行。
5）在括号前不要换行，见反例。
反例：

StringBuider sb = new StringBuider(); 
// 超过 120 个字符的状况下，不要在括号前换行
sb.append("zi").append("xin")...append 
("huang"); 
// 参数不少的方法调用可能超过 120 个字符，不要在逗号前换行
method(args1, args2, args3, ... 
, argsX);
复制代码

避免写太长的方法。一个典型的方法代码在1～25行之间。若是一个方法发代码超过25行，应该考虑将其分解为不一样的方法。
没有必要增长若干空格来使某一行的字符与上一行对应位置的字符对齐。
正例：

int one = 1; 
long two = 2L; 
float three = 3F; 
StringBuilder sb = new StringBuilder ();
复制代码

不一样逻辑、不一样语义、不一样业务的代码之间插入一个空行分隔开来以提高可读性。

（四）注释规约

类、类属性、类方法的注释必须使用 vs 规范,在VS编译器中打出/// 便可生成注释。
正例：

/// <summary>
/// 注释
/// </summary>
/// <returns></returns>
复制代码

全部的抽象方法（包括接口中的方法）必需要用vs注释、除了返回值、参数、异常说明外，还必须指出该方法作什么事情，实现什么功能。
全部的类都必须添加建立者和建立日期。
方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释，使用/* */注释，注意与代码对齐。
全部的枚举类型字段必需要有注释，说明每一个数据项的用途。
与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文便可。
代码修改的同时，注释也要进行相应的修改，尤为是参数、返回值、异常、核心逻辑等的修改。
谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。若是无用，则删除。代码被注释掉有两种可能性：
1）后续会恢复此段代码逻辑。
2）永久不用。前者若是没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
对于注释的要求：第1、可以准确反应设计思想和代码逻辑；第2、可以描述业务含义，使别的程序员可以迅速了解到代码背后的信息。彻底没有注释的大段代码对于阅读者形同天书，注释是给本身看的，即便隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其可以快速接替本身的工做。
好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是至关大的负担。

（五）集合处理

关于 hashCode 和 equals 的处理，遵循以下规则：
（1）只要重写 equals，就必须重写 hashCode。
（2）由于 Set 存储的是不重复的对象，依据 hashCode和equals进行判断，因此 Set 存储的对象必须重写这两个方法。
不要在 foreach 循环里进行元素的 remove/add 操做。remove 元素请使用 Linq
方式，若是并发操做，须要对 List对象加锁。
正例：

List<string> list = new List<string>(); 
list.add("1"); 
list.add("2"); 
List.RemoveAll(o=>o.id==0);
复制代码

集合初始化时，指定集合初始值大小。

（六）并发处理

获取单例对象须要保证线程安全，其中的方法也要保证线程安全。资源驱动类、工具类、单例工厂类都须要注意。
建立线程或线程池时请指定有意义的线程名称，方便出错时回溯。
高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。尽量使加锁的代码块工做量尽量的小，避免在锁代码块中调用 RPC 方法。
对多个资源、数据库表、对象同时加锁时，须要保持一致的加锁顺序，不然可能会形成死锁。线程一须要对表 A、B、C 依次所有加锁后才能够进行更新操做，那么线程二的加锁顺序也必须是 A、B、C，不然可能出现死锁。
并发修改同一记录时，避免更新丢失，须要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 做为更新依据。若是每次访问冲突几率小于 20%，推荐使用乐观锁，不然使用悲观锁。乐观锁的重试次数不得小于 3 次。
在高并发场景中，避免使用”等于”判断做为中断或退出的条件。

（七）控制语句

在一个 switch 块内，每一个 case 要么经过 break/return 等来终止，要么注释说明程序将继续执行到哪个 case 为止；在一个 switch 块内，都必须包含一个 default 语句而且放在最后，即便空代码。
在 if/else/for/while/do 语句中必须使用大括号。即便只有一行代码，避免采用单行的编码方式：if (condition) statements;
表达异常的分支时，少用 if-else 方式，这种方式能够改写成：

if (condition) 
{ 
 ... 
 return obj; 
} 
// 接着写 else 的业务逻辑代码; 
复制代码

若是非得使用 if()...else if()...else...方式表达逻辑，避免后续代码维护困难，请勿超过 3 层。
正例：超过 3 层的 if-else 的逻辑判断代码可使用卫语句、策略模式、状态模式等来实现，其中卫语句示例以下：编程

public void today() 
{
if (isBusy()) 
{
  	return;
}
if (isFree())
 {
 	return;
}
 	return;
}
复制代码

除经常使用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提升可读性。不少 if语句内的逻辑至关复杂，阅读者须要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，若是阅读者分析逻辑表达式错误呢？
正例：

bool existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed)
 {
 ...
} 
反例：
if ((file.open(fileName, "w") != null) && (...) || (...))
 {
 ...
}
复制代码

循环体中的语句要考量性能，如下操做尽可能移至循环体外处理，如定义对象、变量、获取数据库链接，进行没必要要的 try-catch 操做（这个 try-catch 是否能够移至循环体外）。
避免采用取反逻辑运算符。取反逻辑不利于快速理解，而且取反逻辑写法必然存在对应的正向逻辑写法。
正例：使用 if (x < 628) 来表达 x 小于 628。
反例：使用 if (!(x >= 628)) 来表达 x 小于 628。
下列情形，须要进行参数校验：
1）调用频次低的方法。
2）执行时间开销很大的方法。此情形中，参数校验时间几乎能够忽略不计，但若是由于参数错误致使中间执行回退，或者错误，那得不偿失。
3）须要极高稳定性和可用性的方法。
4）对外提供的开放接口，不论是 RPC/API/HTTP 接口。
5）敏感权限入口。
下列情形，不须要进行参数校验：
1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。通常 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，因此 DAO 的参数校验，能够省略。
3）被声明成 private 只会被本身代码所调用的方法，若是可以肯定调用方法的代码传入参数已经作过检查或者确定不会有问题，此时能够不校验参数。

2、异常

（一）异常处理

异常不要用来作流程控制，条件控制。异常设计的初衷是解决程序运行中的各类意外状况，且异常的处理效率比条件判断方式要低不少。
catch 时请分清稳定代码和非稳定代码，稳定代码指的是不管如何不会出错的代码。对于非稳定代码的 catch 尽量进行区分异常类型，再作对应的异常处理。对大段代码进行try-catch，使程序没法根据不一样的异常作出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。
正例：用户注册的场景中，若是用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上做出分门别类的判断，并提示给用户。
捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，若是不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户能够理解的内容。
try块放到了事务代码中，catch异常后，若是须要回滚事务，必定要注意手动回滚事务。
finally 块必须对资源对象、流对象进行关闭，有异常也要作 try-catch。
方法的返回值能够为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么状况下会返回 null 值。
对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。
关于 RPC 方法返回方式使用 Result 方式的理由：
1）使用抛异常返回方式，调用方若是没有捕获到就会产生运行时错误。
2）若是不加栈信息，只是 new 自定义异常，加入本身的理解的 error message，对于调用端解决问题的帮助不会太多。若是加了栈信息，在频繁调用出错的状况下，数据序列化和传输的性能损耗也是问题。
避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。
随意复制和粘贴代码，必然会致使代码的重复，在之后须要修改时，须要修改全部的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。
正例：一个类中有多个 public 方法，都须要进行数行相同的参数校验操做，这个时候请抽取：private bool CheckParam(DTO dto) {...}

（二）日志规范

应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架log 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
日志文件至少保存 15 天，由于有些异常具有以“周”为频次发生的特色。
应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：

appName_logType_logName.log。
logType:日志类型，如 stats/monitor/access等；
logName:日志描述。这种命名的好处：经过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
复制代码

异常信息应该包括两类信息：案发现场信息和异常堆栈信息。若是不处理，那么经过关键字 throw 往上抛出。
谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；若是使用 warn 来记录刚上线时的业务行为信息，必定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。大量地输出无效日志，不利于系统性能提高，也不利于快速定位错误点。记录日志时请思考这些日志真的有人看吗？看到这条日志你能作什么？能不能给问题排查带来好处？
可使用 warn 日志级别来记录用户输入参数错误的状况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。
尽可能用英文来描述日志错误信息，若是日志中的错误信息用英文描述不清楚的话使用中文描述便可，不然容易产生歧义。国际化团队或海外部署的服务器因为字符集问题，使用全英文来注释和描述日志错误信息。

3、安全规约

（一）权限规范

隶属于用户我的的页面或者功能必须进行权限控制校验。防止没有作水平权限校验就可随意访问、修改、删除别人的数据，好比查看他人的私信内容、修改他人的订单。
用户敏感数据禁止直接展现，必须对展现数据进行脱敏。中国大陆我的手机号码显示为:156****1234，隐藏中间 4 位，防止隐私泄露。
用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，禁止字符串拼接 SQL 访问数据库。
用户请求传入的任何参数必须作有效性验证。忽略参数校验可能致使：
1）page size 过大致使内存溢出
2）恶意 order by 致使数据库慢查询
3）任意重定向
4）SQL 注入
5）反序列化注入
6）正则输入源串拒绝服务 ReDoS
说明：代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，可是若是攻击人员使用的是特殊构造的字符串来验证，有可能致使死循环的结果。
禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。
表单、AJAX 提交必须执行 CSRF 安全验证。
说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者能够事先构造好URL，只要受害者用户一访问，后台便在用户不知情的状况下对数据库中用户参数进行相应修改。
在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而致使资损。如注册时发送验证码到手机，若是没有限制次数和频率，那么能够利用此功能骚扰到其它用户，形成短信资源浪费。
发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。