自从用了CheckStyle插件，代码写的越来越规范了

痛定思痛。 2024-03-23 18:01 97阅读 0赞

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

CheckStyle作为检验代码规范的插件，除了可以使用配置默认给定的开发规范，如Sun的，Google的开发规范啊，也可以导入像阿里的开发规范的插件。事实上，每一个公司都存在不同的开发规范要求，所以大部分公司会给定自己的check规范，一般导入给定的checkstyle.xml文件即可实现。

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

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

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

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

![图片][5e764ac9db7cd4feca8850c6ee9ef014.jpeg]

![图片][df736c5667b25ca55dd8c6b9dfef0b23.jpeg]

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

![图片][8454d7277af2ccf9e390359198e3f0d3.png]

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

![图片][18deddbf252560eb536d010cb307a31e.jpeg]

![图片][ec4ad769ad3b9ed18c5b84f33e54449b.jpeg]

![图片][a2bc0fb69094819797f86ceda41c0bd4.jpeg]

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

选择你需要checkstyle的类右击：

![图片][976b7bd8e9828056d400c72a1d58adf8.jpeg]

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

或者：

![图片][5e9aa25c9cac02af13118384a02107bb.png]

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

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

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

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

![图片][6e7666f90e9a2e52706ad7ce37484e4b.png]

注解不全，补齐就行

![图片][d7c4e9be7d0bfd43aa134816ea00b2a2.png]

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

![图片][1263b3604b769dbe7d6e10adaee7f0b7.png]

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

![图片][ca78d9ae5c1028c6083d5fa502dae7b3.png]

先按自己的需求设置code style

![图片][1d80c92aea7d406ba26cd15f98a5270a.png]

然后右击选择

![图片][9d3a149c31552b7d7f49c3e92c5043e1.png]

即可解决

tab问题的话

![图片][a23d55b924050701e0e1d9bc1c74985e.png]

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

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

![图片][53062910da03a5157fb537c62c420710.png]

按要求改就ok了

![图片][4805707a16c38da694ff77003425e0b7.png]

删掉就行

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

名字问题

![图片][8ed53df571bb1ee83d4b116eda5a5961.png]

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

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

![图片][8b7750b3651abe87f5e9344576d77f19.png]

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

![图片][c7a5684fda19a8514049974be5c35f2e.png]

![图片][0d9cb199cadda547cc5201412dec26a5.png]

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

![图片][3492557d73448d973e5027c36a38c8b9.png]

[5e764ac9db7cd4feca8850c6ee9ef014.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5a111c7fe6dc4f20aba6bd55ab9dd8df.png
[df736c5667b25ca55dd8c6b9dfef0b23.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/525b16d4d0034ec58ad27b3fdb4c49db.png
[8454d7277af2ccf9e390359198e3f0d3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/80ea7634d914435f9bb4055ea4f86675.png
[18deddbf252560eb536d010cb307a31e.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/87db52c5b2ef4f68a98e3235183cac88.png
[ec4ad769ad3b9ed18c5b84f33e54449b.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ed34e9bdb40d482ca7ac005a76bccd5c.png
[a2bc0fb69094819797f86ceda41c0bd4.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/2a9d83978782481c8850aaa63b369c75.png
[976b7bd8e9828056d400c72a1d58adf8.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/95ac51f9d80342eab7889113099145e6.png
[5e9aa25c9cac02af13118384a02107bb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/d4c0eb1f68bc4745a74ab91668c13292.png
[6e7666f90e9a2e52706ad7ce37484e4b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/887d8e80221942319488c60741793442.png
[d7c4e9be7d0bfd43aa134816ea00b2a2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/bf9e303743d44240b98c95fc1b65d1d2.png
[1263b3604b769dbe7d6e10adaee7f0b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/06e5eb1c063b4992ac174df7eadec8b0.png
[ca78d9ae5c1028c6083d5fa502dae7b3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/69a48bd63bb845bab7ac23642c583cb3.png
[1d80c92aea7d406ba26cd15f98a5270a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5351fd03e9d7466c8eb3a8980c1869a9.png
[9d3a149c31552b7d7f49c3e92c5043e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/525fe52c19d541f68578bb6858731bf3.png
[a23d55b924050701e0e1d9bc1c74985e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ccdc14c1540b415a9c5ad3a7b673cd63.png
[53062910da03a5157fb537c62c420710.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/3eabdb10bdb944afaadbd2ea9c90dc10.png
[4805707a16c38da694ff77003425e0b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b54f50fdc40843578fd648a3e0a4cb63.png
[8ed53df571bb1ee83d4b116eda5a5961.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/0a28efbe88d445588b0654bcdbfd8146.png
[8b7750b3651abe87f5e9344576d77f19.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/834f8470604d41b980d80b37ddd32acf.png
[c7a5684fda19a8514049974be5c35f2e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b2a111b057b546568e17b9a08013b72d.png
[0d9cb199cadda547cc5201412dec26a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/49889481c7fa40bfa40e3e9c03d8e861.png
[3492557d73448d973e5027c36a38c8b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/af04e5911bdb41a6bad7b9a34353a696.png