前言安装插件配置插件选择版本添加配置文件在项目中应用checkstyle插件具体使用

前言

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

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

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

安装插件

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

配置插件

Settings -> Other Settings -> Checkstyle。

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

选择版本

选择版本 8.14 ，以及Scan scope 选择 'Only Java sources (including tests)'

image

添加配置文件

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

image

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

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

添加属性

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

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

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

在项目中应用checkstyle

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

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

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

插件具体使用

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

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

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

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

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

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

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

maven checkstyle 文件_flink教程-在IntelliJ IDEA 中玩转 checkstyle相关推荐

【Groovy】IntelliJ IDEA 中创建 Gradle 工程 ( Gradle 工程目录文件分析 )
文章目录一.IntelliJ IDEA 中创建 Gradle 工程二.Gradle 工程目录文件分析一.IntelliJ IDEA 中创建 Gradle 工程在 IntelliJ IDEA 中 ...
解决 IntelliJ IDEA 中 .propertise 文件保存后中文乱码
解决 IntelliJ IDEA 中 .propertise 文件保存后中文乱码运行环境: IntelliJ IDEA 2021.3 (Ultimate Edition) 在 IntelliJ ...
在 IntelliJ IDEA 中创建基本的 Maven 多模块项目
在 IntelliJ IDEA 中创建基本的 Maven 多模块项目笔者的环境: Maven 3.6.3 JDK 11 IntelliJ IDEA 2020.2.2 (Ultimate Editio ...
不使用 Maven 等构建工具，而使用原始方法在 IntelliJ IDEA 中整合 Tomcat 部署 Web 应用
不使用 Maven 等构建工具,而使用原始方法在 IntelliJ IDEA 中整合 Tomcat 部署 Web 应用我们知道,部署 Web 应用可以直接将 Web 应用的文件夹置于 Tomca ...
如何在 IntelliJ IDEA 中整合 Maven、Tomcat 部署 Web 应用
如何在 IntelliJ IDEA 中整合 Maven.Tomcat 部署 Web 应用笔者的环境: JDK 11.0.12 Maven 3.6.3 Tomcat 9.0.41(Servlet 4. ...
Maven硒测试自动化教程
在进行测试自动化项目时,您需要与之关联的所有Selenium依赖项. 通常,这些依赖项是在项目生命周期中手动下载和升级的,但是随着项目规模的扩大,管理依赖项可能会非常困难. 这就是为什么需要构建自动化 ...
Maven 的下载安装教程
Maven 3.6.3 下载安装教程笔者的环境: JDK 13.0.2 Maven 3.6.3 IntelliJ IDEA 2020.1.2 (Ultimate Edition) 在继续阅读本教程之 ...
【超级详细教程】IntelliJ IDEA 从入门到上瘾，常用配置、插件、多光标操作、快捷键。
本文共计 1.5 W 字,80 张图介绍 IDEA 中令人相见恨晚的技巧,本文中从入门.简单项目创建开始,介绍 IDEA 中多光标操作.常用配置.插件.版本控制等等.一定包含你在别的文章没有看到的内容 ...
IntelliJ IDEA中Maven插件无法更新索引之解决办法
为什么80%的码农都做不了架构师?>>> Maven的仓库.索引中央仓库:目前来说,http://repo1.maven.org/maven2/ 是真正的Maven中央仓库的 ...

maven checkstyle 文件_flink教程-在IntelliJ IDEA 中玩转 checkstyle

前言