Collègue : Votre code n'est pas bien écrit, il n'est pas assez standardisé.
Moi : Comment le code que j'ai écrit peut-il être irrégulier, ne dis pas de bêtises.
Mon collègue a donc ouvert mon IDEA, installé un plug-in, puis l'a exécuté. La spécification n'est pas standardisée, voyons le rapport.
Comment cela peut-il être bon, cette chose a sélectionné tant de problèmes pour moi, est-ce fiable ou non.
Le collègue s'est éloigné d'une manière froide, me laissant assis à mon siège à regarder l'écran avec panique. J'ai soigneusement vérifié chaque élément de ce rapport, et plus je lisais, plus je sentais que les problèmes signalés par ce plug-in étaient raisonnables. J'ai été vraiment négligent, et j'ai même choisi un bogue pour moi.
De quel type de plugin s'agit-il, le code de révision est invincible.
Ce plug-in est SonarLint, et le slogan du site officiel est clean code begins in your IDE with {SonarLint}.
En tant que programmeur, nous espérons certainement que le code que nous écrivons est impeccable, mais pour diverses raisons, certains problèmes et même des bogues ne peuvent être évités, en particulier pour les étudiants qui débutent dans le développement, et de nombreux programmeurs ayant de nombreuses années d'expérience en développement seront également ont de mauvaises habitudes de codage.
La qualité du code et la spécification du code doivent d'abord être déterminées par le niveau et l'alphabétisation du programmeur, mais pour améliorer le niveau, il faut des méthodes, et il existe de nombreuses méthodes, comme se référer aux spécifications et aux codes des principaux fabricants, comme être dirigé par un grand patron, Le reste s'accumule petit à petit, et quelques plug-ins utiles peuvent toujours nous rappeler ce qu'est une bonne spécification de code et ce qu'est un bon code.
SonarLint est un plug-in tellement utile qui peut nous aider reviewà coder en temps réel, et même à trouver des problèmes potentiels dans le code et à fournir des solutions.
SonarLint utilise des techniques d'analyse de code statique pour détecter les erreurs et les vulnérabilités courantes dans le code. Par exemple, il peut détecter les références de pointeur null, les erreurs de conversion de type, les erreurs de code et de logique en double, etc. Ce sont des problèmes courants, mais parfois difficiles à repérer. En utilisant le plug-in SonarLint, ces problèmes peuvent être découverts lors de l'écriture du code, et ils peuvent être corrigés à temps, ce qui permet d'éviter que ces problèmes n'affectent la stabilité de l'application.
Par exemple, le morceau de code suivant n'a pas le paramètre de condition pour terminer la boucle, SonarLint donnera une invite, et ceux qui souffrent de trouble obsessionnel-compulsif peuvent le supporter. Le soulignement rouge est-il ici ?
Le plugin SonarLint m'aide à améliorer la lisibilité de mon code. Le code doit être facile à lire et à comprendre, ce qui aide les autres développeurs à maintenir et à modifier le code plus facilement. Le plug-in SonarLint peut détecter les mauvaises odeurs de code dans votre code, telles que les commentaires inutiles, les fonctions longues et les noms de variables non descriptifs, etc. En utilisant le plugin SonarLint, vous pouvez mieux comprendre comment écrire un code clair, concis et compréhensible.
hello_worldPar exemple, pour la variable statique nommée ci-dessous final, SonarLint donne deux suggestions.
- Étant donné que la variable n'a pas été utilisée, il est recommandé de la supprimer ;
- Les noms de variables statiques immuables ne sont pas conformes à la spécification ;
Le plugin SonarLint m'aide à suivre les meilleures pratiques et normes. L'écriture de code qui respecte les normes et les meilleures pratiques garantit la qualité et la fiabilité des applications. Le plug-in SonarLint peut détecter les violations de règles dans votre code, telles que les conversions de type non sécurisées, les variables et méthodes inutilisées, la gestion incorrecte des exceptions, etc. En utilisant le plug-in SonarLint, vous pouvez apprendre à écrire du code conforme aux meilleures pratiques et normes, et rendre votre code plus robuste et fiable.
Par exemple, la méthode de levée d'exception suivante est lancée directement Exception, et SonarLint recommande de ne pas l'utiliser Exception, mais de personnaliser une exception. L'exception personnalisée peut permettre aux utilisateurs de voir intuitivement à quoi sert l'exception, au lieu du Exceptiontype de base d'exportation et de transfert.
Installer SonarLint
Vous pouvez ouvrir directement IDEA Settings -> Plugins, MarketPlacey rechercher SonarLintet l'installer directement.
Vous pouvez également télécharger directement depuis le site officiel, ouvrir la page https://www.sonarsource.com/products/sonarlint/, vous pouvez voir les icônes de téléchargement de plusieurs langues et de plusieurs outils de développement sur la page, cliquez sur le bouton ci-dessous EXPLOREpour accéder à la page de téléchargement à télécharger. Bien que nous ne l'utilisions que dans IDEA, il prend en charge Java, non seulement IDEA, mais également de nombreux langages tels que Python et PHP, ainsi que de nombreux IDE tels que Visual Studio et VS Code.
Utilisation dans IDEA
Une fois le plug-in SonarLint installé, la fonction d'analyse en temps réel est activée par défaut, tout comme la fonction d'invite intelligente. Lorsque vous cliquez et tapez sur le clavier, le plug-in analysera en silence. , invites de lignes ondulées jaunes SonarLint.
Bien entendu, vous pouvez également faire un clic droit dans un fichier, ou faire un clic droit dans le répertoire racine du projet, et cliquer dans le menu contextuel Analyze with SonarLintpour analyser le fichier en cours ou l'ensemble du projet.
Après l'analyse, un rapport d'analyse sera généré.
À gauche se trouvent les résultats de l'analyse des dossiers individuels et à droite se trouvent des suggestions et des exemples de modifications au problème.
SonarLint divise les problèmes en trois types
| taper | illustrer |
|---|---|
| Bogue | Un bogue dans le code qui affecte le fonctionnement du programme |
| Vulnérabilité | Vulnérabilités, qui peuvent être utilisées comme points d'entrée d'attaque |
| Odeur de code | Signification du code, qui peut affecter la maintenabilité du code |
Les problèmes sont divisés en 5 catégories selon leur gravité
| gravité | illustrer |
|---|---|
| BLOQUEUR | Cela a affecté le fonctionnement normal du programme et cela ne fonctionnera pas s'il n'est pas modifié. |
| CRITIQUE | Cela peut affecter le fonctionnement du programme et menacer la sécurité du programme. Généralement, il ne peut pas être modifié. |
| MAJEUR | Problèmes de qualité du code, mais sérieux |
| MINEURE | Même problème de qualité de code, mais moins grave |
| INFO | quelques conseils d'ami |
SonarQube
SonarLint est un plug-in d'analyse au niveau de l'IDE, SonarQubeil peut également utiliser des fonctions et s'affiche sous la forme d'un Web, ce qui peut fournir un effet de visualisation Web pour les projets de toute l'équipe de développement. Et il peut être intégré à des outils de déploiement tels que CI\CD pour fournir une analyse de code avant la publication.
SonarQubeIl s'agit d'un projet Java. Vous pouvez télécharger le projet à partir du site officiel et le démarrer localement, ou vous pouvez le démarrer à la manière d'un docker. La configuration globale peut ensuite être configurée dans IDEA SonarQube.
Vous pouvez également configurer un projet séparément dans SonarQube web Après avoir créé le projet, exécutez la commande mvn directement dans le projet à analyser pour générer un rapport d'analyse pour le projet correspondant, puis visualisez-le dans SonarQube web.
Pour la grande majorité des développeurs et des équipes de développement, SonarQube est en fait inutile, tant que chacun de nous résout les suggestions données par SonarLint dans l'IDE, bien sûr la qualité du code final est conforme aux normes.
Plug-in de protocole Ali Java
Chaque équipe de développement a des spécifications de code au sein de l'équipe, telles que la dénomination des variables, le format des commentaires et la manière d'utiliser diverses bibliothèques de classes. Ali a mis à jour la version Java du manuel du développeur d'Alibaba. Vous devez avoir entendu parler de la version Taishan et de la version ultime. Si les développeurs peuvent respecter les réglementations qu'elle contient, je crains que d'autres n'aient aucun moyen de dissoudre votre code. .
Conformément aux spécifications au niveau du langage de ce manuel de développement, Ali a également publié un plug-in IDEA appelé Alibaba Java Coding Guidelines, qui peut être téléchargé directement à partir du magasin de plug-ins.
hello_worldPar exemple, pour le nom de variable mentionné ci-dessus , le plug-in demande directement "Corriger en majuscules séparées par des traits de soulignement".
Un autre exemple est quelques conseils sur les commentaires, il n'est pas recommandé d'utiliser des commentaires de fin de ligne.
Aussi, par exemple, pour l'utilisation du pool de threads, il existe des suggestions basées sur la spécification. Il est recommandé de définir vous-même des paramètres tels que le nombre de threads principaux et le nombre maximum de threads, et il n'est pas recommandé d'utiliser Excutorsclasses d'outils.
Avec ces deux plug-ins, qui peut dire que mon code n'est pas standardisé.
Si vous êtes intéressé par Python et souhaitez obtenir un salaire plus élevé en apprenant Python, alors l'ensemble de matériel d'apprentissage Python suivant doit vous être utile !
Les matériaux incluent : package d'installation Python + code d'activation, développement Web Python, robot d'exploration Python, analyse de données Python, intelligence artificielle, apprentissage automatique et autres didacticiels d'apprentissage. Même les débutants avec 0 bases peuvent comprendre et comprendre. Suivez le tutoriel et amenez-vous à apprendre Python systématiquement à partir de zéro bases !
1. Apprendre les routes dans toutes les directions de Python
L'itinéraire de toutes les directions en Python consiste à organiser les points techniques couramment utilisés de Python pour former un résumé des points de connaissance dans divers domaines. Son utilité réside dans le fait que vous pouvez trouver des ressources d'apprentissage correspondantes en fonction des points de connaissance ci-dessus pour vous assurer que vous apprenez plus exhaustivement.
2. Logiciel d'apprentissage Python
Si un ouvrier veut faire du bon travail, il doit d'abord affûter ses outils. Le logiciel de développement couramment utilisé pour apprendre Python est arrivé !
3. Vidéo d'apprentissage d'introduction à Python
Il existe également de nombreuses vidéos d'apprentissage adaptées pour démarrer avec les bases de 0. Avec ces vidéos, vous pouvez facilement démarrer avec Python~
4. Exercices Python
Après chaque leçon vidéo, il y a des questions pratiques correspondantes, vous pouvez tester les résultats d'apprentissage haha !
Cinq, cas de combat réel Python
La théorie optique est inutile. Vous devez apprendre à taper des codes avec elle, puis vous pouvez appliquer ce que vous avez appris dans la pratique. À ce stade, vous pouvez apprendre de quelques cas pratiques. Cette information est également incluse ~
6. Matériel d'entretien Python
Après avoir appris Python, nous pouvons sortir et trouver un emploi avec les compétences ! Les questions d'entretien suivantes proviennent toutes de grandes sociétés Internet telles qu'Ali, Tencent, Byte, etc., et certains patrons d'Ali ont donné des réponses faisant autorité. Après avoir lu cet ensemble de documents d'entretien, je pense que tout le monde peut trouver un emploi satisfaisant.
7. Collecte d'informations
L'ensemble complet de supports d'apprentissage pour la version complète de Python mentionnée ci-dessus a été téléchargé sur le site officiel CSDN.Ceux qui en ont besoin peuvent scanner le code QR de la certification officielle CSDN ci-dessous sur WeChat pour le recevoir gratuitement.