四年经验老开发，总结的Java代码规范全部奉上。

西魏陶渊明

已于 2022-07-21 20:43:53 修改

阅读量924

点赞数 1

分类专栏： Java编程文章标签： java 代码规范 jvm

于 2020-08-23 16:03:08 首次发布

本文链接：https://blog.csdn.net/Message_lx/article/details/108184310

版权

Java编程专栏收录该内容

1 篇文章 0 订阅

订阅专栏

写代码就像写文章, 好的代码就像好的文章,结构严谨,构思清晰。写代码就像写文章, 一不留神就成流水账，为避免这种情况作为软件开发工程师，重要的是设计而不是实现。

在一个团队中,由于不同经验的开发导致编程风格可能会出现非常混乱的情况,从而导致开发成本上升。难以维护。所以代码规范就显得异常重要了。

本篇文章就是给出编程命名的建议,仅供参考,但是其目的是为了统一规范,提高编程能力,降低开发成本,减少代码维护成本。

契约精神: 做到有法可依，有章可循。

一、类命名

1. 抽象类

适用的设计模式为模板模式。抽象是自下往上的设计。由具体实现推断出抽象方法。建议以Abstract开头。

建议	示例
Abstract 或者 Base 开头	BaseUserService、AbstractUserService

2. 枚举类

枚举是由JVM来保证的单例。可以用来做单例类。
枚举类常用作值判断,不建议每次进行循环判断得到实例。建议由内部维护一个map类型,当做cache。此方法建议放在static静态代码块中实现

建议	示例
Enum 作为后缀	GenderEnum

public enum ProtocolEnum {

    /**
     * ECHO协议
     */
    ECHO(1, null),

    /**
     * mojito协议
     */
    MOJITO(2, MojitoProtocol.class);

    private byte type;

    private Class<? extends Protocol> protocol;

    private static Map<Byte, ProtocolEnum> cache = new HashMap<>();

    static {
        for (ProtocolEnum protocolEnum : values()) {
            cache.put(protocolEnum.type, protocolEnum);
        }
    }

    public static ProtocolEnum byType(byte type) {
        return cache.get(type);
    }
}

3. 工具类

工具类常为无状态对象,无状态对象都是线程安全对象,建议使用 final 修饰。

工具类中避免出现业务属性, 如果出现业务属性,抽象出领域层

建议	示例
Utils作为后缀	StringUtils

4. 异常类

建议保持异常链。

建议	示例
Exception结尾	RuntimeException

5. 接口实现类

众所周知

建议	示例
接口名+ Impl	UserServiceImpl

6. 设计模式相关类

建议	示例
Builder，Factory等	当使用到设计模式时，需要使用对应的设计模式作为后缀，如ThreadFactory

7. 处理特定功能的

其主要的目的是代码可重复使用。

建议	示例
Handler，Predicate, Validator	表示处理器，校验器，断言，这些类工厂还有配套的方法名如handle，predicate，validate

8. 测试类

建议	示例
Test结尾	UserServiceTest，表示用来测试UserService类的

9. 领域模型载体

建议	示例
DTO/*Request	数据传输对象
BO	业务对象
VO	数据展示对象,用于承载页面数据
DO	数据持久化对象