阿里巴巴 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 进行错误返回。

相关文章
|
3月前
|
监控 Java 测试技术
Java并发编程最佳实践:设计高性能的多线程系统
Java并发编程最佳实践:设计高性能的多线程系统
58 1
|
2天前
|
存储 Java 关系型数据库
高效连接之道:Java连接池原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。频繁创建和关闭连接会消耗大量资源,导致性能瓶颈。为此,Java连接池技术通过复用连接,实现高效、稳定的数据库连接管理。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接池的基本操作、配置和使用方法,以及在电商应用中的具体应用示例。
14 5
|
7天前
|
XML JSON 监控
告别简陋:Java日志系统的最佳实践
【10月更文挑战第19天】 在Java开发中,`System.out.println()` 是最基本的输出方法,但它在实际项目中往往被认为是不专业和不足够的。本文将探讨为什么在现代Java应用中应该避免使用 `System.out.println()`,并介绍几种更先进的日志解决方案。
22 1
|
17天前
|
监控 Java 数据库连接
探索Java中的异常处理机制:最佳实践与常见误区
在Java编程世界里,异常处理是确保应用程序稳定性和健壮性的关键环节。本文深入探讨了Java异常处理的机制,包括异常的分类、异常处理的基本原则以及如何在实际开发中应用这些原则。文章还指出了常见的异常处理误区,并提供了最佳实践建议,帮助开发者避免这些陷阱。通过具体代码示例和情景分析,本文旨在提升读者对Java异常处理的理解和应用能力。
|
2月前
|
算法 Oracle Java
Java字符串拼接技术演进及阿里巴巴的贡献
本文主要讲述了Java字符串拼接技术的演进历程,以及阿里巴巴贡献的最新实现 PR 20273。
118 11
|
2月前
|
安全 Java 关系型数据库
代码规范Java阿里巴巴
本文介绍了阿里巴巴的《Java开发手册》,这是一份业界公认的代码规范手册,涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度。手册通过强制、推荐、参考三大类规约,详细指导开发者编写高质量的Java代码。文中还提供了常见问题的正反例对比,如方法参数类型一致性、SimpleDateFormat线程安全等问题的解决方案。此外,还介绍了如何安装和使用阿里规范插件来提高编码效率。
468 9
|
2月前
|
算法 Oracle Java
Java字符串拼接技术演进及阿里巴巴的贡献
本文主要讲述了Java字符串拼接技术的演进历程,以及阿里巴巴贡献的最新实现 PR 20273。
|
3月前
|
JSON Java fastjson
Java日志通关(五) - 最佳实践
作者日常在与其他同学合作时,经常发现不合理的日志配置以及五花八门的日志记录方式,后续作者打算在团队内做一次Java日志的分享,本文是整理出的系列文章第五篇。
|
3月前
|
Java 数据库连接 API
Java中的异常处理:理解、实践与最佳实践
【8月更文挑战第31天】在Java编程的世界中,异常处理是保持代码健壮性的关键。本文将通过浅显易懂的方式,带你了解Java异常处理的基本概念,并通过具体示例展示如何有效管理异常。我们将一起学习如何使用try-catch语句来捕获和处理异常,以及finally块的重要性。同时,我们还将探讨一些最佳实践,帮助你编写更加稳定和可靠的Java代码。无论你是Java新手还是有经验的开发者,这篇文章都将为你提供有价值的见解和技巧。
|
3月前
|
Java 程序员 UED
Java编程中的异常处理最佳实践
【8月更文挑战第28天】在Java的世界里,异常处理是代码健壮性的守护神。它不仅保护程序免受意外错误的侵袭,还确保用户体验的连贯性。本文将引导你穿梭于异常处理的迷宫,揭示捕获、处理及预防异常的艺术。从基本的try-catch语句到精细的异常层次结构,我们将一同探索如何优雅地应对错误,使程序即使在逆境中也能展现出它的韧性和魅力。