idea 配置checkstyle全过程

2023-11-02 04:36
文章标签 配置 idea 全过程 checkstyle

本文主要是介绍idea 配置checkstyle全过程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

checkstyle是提高代码质量,检查代码规范的很好用的一款工具，本文简单介绍一下集成的步骤，并提供一份完整的checkstyle的代码规范格式文件，以及常见的格式问题的解决方法。

一，安装

打开idea的文件选项，选择设置，进入后选择插件，搜索checkstyle,安装，安装后重启idea。

二，格式文件

在项目的根目录下新建checkstyle.xml文件

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN""https://checkstyle.org/dtds/configuration_1_3.dtd"><!--Checkstyle configuration that checks the Google coding conventions from Google Java Stylethat can be found at https://google.github.io/styleguide/javaguide.htmlCheckstyle is very configurable. Be sure to read the documentation athttp://checkstyle.org (or in your downloaded distribution).To completely disable a check, just comment it out or delete it from the file.To suppress certain violations please review suppression filters.Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.--><module name="Checker"><module name="SuppressWarningsFilter"/><property name="charset" value="UTF-8"/><property name="severity" value="warning"/><property name="fileExtensions" value="java, properties, xml"/><!-- Excludes all 'module-info.java' files              --><!-- See https://checkstyle.org/filefilters/index.html --><module name="BeforeExecutionExclusionFileFilter"><property name="fileNamePattern" value="module\-info\.java$"/></module><!-- https://checkstyle.org/filters/suppressionfilter.html --><module name="SuppressionFilter"><property name="file" value="${org.checkstyle.google.suppressionfilter.config}"default="checkstyle-suppressions.xml"/><property name="optional" value="true"/></module><!-- Checks for whitespace                               --><!-- See http://checkstyle.org/checks/whitespace/index.html --><module name="FileTabCharacter"><property name="eachLine" value="true"/></module><module name="LineLength"><property name="fileExtensions" value="java"/><property name="max" value="100"/><property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/></module><module name="TreeWalker"><module name="OuterTypeFilename"/><module name="IllegalTokenText"><property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/><property name="format"value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/><property name="message"value="Consider using special escape sequence instead of octal value or Unicode escaped value."/></module><module name="AvoidEscapedUnicodeCharacters"><property name="allowEscapesForControlCharacters" value="true"/><property name="allowByTailComment" value="true"/><property name="allowNonPrintableEscapes" value="true"/></module><module name="AvoidStarImport"/><module name="OneTopLevelClass"/><module name="NoLineWrap"><property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/></module><module name="EmptyBlock"><property name="option" value="TEXT"/><property name="tokens"value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/></module><module name="NeedBraces"><property name="tokens"value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/></module><module name="LeftCurly"><property name="tokens"value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/></module><module name="RightCurly"><property name="id" value="RightCurlySame"/><property name="tokens"value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,LITERAL_DO"/></module><module name="RightCurly"><property name="id" value="RightCurlyAlone"/><property name="option" value="alone"/><property name="tokens"value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,COMPACT_CTOR_DEF, LITERAL_SWITCH"/></module><module name="SuppressionXpathSingleFilter"><!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 --><property name="id" value="RightCurlyAlone"/><property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]or preceding-sibling::*[last()][self::LCURLY]]"/></module><module name="WhitespaceAfter"><property name="tokens"value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_RETURN,LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_FINALLY, DO_WHILE, ELLIPSIS,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_CATCH, LAMBDA,LITERAL_YIELD, LITERAL_CASE"/></module><module name="WhitespaceAround"><property name="allowEmptyConstructors" value="true"/><property name="allowEmptyLambdas" value="true"/><property name="allowEmptyMethods" value="true"/><property name="allowEmptyTypes" value="true"/><property name="allowEmptyLoops" value="true"/><property name="ignoreEnhancedForColon" value="false"/><property name="tokens"value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/><message key="ws.notFollowed"value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocksmay only be represented as '{}' when not part of a multi-block statement (4.1.3)"/><message key="ws.notPreceded"value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/></module><module name="OneStatementPerLine"/><module name="MultipleVariableDeclarations"/><module name="ArrayTypeStyle"/><module name="MissingSwitchDefault"/><module name="FallThrough"/><module name="UpperEll"/><module name="ModifierOrder"/><module name="EmptyLineSeparator"><property name="tokens"value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,COMPACT_CTOR_DEF"/><property name="allowNoEmptyLineBetweenFields" value="true"/></module><module name="SeparatorWrap"><property name="id" value="SeparatorWrapDot"/><property name="tokens" value="DOT"/><property name="option" value="nl"/></module><module name="SeparatorWrap"><property name="id" value="SeparatorWrapComma"/><property name="tokens" value="COMMA"/><property name="option" value="EOL"/></module><module name="SeparatorWrap"><!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 --><property name="id" value="SeparatorWrapEllipsis"/><property name="tokens" value="ELLIPSIS"/><property name="option" value="EOL"/></module><module name="SeparatorWrap"><!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 --><property name="id" value="SeparatorWrapArrayDeclarator"/><property name="tokens" value="ARRAY_DECLARATOR"/><property name="option" value="EOL"/></module><module name="SeparatorWrap"><property name="id" value="SeparatorWrapMethodRef"/><property name="tokens" value="METHOD_REF"/><property name="option" value="nl"/></module><module name="PackageName"><property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/><message key="name.invalidPattern"value="Package name ''{0}'' must match pattern ''{1}''."/></module><module name="TypeName"><property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,ANNOTATION_DEF, RECORD_DEF"/><message key="name.invalidPattern"value="Type name ''{0}'' must match pattern ''{1}''."/></module><module name="MemberName"><property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/><message key="name.invalidPattern"value="Member name ''{0}'' must match pattern ''{1}''."/></module><module name="ParameterName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Parameter name ''{0}'' must match pattern ''{1}''."/></module><module name="LambdaParameterName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/></module><module name="CatchParameterName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Catch parameter name ''{0}'' must match pattern ''{1}''."/></module><module name="LocalVariableName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Local variable name ''{0}'' must match pattern ''{1}''."/></module><module name="PatternVariableName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Pattern variable name ''{0}'' must match pattern ''{1}''."/></module><module name="ClassTypeParameterName"><property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/><message key="name.invalidPattern"value="Class type name ''{0}'' must match pattern ''{1}''."/></module><module name="RecordComponentName"><property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/><message key="name.invalidPattern"value="Record component name ''{0}'' must match pattern ''{1}''."/></module><module name="RecordTypeParameterName"><property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/><message key="name.invalidPattern"value="Record type name ''{0}'' must match pattern ''{1}''."/></module><module name="MethodTypeParameterName"><property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/><message key="name.invalidPattern"value="Method type name ''{0}'' must match pattern ''{1}''."/></module><module name="InterfaceTypeParameterName"><property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/><message key="name.invalidPattern"value="Interface type name ''{0}'' must match pattern ''{1}''."/></module><module name="NoFinalizer"/><module name="GenericWhitespace"><message key="ws.followed"value="GenericWhitespace ''{0}'' is followed by whitespace."/><message key="ws.preceded"value="GenericWhitespace ''{0}'' is preceded with whitespace."/><message key="ws.illegalFollow"value="GenericWhitespace ''{0}'' should followed by whitespace."/><message key="ws.notPreceded"value="GenericWhitespace ''{0}'' is not preceded with whitespace."/></module><module name="Indentation"><property name="basicOffset" value="4"/><property name="braceAdjustment" value="2"/><property name="caseIndent" value="2"/><property name="throwsIndent" value="4"/><property name="lineWrappingIndentation" value="4"/><property name="arrayInitIndent" value="2"/></module><module name="AbbreviationAsWordInName"><property name="ignoreFinal" value="false"/><property name="allowedAbbreviationLength" value="0"/><property name="tokens"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,RECORD_COMPONENT_DEF"/></module><module name="NoWhitespaceBeforeCaseDefaultColon"/><module name="OverloadMethodsDeclarationOrder"/><module name="VariableDeclarationUsageDistance"/><module name="CustomImportOrder"><property name="sortImportsInGroupAlphabetically" value="true"/><property name="separateLineBetweenGroups" value="true"/><property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/><property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/></module><module name="MethodParamPad"><property name="tokens"value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/></module><module name="NoWhitespaceBefore"><property name="tokens"value="COMMA, SEMI, POST_INC, POST_DEC, DOT,LABELED_STAT, METHOD_REF"/><property name="allowLineBreaks" value="true"/></module><module name="ParenPad"><property name="tokens"value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,RECORD_DEF"/></module><module name="OperatorWrap"><property name="option" value="NL"/><property name="tokens"value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,TYPE_EXTENSION_AND "/></module><module name="AnnotationLocation"><property name="id" value="AnnotationLocationMostCases"/><property name="tokens"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,RECORD_DEF, COMPACT_CTOR_DEF"/></module><module name="AnnotationLocation"><property name="id" value="AnnotationLocationVariables"/><property name="tokens" value="VARIABLE_DEF"/><property name="allowSamelineMultipleAnnotations" value="true"/></module><module name="NonEmptyAtclauseDescription"/><module name="InvalidJavadocPosition"/><module name="JavadocTagContinuationIndentation"/><module name="SummaryJavadoc"><property name="forbiddenSummaryFragments"value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/></module><module name="JavadocParagraph"/><module name="RequireEmptyLineBeforeBlockTagGroup"/><module name="AtclauseOrder"><property name="tagOrder" value="@param, @return, @throws, @deprecated"/><property name="target"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/></module><module name="JavadocMethod"><property name="accessModifiers" value="public"/><property name="allowMissingParamTags" value="true"/><property name="allowMissingReturnTag" value="true"/><property name="allowedAnnotations" value="Override, Test"/><property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/></module><module name="MissingJavadocMethod"><property name="scope" value="public"/><property name="minLineCount" value="2"/><property name="allowedAnnotations" value="Override, Test"/><property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,COMPACT_CTOR_DEF"/></module><module name="MissingJavadocType"><property name="scope" value="protected"/><property name="tokens"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,RECORD_DEF, ANNOTATION_DEF"/><property name="excludeScope" value="nothing"/></module><module name="MethodName"><property name="format" value="^[a-z][a-z0-9]\w*$"/><message key="name.invalidPattern"value="Method name ''{0}'' must match pattern ''{1}''."/></module><module name="SingleLineJavadoc"/><module name="EmptyCatchBlock"><property name="exceptionVariableName" value="expected"/></module><module name="CommentsIndentation"><property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/></module><!-- https://checkstyle.org/filters/suppressionxpathfilter.html --><module name="SuppressionXpathFilter"><property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"default="checkstyle-xpath-suppressions.xml"/><property name="optional" value="true"/></module><module name="SuppressWarningsHolder"/><module name="SuppressionCommentFilter"><property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/><property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/><property name="checkFormat" value="$1"/></module><module name="SuppressWithNearbyCommentFilter"><property name="commentFormat" value="CHECKSTYLE.SUPPRESS\: ([\w\|]+)"/><!-- $1 refers to the first match group in the regex defined in commentFormat --><property name="checkFormat" value="$1"/><!-- The check is suppressed in the next line of code after the comment --><property name="influenceFormat" value="1"/></module></module>
</module>

三，应用检查

1，打开设置--》工具--》Checkstyle

2，新增一个配置文件，并勾上

3，运行检查


四，常见格式问题的解决方法

1，==两边加空格


2，注释后面加句号


3，参数后面加上nonull


4，@param前面空一行
 
5，if后面要空格


6，参数里逗号后有空格

码字不易，记得点赞关注哟！

这篇关于idea 配置checkstyle全过程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/328156。

相关文章

MySQL数据库双机热备的配置方法详解

MySQL数据库双机热备的配置方法详解

《MySQL数据库双机热备的配置方法详解》在企业级应用中,数据库的高可用性和数据的安全性是至关重要的,MySQL作为最流行的开源关系型数据库管理系统之一,提供了多种方式来实现高可用性,其中双机热备（M... 目录1. 环境准备1.1 安装mysql1.2 配置MySQL1.2.1 主服务器配置1.2.2 从
阅读更多...
IDEA和GIT关于文件中LF和CRLF问题及解决

IDEA和GIT关于文件中LF和CRLF问题及解决

《IDEA和GIT关于文件中LF和CRLF问题及解决》文章总结：因IDEA默认使用CRLF换行符导致Shell脚本在Linux运行报错,需在编辑器和Git中统一为LF,通过调整Git的core.aut... 目录问题描述问题思考解决过程总结问题描述项目软件安装shell脚本上git仓库管理，但拉取后，上l
阅读更多...
Linux云服务器手动配置DNS的方法步骤

Linux云服务器手动配置DNS的方法步骤

《Linux云服务器手动配置DNS的方法步骤》在Linux云服务器上手动配置DNS（域名系统）是确保服务器能够正常解析域名的重要步骤,以下是详细的配置方法,包括系统文件的修改和常见问题的解决方案,需要... 目录1. 为什么需要手动配置 DNS？2. 手动配置 DNS 的方法方法 1：修改 /etc/res
阅读更多...
mysql8.0.43使用InnoDB Cluster配置主从复制

mysql8.0.43使用InnoDB Cluster配置主从复制

《mysql8.0.43使用InnoDBCluster配置主从复制》本文主要介绍了mysql8.0.43使用InnoDBCluster配置主从复制,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录1、配置Hosts解析(所有服务器都要执行)2、安装mysql shell(所有服务器都要执行)3、
阅读更多...
idea npm install很慢问题及解决(nodejs)

idea npm install很慢问题及解决(nodejs)

《ideanpminstall很慢问题及解决(nodejs)》npm安装速度慢可通过配置国内镜像源（如淘宝）、清理缓存及切换工具解决,建议设置全局镜像（npmconfigsetregistryht... 目录idea npm install很慢(nodejs)配置国内镜像源清理缓存总结idea npm in
阅读更多...
idea+spring boot创建项目的搭建全过程

idea+spring boot创建项目的搭建全过程

《idea+springboot创建项目的搭建全过程》SpringBoot是Spring社区发布的一个开源项目,旨在帮助开发者快速并且更简单的构建项目,：本文主要介绍idea+springb... 目录一.idea四种搭建方式1.Javaidea命名规范2JavaWebTomcat的安装一.明确tomcat
阅读更多...
idea突然报错Malformed \uxxxx encoding问题及解决

idea突然报错Malformed \uxxxx encoding问题及解决

《idea突然报错Malformeduxxxxencoding问题及解决》Maven项目在切换Git分支时报错,提示project元素为描述符根元素,解决方法：删除Maven仓库中的resolv... 目www.chinasem.cn录问题解决方式总结问题idea 上的 maven China编程项目突然报错，是
阅读更多...
java程序远程debug原理与配置全过程

java程序远程debug原理与配置全过程

《java程序远程debug原理与配置全过程》文章介绍了Java远程调试的JPDA体系,包含JVMTI监控JVM、JDWP传输调试命令、JDI提供调试接口,通过-Xdebug、-Xrunjdwp参数配... 目录背景组成模块间联系IBM对三个模块的详细介绍编程使用总结背景日常工作中，每个程序员都会遇到bu
阅读更多...
Python内存管理机制之垃圾回收与引用计数操作全过程

Python内存管理机制之垃圾回收与引用计数操作全过程

《Python内存管理机制之垃圾回收与引用计数操作全过程》SQLAlchemy是Python中最流行的ORM（对象关系映射）框架之一,它提供了高效且灵活的数据库操作方式,本文将介绍如何使用SQLAlc... 目录安装核心概念连接数据库定义数据模型创建数据库表基本CRUD操作创建数据读取数据更新数据删除数据查
阅读更多...
在Node.js中使用.env文件管理环境变量的全过程

在Node.js中使用.env文件管理环境变量的全过程

《在Node.js中使用.env文件管理环境变量的全过程》Node.js应用程序通常依赖于环境变量来管理敏感信息或配置设置,.env文件已经成为一种流行的本地管理这些变量的方法,本文将探讨.env文件... 目录引言为什么使php用 .env 文件 ?如何在 Node.js 中使用 .env 文件最佳实践引
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2