欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

flink教程-在IntelliJ IDEA 中玩转 checkstyle

程序员文章站 2022-03-12 19:44:59
文章目录前言安装插件配置插件选择版本添加配置文件在项目中应用checkstyle插件具体使用前言当我们想给flink贡献自己的代码的时候,就需要把代码下载下来,然后导入自己的IDE,其中有一个很重要的环节就是对代码规范的检查,也就是flink的checkstyle,如果我们只是靠在用maven编译的时候的出错信息来对flink进行调试,那么就太费事了,所以我们可以利用flink的checkstyle文件对修改过的代码做检查,这样可以省去很多事情。其实除了flink,我们做其他java项目,也是一样的,...

前言

当我们想给flink贡献自己的代码的时候,就需要把代码下载下来,然后导入自己的IDE,其中有一个很重要的环节就是对代码规范的检查,也就是flink的checkstyle,如果我们只是靠在用maven编译的时候的出错信息来对flink进行调试,那么就太费事了,所以我们可以利用flink的checkstyle文件对修改过的代码做检查,这样可以省去很多事情。

其实除了flink,我们做其他java项目,也是一样的,也可以使用同样的方法对我们的代码进行检查,提高工作效率。

今天我们主要讲讲怎么玩这个flink的checkstyle,内容来自官网,我主要是对整个流程做一个图形化的讲解,这样会方便大家使用.

安装插件

安装checkstyle的插件,然后重启IDE。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

配置插件

Settings -> Other Settings -> Checkstyle。

mac电脑,在IntelliJ IDEA -> Preferences -> Other Settings -> Checkstyle.

flink教程-在IntelliJ IDEA 中玩转 checkstyle

选择版本

选择版本 8.14 ,以及Scan scope 选择 ‘Only Java sources (including tests)’

flink教程-在IntelliJ IDEA 中玩转 checkstyle

添加配置文件

在 ’Configuration File‘ 选项卡,我们点击 + 添加一个新的配置。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

  • 添加一个flink配置,选择本地的checkstyle文件

这里我们选择flink home下面 tools/maven/checkstyle.xml 文件。并勾选 “Store relative to project location”, 点击下一步。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

  • 添加属性

在这里我们添加一个属性。

key:checkstyle.suppressions.file
value : suppressions.xml

flink教程-在IntelliJ IDEA 中玩转 checkstyle

然后点击下一步,完成。回到配置页面,我们选择我们刚刚添加的flink。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

在项目中应用checkstyle

我们添加了刚才命名为flink的checkstyle之后,可以把这个应用于我们的项目中了。

在这个配置中,Settings -> Editor -> Code Style -> Java ,我们的Schema选择刚才添加的flink,然后点击最下面的apply ,OK。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

这个会自动的调整项目中import 相关的布局,因为flink对java顶部的import也是有一定要求的,比如先后顺序,空格之类的。

插件具体使用

对于某一个文件来说,当我们代码中出现了不符合checkstyle的编码的时候,IDE就会自动给我们相应的提示。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

我们还可以手工的对相应的文件进行checkstyle检查,打开checkstyle选项卡,Rules选择刚才添加的flink。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

左侧会有三个比较常见的按钮,一个是三角形的按钮,这个可以检查当前打开的文件

flink教程-在IntelliJ IDEA 中玩转 checkstyle

下面的方格可以检查某一个module 。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

再下面的嵌套的方形按钮可以检查整个项目

flink教程-在IntelliJ IDEA 中玩转 checkstyle

比如我们对于当前的某一个文件,我们点击那个三角按钮,然后系统检查之后就会给我们相应的提示,具体在某一行某一列。

flink教程-在IntelliJ IDEA 中玩转 checkstyle

更多精彩内容,欢迎关注我的公众号【大数据技术与应用实战】

flink教程-在IntelliJ IDEA 中玩转 checkstyle

本文地址:https://blog.csdn.net/zhangjun5965/article/details/107283908