融入团队代码风格，代码越写越烂！
Java3y
共 19842字，需浏览 40分钟
·
2023-11-07 22:26
最近是真的有点忙啊，需求和bug都排到下一个月了，难得今天休息有空上来扯扯，主题是有关代码质量问题的。
在我初学的时候，我是挺喜欢专研各种Java语法和性能相关的问题的。举个很明显的例子，我们都知道Java的单例模式有好几种写法，什么饿汉式、简单懒汉式（在方法声明时加锁）、DCL双重检验加锁（进阶懒汉式）、静态内部类（优雅懒汉式）、枚举。
这貌似算是Java的高频面试题了，所以这几种写法的优缺点几乎都已经被说烂了。
1、所谓「饿汉式」指的就是还没被用到，就直接初始化了对象。(浪费内存) 2、所谓「懒汉式」指的就是等用到的时候，才进行初始化。(不浪费内存)
在刚学明白的时候，我一想：“我这以后肯定是用懒汉式啊，对内存多友好。我不用简单懒汉式（在方法声明时加锁），这会影响到性能。我可以用双重检验加锁（进阶懒汉式）或者静态内部类（优雅懒汉式）”。
后来工作了以后，发现工作代码里什么牛鬼邪神都有，逐渐发现：代码也不是不能跑，编译器远比我们想象得更加强。
于是，我用个锤子的懒汉式，我反手就是new出一个单例，代码多简单优雅。我堂堂一个Java开发工程师，我还缺那点小内存？真可笑。
刚进团队的时候还想重构脏代码，后来随着需求的累积，又有编译器给兜底，也没人code review监管，写代码就越来越随意了，融入团队代码风格就完事了。
后来出了点小故障，影响到线上的正常业务了，最后发现是脏代码导致的，被老板吐槽了。让我去找找有哪些工具可以排查下有没有类似的问题（代码质量检查），我一想，项目这里面的代码的坑也太多了，不好搞啊。
工作还是得继续干的，既然是代码质量检查，找些IDEA现成的插件就OK咯。
Alibaba Java Coding Guidelines
集成了阿里巴巴的代码规范和最佳实践，帮助开发者保持代码质量和一致性，austin项目也一直用这个插件做代码的扫描。
CheckStyle
以下是 CheckStyle 插件的一些常见功能和用途：
-
代码规范检查：CheckStyle 插件会分析项目中的源代码，并根据预定义的规则检查代码，包括缩进、命名约定、代码注释、代码结构等。它可以帮助团队确保代码风格一致，符合公司或项目的规范。
-
自定义规则：您可以自定义 CheckStyle 规则，以便根据您的项目需求和编码标准添加自定义规则。这使得 CheckStyle 插件非常灵活，可以适应各种项目。
-
代码质量改进：通过检查代码中的潜在问题和不良实践，CheckStyle 插件可以帮助开发者识别和修复代码中的问题，从而提高代码质量。
比如，我设置了一个规则文件：
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!--checkStyle -->
<module name="Checker">
<!-- 检查文件是否以一个空行结束 -->
<module name="NewlineAtEndOfFile"/>
<!-- 文件长度不超过1500行 -->
<module name="FileLength">
<property name="max" value="1500"/>
</module>
<!-- 长度检查 -->
<!-- 每行不超过140个字符 -->
<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="140"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
<!--禁止打印e.printStackTrace错误信息-->
<module name="RegexpSingleline">
<property name="format" value="printStackTrace"/>
<property name="message" value="Prohibit invoking printStackTrace in source code !"/>
</module>
<!-- 每个java文件一个语法树 -->
<module name="TreeWalker">
<!-- import检查-->
<!-- 避免使用* -->
<module name="AvoidStarImport">
<property name="excludes" value="java.io,java.net,java.lang.Math"/>
<!-- 实例；import java.util.*;.-->
<property name="allowClassImports" value="false"/>
<!-- 实例 ；import static org.junit.Assert.*;-->
<property name="allowStaticMemberImports" value="true"/>
</module>
<!-- 检查是否导入了多余的包 -->
<module name="RedundantImport"/>
<!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
<module name="UnusedImports"/>
<!-- 注释检查 -->
<!-- 检查构造函数的javadoc -->
<module name="JavadocType">
<!--允许位置的tag如@date,@description等-->
<property name="allowUnknownTags" value="true"/>
<message key="javadoc.missing" value="类注释：缺少Javadoc注释。"/>
</module>
<!--方法注释-->
<module name="JavadocMethod">
<property name="tokens" value="METHOD_DEF"/>
<!--允许get set 方法没有注释-->
<!-- <property name="allowMissingPropertyJavadoc" value="true"/>-->
<message key="javadoc.missing" value="方法注释：缺少Javadoc注释。"/>
</module>
<!--校验方法的注释-->
<module name="MissingJavadocMethod">
<!--允许get set 方法没有注释-->
<property name="allowMissingPropertyJavadoc" value="true"/>
<!--允许构造方法没有注释-->
<!-- <property name="" value="true"/>-->
<property name="scope" value="private"/>
</module>
<!-- 命名检查 -->
<!-- 局部的final变量，包括catch中的参数的检查 -->
<module name="LocalFinalVariableName"/>
<!-- 局部的非final型的变量，包括catch中的参数的检查 -->
<module name="LocalVariableName"/>
<!-- 包名的检查（只允许小写字母），默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
</module>
<!-- 仅仅是static型的变量（不包括static final型）的检查 -->
<module name="StaticVariableName"/>
<!-- Class或Interface名检查，默认^[A-Z][a-zA-Z0-9]*$-->
<module name="TypeName">
<property name="severity" value="warning"/>
<message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
</module>
<!-- 非static型变量的检查 -->
<module name="MemberName"/>
<!-- 方法名的检查 -->
<module name="MethodName"/>
<!-- 方法的参数名 -->
<module name="ParameterName "/>
<!-- 常量名的检查（只允许大写），默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
<module name="ConstantName"/>
<!-- 定义检查 -->
<!-- 检查数组类型定义的样式 -->
<module name="ArrayTypeStyle"/>
<!-- 检查long型定义是否有大写的“L” -->
<module name="UpperEll"/>
<!-- 方法不超过100行 -->
<module name="MethodLength">
<property name="tokens" value="METHOD_DEF"/>
<property name="max" value="100"/>
</module>
<!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
<module name="ParameterNumber">
<property name="max" value="5"/>
<property name="ignoreOverriddenMethods" value="true"/>
<property name="tokens" value="METHOD_DEF"/>
</module>
<!-- 空格检查-->
<!-- 方法名后跟左圆括号"(" -->
<module name="MethodParamPad"/>
<!-- 在类型转换时，不允许左圆括号右边有空格，也不允许与右圆括号左边有空格 -->
<module name="TypecastParenPad"/>
<!-- 检查在某个特定关键字之后应保留空格 -->
<module name="NoWhitespaceAfter"/>
<!-- 检查在某个特定关键字之前应保留空格 -->
<module name="NoWhitespaceBefore"/>
<!-- 操作符换行策略检查 -->
<module name="OperatorWrap"/>
<!-- 圆括号空白 -->
<module name="ParenPad"/>
<!-- 检查分隔符是否在空白之后 -->
<module name="WhitespaceAfter"/>
<!-- 检查分隔符周围是否有空白 -->
<module name="WhitespaceAround"/>
<!-- 修饰符检查 -->
<!-- 检查修饰符的顺序是否遵照java语言规范，默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
<module name="ModifierOrder"/>
<!-- 检查接口和annotation中是否有多余修饰符，如接口方法不必使用public -->
<module name="RedundantModifier"/>
<!-- 代码块检查 -->
<!-- 检查是否有嵌套代码块 -->
<module name="AvoidNestedBlocks"/>
<!-- 检查是否有空代码块 -->
<module name="EmptyBlock"/>
<!-- 检查左大括号位置 -->
<module name="LeftCurly"/>
<!-- 检查代码块是否缺失{} -->
<module name="NeedBraces"/>
<!-- 检查右大括号位置 -->
<module name="RightCurly"/>
<!-- 代码检查 -->
<!-- 检查空的代码段 -->
<module name="EmptyStatement"/>
<!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
<module name="EqualsHashCode"/>
<!-- 检查子表达式中是否有赋值操作 -->
<module name="InnerAssignment"/>
<!-- 检查是否有"魔术"数字 -->
<module name="MagicNumber">
<property name="ignoreNumbers" value="0, 1"/>
<property name="ignoreAnnotation" value="true"/>
</module>
<!-- 检查switch语句是否有default -->
<module name="MissingSwitchDefault"/>
<!-- 检查是否有过度复杂的布尔表达式 -->
<module name="SimplifyBooleanExpression"/>
<!-- 检查是否有过于复杂的布尔返回代码段 -->
<module name="SimplifyBooleanReturn"/>
<!-- 类设计检查 -->
<!-- 检查类是否为扩展设计l -->
<!-- 检查只有private构造函数的类是否声明为final -->
<module name="FinalClass"/>
<!-- 语法 -->
<!-- String的比较不能用!= 和 == -->
<module name="StringLiteralEquality"/>
<!-- 限制for循环最多嵌套2层 -->
<module name="NestedForDepth">
<property name="max" value="2"/>
</module>
<!-- if最多嵌套3层 -->
<module name="NestedIfDepth">
<property name="max" value="3"/>
</module>
<!-- 检查未被注释的main方法,排除以Application结尾命名的类 -->
<module name="UncommentedMain">
<property name="excludedClasses" value=".*[Application,Test]$"/>
</module>
<!-- 禁止使用System.out.println -->
<module name="Regexp">
<property name="format" value="System\.out\.println"/>
<property name="illegalPattern" value="true"/>
</module>
<!-- return个数 3个-->
<module name="ReturnCount">
<property name="max" value="3"/>
</module>
<!--try catch 异常处理数量 3-->
<module name="NestedTryDepth ">
<property name="max" value="3"/>
</module>
</module>
</module>
当我写出几层for循环的时候和常量的时候，就会被扫描和监控到。
FindBugs
以下是Bug IDEA插件的一些常见用途和功能：
-
静态代码分析：Bug IDEA插件可以执行静态代码分析，以检测潜在的编码错误、代码风格问题和性能问题。它可以识别诸如未使用的变量、空指针异常、不一致的缩进、未处理的异常等问题。 -
代码质量评估：该插件可以生成代码质量报告，帮助开发人员了解代码的质量水平。这些报告通常包括代码复杂性、代码覆盖率、代码重复率等指标。 -
检查代码规范：Bug IDEA插件可以根据您选择的编码标准或规范检查代码，确保团队的代码风格一致性，并提供建议以改进代码。 -
自动修复问题：插件通常提供了自动修复选项，可以帮助开发人员快速修复代码中的问题，提高代码的质量和可维护性。 -
安全漏洞检测：有些Bug IDEA插件还可以检测潜在的安全漏洞，如SQL注入、跨站脚本攻击等，以提高应用程序的安全性。 -
代码重构建议：插件还可以提供有关代码重构的建议，帮助改进代码的结构和性能。
在这个位置可以扫描
扫描的结果：
SonarLint
SonarLint提供了更广泛的代码质量和安全性检查，让你在编写代码的过程中就能发现和解决问题。相比之下，FindBugs更专注于静态代码分析，帮助开发人员发现潜在的bug模式。
下载IDEA插件：
在这个位置可以使用扫描：
能扫描出很多的优化建议：
就这些吧，等我把austin的代码都改改，通过了各种插件的扫描，再来推荐下我的股东服务
评论