service
1.0.0
YouShallNotPass est l'analyseur statique de votre code élégant.
Voyez, ce qu'il peut trouver dans le code apparemment habituel:
package com . example ;
import java . util . Collection ;
import java . util . StringTokenizer ;
public class Words {
public static final String DELIM = " ,." ;
private Collection < String > words ;
public Words () {
this . words = null ;
}
public Words ( Collection < String > words ) {
this . words = words ;
}
boolean containsIn ( String text ) {
if ( words == null ) return false ;
StringTokenizer tokenizer = new StringTokenizer ( text , DELIM );
while ( tokenizer . hasMoreTokens ()) {
String nextWord = tokenizer . nextToken ();
if ( words . contains ( nextWord )) return true ;
}
return false ;
}
}Les violations de l'analyse YouShallNotPass :
nullfree
com.example.Words(Words.java:12) > null
com.example.Words.containsIn(Words.java:20) > null
staticfree
com.example.A.main(A.java:6) > static
com.example.Words(Words.java:7) > static
allfinal
com.example.A.main(A.java:6) > String[] args
com.example.A(A.java:5) > A
com.example.Words(Words.java:9) > words
com.example.Words.containsIn(Words.java:22) > StringTokenizer tokenizer = new StringTokenizer(text, DELIM)
com.example.Words.containsIn(Words.java:24) > String nextWord = tokenizer.nextToken()
com.example.Words(Words.java:15) > Collection<String> words
com.example.Words.containsIn(Words.java:19) > String text
com.example.Words(Words.java:6) > Words
allpublic
com.example.Words.containsIn(Words.java:19)
nomultiplereturn
com.example.Words.containsIn(Words.java:19)
Ajouter le plugin à la build.gradle root.gradle
plugins {
id ' dev.youshallnotpass ' version ' x.y.z '
}
// then configure it, if you need:
youshallnotpass {
offline = true // default false
nullfree {
disabled = true // default false
threshold = 3 // default 0
skipComparisons = true // default false
}
staticfree {
disabled = true // default false
threshold = 2 // default 0
}
allfinal {
disabled = true // default false
threshold = 1 // default 0
skipInterfaceMethodParams = false // default true
skipLambdaParams = true // default false
skipCatchParams = true // default false
}
allpublic {
disabled = true // default false
threshold = 4 // default 0
}
setterfree {
disabled = true // default false
threshold = 5 // default 0
}
nomultiplereturn {
disabled = true // default false
threshold = 6 // default 0
}
inheritancefree {
disabled = true // default false
threshold = 7 // default 0
}
} Où xyz est la version réelle des plugins gradle
Invoquez-le:
./gradlew youshallnotpass Ajouter le plugin au pom.xml
< plugin >
< groupId >dev.youshallnotpass</ groupId >
< artifactId >youshallnotpass-maven-plugin</ artifactId >
< version >x.y.z</ version >
<!-- then configure it, if you need: -->
< configuration >
< offline >true</ offline > <!-- default false -->
< nullfree >
< disabled >true</ disabled > <!-- default false -->
< threshold >3</ threshold > <!-- default 0 -->
< skipComparisons >true</ skipComparisons > <!-- default false -->
</ nullfree >
< staticfree >
< disabled >true</ disabled > <!-- default false -->
< threshold >2</ threshold > <!-- default 0 -->
</ staticfree >
< allfinal >
< disabled >true</ disabled > <!-- default false -->
< threshold >1</ threshold > <!-- default 0 -->
< skipInterfaceMethodParams >false</ skipInterfaceMethodParams > <!-- default true -->
< skipLambdaParams >true</ skipLambdaParams > <!-- default false -->
< skipCatchParams >true</ skipCatchParams > <!-- default false -->
</ allfinal >
< allpublic >
< disabled >true</ disabled > <!-- default false -->
< threshold >4</ threshold > <!-- default 0 -->
</ allpublic >
< setterfree >
< disabled >true</ disabled > <!-- default false -->
< threshold >5</ threshold > <!-- default 0 -->
</ setterfree >
< nomultiplereturn >
< disabled >true</ disabled > <!-- default false -->
< threshold >6</ threshold > <!-- default 0 -->
</ nomultiplereturn >
< inheritancefree >
< disabled >true</ disabled > <!-- default false -->
< threshold >7</ threshold > <!-- default 0 -->
</ inheritancefree >
</ configuration >
</ plugin >Invoquez-le:
mvn youshallnotpass:youshallnotpass Où xyz est la version réelle de Maven Central
✅ NullFree (pourquoi null est mauvais?) Le code élégant ne doit pas utiliser les mots clés null
✅ STATIQUE FREE (Pourquoi static est mauvais?) Le code élégant ne doit pas utiliser les mots clés static
✅ Allfinal chaque classe, chaque champ, chaque argument, chaque variable locale doit être final dans le code élégant
instanceOffree [in progress] Le code élégant ne doit pas utiliser les mots clés instanceof
✅ Le code élégant sans héritage ne doit pas utiliser l'héritage de la classe (lorsqu'une classe extends une autre), seule la composition et l'héritage de type ont été autorisés
Enumfree [in progress] le code élégant ne doit pas utiliser l' enum S
SwitchFree [in progress] Le code élégant ne doit pas utiliser les blocs / expressions switch
✅ Le code élégant nomultiplereturn ne doit contenir qu'un seul (ou personne) renvoie dans une méthode
GetterFree [in progress] Le code élégant ne doit contenir aucun getters
✅ Le code élégant sans setter ne doit contenir aucun secteur
✅ Le code élégant AllPublic ne doit utiliser que des méthodes public
NopublicMethodNotOverrides [in progress] Chaque méthode publique du code élégant doit être remplacée par une interface
Options de configuration du plugin:
skipComparisons permet d'utiliser null dans les expressions booléennes: if ( some == null ) {
...
} Peut être supprimé dans le code par @SuppressWarnings("nullfree")
Peut être supprimé dans le code par @SuppressWarnings("staticfree")
Options de configuration du plugin:
skipInterfaceMethodParams permet de restreindre ou non la méthode d'interface paramètre final s, par défaut, il n'y a pas nécessaire pour définir final pour ces endroitsskipLambdaParams permet à Skip final dans les paramètres Lambda, par défaut, le paramètre Lambda doit être finalskipCatchParams permet à Skip final dans les paramètres catch , par défaut, le paramètre catch doit être final Peut être supprimé dans le code par @SuppressWarnings("allfinal")
Peut être supprimé dans le code par @SuppressWarnings("allpublic")
Peut être supprimé dans le code par @SuppressWarnings("setterfree")
Peut être supprimé dans le code par @SuppressWarnings("nomultiplereturn")
Peut être supprimé dans le code par @SuppressWarnings("inheritancefree")
Si vous utilisez le plugin YouShallNotPass sans paramètres offline = true , vous pouvez joindre les badges d'inspection à votre fichier ReadMe:
 Toute inspection peut être configurée avec threshold :
À gradle
youshallnotpass {
.. .
staticfree {
threshold = 19
}
.. .
} En maven
< configuration >
< staticfree >
< threshold >19</ threshold >
</ staticfree >
</ configuration > Toute inspection peut être désactivée par les paramètres disabled :
À gradle
youshallnotpass {
.. .
staticfree {
disabled = true
}
.. .
} En maven
< configuration >
< staticfree >
< disabled >true</ disabled >
</ staticfree >
</ configuration >Toutes les inspections sont activées par défaut.
Il existe des paramètres exclude globaux, qui peuvent être utilisés pour définir des modèles d'exclusion: à gradle
youshallnotpass {
exclude = [ " glob:**/test/**/*Test.java " ]
} En maven
< configuration >
< exclude >glob:**/test/**/*Test.java</ exclude >
</ configuration >Il existe une inspection d'option de configuration d'exclusion locale, qui a une priorité plus élevée que la configuration d'exclusion globale:
À gradle
nullfree {
exclude = [ " glob:**/*SomeBadFile.java " ]
} En maven
< nullfree >
< exclude >glob:**/*SomeBadFile.java</ exclude >
</ nullfree >Mit
