java编码规范

在入职阿里以后,周三一度是我的噩梦,因为基本每周三都要review代码,啊啊啊,崩溃,第一次review被批的体无完肤,被怼到无地自容了好吗,第二次稍微好一点,虽然还是很多问题,但也被表扬进步很大,第三次,嗯,不错了,基本符合我们对代码的要求了。啊啊啊,尽管如此,依然是黑色星期三

下面就列举一些我自己整理的在敲代码的时候的一些注意事项,当然,多看看阿里巴巴的编码规范还是蛮好的,百度就可以查到,我就不贴链接上来了。

1、推荐用IDEA进行开发,真的不要好用太多,基本的插件都有集成进去,功能很强大,习惯了eclipse的可以把IDEA设置为eclipse风格,这样快捷键就跟eclipse一样了

2、灵狐插件一定要装,可以对你的代码进行扫描,然后告诉你代码中不规范的地方,也是一个很强大的插件了,步骤以及使用可以参考这个 https://www.jianshu.com/p/cd19d42b00c8,感觉不够用可以百度,网上一堆教程呢,呦呦呦

3、什么类名啊,方法名啊,参数名啊,变量名啊,反正就是各种名字一定要起的有意义,所见即所得,不怕名字长,不要用拼音、不要用拼音、不要用拼音,重要的事情说三遍,这是很low的行为,有道是个很好用的翻译软件,至少对我们这些码农是够用了

4、关于类名,可以用不同的后缀去表达这个类的作用,比如..Service,表明这个类是个服务类,里面包含了给其他类提同业务服务的方法,..ServiceImpl就表明是实现类,其他同理

5、还有像一些静态常量啊,枚举啊用全大写,单词之间用下划线分割

6、没用到的东西全删掉,像是import的包啊,声明的变量啊,参数啊只要没用到,统统删掉,希望你们的编译器会有提示,要是没有提示就去配置,idea是有配置,eclipse估计要装插件

7、代码中如果有不确定的代码,或是为了测试写的一些代码不能立即删最好是加上TODO注释,提醒自己这段代码是有问题的,要改掉,不然等代码一多,就记不得它们的存在了,之后维护也会是个问题

8、代码学会分段,就像写作文一样,做完一件事就空一行再接着往下写,这样读代码的时候不会太累,想停下来休息的时候能及时停下来、

9、一个方法不宜过长,最好不要超过一屏,如果业务太复杂的话可以对一些比较独立的部分进行封装,当前方法只是一些主流程,这样一眼看去就很舒服

10、注释,注释,注释,我们提倡少而精,但是如果真的要很多字去说明也是可以的,但切记不要啰嗦,要保证每个字都是有用的注释

11、尽量减少用if else这种判断,避免嵌套很多层。

12、善用AssertUtil,比如我需要保证前端传的id不能为空,就可以用AssertUtil.notNull(id,"id不能为空")代替if判断,如果id为空的话就会抛出id不能为空的异常

13、关于传参问题,如果参数超过3个了就要考虑封装成对象去传,不然总要带着一大串参数,能累死

14、如果代码中涉及到获取当前登录用户的问题,从controller传,不要在service层直接拿,会造成代码耦合度太高

15、在提交代码先格式化下代码,最好养成每写完一段代码就格式化一下,IDEA快捷键是Ctrl+alt+L

目前就整理了这么多,以后想到了再补充,这些都是最基本的要注意的,还有一些深层次的等我学到了再更新,啦啦啦,为了能敲得一手优雅的代码,可以多读一些源码,同时也能学一下框架是咋封装的,何乐而不为呢

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值