别再满屏找日志了!推荐一款 IDEA 日志管理插件,看日志轻松多了!

Posted Java技术栈

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了别再满屏找日志了!推荐一款 IDEA 日志管理插件,看日志轻松多了!相关的知识,希望对你有一定的参考价值。

1.简介

Grep Console是一款方便开发者对idea控制台输出日志进行个性化管理的插件。

2.功能特性

Grep Console的主要功能特性:

  • 支持自定义规则来过滤日志信息;
  • 支持不同级别的日志的输出样式的个性化配置;

总结:通过过滤功能、输出日志样式配置功能,可以更方便开发者在大量的日志信息中筛选出自己比较关注的日志信息。

推荐一个开源免费的 Spring Boot 最全教程:

https://github.com/javastacks/spring-boot-best-practice

3.下载

官网下载地址:https://plugins.jetbrains.com/,在搜索输入中输入“Grep Console”,就可以到达下载页面。

4.安装

Grep Console的安装方式有两种,优化推荐第一种在线安装:

4.1 在线安装

在线安装,需要可以连接到外网,file-->settings-->plugins-->browse repositories,在查询输入框中输入“grep console”,然后点击install,最后重启idea就可以使用了。

4.2 离线安装

有的时候,无法连接到外网的时候,可以使用离线安装的方法进行idea插件安装 :

a.从官网下载与自己使用idea的版本号相匹配的插件安装包;(我的idea版本是2018.2),所以我下载的grep console版本是9.6.162.000.1

b.file-->settings-->plugins-->install plugin from disk,然后选中下载好的插件安装包进行安装,完装完成后重启idea就可以使用了;

4.3 卸载插件

file-->settings-->plugins,在搜索输入框中输入“grep console”,然后点击uninstall进行插件卸载;

5.使用方法

5.1 配置

1、grep console的配置界面弹出有两种方法:

第一种:file-->other settings-->grep console

第二种,项目启动后,点击控制台上左上角的小图标,也可以弹出配置界面

2、比较关注的配置有两处:

第一处:input filtering,这里主要是对输入到控制台的日志进行过滤。

  • expression:配置正则表达式;
  • unless expression:和expression表达的意义相反;
  • whole line:勾选中,表示匹配整行;
  • case insensitive:表示忽略大小写
  • action:表示命中正则表达式后,要作出什么样的操作,有三种:1、移除(除非前面已有其他配置项匹配不移除),实际意思是说如果前面有其他不移除的配置项已经匹配上,这里就可以不移除,否则还是要移除匹配上的内容;2、移除(匹配上就移除);3、什么也不做;
  • continue matching:勾选中,表示下一个匹配项依然可以继续匹配当前匹配项命中的行,即多个匹配项可以同时去匹配同一行日志信息;
  • clear console:勾选中,表示清除控制台内除被当前配置项命中的其他日志信息,即只显示与配置项匹配的日志信息;
  • soud:这个就比较厉害了,命中配置项时会有声音提示,有兴趣的可以尝试一下;

注:实际使用的时候,无论我怎么写expression表达式都没有办法完全匹配整行,遇到空格就不匹配,只能匹配到一部分,有可能是我写的expression表达式不正确,也有可能插件本身在这块有问题,有知道原因的小伙伴,可以在评论区告诉我吧,非常感谢。

第二处:highlighting&folding

  • expression:配置正则表达式;

  • unless expression:和expression表达的意义相反;

  • whole line:勾选中,表示匹配整行;

  • case insensitive:表示忽略大小写

  • continue matching:勾选中,表示下一个匹配项依然可以继续匹配当前匹配项命中的行,即多个匹配项可以同时去匹配同一行日志信息;

  • bold:勾选中,表示命中的日志信息粗体显示;

  • italic:勾选中,表示命中的日志信息斜体显示;

  • background:设置命中日志信息的背景颜色;

  • foreground:设置命中日志信息的字体颜色;

  • statusbar count:勾选中,可以在Status Bar statistics panel中显示命中日志信息的次数(找了很久,没找到这个面板,有知道的小伙伴在评论区告诉我,多谢);

  • console count:勾选中,可以在Console statistics panel上显示命中日志信息的次数(找了很久,没找到这个面板,有知道的小伙伴在评论区告诉我,多谢);

  • fold:勾选中,可以把命中的日志信息折叠在一起(感觉这个功能没什么用);

  • sound:这个就比较厉害了,根据配置项命中日志信息时会有声音提示,有兴趣的可以尝试一下;

5.2 实战

下面实际演示一个这个插件怎么用,测试用的源代码:https://gitcode.net/fox9916/fanfu-web.gitgrep-console-test分支。

1、有三个定时调度类,在被执行的时候会输出info级别日志信息;

2、对这三个调度任务输出的日志信息进行配置,要求:匹配整行日志信息;忽略大小;EatTask调度任务输出日志信息背景色为黄色;DrinkTask调度任务输出日志信息为绿色;SportTask调用任务输出日志信息为蓝色;配置信息如下:

3、启动项目,输出日志信息如下:

4、在控制台输出的日志信息选中“com.fanfu.task.EatTask”,然后在选中的信息上右键弹窗中选中“Grep”,可以把包含“com.fanfu.task.EatTask”的日志信息在单独的弹窗中显示,可以通过这个功能把自己比较关注的日志信息集中显示。右键中还有另外一个功能“Add highlight”,可以把自己关注的日志信息标记为高亮,很方便在众多的日志里找到自己最想要的。

6.总结

这个插件还是很用的,终于可以在满屏的日志中,迅速找到自己关注的内容,调试程序的绝佳小帮手呀,以上就是这个插件的主要内容,可以根据自己的实际需要动手操作起来了,祝各位早点下班,bug绕着走,如果觉得很有用,麻烦各位关注加收藏,永远不迷路哦。

原文链接:https://blog.csdn.net/fox9916/article/details/128568466

版权声明:本文为CSDN博主「凡夫贩夫」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。

近期热文推荐:

1.1,000+ 道 Java面试题及答案整理(2022最新版)

2.劲爆!Java 协程要来了。。。

3.Spring Boot 2.x 教程,太全了!

4.别再写满屏的爆爆爆炸类了,试试装饰器模式,这才是优雅的方式!!

5.《Java开发手册(嵩山版)》最新发布,速速下载!

觉得不错,别忘了随手点赞+转发哦!

别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!

点击关注公众号,Java干货及时送达

推荐阅读:

学习 Spring Cloud 微服务的最佳姿势!

Spring Cloud 2022 正式发布!


随着业务的发展,系统会越来越庞大,原本简单稳定的功能,可能在不断迭代后复杂度上升,潜在的风险也随之暴露,导致最终服务不稳定,造成业务价值的损失。而为了减少这种情况,其中一种比较好的方式就是提高代码质量,比如通过代码审查,从而降低错误风险,但是,代码审查难度大,代码缺陷、漏洞不易发现,且审查工作随着代码量增加而增加,审查效率低。

工欲善其事,必先利其器,因此,这篇文章给大家介绍几种检查代码质量的利器,Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint,让你在关注代码质量的同时,减少 code review 的工作量,提高 code review 的效率,并通过代码质量分析去反向提升我们的代码编写能力

一、Alibaba Java Coding Guidelines

1、整体介绍:

Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。

阿里巴巴规约扫描包括:

  • OOP规约

  • 并发处理

  • 控制语句

  • 命名规约

  • 常量定义

  • 注释规范

2、安装步骤:

File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。

另外,关注公众号Java核心技术,在后台回复:手册,可获取最新高清版阿里巴巴 Java 开发手册。

3、使用说明:

3.1、运行方式:

(1)可以Tools > 阿里编码规约 > 编码规约扫描

(2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可:

3.2、菜单功能:

  • 编码规约扫描:开始扫描代码

  • 打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能

  • 切换语言至英文:中英文切换

3.3、运行结果:

扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。

选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到):

(1)指定区域搜索同一类问题:

当点击③处的按钮时,会弹出如下按钮:

这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示:

这里我们可以看到,显示了整个Project中的所有该类的问题。

另外,如果你近期准备面试跳槽,建议在Java面试库小程序在线刷题,涵盖 2000+ 道 Java 面试题,几乎覆盖了所有主流技术面试题。

(2)预览具体的不规范代码:

如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。

3.4、工具栏功能介绍:

  • Rerun Inspection:重新运行一次扫描

  • Close:关闭真个AJCG面板

  • Expand All:展开结果的树状结构,整个结果是树状结构的。

  • Collapse All:收起结果的树状结构

  • Go Pre Problem:选择上一个问题

  • Go Next Problem:选择下一个问题

  • Help:帮助

  • Group by Serverity:(不知道如何描述)

  • Group by derectory:按目录分组/按类名分组间切换

  • Filter resoled items:过滤掉已经解决的项

  • Autoscroll to Source:自动滚动到源码

  • Export:导出,可以导出为XML和HTML两种格式

  • Edit Settings:编辑设置

二、CheckStyle:

1、整体介绍:

CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。

Checkstyle插件中默认内置有2个执行代码检查的配置文件(Sun Checks 和 Sun Checks),但是这两个文件检查的非常详细严格,即使优秀的开源项目也会检查出来有非常多的错误告信息,所以需要导入我们自定义的配置文件。

2、安装步骤:

通过 File > Settings > Plugins > Marketplace 搜索 “CheckStyle”,按照提示进行安装,然后重启即可。

3、使用说明:

可以看到基本都是一些缩进啥的编码规范,可以不用太关注。

三、PMD

1、整体介绍:

PMD侧重面向安全编码规则,且具备一定的数据流分析和路径分析能力,能力比CheckStyle稍微强点,并且 PMD 支持自定义规则,PMD可以直接使用的规则包括以下内容:

  • 潜在的bug:空的try/catch/finally/switch语句

  • 未使用的代码(Dead code):未使用的变量、参数、私有方法等

  • 可选的代码:String/StringBuffer的滥用

  • 复杂的表达式:不必须的if语句、可被while替代的for循环

  • 重复的代码:拷贝/粘贴代码意味着拷贝/粘贴bugs

  • 循环体创建新对象:尽量不要在循环体内实例化新对象

  • 资源关闭:Connect,Result,Statement等使用之后确保关闭掉

2、安装步骤:

通过 File > Settings > Plugins > Marketplace 搜索 “PMDPlugin”,按照提示进行安装,然后重启即可

3、使用说明:
  • 参考文章:http://wjhsh.net/andy-songwei-p-11830812.html

3.1、运行方式:

(1)从Tools菜单中启动:

通过 Tools > Run PMD 可以看到如下的界面,如果通过该方式启动,扫描的范围就是整个项目中的文件了。

  • Pre Defined:预定义的规则,也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表,想扫描哪一种类型的问题,点击即可。其中“All”表示使用所有的规则。

  • Custom Rules:自定义的检测规则,PMD允许用户根据需要自定义检查规则,默认这里是不可点击的,需要在设置中导入自定义规则文件后方可选择。

(2)从右键菜单中启动:

在文件或者编辑器中点击右键,也可以看到“Run PMD”选项,如果通过该方式启动, 检测范围取决于鼠标或光标当前所选中的区域。

3.2、运行结果:

运行后会出现如上所示的面板,左边工具栏,鼠标停留在上面会提示其功能;右边显示了检测结果,当点击具体某一问题项时,会跳转到对应的源码中。点击关注公众号,Java干货及时送达

3.3、配置检测规则:

通过 File > Settings > Other Settings > PMD 可以打开检测规则的设置界面:

在 “RuleSets(规则设置)” 界面可以管理自定义的检测规则。因为在实际工作中,可能需要根据实际情况自定义检测规则,就可以通过这里导入,如果要使用它,需要在启动PMD进行检测时选择该自定义规则。

点击“Options”选项卡,在其中可以配置一些检测规则选项:

其中重点需要留意的是“Skip TestSource”这一项,因为在项目中有不少Android Studio自动生成的测试代码,如下所示,选择上述选项后可以将其过滤掉。

另外,IDEA 正版激活方法,可参考我之前分享的教程:https://www.javastack.cn/intellij-idea-reactivation-succeed/

四、FindBugs:

1、整体介绍:

FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考

2、安装步骤:

通过 File > Settings > Plugins > Marketplace 搜索 “FindBugs”,按照提示进行安装,然后重启即可

3、使用说明:

FindBugs 可以分析单个文件、包下面的所有文件、整个module下的文件、整个project下的文件,右键想要分析的文件名/包名/module/project

分析完之后就会出现结果面板

点击对应的item在右边会定位到具体的代码,这是根据提示进行处理修改就行

4、附:常见的错误信息

4.1、Bad practice 代码坏习惯:

4.2、Dodgy code 糟糕的代码:

4.3、Internationalization 代码国际化相关:

4.4、Performance 代码性能相关:

4.5、Experimental:

4.6、Malicious code vulnerability 恶意破坏代码相关:

4.7、Multithreaded correctness 多线程代码正确性相关:

4.8、Correctness 代码正确性相关:

另外,如果你近期准备面试跳槽,建议在Java面试库小程序在线刷题,涵盖 2000+ 道 Java 面试题,几乎覆盖了所有主流技术面试题。

五、SonarLint:

1、整体介绍:

sonar 比 Findbugs 高了一个层级,它不仅关注常规静态BUG,还关注到了如代码质量、包与包、类与类之间的依赖情况,代码耦合情况,类、方法、文件的复杂度,代码中是否包含大量复制粘贴的代码,关注的是项目代码整体的健康情况。sonar 有两种使用方式:插件和客户端,sonar 的插件名称为 sonarLint

2、安装步骤:

通过 File > Settings > Plugins > Marketplace 搜索 “SonarLint”,按照提示进行安装,然后重启即可

3、使用说明:

右键项目或者文件进行如上图所示操作,执行之后可以看到如下信息,如果代码中有不合理的地方会在report中显示,同时点击错误的地方在右边会给出建议的修改供参考。

4、配置 SonarLint 服务端:

4.1、配置 Sonar 服务器:

sonarLint 插件的使用场景是自用自审,但 sonar 也提供了平台版本,使用场景则是他审,sonar 平台的搭建就不在这篇文章介绍了,感兴趣的读者可以自己上网查看,我们这里主要介绍如何在 sonarLint 插件中配置关联 sonar 平台服务器的工程,进行本地检查:

点击新增按钮,输入Configuration Name,配置sonarlint 服务器的地址,然后下拉框选择 Login/Password,输入 sonarlint服务器的账号密码

4.2、具体 Sonar工程配置:

配置完服务器之后,需要针对具体工程进行配置,点击 connection下拉框,选择上面配置好的服务器连接,然后点击 Search in list,找到对应的工程:

4.3、使用 SonarLint 检查:

配置完上面两步之后,接下来就可以选择要进行检查的类或者目录进行 sonarlint 检查了(跟第3点的使用方式一致),同时,在 commit 代码的时候,勾选 “Perform Sonarlint analysis”,会针对你要提交的代码进行sonarlint检查

总结

  • 检查代码规范的话,直接使用 Alibaba Java Coding Guidelines 就可以了

  • 找 BUG 的话,使用 PMD、Findbugs、SonarLint 相互补充:

    • PMD 自定义能力强,用来自定义项目BUG规则非常好用

    • Findbugs 找 BUG 能力很强,我们拿找到的BUG给新员工培训也很好。

    • SonarLint 规则丰富,比 Findbugs 能覆盖到更全的场景

版权声明:本文为CSDN博主「张维鹏」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。原文链接:https://blog.csdn.net/a745233700/article/details/126202100

End

Spring 旗下最牛逼的国产项目!

23 种设计模式实战(很全)

Spring Boot 3.0 正式发布,王炸!!

Spring Cloud Alibaba 最新重磅发布!

Nacos 2.2 正式发布,这次更新太炸了!

Spring Cloud 微服务最新课程!

以上是关于别再满屏找日志了!推荐一款 IDEA 日志管理插件,看日志轻松多了!的主要内容,如果未能解决你的问题,请参考以下文章

别在再满屏的 ifelse 了,试试策略模式,真香!!

别在再满屏的 ifelse 了,试试策略模式,真香!!

别在再满屏的 if/ else 了,试试策略模式,真香!!

别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!

别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!

别再写狗屎代码了,推荐这 5 款 IDEA 插件,让你的代码质量直接起飞!