老K致不懂开发规范的你--One

前景提要:小编最近是在做一个项目迭代,很难受啊,这个项目开发很非常久,里面很多东西可以说是五花八门,五脏俱全(很多就是没有注释的,没有使用的类也没有处理)
写下本片博客也只是为了码出高效,码出质量。
小编也会用几篇博客来完成这个系列

编码规范

(1)命名风格
一:强制要求代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
在这里插入图片描述
二:强制要求代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
为什么这么搞呢?一个正确的英文拼写和语法可以让阅读者更加容易理解,避免歧义。注意:即使纯粹的拼音命名方式也是避免采用。
在这里插入图片描述三:强制要求类名使用 UpperCamelCase 风格,必须遵从驼峰形式。但以下情形例外:DO / BO / DTO / VO / AO
在这里插入图片描述
四:强制要求方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从 驼峰形式。
只供参考

package com.onlyK.ssm;

/**
 * @author only老K 我为自己代言
 * @create 2020-06-07 11:19
 * @blogaddress https://blog.csdn.net/weixin_44255950
 */
public class TestDome {
    class User{
        String Uid;
        String Uname;

        public String getUid() {
            return Uid;
        }
        public void setUid(String uid) {
            Uid = uid;
        }
        public String getUname() {
            return Uname;
        }
        public void setUname(String uname) {
            Uname = uname;
        }
    }
    public static void main(String[] args) {
        //错误命名规范一: _name;__name;$name;name_;name$;
        //错误命名规范二:DaZhePromotion【打折拼音?】;getPingfenByName()【评分拼音?】
        //正确命名规范二:taobao/youku/alibaba 这些国际通用的名称还是可以使用的
        //错误命名规范三:testDome,TestDo,XMLService
        //正确命名规范三:TestDome,TestDO,XmlService

    }
    public void AddUser(User u){
        u.setUid("1");
        u.setUname("only老K");
    }
}

五:强制要求常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
在这里插入图片描述
六:强制要求抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。
七:强制要求中括号是数组类型的一部分,数组定义如下:String[] args;
反例:使用 String args[]的方式来定义。
八:强制要求POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 Boolean isDeleted;的属性,它的方法也是 isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。
九:强制要求包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例: 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考 spring 的框架结构)
十:强制要求杜绝完全不规范的缩写,避免望文不知义
。 反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。
十一:【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。
正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
反例:变量 int a; 的随意命名方式。
十二:【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class OrderFactory; public class LoginProxy; public class ResourceObserver;
十三:【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();接口基础常量表示:String COMPANY = “alibaba”;
反例:接口方法定义:public abstract void f(); 说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默 认实现。
十四 接口和实现类的命名有两套规则:

  • 强制要求对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部 的实现类用 Impl 的后缀与接口区别。 正例:CacheServiceImpl 实现 CacheService 接口。
  • 【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)正例:AbstractTranslator 实现Translatable。

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

  1. Service/DAO 层方法命名规约
  • 获取单个对象的方法用 get 做前缀。

  • 获取多个对象的方法用 list 做前缀。

  • 获取统计值的方法用 count 做前缀。

  • 插入的方法用 save/insert 做前缀。

  • 删除的方法用 remove/delete 做前缀。

  • 修改的方法用 update 做前缀。

    2.领域模型命名规约

  • 数据对象:xxxDO,xxx 即为数据表名。

  • 据传输对象:xxxDTO,xxx 为业务领域相关的名称。

  • 展示对象:xxxVO,xxx 一般为网页名称。

  • POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。

(2)常量定义

1 强制要求不允许任何魔法值(即未经定义的常量)直接出现在代码中

 反例:String key = "Id#taobao_" + tradeId;       cache.put(key, value)

2 强制要求long 或者 Long 初始赋值时,使用大写的 L,不能是小写的 l,小写容易跟数字 1 混 淆,造成误解(一般是在实现序列化接口的时候)

Long a = 2l; 写的是数字的 21,还是 Long 型的 2? 

3 【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护。

说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。
正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下

4 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。
1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。
2) 应用内共享常量:放置在一方库中,通常是 modules 中的 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 定义。
5. 【推荐】如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。下面 正例中的数字就是延伸信息,表示星期几

正例:public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

未完待续…后续还有哦

后续三目标:可能是公众号,可能是Mysql的。可能是继续先写开发规范

猜你喜欢

转载自blog.csdn.net/weixin_44255950/article/details/106599076