阿里巴巴 Java 编码规范最佳实践

简介:

概述

最近在实际项目中使用 p3c for eclipse 插件进行检测,发现项目中有不少不符合 “阿里巴巴 Java 编码规范” 的代码,现在已经由之前的 2000+ 个优化到 500 个以内了(还需要继续努力优化),这里就优化的过程中遇到的难点已经实践中的经验进行分享。

如何使用插件

eclipse 中可以安装 p3c 插件,可以参考官方的教程进行安装:https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README_cn.md

如何优化代码

使用插件进行代码检测之后可以看到 Blocker、Critical、Major 三种级别信息,其中 Blocker 为最高级别,Major 为最低级别,如果需要优化的代码比较多的话,可以按照从高到低、从简到难到顺序进行优化。

在优化代码的过程中的一些典型的案例这里一一分享给大家

【Blocker】所有的包装类对象之间值的比较,全部使用equals方法比较

优化建议:如果是从数据库中查询出来的对象进行比较的话,重写对象的 equals 方法,方法内部使用 ID 进行比较,外部调用 equals 进行比较即可,一般情况下数据库中 ID 相同的对象就可以认为是一个对象了

【Major】不允许任何魔法值(即未经定义的常量)直接出现在代码中

优化建议:这一条规范在我们的项目中是最容易犯的,这也是容易偷懒不按照规范来进行编码的地方之一。例如我们判断身份证长度为 15 或 18 位,一般进行 if (length == 15 || length == 18) ,像银行卡长度等之类的都会用到这些数字,最好的方式是定义一个全局的常量来规范这些身份证长度、银行卡长度等,这样解决不规范的代码的同时还方便阅读代码。

手机号正则表达式验证、HTTP 请求成功响应码 200、一周 7 天、编码集字符串(例如:UTF-8)、换行符、逗号分隔符等,这些均可以定义为全局变量方便整个项目使用。

如果后端需要返回一些错误提示等,我们可以定义全局的提示 Language.java 或者使用不同的 Exception 进行错误返回。

相关文章
|
20天前
|
存储 Java 关系型数据库
高效连接之道:Java连接池原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。频繁创建和关闭连接会消耗大量资源,导致性能瓶颈。为此,Java连接池技术通过复用连接,实现高效、稳定的数据库连接管理。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接池的基本操作、配置和使用方法,以及在电商应用中的具体应用示例。
39 5
|
8天前
|
Java 数据库连接 开发者
Java中的异常处理机制及其最佳实践####
在本文中,我们将探讨Java编程语言中的异常处理机制。通过深入分析try-catch语句、throws关键字以及自定义异常的创建与使用,我们旨在揭示如何有效地管理和响应程序运行中的错误和异常情况。此外,本文还将讨论一些最佳实践,以帮助开发者编写更加健壮和易于维护的代码。 ####
|
11天前
|
Java
Java 异常处理下篇:11 个异常处理最佳实践
本文深入探讨了 Java 异常处理的最佳实践,包括早抛出晚捕获、只捕获可处理的异常、不要忽略捕获的异常、抛出具体检查性异常、正确包装自定义异常、记录或抛出异常但不同时执行、避免在 `finally` 块中抛出异常、避免使用异常进行流程控制、使用模板方法处理重复的 `try-catch`、尽量只抛出与方法相关的异常以及异常处理后清理资源。通过遵循这些实践,可以提高代码的健壮性和可维护性。
|
9天前
|
安全 Java 编译器
Java多线程编程的陷阱与最佳实践####
【10月更文挑战第29天】 本文深入探讨了Java多线程编程中的常见陷阱,如竞态条件、死锁、内存一致性错误等,并通过实例分析揭示了这些陷阱的成因。同时,文章也分享了一系列最佳实践,包括使用volatile关键字、原子类、线程安全集合以及并发框架(如java.util.concurrent包下的工具类),帮助开发者有效避免多线程编程中的问题,提升应用的稳定性和性能。 ####
37 1
|
12天前
|
Java 编译器 开发者
Java异常处理的最佳实践,涵盖理解异常类体系、选择合适的异常类型、提供详细异常信息、合理使用try-catch和finally语句、使用try-with-resources、记录异常信息等方面
本文探讨了Java异常处理的最佳实践,涵盖理解异常类体系、选择合适的异常类型、提供详细异常信息、合理使用try-catch和finally语句、使用try-with-resources、记录异常信息等方面,帮助开发者提高代码质量和程序的健壮性。
29 2
|
18天前
|
存储 Java 关系型数据库
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接创建、分配、复用和释放等操作,并通过电商应用实例展示了如何选择合适的连接池库(如HikariCP)和配置参数,实现高效、稳定的数据库连接管理。
34 2
|
24天前
|
XML JSON 监控
告别简陋:Java日志系统的最佳实践
【10月更文挑战第19天】 在Java开发中,`System.out.println()` 是最基本的输出方法,但它在实际项目中往往被认为是不专业和不足够的。本文将探讨为什么在现代Java应用中应该避免使用 `System.out.println()`,并介绍几种更先进的日志解决方案。
47 1
|
1月前
|
监控 Java 数据库连接
探索Java中的异常处理机制:最佳实践与常见误区
在Java编程世界里,异常处理是确保应用程序稳定性和健壮性的关键环节。本文深入探讨了Java异常处理的机制,包括异常的分类、异常处理的基本原则以及如何在实际开发中应用这些原则。文章还指出了常见的异常处理误区,并提供了最佳实践建议,帮助开发者避免这些陷阱。通过具体代码示例和情景分析,本文旨在提升读者对Java异常处理的理解和应用能力。
|
2月前
|
算法 Oracle Java
Java字符串拼接技术演进及阿里巴巴的贡献
本文主要讲述了Java字符串拼接技术的演进历程,以及阿里巴巴贡献的最新实现 PR 20273。
131 11
|
2月前
|
安全 Java 关系型数据库
代码规范Java阿里巴巴
本文介绍了阿里巴巴的《Java开发手册》,这是一份业界公认的代码规范手册,涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度。手册通过强制、推荐、参考三大类规约,详细指导开发者编写高质量的Java代码。文中还提供了常见问题的正反例对比,如方法参数类型一致性、SimpleDateFormat线程安全等问题的解决方案。此外,还介绍了如何安装和使用阿里规范插件来提高编码效率。
564 9