原创

【C#编程规范 一】编程规约(上)

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-NC-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://tianmaolin.blog.csdn.net/article/details/86286926

编程规约是比较重要的部分,按照基础和高级,我分成了两篇来学习,上篇涉及到命名风格、常量定义、代码格式OOP规约都是面向对象基础部分和一些通识命名规范。

命名风格

条目较多,所以使用金字塔的风格进行分类整理,易于记忆。命名风格可以按照级别和通识基础进行如下分类:

  • 通识规范:通识的规范,使各种命名更容易被理解。
  • 包名规范:包的命名规范。
  • 类和接口名规范:类和接口相关的命名规范。
  • 方法、参数、成员变量和局部变量规范

分为以上几个级别和大类之后,再理解规则会更深刻。

首先明确两种命名规范:

  • Camel(驼峰)命名法:首个单词首字母小写,后续单词首字母大写:适用于变量命名,例如:tmlGetGirl
  • Pascal(帕斯卡)命名法:每个单词首字母均大写:适用于方法和类,例如:TmlAiTest

通识规范

通识规范有如下几条:
1, 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例: _name / __name / $name / name_ / name$ / name__

2,【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。,说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。
正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。
反例: DaZhePromotion [ 打折 ] / getPingfenByName() [ 评分 ] / int 某变量 = 3

3,【强制】杜绝完全不规范的缩写,避免望文不知义。
反例: AbstractClass “缩写”命名成 AbsClass;condition “缩写”命名成 condi ,此类随意缩写严重降低代码的可阅读性。

4, 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词
组合来表达其意。
正例:在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater
反例:变量 int a 的随意命名方式。

阅读完以上四条规范,回忆下Java的命名规范:

  • 名称只能由字母、数字、下划线、$符号组成
  • 不能以数字开头
  • 名称不能使用JAVA中的关键字
  • 坚决不允许出现中文及拼音命名。

综合阿里和标准的java命名规范,得出最佳:最好使用纯英文且尽量完整的单词进行命名,下划线和$符只能出现在中间,数字只能出现在中间和末尾

结合下C#命名规范:

  • 标识符可以包含大小写字母、数字、下划线和@字符。
  • 标识符不能以数字开头,也不能包含空格。
  • 标识符必须区分大小写。大写字母和小写字母被认为是不同的字母。
  • @字符只能是标识符的第一个字符。带@前缀的标识符称为逐字标识符。
  • 不能使用C#中的关键字。但是,@字符加关键字可以成为合法的标识符,建议不要这样做。
  • 不能与C#的类库名称相同。

综合阿里和标准的java命名规范,得出最佳:最好使用纯英文且尽量完整的单词进行命名,下划线和数字只能出现在中间和末尾

结论1:无论何种编程语言,按我理解的通用写法就是最好使用纯英文且尽量完整的单词进行命名,顶多有下划线,但只放到中间

包名规范

1,【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。正例:应用工具类包名为 com . alibaba . ai . util 、类名为 MessageUtils( 此规则参考 spring的框架结构 )

依据之前java的视频学习和C#,推荐的命名规范是:com.公司名.项目名

结论2:无论何种编程语言,包结构如下:公司名+ 项目名称+ 模块名称区别在于Java采用纯小写,C#采用Pascal命名法。

类和接口名规范

常规类的规范采用帕斯卡命名法:

1,【强制】类名使用 UpperCamelCase 风格,但以下情形例外: DO / BO / DTO / VO / AO /PO / UID 等。
正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

除外的原因是DO / BO / DTO / VO / AO /PO / UID 等本身是缩写。补充说明:类的名字要用名词,例如计划清单类:PlanList

布尔类规范

2,【强制】 POJO 类中布尔类型的变量,都不要加 is 前缀 ,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted() , RPC框架在反向解析的时候,“误以为”对应的属性名称是 deleted ,导致属性获取不到,进而抛出异常。

注:POJO 专指只有 setter / getter/ toString 的简单类,包括 DO/DTO/BO/VO 等。属于贫血类,相对于领域驱动设计里的充血类而言的。

枚举类规范

3,【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。说明:枚举其实就是特殊的类,域成员均为常量且构造方法被默认强制是私有
正例:枚举名字为 ProcessStatusEnum 的 成员名称: SUCCESS / UNKNOWN _ REASON 。

抽象类、异常类和测试类规范

4【强制】抽象类命名使用 Abstract 或 Base 开头异常类命名使用 Exception 结尾测试类
命名以它要测试的类的名称开始,以 Test 结尾

例如:AbstractTmlPlanList、TmlPlanListException 、TmlPlanListTest

结论3:无论何种编程语言,类均采用Pascal命名法且均为名词,并且特殊用途时需要加特殊前后缀。

接口和实现类规范

5,【推荐】接口类中的方法和属性不要加任何修饰符号 (public 也不要加 )保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名 void commit(); 接口基础常量 String COMPANY = " alibaba " ;
反例:接口方法定义 public abstract void f();
说明: JDK 8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。

6,接口和实现类的命名有两套规则:
1 ) 【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。
正例: CacheServiceImpl 实现 CacheService 接口。注:在C#中这通常是ICacheProvider,在接口的上一层使用Service表明该包下均为接口例如:Cache.Service,而实现类为CacheProvider,同样在实现类的上一层使用ServiceImpl表明该包下均为接口的实现。
2 ) 【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名 ( 通常是– able 的形式 ) 。
正例: AbstractTranslator 实现 Translatable 接口

结论4:Java中以Servie标注接口,而在C#中以大写字母I开头标注。

设计模式规约

7,【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例: public class OrderFactory; public class LoginProxy; public class ResourceObserver;

方法名、参数名、成员变量、局部变量

1,【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage() / inputUserId正例: localValue / getHttpMessage() / inputUserId

2 【参考】各层命名规约:A) Service / DAO 层方法命名规约

  • 获取单个对象的方法用 get 做前缀(Get)。
  • 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects(List)。
  • 如若返回的值是bool变量,一般以Is作为前缀
  • 获取统计值的方法用 count 做前缀(Count)。
  • 插入的方法用 save/insert 做前缀(Save/Insert)。
  • 删除的方法用 remove/delete 做前缀(Remove/Delete)。
  • 修改的方法用 update/Set 做前缀(Update)。

B) 领域模型命名规约(不重要,暂时不用关心)
1 ) 数据对象: xxxDO , xxx 即为数据表名。
2 ) 数据传输对象: xxxDTO , xxx 为业务领域相关的名称。
3 ) 展示对象: xxxVO , xxx 一般为网页名称。
4 ) POJO 是 DO / DTO / BO / VO 的统称,禁止命名成 xxxPOJO

3【强制】类型与中括号紧挨相连来表示数组。
正例:定义整形数组 int[] arrayDemo;
反例:在 main 参数中,使用 String args[]来定义。

结论5:无论何种编程语言,方法名一般第一个单词为动词且采用Pascal命名规范,参数名、成员变量、局部变量则采用Camel命名法,定义数组变量只推荐类型紧挨中括号不同的是Java的方法采用Camel命名法,而C#采用Pascal。

常量定义

常量相关的一些规范:

1,【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例: MAX _ STOCK _ COUNT
反例: MAX _ COUNT

2,【强制】不允许任何魔法值 ( 即未经预先定义的常量 ) 直接出现在代码中。
反例: String key = " Id # taobao _" + tradeId; cache . put(key , value);

3,【强制】在 long 或者 Long 赋值时,数值后使用大写的 L ,不能是小写的 l ,小写容易跟数字1 混淆,造成误解。
说明: Long a = 2 l; 写的是数字的 21,还是 Long 型的 2?

4,【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。
说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。
正例:缓存相关常量放在类 CacheConsts 下 ; 系统配置相关常量放在类 ConfigConsts 下。

5,【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包
内共享常量、类内共享常量。

  1. 跨应用共享常量:放置在二方库中,通常是 client . jar 中的 constant 目录下。
  2. 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示“是”的变量:类 A 中: public static final String YES = " yes " ;类 B 中: public static final String YES = " y " ;A . YES . equals(B . YES) ,预期是 true ,但实际返回为 false ,导致线上问题。
  3. 子工程内部共享常量:即在当前子工程的 constant 目录下。
  4. 包内共享常量:即在当前包下单独的 constant 目录下。
  5. 类内共享常量:直接在类内部 private static final 定义。

解释下:一方库: 本工程内部子项目模块依赖的库(jar 包)。二方库: 公司内部发布到中央仓库,可供公司内部其它应用依赖的库(jar 包)。三方库: 公司之外的开源库(jar 包)。

6,【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。
说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的第几个季节。通俗的说就是变量值变化范围有限采用枚举类来定义!

结论6:无论何种编程语言,常量命名一定全部大写且以下划线间隔;常量按照级别要分层维护,同时在每一层又要按照常量功能分类维护!;能用常量少用变量

代码格式

一些代码编排规范:

空格、换行和缩进规范

1,【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行 ; 如果
是非空代码块则:
1 ) 左大括号前不换行。
2 ) 左大括号后换行。
3 ) 右大括号前换行。
4 ) 右大括号后还有 else 等代码则不换行 ; 表示终止的右大括号后必须换行。

2,【强制】左小括号和字符之间不出现空格 ; 同样,右小括号和字符之间也不出现空格;而左大括号前需要空格。反例: if (空格 a == b 空格)

3,【强制】 if / for / while / switch / do 等保留字与括号之间都必须加空格

4,【强制】任何二目、三目运算符的左右两边都需要加一个空格。说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5,【强制】采用 4 个空格缩进,禁止使用 tab 字符。,说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。

以上5点的正确示例:

在这里插入图片描述

6,【强制】注释的双斜线与注释内容之间有且仅有一个空格

7,【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。正例:下例中实参的 args1,后边必须要有一个空格。method(args1, args2, args3);

8,【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。正例:

int one = 1;
long two = 2L;
float three = 3F;
StringBuffer sb = new StringBuffer();

说明:增加 sb 这个变量,如果需要对齐,则给 one 、two 、three 都要增加几个空格,在变量比较多的情况下,是非常累赘的事情。

结论7:无论何种编程语言,空格的使用均需注意,尤其是涉及到关键字、括号、注释、参数罗列

代码长度与拆分规范

9,【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:

  • 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
  • 运算符与下文一起换行。
  • 方法调用的点符号与下文一起换行。
  • 方法调用中的多个参数需要换行时,在逗号后进行。
  • 在括号前不要换行,见反例。

在这里插入图片描述

10,【推荐】单个方法的总行数不超过 80 行。
说明:包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。
正例:代码逻辑分清红花和绿叶个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护。

11,【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明:任何情形,没有必要插入多个空行进行隔开。

结论8:无论何种编程语言,都要注意代码的圈复杂度,在适当的时候要进行拆分和整理

格式设置

12,【强制】 IDE 的 text file encoding 设置为 UTF -8 ; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式。

OOP规约

OOP也就是面向对象编程,涉及这几个方面的规约吧:

  • 类和接口的使用:怎么用才能降低性能损耗,减少错误的发生
  • 方法的使用:有些方法天生不能写业务逻辑,同样,有些方法调用时候也要看看实现逻辑再用
  • 常用操作规范:你clone的不一定是你想clone的,比较的时候注点儿意
  • 调用规范:调别人接口时候别给人家改了,给别人写接口的时候看看自己的旧版本能不能扔了

通盘考虑,提高性能。

类和接口的使用

1,【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。

2, 关于基本数据类型与包装数据类型的使用标准如下:

  • 【强制】所有的 POJO 类属性必须使用包装数据类型。
  • 【强制】 RPC 方法的返回值和参数必须使用包装数据类型。(RPC就是远程调用的意思)
  • 【推荐】所有的局部变量使用基本数据类型。

说明: POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何NPE 问题(NPE指空指针异常),或者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null ,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:比如显示成交总额涨跌情况,即正负 x %, x 为基本数据类型,调用的 RPC 服务,调用不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。

通俗的说远程调用返回值只有包装类型才能包装没有NPE风险并且可以提供额外错误信息

3,【强制】所有的覆写方法,必须加@ Override 注解。说明: getObject() 与 get 0 bject() 的问题。一个是字母的 O ,一个是数字的 0,加@ Override可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。

4,【强制】定义 DO / DTO / VO 等 POJO 类时,不要设定任何属性默认值。,反例: POJO 类的 gmtCreate 默认值为 new Date(), 但是这个属性在数据提取时并没有置入具体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。

5,【强制】 POJO 类必须写 toString 方法。使用 IDE 中的工具: source > generate toString,时,如果继承了另一个 POJO 类,注意在前面加一下 super . toString 。说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString() 方法打印其属性值,便于排查问题。

6,【强制】禁止在 POJO 类中,同时存在对应属性 xxx 的 isXxx() 和 getXxx() 方法。说明:框架在调用属性 xxx 的提取方法时,并不能确定哪个方法一定是被优先调用到。

7,【推荐】 类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter / setter方法。说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好 ; 保护方法虽然只是子类关心,也可能是“模板设计模式”下的核心方法 ; 而私有方法外部一般不需要特别关心,是一个黑盒实现 ; 因为承载的信息价值较低,所有 Service 和 DAO 的 getter / setter 方法放在类体最后。

8, 【推荐】类成员与方法访问控制从严,其实就是访问修饰符如何使用的问题:

  • 如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private 。
  • 工具类不允许有 public 或 default 构造方法。当然了,是做事的,不是包含内容的
  • 类非 static 成员变量并且与子类共享,必须是 protected 。
  • 类非 static 成员变量并且仅在本类使用,必须是 private 。
  • 类 static 成员变量如果仅在本类使用,必须是 private 。
  • 若是 static 成员变量,考虑是否为 final 。考虑一下静态变量被修改了麻烦了,推荐使用final
  • 类成员方法只供类内部调用,必须是 private 。
  • 类成员方法只对继承类公开,那么限制为 protected 。

说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦
思考:如果是一个 private 的方法,想删除就删除,可是一个 public 的 service 成员 方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。

结论9:无论何种编程语言,类、方法、成员的访问是能严就严,性能损耗能小就小,少定默认值,多用包装类

方法的使用

1,【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。

2,【推荐】使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException 的风险。说明:

String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于 3,结果是 3
System.out.println(ary.length);

3,【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读。这条规则优先于规则【类内方法定义顺序】

4,【推荐】 final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:

  • 不允许被继承的类,如: String 类。
  • 不允许修改引用的域对象。
  • 不允许被重写的方法,如: POJO 类的 setter 方法。
  • 不允许运行过程中重新赋值的局部变量。
  • 避免上下文重复使用一个变量,使用 final 描述可以强制重新定义一个变量,方便更好地进行重构。

5,【推荐】慎用 Object 的 clone 方法来拷贝对象。,说明:对象的 clone 方法默认是浅拷贝,若想实现深拷贝需要重写 clone 方法实现域对象的深度遍历式拷贝。关于深拷贝和浅拷贝可以看我另一篇博客讲到了 深浅拷贝,可以参考下

6,【推荐】 setter 方法中,参数名称与类成员变量名称一致, this .成员名 = 参数名。在getter / setter 方法中,不要增加业务逻辑,增加排查问题的难度反例

public Integer getData() {
    if (condition) {
       return this.data + 100;
     } else {
    return this.data - 100;
    }
}

结论10:无论何种编程语言,PoJo类的那几个初始化方法(构造方法、setter、getter)都别写业务逻辑,并且有时候系统提供的方法不一定满足要求要按业务重构

常用操作规范

常用操作,包括比较和序列化等:

1,【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。说明:对于 Integer var = ? 在-128 至 127 范围内的赋值, Integer 对象是在IntegerCache . cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals 方法进行判断。

2, 【强制】 Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals
正例:" test " .equals(object);
反例: object.equals( " test " );
说明:推荐使用 java . util . Objects # equals(JDK 7 引入的工具类 )

3,【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败 ; 如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

4,【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。说明:下例中,反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。反例:

String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}

5【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object 。说明:可变参数必须放置在参数列表的最后。 ( 提倡同学们尽量不用可变参数编程 )正例: public List listUsers(String type, Long… ids) {…}还是别用可变参数了,倒是C#里的可空参数还不错

调用规范

关于方法调用的一些规范:

1,【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时必须加@ Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。

2,【强制】不能使用过时的类或方法。说明: java . net . URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应该使用双参数 decode(String source, String encode) 。接口提供方既然明确是过时接口,那么有义务同时提供新的接口 ; 作为调用方来说,有义务去考证过时方法的新实现是什么。

结论11:无论何种编程语言,别该第三方接口的方法签名,同时,长点儿心,更新了接口考虑好兼容性就把旧的替了好不好,很让调用方苦恼的。

通读了《阿里巴巴代码开发手册》的第一部分,结合平时使用和对C#编写规范的解读,总结了11个结论,有所收获,同时希望对大家也有帮助。

文章最后发布于: 2019-01-12 13:27:14
展开阅读全文
0 个人打赏
私信求帮助

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: Age of Ai 设计师: meimeiellie

分享到微信朋友圈

×

扫一扫,手机浏览