来源:blog.csdn.net/iXinRu/article/details/85242553
👉 欢迎加入小哈的星球,你将获得: 专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论
新项目:《从零手撸:仿小红书(微服务架构)》 正在持续爆肝中,基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17..., 点击查看项目介绍;
《从零手撸:前后端分离博客项目(全栈开发)》 2期已完结,演示链接:http://116.62.199.48/;
截止目前,累计输出 47w+ 字,讲解图 2090+ 张,还在持续爆肝中.. 后续还会上新更多项目,目标是将 Java 领域典型的项目都整一波,如秒杀系统, 在线商城, IM 即时通讯,Spring Cloud Alibaba 等等,戳我加入学习,已有1700+小伙伴加入(早鸟价超低)
![]()
CheckStyle作为检验代码规范的插件,除了可以使用配置默认给定的开发规范,如Sun的,Google的开发规范啊,也可以导入像阿里的开发规范的插件。
事实上,每一个公司都存在不同的开发规范要求,所以大部分公司会给定自己的check规范,一般导入给定的 checkstyle.xml 文件即可实现。
作为新人,我checkstyle了一整个项目,苦不堪言,所以大家怕是还是多注意代码规范啊,利人利己。
楼主用的是idea,所以先说一下插件的导入,然后再细说怎么修改不规范的代码。
1.导入CheckStyle插件
1.File ——> setting 安装插件
![4d63d5aa8c63b2da88998783164d4f18.png](https://img-blog.csdnimg.cn/img_convert/4d63d5aa8c63b2da88998783164d4f18.png)
![a90ace93a0b16041a113e5b85ad6f8df.png](https://img-blog.csdnimg.cn/img_convert/a90ace93a0b16041a113e5b85ad6f8df.png)
也可以下载阿里的开发规范,看个人需求和喜好。
![33a7ccad383613195c2fb3061c884486.png](https://img-blog.csdnimg.cn/img_convert/33a7ccad383613195c2fb3061c884486.png)
2.配置插件
![46df79ede276af88588fac9303479aad.png](https://img-blog.csdnimg.cn/img_convert/46df79ede276af88588fac9303479aad.png)
![0b6629c04508899d5e893dc23f137450.png](https://img-blog.csdnimg.cn/img_convert/0b6629c04508899d5e893dc23f137450.png)
![db334bed76625f16c1e4874bb050e4a8.png](https://img-blog.csdnimg.cn/img_convert/db334bed76625f16c1e4874bb050e4a8.png)
3.开始
选择你需要checkstyle的类右击:
![176d6c61fe1f88fe173cd83096099173.png](https://img-blog.csdnimg.cn/img_convert/176d6c61fe1f88fe173cd83096099173.png)
点击checkstyle,因为我导入的是阿里巴巴,使用checkstyle的按键被占用了,懒得弄了,阿里蛮好的
或者:
![2499eac042d997bdef94a906240c13dc.png](https://img-blog.csdnimg.cn/img_convert/2499eac042d997bdef94a906240c13dc.png)
2.报错原因和处理方式
原则:少改动代码,处理时候不盲目大意,git提交多写点改动的情况。
1.第一大类:注解问题
缺少注解,点击问题即可跳转到缺少注解的地方
![f0c6e5cfc3e541e84f0a39d91a284b8b.png](https://img-blog.csdnimg.cn/img_convert/f0c6e5cfc3e541e84f0a39d91a284b8b.png)
注解不全,补齐就行
![62fc9ebf26b36bece1fc8c2b22a78d7f.png](https://img-blog.csdnimg.cn/img_convert/62fc9ebf26b36bece1fc8c2b22a78d7f.png)
补齐,每一个@的值都要完整
2.字符占位问题
![a731f4ba6c12a71a8a5d1a11ef653ad5.png](https://img-blog.csdnimg.cn/img_convert/a731f4ba6c12a71a8a5d1a11ef653ad5.png)
先按自己的需求设置code style
![2f4d1366909d9c8561dafe24da4a87df.png](https://img-blog.csdnimg.cn/img_convert/2f4d1366909d9c8561dafe24da4a87df.png)
然后右击选择
![44ca29f284816e8d1aeb276e8fe9444d.png](https://img-blog.csdnimg.cn/img_convert/44ca29f284816e8d1aeb276e8fe9444d.png)
即可解决
tab问题的话
![98ab672b441176e678072af52dfcb202.png](https://img-blog.csdnimg.cn/img_convert/98ab672b441176e678072af52dfcb202.png)
默认情况下的是tab=4个空格,不存在tab的情况的,其实我也不会,欢迎补充。
3.见名知意
![356d698257955da8c3cb3db14647be5e.png](https://img-blog.csdnimg.cn/img_convert/356d698257955da8c3cb3db14647be5e.png)
按要求改就ok了
![65860f80af4a679def305f6d0c309fb3.png](https://img-blog.csdnimg.cn/img_convert/65860f80af4a679def305f6d0c309fb3.png)
删掉就行
4.格式问题
名字问题
![0defa516ab8d7069fc08d3716a6f6774.png](https://img-blog.csdnimg.cn/img_convert/0defa516ab8d7069fc08d3716a6f6774.png)
建议少改动,如果是公共类,影响较大,还是提前多留意吧。
5.逻辑错误
![9a06a7499d8f429529762ebb1e636cff.png](https://img-blog.csdnimg.cn/img_convert/9a06a7499d8f429529762ebb1e636cff.png)
![6d68f4e15b3ebac1c39ecec208f20fd7.png](https://img-blog.csdnimg.cn/img_convert/6d68f4e15b3ebac1c39ecec208f20fd7.png)
6.导包顺序
![1a868aef08af5d343ecf53037dd0564b.png](https://img-blog.csdnimg.cn/img_convert/1a868aef08af5d343ecf53037dd0564b.png)
类似这种情况的,都是导包顺序没有按照checkstyle的规范,一般情况下,eclispe的ctrl + shift + o 快捷键可以解决这个盗版问题,idea的也一样,当然也可以右击选择
![ce68bcc7942e0c54e78aa69df08a038d.png](https://img-blog.csdnimg.cn/img_convert/ce68bcc7942e0c54e78aa69df08a038d.png)
👉 欢迎加入小哈的星球,你将获得: 专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论
新项目:《从零手撸:仿小红书(微服务架构)》 正在持续爆肝中,基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17..., 点击查看项目介绍;
《从零手撸:前后端分离博客项目(全栈开发)》 2期已完结,演示链接:http://116.62.199.48/;
截止目前,累计输出 47w+ 字,讲解图 2090+ 张,还在持续爆肝中.. 后续还会上新更多项目,目标是将 Java 领域典型的项目都整一波,如秒杀系统, 在线商城, IM 即时通讯,Spring Cloud Alibaba 等等,戳我加入学习,已有1700+小伙伴加入(早鸟价超低)
![]()
1. 我的私密学习小圈子~
2. IDEA 源码阅读利器,你居然还不会?
3. Linux 下如何实现 MySQL 数据库每天自动备份定时备份?
4. 面试官:业务开发时,接口不能对外暴露怎么办?有 3 种实现方案!
最近面试BAT,整理一份面试资料《Java面试BATJ通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
获取方式:点“在看”,关注公众号并回复 Java 领取,更多内容陆续奉上。
PS:因公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。
点“在看”支持小哈呀,谢谢啦