自从用了这款 IDEA 神器，领导都夸我代码写得好！

川长思鸟来 2023-10-12 21:57 21阅读 0赞

作者：iXinRu

来源：blog.csdn.net/iXinRu/article/details/85242553

CheckStyle作为检验代码规范的插件，除了可以使用配置默认给定的开发规范，如Sun的，Google的开发规范啊，也可以导入像阿里的开发规范的插件。

事实上，每一个公司都存在不同的开发规范要求，所以大部分公司会给定自己的check规范，一般导入给定的 checkstyle.xml 文件即可实现。

作为新人，我checkstyle了一整个项目，苦不堪言，所以大家怕是还是多注意代码规范啊，利人利己。

楼主用的是idea，所以先说一下插件的导入，然后再细说怎么修改不规范的代码。

### 1.导入CheckStyle插件 ###

#### 1.File ——> setting 安装插件 ####

![06ff95a4e7b3a45828e02fd4b55f57c2.png][]

![2cdd3b189c15949dd9611b157e2c15c3.png][]

也可以下载阿里的开发规范，看个人需求和喜好。

![24a8a30d81c47e83fd5fff2c47eab9a5.png][]

#### 2.配置插件 ####

![81bc86059d20e0cf4ea1d940bcf4e288.png][]

![6a023d2f34220ed470229db7302ed3ed.png][]

![7623204c72b83609ae798aa704f43939.png][]

#### 3.开始 ####

选择你需要checkstyle的类右击：

![b003fb1792657af41db7bd506c371034.png][]

点击checkstyle，因为我导入的是阿里巴巴，使用checkstyle的按键被占用了，懒得弄了，阿里蛮好的

或者：

![838117bc1bef88bb1477f335cd179dc8.png][]

### 2.报错原因和处理方式 ###

原则：少改动代码，处理时候不盲目大意，git提交多写点改动的情况。

#### 1.第一大类：注解问题 ####

缺少注解，点击问题即可跳转到缺少注解的地方

![b9c219a931d6baa3e66c9a35113671eb.png][]

注解不全，补齐就行

![0ba4c9951921ad783144dc387a5fc217.png][]

补齐，每一个@的值都要完整

![5e97f1040b9627db0a6779085467ec93.png][]

#### 2.字符占位问题 ####

![bf16bbc40f410c080c3f1ce3235e50c1.png][]

先按自己的需求设置code style

![50da4ec3a5324dace17aa468011b3b01.png][]

然后右击选择

![1a3ba836046e1c3ed94353ef4867e8db.png][]

即可解决

tab问题的话

![a6bb98c309ce39d510b12da41810ea9e.png][]

默认情况下的是tab=4个空格，不存在tab的情况的，其实我也不会，欢迎补充。

#### 3.见名知意 ####

![1c0cab90d535c2f15584b9484d376dfa.png][]

按要求改就ok了

![bb1b9c54e38bda191defd58c8669d53a.png][]

删掉就行

#### 4.格式问题 ####

名字问题

![e412446e01c09741f05398fd9e7d6b22.png][]

建议少改动，如果是公共类，影响较大，还是提前多留意吧。

#### 5.逻辑错误 ####

![3f9775ede93c352cb728e6d7fb1b906f.png][]

![119882b736f03e27aa484da10977a29a.png][]

#### 6.导包顺序 ####

![62c5403b840bf3f1113ed8cf90dc5b90.png][]

类似这种情况的，都是导包顺序没有按照checkstyle的规范，一般情况下，eclispe的ctrl + shift + o 快捷键可以解决这个盗版问题，idea的也一样，当然也可以右击选择

![a91c7bfb9cd55a31c0f2646abd8b26a9.png][]

[06ff95a4e7b3a45828e02fd4b55f57c2.png]: https://img-blog.csdnimg.cn/img_convert/06ff95a4e7b3a45828e02fd4b55f57c2.png
[2cdd3b189c15949dd9611b157e2c15c3.png]: https://img-blog.csdnimg.cn/img_convert/2cdd3b189c15949dd9611b157e2c15c3.png
[24a8a30d81c47e83fd5fff2c47eab9a5.png]: https://img-blog.csdnimg.cn/img_convert/24a8a30d81c47e83fd5fff2c47eab9a5.png
[81bc86059d20e0cf4ea1d940bcf4e288.png]: https://img-blog.csdnimg.cn/img_convert/81bc86059d20e0cf4ea1d940bcf4e288.png
[6a023d2f34220ed470229db7302ed3ed.png]: https://img-blog.csdnimg.cn/img_convert/6a023d2f34220ed470229db7302ed3ed.png
[7623204c72b83609ae798aa704f43939.png]: https://img-blog.csdnimg.cn/img_convert/7623204c72b83609ae798aa704f43939.png
[b003fb1792657af41db7bd506c371034.png]: https://img-blog.csdnimg.cn/img_convert/b003fb1792657af41db7bd506c371034.png
[838117bc1bef88bb1477f335cd179dc8.png]: https://img-blog.csdnimg.cn/img_convert/838117bc1bef88bb1477f335cd179dc8.png
[b9c219a931d6baa3e66c9a35113671eb.png]: https://img-blog.csdnimg.cn/img_convert/b9c219a931d6baa3e66c9a35113671eb.png
[0ba4c9951921ad783144dc387a5fc217.png]: https://img-blog.csdnimg.cn/img_convert/0ba4c9951921ad783144dc387a5fc217.png
[5e97f1040b9627db0a6779085467ec93.png]: https://img-blog.csdnimg.cn/img_convert/5e97f1040b9627db0a6779085467ec93.png
[bf16bbc40f410c080c3f1ce3235e50c1.png]: https://img-blog.csdnimg.cn/img_convert/bf16bbc40f410c080c3f1ce3235e50c1.png
[50da4ec3a5324dace17aa468011b3b01.png]: https://img-blog.csdnimg.cn/img_convert/50da4ec3a5324dace17aa468011b3b01.png
[1a3ba836046e1c3ed94353ef4867e8db.png]: https://img-blog.csdnimg.cn/img_convert/1a3ba836046e1c3ed94353ef4867e8db.png
[a6bb98c309ce39d510b12da41810ea9e.png]: https://img-blog.csdnimg.cn/img_convert/a6bb98c309ce39d510b12da41810ea9e.png
[1c0cab90d535c2f15584b9484d376dfa.png]: https://img-blog.csdnimg.cn/img_convert/1c0cab90d535c2f15584b9484d376dfa.png
[bb1b9c54e38bda191defd58c8669d53a.png]: https://img-blog.csdnimg.cn/img_convert/bb1b9c54e38bda191defd58c8669d53a.png
[e412446e01c09741f05398fd9e7d6b22.png]: https://img-blog.csdnimg.cn/img_convert/e412446e01c09741f05398fd9e7d6b22.png
[3f9775ede93c352cb728e6d7fb1b906f.png]: https://img-blog.csdnimg.cn/img_convert/3f9775ede93c352cb728e6d7fb1b906f.png
[119882b736f03e27aa484da10977a29a.png]: https://img-blog.csdnimg.cn/img_convert/119882b736f03e27aa484da10977a29a.png
[62c5403b840bf3f1113ed8cf90dc5b90.png]: https://img-blog.csdnimg.cn/img_convert/62c5403b840bf3f1113ed8cf90dc5b90.png
[a91c7bfb9cd55a31c0f2646abd8b26a9.png]: https://img-blog.csdnimg.cn/img_convert/a91c7bfb9cd55a31c0f2646abd8b26a9.png