Java编码规范总结

背景：公司开发新项目，小组几个人共同开发，平时也没特意规定，简单写个约规；

说明：本文简单罗列一些常见的Java编码规范，目的是使大家编码风格保持一致。
便于项目维护，所有约规不强制，但要有这个意识；

一、注释
1、类注释，包括Controller层、Service层等；
2、方法注释，所有接口及公私有方法；
3、代码逻辑块中尽量有点注释；

二、提交规范
1、冗余的类、方法、代码块尽量都删除；
2、无效的import，idea设置勿用import xxx.xxx.*；
3、提交注释参考公司规范要求；

三、编码风格
1、接口之间尽量解耦，不共用请求、响应类，每个接口都应该有请求响应体；
2、常量尽量定义在常量类中；
3、多张表的更新根据情况考虑使用事务，但@Transactional事务不要滥用，事务会影响数据库的 QPS；
4、非必要的业务逻辑单独提取出来，考虑用异步注解@Async修饰；
5、判空统一使用工具类方法；
6、相同之处的代码优先考虑提取公共方法；

四、命名规范
1、获取单个对象的方法用 get 做前缀，例："getXXX"；
2、获取多个对象的方法用 list 做前缀，例："getXXXList"；
3、获取统计值的方法用 count 做前缀，例："getXXXCount"；
4、插入的方法用 insert 或 save 做前缀，例："insertXXX"；
5、删除的方法用 delete 或 remove 做前缀，例："deleteXXX"；
6、修改的方法用 update 或 modify 做前缀，例："updateXXX"；

五、日志规范
1、某些关键或经常报错或逻辑复杂的方法的入口出口，或者某些业务代码块可适当加些日志，避免因加日志而产生的报错。
例：入口、出口加info级别日志()，代码块中debug级别；
2、catch中异常日志要打印出来，加error级别日志；

Java编码规范总结相关推荐

java编码ppt_[2018年最新整理]Java编码规范.ppt
[2018年最新整理]Java编码规范制定编码规范的最主要的目的是为了对产出代码的长期维护.通常负责维护代码的人大多都不是开发者本人,如果有一个统一的代码格式以及说明就可以减少混淆提高理解速度. ...
规定自己的Java编码规范
给自己规定了Java编码规范.编写Java代码严格依照自己规定的格式.欢迎大家指出问题. /* *COPYRIGHT */package com.triangle23.projectabbreviat ...
Java编码规范,在您进行编码之前应该阅读的规范
为什么80%的码农都做不了架构师?>>> 本文转载于:http://www.web3d.com.cn/new/teach/java3d/2006/11/13/363276161 ...
掌握Java编码规范
掌握Java编码规范
Java基础学习总结（92）——Java编码规范之排版、注释及命名
为使开发人员养成良好的开发习惯,编写可读性强.易维护的程序,结合以往资料,现整理Java编码规范,将之作为开发人员的参照依据. 一.排版 1.相对独立的程序块之间必须加空行
java编码规范文档下载_软件项目实训及课程设计指导——制定待开发项目中各种文档的规范...
软件项目实训及课程设计指导--制定待开发项目中各种形式文档的规范 1.制定对课程设计项目开发过程中的规范性要求 (1)从"形式"到"内容"两个方面控制和要求开发 ...
java11规范_京东Java编码规范V11.pdf
京东Java编码规范V11 Java 编码规范版本 1.1 作者李永刚.陈泽洪发布日期 2014-04-28 Java 编码规范发布部门:技术研发管理部/PMO/质量提升部第 2 页 / 共 ...
公司让我编写一套自己的【Java 编码规范】作为员工季度考核标准？！参照Alibaba
目录一.编码规范 (一)命名风格 (二)常量定义 (三)代码格式 (四)OOP规范 (五)集合处理 (六)并发处理 (七)控制语句 (八)注释规范 (九)其它二.SVN操作规范三.异常日志 (一 ...
chinapay java_Chinapay应用技术部Java编码规范.docx
Chinapay应用技术部Java编码规范 PAGE \* MERGEFORMAT 7 Chinapay技术部Java编码规范 (Version: 0.14) 版本变迁记录: 版本号修改人时间修 ...
Java 编码规范15(工程结构)
工程结构其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-OOP规约) ...

Java编码规范总结

Java编码规范总结相关推荐

最新文章

热门文章