1. 介绍
介绍如何使用CodeNarc 提供静态代码分析服务.
groovy语言毕竟不是java语言,有一些自己独特的语法特点, 因此一个全面而缜密的代码分析服务就非常必须.
编写代码时，需要遵循一些规则，正确的实践，样式规则等很重要。但是，有时它并不那么简单。 当我们在团队中工作时更为重要，每个成员都有自己的偏好。改善这种情况的一种方法是为代码添加静态分析工具。
通过安装和配置Codenarc 以提高代码的质量，并创建自定义CodeNarc规则。 CodeNarc分析Groovy代码并报告潜在的错误和代码问题。
2. 使用
修改build.gradle文件,增加如下配置
build.gradle
apply plugin: 'codenarc' (1)
codenarc {
toolVersion = '1.2.1' (2)
configFile = file("${project.projectDir}/config/codenarc/rules.groovy") (3)
reportFormat = 'html' (4)
ignoreFailures = true (5)
}| 1 | 添加codenarc 插件依赖. |
| 2 | 确定CodeNarc 版本号. |
| 3 | 定义规则文件. 默认使用 config/codenarc/codenarc.xml |
| 4 | 报告格式. 如果集成Jenkins,应该改为 xml. |
| 5 | 忽略违约造成的中断. |
创建rules 规则文件:
/config/codenarc/rules.groovy
rules.groovy
ruleset {
description '''
A Sample Groovy RuleSet containing all CodeNarc Rules, grouped by category.
You can use this as a template for your own custom RuleSet.
Just delete the rules that you don't want to include.
'''
// rulesets/basic.xml
AssertWithinFinallyBlock
AssignmentInConditional
BigDecimalInstantiation
BitwiseOperatorInConditional
BooleanGetBoolean
BrokenNullCheck
BrokenOddnessCheck
ClassForName
ComparisonOfTwoConstants
ComparisonWithSelf
ConstantAssertExpression
ConstantIfExpression
ConstantTernaryExpression
DeadCode
DoubleNegative
DuplicateCaseStatement
DuplicateMapKey
DuplicateSetValue
EmptyCatchBlock
EmptyClass
EmptyElseBlock
EmptyFinallyBlock
EmptyForStatement
EmptyIfStatement
EmptyInstanceInitializer
EmptyMethod
EmptyStaticInitializer
EmptySwitchStatement
EmptySynchronizedStatement
EmptyTryBlock
EmptyWhileStatement
EqualsAndHashCode
EqualsOverloaded
ExplicitGarbageCollection
ForLoopShouldBeWhileLoop
HardCodedWindowsFileSeparator
HardCodedWindowsRootDirectory
IntegerGetInteger
MultipleUnaryOperators
RandomDoubleCoercedToZero
RemoveAllOnSelf
ReturnFromFinallyBlock
ThrowExceptionFromFinallyBlock
// rulesets/braces.xml
ElseBlockBraces
ForStatementBraces
IfStatementBraces
WhileStatementBraces
// rulesets/concurrency.xml
BusyWait
DoubleCheckedLocking
InconsistentPropertyLocking
InconsistentPropertySynchronization
NestedSynchronization
StaticCalendarField
StaticConnection
StaticDateFormatField
StaticMatcherField
StaticSimpleDateFormatField
SynchronizedMethod
SynchronizedOnBoxedPrimitive
SynchronizedOnGetClass
SynchronizedOnReentrantLock
SynchronizedOnString
SynchronizedOnThis
SynchronizedReadObjectMethod
SystemRunFinalizersOnExit
ThisReferenceEscapesConstructor
ThreadGroup
ThreadLocalNotStaticFinal
ThreadYield
UseOfNotifyMethod
VolatileArrayField
VolatileLongOrDoubleField
WaitOutsideOfWhileLoop
// rulesets/convention.xml
ConfusingTernary
CouldBeElvis
HashtableIsObsolete
IfStatementCouldBeTernary
InvertedIfElse
LongLiteralWithLowerCaseL
//NoDef
NoTabCharacter
ParameterReassignment
TernaryCouldBeElvis
TrailingComma
VectorIsObsolete
// rulesets/design.xml
AbstractClassWithPublicConstructor
AbstractClassWithoutAbstractMethod
AssignmentToStaticFieldFromInstanceMethod
BooleanMethodReturnsNull
BuilderMethodWithSideEffects
CloneableWithoutClone
CloseWithoutCloseable
CompareToWithoutComparable
ConstantsOnlyInterface
EmptyMethodInAbstractClass
FinalClassWithProtectedMember
ImplementationAsType
Instanceof
LocaleSetDefault
NestedForLoop
PrivateFieldCouldBeFinal
PublicInstanceField
ReturnsNullInsteadOfEmptyArray
ReturnsNullInsteadOfEmptyCollection
SimpleDateFormatMissingLocale
StatelessSingleton
ToStringReturnsNull
// rulesets/dry.xml
DuplicateListLiteral
//DuplicateMapLiteral
DuplicateNumberLiteral
//DuplicateStringLiteral
// rulesets/enhanced.xml
//CloneWithoutCloneable
//JUnitAssertEqualsConstantActualValue
//UnsafeImplementationAsMap
// rulesets/exceptions.xml
CatchArrayIndexOutOfBoundsException
CatchError
CatchException
CatchIllegalMonitorStateException
CatchIndexOutOfBoundsException
CatchNullPointerException
CatchRuntimeException
CatchThrowable
ConfusingClassNamedException
ExceptionExtendsError
ExceptionExtendsThrowable
ExceptionNotThrown
MissingNewInThrowStatement
ReturnNullFromCatchBlock
SwallowThreadDeath
ThrowError
ThrowException
ThrowNullPointerException
ThrowRuntimeException
ThrowThrowable
// rulesets/formatting.xml
BlankLineBeforePackage
BracesForClass
BracesForForLoop
BracesForIfElse
BracesForMethod
BracesForTryCatchFinally
//ClassJavadoc
ClosureStatementOnOpeningLineOfMultipleLineClosure
ConsecutiveBlankLines
FileEndsWithoutNewline
LineLength
MissingBlankLineAfterImports
MissingBlankLineAfterPackage
SpaceAfterCatch
SpaceAfterClosingBrace
SpaceAfterComma
SpaceAfterFor
SpaceAfterIf
SpaceAfterOpeningBrace
SpaceAfterSemicolon
SpaceAfterSwitch
SpaceAfterWhile
SpaceAroundClosureArrow
//SpaceAroundMapEntryColon
SpaceAroundOperator
SpaceBeforeClosingBrace
SpaceBeforeOpeningBrace
TrailingWhitespace
// rulesets/generic.xml
IllegalClassMember
IllegalClassReference
IllegalPackageReference
IllegalRegex
IllegalString
IllegalSubclass
RequiredRegex
RequiredString
StatelessClass
// rulesets/grails.xml
GrailsDomainHasEquals
GrailsDomainHasToString
GrailsDomainReservedSqlKeywordName
GrailsDomainWithServiceReference
GrailsDuplicateConstraint
GrailsDuplicateMapping
//GrailsMassAssignment
//GrailsPublicControllerMethod
//GrailsServletContextReference
//GrailsSessionReference // DEPRECATED
//GrailsStatelessService
// rulesets/groovyism.xml
AssignCollectionSort
AssignCollectionUnique
ClosureAsLastMethodParameter
CollectAllIsDeprecated
ConfusingMultipleReturns
ExplicitArrayListInstantiation
ExplicitCallToAndMethod
ExplicitCallToCompareToMethod
ExplicitCallToDivMethod
ExplicitCallToEqualsMethod
ExplicitCallToGetAtMethod
ExplicitCallToLeftShiftMethod
ExplicitCallToMinusMethod
ExplicitCallToModMethod
ExplicitCallToMultiplyMethod
ExplicitCallToOrMethod
ExplicitCallToPlusMethod
ExplicitCallToPowerMethod
ExplicitCallToRightShiftMethod
ExplicitCallToXorMethod
ExplicitHashMapInstantiation
ExplicitHashSetInstantiation
ExplicitLinkedHashMapInstantiation
ExplicitLinkedListInstantiation
ExplicitStackInstantiation
ExplicitTreeSetInstantiation
GStringAsMapKey
GStringExpressionWithinString
GetterMethodCouldBeProperty
GroovyLangImmutable
UseCollectMany
UseCollectNested
// rulesets/imports.xml
DuplicateImport
ImportFromSamePackage
ImportFromSunPackages
MisorderedStaticImports
NoWildcardImports
UnnecessaryGroovyImport
UnusedImport
// rulesets/jdbc.xml
DirectConnectionManagement
JdbcConnectionReference
JdbcResultSetReference
JdbcStatementReference
// rulesets/junit.xml
ChainedTest
CoupledTestCase
JUnitAssertAlwaysFails
JUnitAssertAlwaysSucceeds
JUnitFailWithoutMessage
JUnitLostTest
JUnitPublicField
JUnitPublicNonTestMethod
JUnitPublicProperty
JUnitSetUpCallsSuper
JUnitStyleAssertions
JUnitTearDownCallsSuper
JUnitTestMethodWithoutAssert
JUnitUnnecessarySetUp
JUnitUnnecessaryTearDown
JUnitUnnecessaryThrowsException
SpockIgnoreRestUsed
UnnecessaryFail
UseAssertEqualsInsteadOfAssertTrue
UseAssertFalseInsteadOfNegation
UseAssertNullInsteadOfAssertEquals
UseAssertSameInsteadOfAssertTrue
UseAssertTrueInsteadOfAssertEquals
UseAssertTrueInsteadOfNegation
// rulesets/logging.xml
LoggerForDifferentClass
LoggerWithWrongModifiers
LoggingSwallowsStacktrace
MultipleLoggers
PrintStackTrace
Println
SystemErrPrint
SystemOutPrint
// rulesets/naming.xml
AbstractClassName
ClassName
ClassNameSameAsFilename
ClassNameSameAsSuperclass
ConfusingMethodName
FactoryMethodName
FieldName
InterfaceName
InterfaceNameSameAsSuperInterface
MethodName
ObjectOverrideMisspelledMethodName
PackageName
PackageNameMatchesFilePath
ParameterName
PropertyName
VariableName
// rulesets/security.xml
FileCreateTempFile
InsecureRandom
JavaIoPackageAccess
NonFinalPublicField
NonFinalSubclassOfSensitiveInterface
ObjectFinalize
PublicFinalizeMethod
SystemExit
UnsafeArrayDeclaration
// rulesets/serialization.xml
EnumCustomSerializationIgnored
SerialPersistentFields
SerialVersionUID
SerializableClassMustDefineSerialVersionUID
// rulesets/size.xml
//AbcComplexity // DEPRECATED: Use the AbcMetric rule instead. Requires the GMetrics jar
AbcMetric // Requires the GMetrics jar
ClassSize
//CrapMetric // Requires the GMetrics jar and a Cobertura coverage file
CyclomaticComplexity // Requires the GMetrics jar
MethodCount
MethodSize
NestedBlockDepth
ParameterCount
// rulesets/unnecessary.xml
AddEmptyString
ConsecutiveLiteralAppends
ConsecutiveStringConcatenation
UnnecessaryBigDecimalInstantiation
UnnecessaryBigIntegerInstantiation
UnnecessaryBooleanExpression
UnnecessaryBooleanInstantiation
UnnecessaryCallForLastElement
UnnecessaryCallToSubstring
UnnecessaryCast
UnnecessaryCatchBlock
UnnecessaryCollectCall
UnnecessaryCollectionCall
UnnecessaryConstructor
UnnecessaryDefInFieldDeclaration
UnnecessaryDefInMethodDeclaration
UnnecessaryDefInVariableDeclaration
UnnecessaryDotClass
UnnecessaryDoubleInstantiation
UnnecessaryElseStatement
UnnecessaryFinalOnPrivateMethod
UnnecessaryFloatInstantiation
UnnecessaryGString
UnnecessaryGetter
UnnecessaryIfStatement
UnnecessaryInstanceOfCheck
UnnecessaryInstantiationToGetClass
UnnecessaryIntegerInstantiation
UnnecessaryLongInstantiation
UnnecessaryModOne
UnnecessaryNullCheck
UnnecessaryNullCheckBeforeInstanceOf
UnnecessaryObjectReferences
UnnecessaryOverridingMethod
UnnecessaryPackageReference
UnnecessaryParenthesesForMethodCallWithClosure
UnnecessaryPublicModifier
UnnecessaryReturnKeyword
UnnecessarySafeNavigationOperator
UnnecessarySelfAssignment
UnnecessarySemicolon
UnnecessaryStringInstantiation
UnnecessarySubstring
UnnecessaryTernaryExpression
UnnecessaryToString
UnnecessaryTransientModifier
// rulesets/unused.xml
UnusedArray
UnusedMethodParameter
UnusedObject
UnusedPrivateField
UnusedPrivateMethod
UnusedPrivateMethodParameter
UnusedVariable
}2.1. 运行检查
运行 check 任务.
$ ./gradlew check或直接使用idea的gradle工具
2.2. 查看报告
查看 /build/reports/codeNarc/main.html
