AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

【代码规范】Java程序员的编程笔记（培养好习惯）

2022-05-28 230
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
简介： 分享优秀的Java编程好习惯！欢迎打卡学习！
【辰兮要努力】：hello你好我是辰兮，很高兴你能来阅读，昵称是希望自己能不断精进，向着优秀程序员前行！

博客来源于项目以及编程中遇到的问题总结，偶尔会有读书分享，我会陆续更新Java前端、后台、数据库、项目案例等相关知识点总结，感谢你的阅读和关注，希望我的博客能帮助到更多的人，分享获取新知，大家一起进步!

吾等采石之人，应怀大教堂之心，愿大家奔赴在各自的热爱里…

一、注释清晰

每个类、方法都写清楚注释 且行注释应该在代码之前另起一行

备注如下是Java方法里面的注释模板

   /**
     * 功能描述: 
     *
     * @param 方法参数的说明
     * @return 对方法返回值的说明
     * @author 模块的作者
     * @date 编写日期
     */

普通实体类的注解

/**
 * @author: 辰兮要努力
 * @createDate: 2021-8-8 11:56:10
 * @description: Java编程反思
 */

注释可以很好的帮助后续要维护，拓展你代码的人阅读

【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容/格式，不得使用//xxx方式。

说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

更多详细的学习可以参考阿里巴巴java开发手册详解-编程规约 -注释规约

二、命名规范

开发前期一定要培养自己的好习惯，要思考如何让代码写好

具体包括方法，类名以及变量名等

最常见的基础方法如下，命名中不要出现中英文拼接或者中文拼音的情况，可以百度一下对应的英文翻译，命名要正规

Service/DAO层方法命名规约
1) 获取单个对象的方法用get做前缀。
2) 获取多个对象的方法用list做前缀。
3) 获取统计值的方法用count做前缀。
4) 插入的方法用save(推荐)或insert做前缀。
5) 删除的方法用remove(推荐)或delete做前缀。
6) 修改的方法用update做前缀
领域模型命名规约
1) 数据对象:xxxDO，xxx即为数据表名。
2) 数据传输对象:xxxDTO，xxx为业务领域相关的名称。
3) 展示对象:xxxVO，xxx一般为网页名称。
4) POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO

举几个简单的案例

【强制】 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

反例: name / __name / $Object / name / name$ / Object$

【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
正例: alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。

【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外:(领域模型 的相关命名)DO / BO / DTO / VO等。

正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明: 枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例: 枚举名字:DealStatusEnum，成员名称: SUCCESS / UNKOWN_REASON。

备注：枚举全部大写即可，在项目中要巧用枚举

枚举学习参考：一篇文章彻底读懂Java枚举Enum类（案例详解）

三、入参校验

入参校验，普通的常量和集合的判空

在Java的Service层的实现类中，一定要有完善的入参校验

部分公司DAO层也是自己封装的框架，所以单独拿出来也要有自己的入参校验

普通字符串的入参校验

StringUtils.isEmpty(String str) 判断某字符串是否为空，为空的标准是 str==null 或 str.length()==0
StringUtils.isBlank(String str) 判断某字符串是否为空或长度为0或由空白符(whitespace) 构成
System.out.println(StringUtils.isEmpty("   "));       //false
System.out.println(StringUtils.isBlank("   "));       //true

集合的入参校验

判断list集合不能为空

CollectionUtils.isEmpty(list)

如下的判断方法也可以，不过我更建议使用如上集合帮助类，简介清晰

if(null == list || list.size() ==0 ){
 
　　//为空的情况
　　 
}else{
 
　　//不为空的情况
 
}

在service层的第一步就应该是入参校验，如果传入参数有问题，直接返回对应的错误提示，这样也可以提高接口的响应速度

四、日志清晰

有效的输出日志，比如抛出异常，打印有效的参数更好的帮助我们解决异常的问题

日志的案例：使用参数化形式{}占位，[]进行参数隔离

 logger.debug("Processing trade with param1:[{}] and param2: [{}] ", param1, param2);

不推荐使用

logger.debug("Processing trade with param1: " + param1 + " param2: " + param2);

异常添加对应的日志外,部分逻辑比较复杂的接口，我们需要详细的了解具体走到哪里出问题了，入参等是否进入都可以添加对应的日志，方便我们阅读

常见错误总结

1、不要抛出异常后又输出日志，不然会造成重复输出日志。

try {
    // ...
} catch (Exception e) {
    // 错误案例 
    LOG.error("xxx", e);
    throw new RuntimeException();
}

2、不要使用错了日志的级别

try {
    // ...
} catch (Exception e) {
    // 错误案例- 如果捕获异常就写error
    LOG.info("XX 发生异常...", e);
}

正常打印日志记录入参，出参就用info，错误日志就用error

五、返参清晰

及时的输出返回值，同时msg里面的信息要准确和清晰

    /** 状态码 */
    public static final String CODE_TAG = "code";

    /** 返回内容 */
    public static final String MSG_TAG = "msg";

    /** 数据对象 */
    public static final String DATA_TAG = "data";

比如传入的人员ID不能为空; 比如未配置文件存储服务器等;

如上的清晰描述可以让前后端在联调或者线上出现操作问题的时候更好的排查问题

很多时候不要直接返回一个服务端错误，能写清楚就写清楚

六、常量提取

常量类：常量等要提取出来，创建常量类、避免魔法值的使用

阿里强制规定不允许任何魔法值（未经定义的常量）直接出现在代码中

---

提取的好处分享

当我们常量提取后：如定义了一个公共的试题类型编号COMMON

当我们后台再做逻辑操作的时候，只要引用这一个同样的常量即可

    /**
     * 公共的试题类型编号
     */
    public static final String TYPE = "COMMON";

此时后面所有service层逻辑中引用都可以直接使用这一个定义的常量，如果此时因为某种特殊原因我将公共的试题类型编号修改为“COMMON_CODE”,这样也只需要在此处一个地方修改即可；

如上的操作提高了的代码的拓展性和复用性； 不然我要全局搜索哪里用到了公共试题这个编号，然后一个个修改;

七、方法复用

帮助类：可以统一复用的方法要写在帮助类中，统一的复用；

如日期的帮助类,获取IP的帮助类，文件上传的公共类等等…
![在这
能统一抽出来复用的类就统一抽出来

Java逻辑层中同样抽离公共方法复用

同样Java中service层的逻辑代码里面两个业务封装逻辑相同的方法能复用的地方就抽离出来

如查询热门帖子和查询最新帖子-逻辑层中封装的点赞，关注，用户状态等的业务逻辑一样，唯一不一样的是底层查询出来一个根据权重查询，一个根据时间查询;

这样我们把封装的方法抽离出来，做成共用的，这样提高了代码的复用性

八、代码美化

代码美化 去掉空白： Ctrl + Shift + J

       格式化代码： Ctrl + Alt + L
       一致的缩进

九、巧用工具

巧妙地使用工具检查代码

idea里面下载工具，搜索框中输入alibaba 选择 Alibaba Java Coding Guidelines，点击 右边的Install按钮进行安装，安装完成之后重启idea

在这里插入图片描述

  <font face="楷体" size=4>找到要扫描的包或者类点击右键

在这里插入图片描述
效果如下：【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容/格式，不得使用//xxx方式
在这里插入图片描述

当然还有很多其它的代码检测工具，合理使用即可

十、提交规范

提交代码Git或者SVN描述 要清晰; 方便清晰地知道代码提交代码或者修改的内容

feat - 新功能 feature
fix - 修复 bug
docs - 文档注释
style - 代码格式(不影响代码运行的变动)
refactor - 重构、优化(既不增加新功能，也不是修复bug)
perf - 性能优化
test - 增加测试
chore - 构建过程或辅助工具的变动
revert - 回退
build - 打包

参考案例

[feat]-影院管理模块- 功能描述: 新增影院模块首页查询功能

[fix]-影院管理模块- 功能描述: 解决影院模块首页根据区域查询失败的问题

当然上述提交的格式还可以更加的规范，在开发过程跟着项目的提交规范走即可，培养好的习惯，方便阅读代码的人，也方便后续排查问题

请添加图片描述

当我们书写代码的时候就要思考如何把代码写好，而不仅仅是完成！

上述总结还有很多待完善的地方，仅供参考，后续会不断的反思和完善自己的思维！争取成为一个合格的开发工程师！

期待有更多的进步！

---

非常感谢你阅读到这里，如果这篇文章对你有帮助，希望能留下你的点赞👍 关注❤️ 分享👥 留言💬thanks！！！

2021年8月29日22:13:35 愿你们奔赴在自己的热爱里！

文章标签：
日志服务
Java
前端开发
开发工具
文件存储
IDE
git
程序员
数据库
关键词：
Java编程
Java笔记
Java程序员
代码规范Java
Java代码规范
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
辰兮
目录
相关文章
蓝易云
|
6天前
|
Kubernetes 负载均衡 Java
k8s的出现解决了java并发编程胡问题了
Kubernetes通过提供自动化管理、资源管理、服务发现和负载均衡、持续交付等功能，有效地解决了Java并发编程中的许多复杂问题。它不仅简化了线程管理和资源共享，还提供了强大的负载均衡和故障恢复机制，确保应用程序在高并发环境下的高效运行和稳定性。通过合理配置和使用Kubernetes，开发者可以显著提高Java应用程序的性能和可靠性。
蓝易云
53 31
蓝易云
|
7天前
|
Java 编译器 开发者
注解的艺术：Java编程的高级定制
注解是Java编程中的高级特性，通过内置注解、自定义注解及注解处理器，可以实现代码的高度定制和扩展。通过理解和掌握注解的使用方法，开发者可以提高代码的可读性、可维护性和开发效率。在实际应用中，注解广泛用于框架开发、代码生成和配置管理等方面，展示了其强大的功能和灵活性。
蓝易云
59 25
通义灵码
|
1月前
|
人工智能 Java 程序员
【AI程序员】通义灵码 AI 程序员全面上线JAVA使用体验
通过 AI 程序编写一个JAVA后台项目登陆页面
通义灵码
381 42
潜意识Java
|
2月前
|
存储 Java 开发者
【潜意识Java】深入详细理解分析Java中的toString()方法重写完整笔记总结，超级详细。
本文详细介绍了 Java 中 `toString()` 方法的重写技巧及其重要
潜意识Java
63 10
【潜意识Java】深入详细理解分析Java中的toString()方法重写完整笔记总结，超级详细。
技术小达人
|
8天前
|
Java 开发工具
课时6：Java编程起步
课时6：Java编程起步，主讲人李兴华。课程摘要：介绍Java编程的第一个程序“Hello World”，讲解如何使用记事本或EditPlus编写、保存和编译Java源代码（*.java文件），并解释类定义、主方法（public static void main）及屏幕打印（System.out.println）。强调类名与文件名一致的重要性，以及Java程序的编译和执行过程。通过实例演示，帮助初学者掌握Java编程的基本步骤和常见问题。
技术小达人
28 0
潜意识Java
|
2月前
|
搜索推荐 Java 数据库
【潜意识Java】深入理解Java中的方法重写，理解重写的意义，知道其使用场景，以及重写的访问权限限制等的完整笔记详细总结。
本文详细介绍了Java中的方法重写概念、规则及应用场景。
潜意识Java
89 16
潜意识Java
|
2月前
|
前端开发 JavaScript Java
Java构建工具-maven的复习笔记【适用于复习】
这篇文档由「潜意识Java」创作，主要介绍Maven的相关知识。内容涵盖Maven的基本概念、作用、项目导入步骤、依赖管理（包括依赖配置、代码示例、总结）、依赖传递、依赖范围以及依赖的生命周期等七个方面。作者擅长前端开发，秉持“得之坦然，失之淡然”的座右铭。期待您的点赞、关注和收藏，这将是作者持续创作的动力！ [个人主页](https://blog.csdn.net/weixin_73355603?spm=1000.2115.3001.5343)
潜意识Java
48 3
运营研究坊
|
3月前
|
存储 缓存 Java
Java 并发编程——volatile 关键字解析
本文介绍了Java线程中的`volatile`关键字及其与`synchronized`锁的区别。`volatile`保证了变量的可见性和一定的有序性，但不能保证原子性。它通过内存屏障实现，避免指令重排序，确保线程间数据一致。相比`synchronized`，`volatile`性能更优，适用于简单状态标记和某些特定场景，如单例模式中的双重检查锁定。文中还解释了Java内存模型的基本概念，包括主内存、工作内存及并发编程中的原子性、可见性和有序性。
运营研究坊
93 5
Java 并发编程——volatile 关键字解析
互联网课堂
|
3月前
|
算法 Java 调度
java并发编程中Monitor里的waitSet和EntryList都是做什么的
在Java并发编程中，Monitor内部包含两个重要队列：等待集（Wait Set）和入口列表（Entry List）。Wait Set用于线程的条件等待和协作，线程调用`wait()`后进入此集合，通过`notify()`或`notifyAll()`唤醒。Entry List则管理锁的竞争，未能获取锁的线程在此排队，等待锁释放后重新竞争。理解两者区别有助于设计高效的多线程程序。 - **Wait Set**：线程调用`wait()`后进入，等待条件满足被唤醒，需重新竞争锁。 - **Entry List**：多个线程竞争锁时，未获锁的线程在此排队，等待锁释放后获取锁继续执行。
互联网课堂
99 12
栈江湖
|
3月前
|
存储 安全 Java
Java多线程编程秘籍：各种方案一网打尽，不要错过！
Java 中实现多线程的方式主要有四种：继承 Thread 类、实现 Runnable 接口、实现 Callable 接口和使用线程池。每种方式各有优缺点，适用于不同的场景。继承 Thread 类最简单，实现 Runnable 接口更灵活，Callable 接口支持返回结果，线程池则便于管理和复用线程。实际应用中可根据需求选择合适的方式。此外，还介绍了多线程相关的常见面试问题及答案，涵盖线程概念、线程安全、线程池等知识点。
栈江湖
286 2

热门文章

最新文章

  • 1
    【AI程序员】通义灵码 AI 程序员全面上线JAVA使用体验
  • 2
    从理论到实践：使用JAVA实现RAG、Agent、微调等六种常见大模型定制策略
  • 3
    Java也能快速搭建AI应用？一文带你玩转Spring AI可落地性
  • 4
    一天成为Java开发高手：用飞算JavaAI实现十倍提效
  • 5
    【Java并发】【线程池】带你从0-1入门线程池
  • 6
    java语言后台管理若依框架-登录提示404-接口异常-系统接口404异常如何处理-登录验证码不显示prod-api/captchaImage 404 (Not Found) 如何处理-解决方案优雅草卓伊凡
  • 7
    Java+机器学习基础：打造AI学习基础
  • 8
    java语言后台管理ruoyi后台管理框架-登录提示“无效的会话，或者会话已过期，请重新登录。”-扩展知识数据库中密码加密的方法-问题如何解决-以及如何重置若依后台管理框架admin密码-优雅草卓伊凡
  • 9
    Java社招面试题：一个线程运行时发生异常会怎样？
  • 10
    深入理解Java锁升级：无锁 → 偏向锁 → 轻量级锁 → 重量级锁（图解+史上最全）
  • 1
    Java对象创建和访问
    11
  • 2
    【YashanDB知识库】yasdb jdbc驱动集成druid连接池，业务(java)日志中有token IDENTIFIER start异常
    16
  • 3
    【YashanDB知识库】yasdb jdbc驱动集成BeetISQL中间件，业务(java)报autoAssignKey failure异常
    11
  • 4
    《从头开始学java，一天一个知识点》之：字符串处理：String类的核心API
    27
  • 5
    《从头开始学java，一天一个知识点》之：多维数组与常见操作
    26
  • 6
    【Java并发】【synchronized】适合初学者体质入门的synchronized
    41
  • 7
    怎么理解Java中的lambda表达式
    16
  • 8
    Java中的Sort
    17
  • 9
    JVM简介—1.Java内存区域
    70
  • 10
    《从头开始学java，一天一个知识点》之：数组入门：一维数组的定义与遍历
    49

    • 相关课程

    更多
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计
  • Java编程入门
  • Java面向对象编程
  • Java高级编程

    • 相关电子书

    更多
  • Spring Cloud Alibaba - 重新定义 Java Cloud-Native
  • The Reactive Cloud Native Arch
  • JAVA开发手册1.5.0

    • 相关实验场景

    更多
  • 语言入门-1：环境构建
  • 阿里云平台上进行Java程序的编译与运行
  • 代码质量提升小妙招
  • 使用Java面向对象编写网络通信程序应用
  • 手动部署Java Web环境（Alibaba Cloud Linux 2）
  • 搭建Java Web开发环境（Anolis OS）
    • 下一篇
    阿里云百炼已上线超强推理开源模型QwQ-32B，尺寸更小，性能比肩DeepSeek满血版