后端开发者必备的优良开发习惯有哪些?
- 内容介绍
- 文章标签
- 相关推荐
本文共计3623个文字,预计阅读时间需要15分钟。
1. 注意图面尽可能全面,注释应具有意义,包括方法注释、接口方法、类、复杂的业务逻辑,都应添加有意义的注释。接口方法的注释应详细包含输入和输出说明,以及异常情况的处理。
1.注释尽可能全面,写有意义的方法注释
接口方法、类、复杂的业务逻辑,都应该添加有意义的注释
- 对于接口方法的注释,应该包含详细的入参和结果说明,有异常抛出的情况也要详细叙述
- 类的注释应该包含类的功能说明、作者和修改者。
- 如果是业务逻辑很复杂的代码,真的非常有必要写清楚注释。
清楚的注释,更有利于后面的维护。
2.项目拆分合理的目录结构
记得读大学那会,刚学做各种各样的管理系统,都是用MVC模式,也就是controller、service、mapper、entity。如果未来业务扩展,你没有拆分业务结构的话,很可能就会发现,一个service包下,有上百个服务。。。
正确的做法,如果服务过多,应该根据不同的业务进行划分,比如订单、登陆、积分等等
当然,你也可以根据不同的业务划分模块,比如建一个moudles包,然后按订单、登陆等业务划分,每个业务都有自己的controller、service、mapper、entity。
我们拆分的目的,就是让项目结构更清晰,可读性更强,更容易维护而已。
3\. 不在循环里远程调用、或者数据库操作,优先考虑批量进行。
远程操作或者数据库操作都是比较耗网络、IO资源的,所以尽量不在循环里远程调用、不在循环里操作数据库,能批量一次性查回来尽量不要循环多次去查。(但是呢,如果是操作数据库,也不要一次性查太多数据哈,可以分批500一次酱紫)。
本文共计3623个文字,预计阅读时间需要15分钟。
1. 注意图面尽可能全面,注释应具有意义,包括方法注释、接口方法、类、复杂的业务逻辑,都应添加有意义的注释。接口方法的注释应详细包含输入和输出说明,以及异常情况的处理。
1.注释尽可能全面,写有意义的方法注释
接口方法、类、复杂的业务逻辑,都应该添加有意义的注释
- 对于接口方法的注释,应该包含详细的入参和结果说明,有异常抛出的情况也要详细叙述
- 类的注释应该包含类的功能说明、作者和修改者。
- 如果是业务逻辑很复杂的代码,真的非常有必要写清楚注释。
清楚的注释,更有利于后面的维护。
2.项目拆分合理的目录结构
记得读大学那会,刚学做各种各样的管理系统,都是用MVC模式,也就是controller、service、mapper、entity。如果未来业务扩展,你没有拆分业务结构的话,很可能就会发现,一个service包下,有上百个服务。。。
正确的做法,如果服务过多,应该根据不同的业务进行划分,比如订单、登陆、积分等等
当然,你也可以根据不同的业务划分模块,比如建一个moudles包,然后按订单、登陆等业务划分,每个业务都有自己的controller、service、mapper、entity。
我们拆分的目的,就是让项目结构更清晰,可读性更强,更容易维护而已。
3\. 不在循环里远程调用、或者数据库操作,优先考虑批量进行。
远程操作或者数据库操作都是比较耗网络、IO资源的,所以尽量不在循环里远程调用、不在循环里操作数据库,能批量一次性查回来尽量不要循环多次去查。(但是呢,如果是操作数据库,也不要一次性查太多数据哈,可以分批500一次酱紫)。

