开发者社区> 小鲍侃java> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

开发规范实战(一)代码书写规范

简介: 开发规范实战(一)代码书写规范
+关注继续查看


1.入参必须使用对象或者List,非特殊情况下不允许使用jsonobject

2.service与dao层也尽量使用对象封装 减少参数罗列

3.参数传递非必要情况不要使用map传递

4.出参使用封装好的Result对象

5.接口文档书写需要详细 

6.在使用系统统一异常处理时 不需要使用try catch

7.在特别需要时 需要向统一异常处理方法维护异常类别

image.png

8.需要加入类注释与方法注释 详细请参考新人项目搭建文档

9.非特殊情况方式不允许使用@requstmapping

10.实体类需要继承 BaseEntity

image.png


11.尽量将同一业务的接口写到一个类中 通用方法抽取出来 并提交给组长 维护到文档中

12.服务间调用请参考ribbon与feign

13.使用格式化文档对代码格式化

14.类上与接口路径都需要书写 且不要省略“/”

image.png

15.类命名规范 分别为xxController,xxService,xxServiceImpl,xxDao,xxMapper

16.方法命名规范:

image.png

17.事务书写方式

image.png

18.失效代码尽量删除掉 而不是注释

19.是否等可复用魔法值需要放入枚举类中 不要在代码中写死

20.实体类需要写明各字段注释 可使用代码生成器生成 

21.实体中除了设计到计算字段 其他一律使用封装类类型

22.接口类型不需要public等关键字

image.png

23.mapper中需要写全jdbcType 可以使用代码生成器生成

其他详细可以参考 阿里巴巴Java开发手册(华山版).pdf


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
霍夫直线检测代码实战
霍夫圆检测原理+实战
37 0
c#小灶——注释和代码规范
c#小灶——注释和代码规范为什么要写注释?早上我写完了代码,我和我的朋友们都能看懂,到了晚上,我还能看懂,一周后,就只有上帝能看懂了…… 将来我们写的代码量是很大的,代码又不像我们自然语言这么好理解,可能过段时间我们就不认识自己的代码了,所以我们要养成写注释的好习惯。
828 0
CSS开发规范
摘要:   无论多少人开发一个项目,规范是最初始也是最基本的,一个好的规范不仅让代码看起来完美也能够解决冲突。下面是我在开发时使用的css规范 基本规范: 所有名称小写,符合w3c规范 类名和id,多个变量之间用中划线连接 所有变量只能使用名词 变量定义要符合语义化 基本原则: 以项目名或者一个全局名称为命名空间,例如你的项目名叫demo,则命名空间为demo,这样在多人合作开发时,高度统一如一人编写。
1321 0
开发者编写代码的态度
版权声明:本文为半吊子子全栈工匠(wireless_com,同公众号)原创文章,未经允许不得转载。
452 0
java开发代码规范
一、目的       对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。
916 0
+关注
小鲍侃java
小作坊架构师。
366
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载