Java后台项目开发规范

写在前边

1、目标

• 项目以功能模块来划分分工
• 数据库不能随意修改，本地数据库须统一
• 有标准的Java代码风格，有良好习惯
• 时刻考虑代码的可复用性
• 每个人需要有每周项目进度报告

2、 原则

​ 标识符的命名力求做到统一、达意和简洁

2.1 统一

​ 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。

2.2 达意

​ 达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。

2.3简洁

​ 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。

2.4 骆驼法则

​ Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是 supplier_name, add_new_contract。

2.5 英文拼音

​ 尽量使用通俗易懂的英文单词，如果不会可以谷歌，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole、guiDang则不好。

一、命名规范

尽量保证能够通过变量名得知变量的含义

1、包命名规范

目的：包的命名规范应当体现出****项目资源良好的划分****

自定义标签类所在包命名规范：com.****项目名称**(小写)****.tags

• 包命名采用全小写命名
• 通过唯一域名+组件来命名

// <projectname>为项目英文简称或缩写；