java日常开发中如何写出优雅的好维护的代码

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 代码可读性太差,实际是给团队后续开发中埋坑,优化在平时,没有那个团队会说我专门给你一个月来优化之前的代码,所以在日常开发中就要多注意可读性问题,不要写出几天之后自己都看不懂的代码。

注释

开发中合理添加注释,提高代码的可读性和易读性

1、在类、接口、方法、属性、代码块、有特殊逻辑的地方都要添加注释说明

2、推荐中文注释,减少理解成本

3、遵循 javaDoc 注释规范,除方法内的代码块用 // 注释,其他地方推荐 javaDoc 注释

日志

开发中要合理添加 info、error 日志,方便线上问题定位

1、在关键步骤上要添加日志

2、异常分支必须增加日志,比如throw抛异常的地方,打印出关键信息,提升问题定位效率

3、日志描述信息用英文,不要用中文,防止不同编码导致乱码问题

4、一般只在开发中打印的日志会用debug打印,线上日志debug级别的一般会设置不打印出来,不过上线前还是建议删除开发中调试的日志

命名

1、不能太随意,反例:BaseResultMap1、param1

2、能正确区分含义和功能

3、拼写要正确,反例:supper => super

代码可读性

日常开发中哪怕是不断在开发新需求,但我们至少有一半的时间都是在阅读老的代码,想要提高代码可维护性,那可读性就很重要。

就像Martin Fowler在《Refactoring: Improving the Design of Existing Code》中提到的:“任何傻瓜都能写出计算机能理解的代码,但只有优秀的程序员能写出人类能理解的代码。” 所以一定不要按照需求文档一步一步的去写出面条式的代码,多去抽离和提取。

1、每个函数不要太长

2、函数参数不要超过3个,多个参数可以定义成单独的对象传递

3、复杂的参数可以封装成上下文context对象里再嵌套其他实体对象,利用引用数据类型的特点,单独的方法中也不需要在额外return出结果,后续其他方法中通过context对象就可以直接获取其他方法中处理过的最新的数据

4、可读性比节省的那点性能重要,比如在同一个for循环中去同时做两件不同的事,看似只用1次循环节省了点性能,实际可读性变差了

5、一些DTO、entity对象附属的判断、赋值之类操作可以直接封装在实体对象里面

6、保持简单,不要炫技,如果一眼就能让人看明白的,就不要去写出需要别人想半天才能明白的代码

条件判断

1、判空统一用 StringUtils、CollectionUtils 这类官方库 如字符串判空项目中有自己判断的,有用 hutool 的,推荐统一使用 Apache 的 StringUtils 来判断,多条判断可以用 isAnyBlank、isAnyEmpty 合并,反例:

if (str == null || str.isEmpty()) {
   }
if (StrUtil.isNotBlank(testDO.getName())) {
   }
AI 代码解读

2、复杂判断抽成单独的方法,比如抽成单独的assembler静态方法,这样也很方便单独针对判断逻辑来写单测测试,反例:

if (queryEntity.getId() == null && queryEntity.getName() == null && queryEntity.getUserId() == null && (queryEntity.getAge() > 0)) {
   
    return true;
}
AI 代码解读

3、if 判断不要嵌套太深 可以提前 return 来减少 if 嵌套层级,也可以利用 switch、策略模式、提取单独的方法简化逻辑

4、多用 StringUtils.defaultString、ListUtils.emptyIfNull 简化代码:

if (CollectionUtils.isNotEmpty(testList)) {
   
    for (Item item : testList) {
   
        item.setNickName(StringUtils.isEmpty(item.getName()) ? "" : item.getName())
    }
}
AI 代码解读

可以简化成:

for (Item item : ListUtils.emptyIfNull(testList)) {
   
    item.setNickName(StringUtils.defaultString(item.getName()))
}
AI 代码解读

代码逻辑

1、方法职责单一,尽量保证每个方法只做一件事

2、转换代码抽到单独的 Assembler 里

3、无用的代码直接删除掉,除非确实容易埋坑的代码可以注释掉保留

4、消除魔法值,可以定义成公共/局部常量、枚举,反例:

if (!"YEAR".equals(request.getUnit())) {
   }
AI 代码解读

单测

1、caseDesc 里清晰描述每条用例

2、用例文件名命名有意义,反例:success1.json5、fail2.json5

3、所有外部依赖数据要全部 mock 掉

4、尽量覆盖所有场景的用例,单测实际能检测出大部分的问题

5、不像前端开发中基本不会单独写单测,后端开发实际很依赖单测来自测,所以要重视单测

以上就是开发中总结出来的有利于提高代码优雅性、可维护性的一些地方,其中最重要的我觉得还是可读性那一点,代码可读性太差,实际是给团队后续开发中埋坑。

优化在平时,没有那个团队会说我专门给你一个月来优化之前的代码,所以在日常开发中就要多注意可读性问题,不要写出几天之后自己都看不懂的代码。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
菜鸟之路day02-04拼图小游戏开发一一JAVA基础综合项目
本项目基于黑马程序员教程,涵盖面向对象进阶、继承、多态等知识,历时约24小时完成。项目去除了登录和注册模块,专注于单机游戏体验。使用Git进行版本管理,代码托管于Gitee。项目包含窗体搭建、事件监听、图片加载与打乱、交互逻辑实现、菜单功能及美化界面等内容。通过此项目,巩固了Java基础并提升了实际开发能力。 仓库地址:[https://gitee.com/zhang-tenglan/puzzlegame.git](https://gitee.com/zhang-tenglan/puzzlegame.git)
26 6
【潜意识Java】javaee中的SpringBoot在Java 开发中的应用与详细分析
本文介绍了 Spring Boot 的核心概念和使用场景,并通过一个实战项目演示了如何构建一个简单的 RESTful API。
26 5
如何在 Java 代码中使用 JSqlParser 解析复杂的 SQL 语句?
大家好,我是 V 哥。JSqlParser 是一个用于解析 SQL 语句的 Java 库,可将 SQL 解析为 Java 对象树,支持多种 SQL 类型(如 `SELECT`、`INSERT` 等)。它适用于 SQL 分析、修改、生成和验证等场景。通过 Maven 或 Gradle 安装后,可以方便地在 Java 代码中使用。
135 11
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
23 2
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
JavaFX是Java的下一代图形用户界面工具包。JavaFX是一组图形和媒体API,我们可以用它们来创建和部署富客户端应用程序。 JavaFX允许开发人员快速构建丰富的跨平台应用程序,允许开发人员在单个编程接口中组合图形,动画和UI控件。本文详细介绍了JavaFx的常见用法,相信读完本教程你一定有所收获!
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
建筑施工一体化信息管理平台源码,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
智慧工地云平台是专为建筑施工领域打造的一体化信息管理平台,利用大数据、云计算、物联网等技术,实现施工区域各系统数据汇总与可视化管理。平台涵盖人员、设备、物料、环境等关键因素的实时监控与数据分析,提供远程指挥、决策支持等功能,提升工作效率,促进产业信息化发展。系统由PC端、APP移动端及项目、监管、数据屏三大平台组成,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
利用 Java 代码获取淘宝关键字 API 接口
在数字化商业时代,精准把握市场动态与消费者需求是企业成功的关键。淘宝作为中国最大的电商平台之一,其海量数据中蕴含丰富的商业洞察。本文介绍如何通过Java代码高效、合规地获取淘宝关键字API接口数据,帮助商家优化产品布局、制定营销策略。主要内容包括: 1. **淘宝关键字API的价值**:洞察用户需求、优化产品标题与详情、制定营销策略。 2. **获取API接口的步骤**:注册账号、申请权限、搭建Java开发环境、编写调用代码、解析响应数据。 3. **注意事项**:遵守法律法规与平台规则,处理API调用限制。 通过这些步骤,商家可以在激烈的市场竞争中脱颖而出。
深入理解Java中synchronized三种使用方式:助您写出线程安全的代码
`synchronized` 是 Java 中的关键字,用于实现线程同步,确保多个线程互斥访问共享资源。它通过内置的监视器锁机制,防止多个线程同时执行被 `synchronized` 修饰的方法或代码块。`synchronized` 可以修饰非静态方法、静态方法和代码块,分别锁定实例对象、类对象或指定的对象。其底层原理基于 JVM 的指令和对象的监视器,JDK 1.6 后引入了偏向锁、轻量级锁等优化措施,提高了性能。
60 3
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等