本文讲述了同事通过SonarLint插件发现作者代码问题的故事，强调SonarLint如何通过静态代码分析帮助程序员改进代码规范、发现潜在bug和遵循最佳实践，包括安装、使用和其在提升代码质量方面的作用。
同事：你的代码写的不行啊，不够规范啊。
我：我写的代码怎么可能不规范，不要胡说。
于是同事打开我的 IDEA ，安装了一个插件，然后执行了一下，规范不规范，看报告吧。
这可怎么是好，这玩意竟然给我挑出来这么多问题，到底靠谱不。
同事潇洒的走掉了，只留下我在座位上盯着屏幕惊慌失措。我仔细的查看了这个报告的每一项，越看越觉得这插件指出的问题有道理，果然是我大意了，竟然还给我挑出一个 bug 来。
这是什么插件，review 代码无敌了。
这个插件就是 SonarLint，官网的 Slogan 是 clean code begins in your IDE with {SonarLint}。
作为一个程序员，我们当然希望自己写的代码无懈可击了，但是由于种种原因，有一些问题甚至bug都无法避免，尤其是刚接触开发不久的同学，也有很多有着多年开发经验的程序员同样会有一些不好的代码习惯。
代码质量和代码规范首先肯定是靠程序员自身的水平和素养决定的，但是提高水平的是需要方法的，方法就有很多了，比如参考大厂的规范和代码、比如有大佬带着，剩下的就靠平时的一点点积累了，而一些好用的插件能够时时刻刻提醒我们什么是好的代码规范，什么是好的代码。
SonarLint 就是这样一款好用的插件，它可以实时帮我们 review代码，甚至可以发现代码中潜在的问题并提供解决方案。
SonarLint 使用静态代码分析技术来检测代码中的常见错误和漏洞。例如，它可以检测空指针引用、类型转换错误、重复代码和逻辑错误等。这些都是常见的问题，但是有时候很难发现。使用 SonarLint 插件，可以在编写代码的同时发现这些问题，并及时纠正它们，这有助于避免这些问题影响应用程序的稳定性。
比如下面这段代码没有结束循环的条件设置，SonarLint 就给出提示了，有强迫症的能受的了这红下划线在这儿？
SonarLint 插件可以帮助我提高代码的可读性。代码应该易于阅读和理解，这有助于其他开发人员更轻松地维护和修改代码。 SonarLint 插件可以检测代码中的代码坏味道，例如不必要的注释、过长的函数和变量名不具有描述性等等。通过使用 SonarLint 插件，可以更好地了解如何编写清晰、简洁和易于理解的代码。
例如下面这个名称为 hello_world的静态 final变量，SonarLint 给出了两项建议。
- 因为变量没有被使用过，建议移除；
- 静态不可变变量名称不符合规范；
SonarLint 插件可以帮助我遵循最佳实践和标准。编写符合标准和最佳实践的代码可以确保应用程序的质量和可靠性。 SonarLint 插件可以检测代码中的违反规则的地方，例如不安全的类型转换、未使用的变量和方法、不正确的异常处理等等。通过使用 SonarLint 插件，可以学习如何编写符合最佳实践和标准的代码，并使代码更加健壮和可靠。
例如下面的异常抛出方式，直接抛出了 Exception，然后 SonarLint 建议不要使用 Exception，而是自定义一个异常，自定义的异常可能让人直观的看出这个异常是干什么的，而不是 Exception基本类型导出传递。
安装 SonarLint
可以直接打开 IDEA 设置 -> Plugins，在 MarketPlace中搜索SonarLint，直接安装就可以。
还可以直接在官网下载，打开页面https://www.sonarsource.com/products/sonarlint/，在页面中可以看到多种语言、多种开发工具的下载图标，点击下方的 EXPLORE即可到下载页面去下载了。虽然我们只是在 IDEA 中使用，但是它不管支持 Java 、不只支持 IDEA ，还支持 Python、PHP等众多语言，以及 Visual Studio 、VS Code 等众多 IDE。
在 IDEA 中使用
SonarLint 插件安装好之后，默认就开启了实时分析的功能，就跟智能提示的功能一样，随着你噼里啪啦的敲键盘，SonarLint插件就默默的进行分析，一旦发现问题就会以红框、红波浪线、黄波浪线的方式提示。
当然你也可以在某一文件中点击右键，也可在项目根目录点击右键，在弹出菜单中点击Analyze with SonarLint，对当前文件或整个项目进行分析。
分析结束后，会生成分析报告。
左侧是对各个文件的分析结果，右侧是对这个问题的建议和修改示例。
SonarLint 对问题分成了三种类型
| 类型 | 说明 |
|---|---|
| Bug | 代码中的 bug，影响程序运行 |
| Vulnerability | 漏洞，可能被作为攻击入口 |
| Code smell | 代码意味，可能影响代码可维护性 |
问题按照严重程度分为5类
| 严重性 | 说明 |
|---|---|
| BLOCKER | 已经影响程序正常运行了，不改不行 |
| CRITICAL | 可能会影响程序运行，可能威胁程序安全，一般也是不改不行 |
| MAJOR | 代码质量问题，但是比较严重 |
| MINOR | 同样是代码质量问题，但是严重程度较低 |
| INFO | 一些友好的建议 |
SonarQube
SonarLint 是在 IDE 层面进行分析的插件，另外还可以使用 SonarQube功能，它以一个 web 的形式展现，可以为整个开发团队的项目提供一个web可视化的效果。并且可以和 CI\CD 等部署工具集成，在发版前提供代码分析。
SonarQube是一个 Java 项目，你可以在官网下载项目本地启动，也可以以 docker 的方式启动。之后可以在 IDEA 中配置全局 SonarQube配置。
也可以在 SonarQube web 中单独配置一个项目，创建好项目后，直接将 mvn 命令在待分析的项目中执行，即可生成对应项目的分析报告，然后在 SonarQube web 中查看。
对于绝大多数开发者和开发团队来说，SonarQube 其实是没有必要的，只要我们每个人都解决了 IDE 中 SonarLint 给出的建议，当然最终的代码质量就是符合标准的。
阿里 Java 规约插件
每一个开发团队都有团队内部的代码规范，比如变量命名、注释格式、以及各种类库的使用方式等等。阿里一直在更新 Java 版的阿里巴巴开发者手册，有什么泰山版、终极版，想必各位都听过吧，里面的规约如果开发者都能遵守，那别人恐怕再没办法 diss 你的代码不规范了。
对应这个开发手册的语言层面的规范，阿里也出了一款 IDEA 插件，叫做 Alibaba Java Coding Guidelines，可以在插件商店直接下载。
比如前面说的那个 hello_world变量名，插件直接提示「修正为以下划线分隔的大写模式」。
再比如一些注释上的提示，不建议使用行尾注释。
还有，比如对线程池的使用，有根据规范建议的内容，建议自己定义核心线程数和最大线程数等参数，不建议使用 Excutors工具类。
有了这俩插件，看谁还能说我代码写的不规范了。
这里给大家分享一份Python全套学习资料，包括学习路线、软件、源码、视频、面试题等等，都是我自己学习时整理的，希望可以对正在学习或者想要学习Python的朋友有帮助！
优快云大礼包：全网最全《全套Python学习资料》免费分享🎁
😝有需要的小伙伴，可以点击下方链接免费领取或者V扫描下方二维码免费领取🆓
1️⃣零基础入门
① 学习路线
对于从来没有接触过Python的同学，我们帮你准备了详细的学习成长路线图。可以说是最科学最系统的学习路线，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。
② 路线对应学习视频
还有很多适合0基础入门的学习视频，有了这些视频，轻轻松松上手Python~
③练习题
每节视频课后，都有对应的练习题哦，可以检验学习成果哈哈！
因篇幅有限，仅展示部分资料
2️⃣国内外Python书籍、文档
① 文档和书籍资料
3️⃣Python工具包+项目源码合集
①Python工具包
学习Python常用的开发软件都在这里了！每个都有详细的安装教程，保证你可以安装成功哦！
②Python实战案例
光学理论是没用的，要学会跟着一起敲代码，动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。100+实战案例源码等你来拿！
③Python小游戏源码
如果觉得上面的实战案例有点枯燥，可以试试自己用Python编写小游戏，让你的学习过程中增添一点趣味！
4️⃣Python面试题
我们学会了Python之后，有了技能就可以出去找工作啦！下面这些面试题是都来自阿里、腾讯、字节等一线互联网大厂，并且有阿里大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。
5️⃣Python兼职渠道
而且学会Python以后，还可以在各大兼职平台接单赚钱，各种兼职渠道+兼职注意事项+如何和客户沟通，我都整理成文档了。
上述所有资料 ⚡️ ，朋友们如果有需要 📦《全套Python学习资料》的，可以扫描下方二维码免费领取 🆓
😝有需要的小伙伴，可以点击下方链接免费领取或者V扫描下方二维码免费领取🆓
扫一扫
2561
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
