Ajout automatique d'un constructeur privé avec Sensei

Ajout automatique d'un constructeur privé avec Sensei

Dans une classe utilitaire, lorsque les champs et les méthodes sont statiques, il n'y a pas de raison évidente de l'instancier.

Par exemple, UtilityClass utility = new UtilityClass() ;

Le code ci-dessous est une implémentation simple d'une classe Utility.

public class UtilityClass {
    public static final Boolean ULTIMATE_TRUTH = true;
    public static boolean getTrue(){
        return ULTIMATE_TRUTH;
    }
}

C'est le type de schéma de codage que les outils d'analyse statique peuvent détecter, mais ils n'offrent souvent pas la possibilité de résoudre le problème.

Je peux utiliser Sensei pour identifier le modèle de codage et générer automatiquement un constructeur privé pour m'empêcher d'instancier la classe.

Recherche de la classe

Je vais ajouter une nouvelle recette sur la classe utilitaire appelée :

•  Classes statiques : créer un constructeur privé.

Dans un premier temps, je vais créer un matcheur simple pour rechercher une classe.

recherche :

  class: {}

Cela correspondra à n'importe quelle classe, ce qui est suffisant pour me permettre de commencer à écrire une solution rapide. Une fois que j'aurai trouvé une solution rapide qui fonctionne, j'affinerai la recherche pour qu'elle mette en évidence les classes qui ont le plus de chances d'avoir un constructeur privé.

Correction rapide

Pour la solution rapide, je souhaite générer un constructeur privé.

Dans la classe d'exemple, cela se traduirait par

   private UtilityClass(){}

Pour ajouter le code ci-dessus à ma classe, ma solution rapide ajoutera une méthode, et le nom de la méthode sera un modèle Mustache qui utilise le nom de la classe.

les correctifs disponibles :

- name: "add private constructor"
  actions:
  - addMethod:
      method: "private {{{ name }}}(){}"

Dans l'éditeur graphique, j'utilise l'option Afficher les variables pour créer le modèle Moustache, puis je modifie le champ pour ajouter le modificateur privé, les crochets et les accolades afin que la syntaxe soit correcte.

Cela me permet d'ajouter un constructeur privé à n'importe quelle classe.

L'aperçu QuickFix m'aide car je peux voir le code généré pendant que j'écris le modèle Mustache.

Maintenant que je le sais, je peux résoudre le problème. J'affinerai les conditions de recherche pour afficher la recette au moment le plus approprié.

Recherche des constructeurs manquants

Idéalement, je ne veux pas créer une recette qui signale une erreur pour chaque classe. J'ajouterai donc quelques conditions supplémentaires dans la recherche afin de ne faire correspondre que les classes qui n'ont pas de constructeur.

recherche :

  classe :
sans :
enfant :
méthode :
constructeur : true

Le YAML est légèrement différent de l'interface graphique.

Dans l'interface graphique, je la configure pour qu'elle recherche une classe sans méthode enfant, c'est-à-dire un constructeur "oui". Nous utilisons "yes" dans l'interface graphique au lieu de "true" pour rendre l'interface graphique un peu plus conviviale.

Cette recette ne se révèlera désormais que pour toute classe sans constructeur.

Réduire la recherche de coupables probables

Je pourrais donc aller plus loin et rechercher la présence de méthodes ou de champs statiques.

Je recherche toute classe sans constructeur et qui possède soit tous les champs statiques publics, soit toutes les méthodes statiques publiques.

recherche :

  class :
with :
anyOf :
- child :
method :
allOf :
- modifier : "public"
- modificateur : "static"
- enfant :
champ :
allOf :
- modificateur : "static"
- modificateur : "public"
sans :
enfant :
méthode :
constructeur : true

Puisque Sensei est utilisé pour m'aider, en tant que programmeur, dans l'IDE, plutôt que pour analyser statiquement le code et signaler toutes les erreurs, ce filtre est suffisamment bon pour exclure la plupart des classes de ma base de code où je pourrais avoir une bonne raison d'avoir un constructeur public par défaut.

Dans certains projets, cela peut être un pas de trop car les classes utilitaires peuvent avoir des méthodes privées, et je peux donc choisir de rechercher la présence de "toutes" les méthodes statiques publiques, plutôt que "toutes".

       - enfant :
champ :
anyOf :
- modificateur : "static"
- modificateur : "public"

Conseils

Sensei n'est pas conçu pour remplacer un outil d'analyse statique. Sensei peut compléter un outil d'analyse statique pour les problèmes courants associés à votre processus de codage ou à votre technologie. En reproduisant suffisamment la correspondance pour mettre en évidence un problème, et en soutenant le processus de développement en générant le code QuickFix.

Ce que j'essaie de faire, c'est de créer une recette assez simple qui inclut toutes les situations où j'en ai besoin, mais en la filtrant pour qu'elle ne soit pas suggérée dans chaque classe.

Lorsque je travaille sur des recettes, j'essaie de réduire les risques. Dans ce cas, je n'étais pas sûr de pouvoir créer le constructeur privé, j'ai donc créé le QuickFix en premier. J'ai ensuite remanié les conditions de recherche pour les rendre plus spécifiques.

Parfois, lorsque je travaille sur des recettes, je ne suis pas sûre de savoir comment effectuer la recherche, alors j'y travaille d'abord.

Je trouve qu'il est plus facile de créer des recettes lorsque je les construis de manière incrémentale, en passant du remaniement du QuickFix à la recherche.

---

Vous pouvez installer Sensei à partir d'IntelliJ en utilisant "Préférences \NPlugins" (Mac) ou "Paramètres \NPlugins" (Windows) puis en recherchant "sensei secure code".

Le code source et les recettes se trouvent dans le dépôt `sensei-blog-examples` sur le compte GitHub Secure Code Warrior , dans le module `pojoexamples`.

https://github.com/securecodewarrior/sensei-blog-examples

‍