springboot项目 使用 CheckStyle检查项目去掉一些规则跟不必要类不检查应该如何配置

注：当你在项目中使用了 checkstyle 进行了代码检查install项目的时候总会出现一些无关紧要的一些编译不通过的问题 你可以用以下方式绕过它的检查！

一.在你报错的这个类的最上面加入你报错的 提示

这里代表去掉对该类中有魔术数字的校验 
// Checkstyle OFF: MagicNumber

如下图这样配置：注意 跟package 有一个空格

二：如果你想去掉对某个类 整个类都不进行检查 可以用以下配置 首先在你的项目下面创建一个 suppressions.xml 文件

然后在 suppressions.xml 文件中添加你想过滤掉的规则

<?xml version="1.0"?> <!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
// checks配置你不想检查这个类的规则  files配置你不检查哪个类
    <suppress checks="Javadoc" files="com.xxx.xxx.xxx.xxx.xxx.dto"/>
    <suppress checks="Javadoc" files="com.xxx.xxx.xxx.xxx.xxx.admin"/>
    <suppress checks="HiddenField" files="com.xxx.xxx.xxx.xxx.xxx.xxx"/>
</suppressions>

三：CheckStyle 都有哪些规则这里举例一些 具体请看自己项目中checkstyle.xml文件配置

包信息文件检查: 
<module name="JavadocPackage"/> 
这一规则用于确保每个包都有对应的 package-info.java 文件。

文件结束新行检查: 
<module name="NewlineAtEndOfFile"> 
用于验证文件中的每条语句后都跟随着一个新行。

属性文件键一致性检查: 
<module name="Translation"/> 
用于检测属性文件中是否有重复的键。

文件长度限制: 
<module name="FileLength"> 
设置了文件的最大长度为 2500 字符，这有助于控制代码的可读性和维护性。

空白字符检查: 
<module name="FileTabCharacter"/> 
用于确保文件中没有制表符和不必要的空白字符。

正则表达式单行注释: 
<module name="RegexpSingleline"> 
用于检测单行注释是否以特定的格式存在，例如删除尾随空格。

Javadoc注释检查: 
<module name="SuppressWarningsHolder"/>、
<module name="JavadocMethod"/> 
等规则用于验证 Javadoc 注释是否符合规定的格式和内容要求。

命名规范检查: 包括 
<module name="ConstantName"/>, 
<module name="LocalFinalVariableName"/>, 
<module name="LocalVariableName"/>, 
<module name="MethodName"/> 
等，这些规则主要用于确保变量名、方法名和常量名遵循一致的命名约定。

导入检查: 
<module name="AvoidStarImport"/>, 
<module name="IllegalImport"/>, 
<module name="RedundantImport"/>, 
<module name="UnusedImports"/> 
等规则用于检查导入语句的正确性和避免冗余。

代码块布局和结构检查: 如 
<module name="EmptyBlock"/>, 
<module name="LeftCurly"/>, 
<module name="RightCurly"/> 
等，这些规则帮助确保代码块正确使用大括号，并保持代码结构的清晰和一致性。

其他常见编码问题检查: 
包括空语句、魔术数字等问题的检查，如 
<module name="EmptyStatement"/>, 
<module name="MagicNumber"/> 

至此两种过滤不校验的方法完成！