Java开发常用代码规范

作者：小符
撰写时间：2019.05.15
代码与程序员的关系，就像是零件和机械工，庄稼和农民的关系一般，它是软件的基石，每一行代码都程序员心血，亦是一个程序员的尊严和价值所在。遵守编程规范，就是遵守大家达成一致的约定，使代码更容易理解，团队维护起来也会更容易，提高团队的高效效率。
1、基本语法规范：
编写基本语法时，应遵守一下几点：
·大小写敏感：Java是大小写敏感的，这就意味着在编写过程中，变量名Hello和hello是不同的。
·类名：对于所有的类来说，类名的首字母应该大写。如果类名由若干单词组成，那么每个单词的首字母应该大写。例如MyJavaClass。
·源文件名：源文件名必须和类名相同。当保存文件的时候，你应该使用public修饰的类名作为文件名保存（切记Java是大小写敏感的），文件名的后缀为.java。（如果文件名和类名不相同则会导致编译错误）。
2、标识符命名规范
标识符的命名规范一般要求统一，能充分表达出它的意思，还有就是简洁。
2.1 统一
什么是统一呢？统一是指同一个概念，在程序中用同一种表示方法，比如“删除”，既可以用delete，也可以用remove，但是我们只能选定一个大众最熟悉的来使用，而且每个人都要保持统一，如果对同一个词语，每个人都写不同的表示方法，这不仅不能不会提高效率，反而还会混淆阅读者，所以即使不能取到好的名称，但必须统一。
还有就是，很多人在找不到好的名称的时候，就会将英文和拼音拼接在一起组成标识符，这是真的不值得提倡。
2.2 达意
充分表达，简单的说就是达意。如何做到通俗达意呢，其实很简单，就是宁愿麻烦都不要起花里胡哨的命名，比如：String self = “.element”;和String KaTeX parse error: Unexpected character: '' at position 400: …·所有的标识符都应该以字母（A̲Z 或者 az）,美元符（）、或者下划线（_）开始；
·首字符之后可以是字母（AZ 或者 az）,美元符（$）、下划线{（}_{）}或数字的任何字符组合；\cdot 关键字不能用作标识符；\cdot 标识符是大小写敏感的；\cdot 合法标识符举例：age、$age、_value、__age_value；
·非法标识符举例：123abc、age；
3、包名
包名是必须使用小写字母编写的，比如com.user.age，不要是com.user.Age。而且单词间不能使用字符隔开，如com.user.user_age。包名一般公司命名方式是：域名.公司名称.包名；或者学校的是：域名.学校名称.包名。
4、类名
4.1 首字母大写
类名首字母要大写，如UserName。
4.2 类名的后缀
在java中，类名都有不同的后缀来表达不同的意思，比如下表：
后缀名 意义
EJB 表示这个类为 EJB 类
Service 表明这个类是个服务类，里面包含了给其他类提同业务服务的方法
Impl 这个类是一个实现类，而不是接口
Inter 这个类是一个接口
Dao 这个类封装了数据访问方法
Action 直接处理页面请求，管理页面逻辑的类
Listener 响应某种事件的类
Event 这个类代表了某种事件
Servlet 一个 Servlet
Factory 生成某种对象工厂的类
Adapter 用来连接某种以前不被支持的对象的类
Job 某种按时间运行的任务
Wrapper 这是一个包装类，为了给某个类提供没有的能力
Bean 这是一个 POJO
5、方法名
首字母小写，如addUser()不要AddUser()；动词在前，如addOrder(),不要orderAdd()；下面的前缀就是动词：
前缀名 意义 举例
create 创建 createOrder()
delete 删除 deleteOrder()
add 创建，暗示新创建的对象属于某个集合 addPaidOrder()
remove 删除 removeOrder()
init或则 初始化，暗示会做些诸如获取资源等特殊 initializeObjectPool
initialize 动作
destroy 销毁，暗示会做些诸如释放资源的特殊动作 destroyObjectPool
open 打开 openConnection()
close 关闭 closeConnection()<
read 读取 readUserName()
write 写入 writeUserName()
get 获得 getName()
set 设置 setName()
prepare 准备 prepareOrderList()
copy 复制 copyCustomerList()
modity 修改 modifyActualTotalAmount()
calculate 数值计算 calculateCommission()
do 执行某个过程或流程 doOrderCancelJob()
dispatch 判断程序流程转向 dispatchUserRequest()
start 开始 startOrderProcessing()
stop 结束 stopOrderProcessing()
send 发送某个消息或事件 sendOrderPaidMessage()
receive 接受消息或时间 receiveOrderPaidMessgae()
respond 响应用户动作 responseOrderListItemClicked()
find 查找对象 findNewSupplier()
update 更新对象 updateCommission()
完。