美文网首页程序员
JAVA命名规范

JAVA命名规范

作者: 陈金泽 | 来源:发表于2019-02-19 09:38 被阅读0次

    1.[强制] 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束.

    2.[强制] 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式.

    3.[强制] 类名使用UpperCamelCase风格,必须遵守驼峰命名的形式.

    4.[强制] 方法名、参数名、成员变量、局部变量同意使用lowerCamelCase风格,必须遵守驼峰命名的形式.

    5.[强制] 常量命名全部大写,单子间使用下划线隔开,力求语义表达完整.

    6.[强制] 抽象类命名使用Abstract或Base开头;异常类名使用Exception结尾;测试类命名以被测试的类名开头以Test结尾.

    7.[强制] POJO类中不二类型的变量,都不要加is,否则部分框架解析会引起序列化错误.

    8.[强制] 包名统一使用小写,点分隔符之间仅有一个自然语义的英文单词.包名统一使用单数形式,但是类名如果有复数含义可以使用复数形式.

    9.[强制] 杜绝完全不规范的缩写,避免望文不知意.

    10.[推荐] 模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。将设计模式体现在名字中,有利于阅读者快速理解架构设计理念.

    11.[推荐] 接口类中的方法和属性不要加任何修饰符号,保持代码的简洁性,并加上有效的javadoc注释.尽量不要在接口里定义变量,如果一定要

    定义变量肯定是与接口方法相关,并且是整个应用的基础常量.

    12.[推荐] 接口和实现类的命名有两套规则:

        1).[强制] 对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别.

        2).[推荐] 如果是形容能力的接口名称,去对应的形容词做接口名(通常是-able的形式)

    13.[参考] 枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开.枚举其实是特殊的常量类,且构造方法被默认强制私有.

    14.各层命名规范:

        A)Service/DAO层方法名规约

            1). 获取单个对象的方法用get做前缀

            2). 获取多个对象的方法用list做前缀

            3). 获取统计值得方法用count做前缀

            4). 插入的方法用 save/insert做前缀

            5). 删除的方法用remove/delete做前缀

            6). 修改的方法用update做前缀

        B)领域模型命名规范

            1). 数据对象: xxxDO, xxx为数据库表名

            2). 数据传输对象: xxxDTO, xxx为业务领域相关的名称

            3). 展示对象: xxxVO, xxx一般为网页名称

            4). POJO是DO/DTO/BO/VO的统称,精致命名成xxxPOJO

    >--------------------------------------------------------------------------------cjz

    ##简单搭建框架

    点击我的头像,查看更多框架简化搭建的内容!

    小白也能快速搭建MyBatis框架,学习框架不入坑!

    这里是spring-boot-demo:

    https://pan.baidu.com/s/1jN5udzNr_WUsosPIYvqrew

    提取码:jiml

    关注赞赏我:更新更多框架搭建内容!你们的坑我来跳,帮你规避百度上的那些问题教程!

    相关文章

      网友评论

        本文标题:JAVA命名规范

        本文链接:https://www.haomeiwen.com/subject/eyfxyqtx.html