工程代码规范和更新规范

Posted 2021-02-13 wmqiang

java的共性规范是必须要遵守的，如命名规范，命名规范包括变量命名、包命名、类命名等；

共性的就不多说了，类名要首字母大写，变量名驼峰命名法，要说的是变量名命名的时候能用英文单词拼凑就用英文单词，请尽量不要使用中文拼音的首个字母拼凑，因为汉语博大精深，其他协同合作开发的人可能不能一下子看出变量名的意思，打死！

类名命名也是，尽量使用英文单词拼凑，要一下子能看出来它的意思和作用；

涉及到框架分层的，还要注意类名要体现出来，如业务管理层一般是**Action，业务逻辑实施层一般是**Service，数据访问层一般是**Dao，接口类的实现类一般是**Impl等；

还有涉及到框架分层的，请一定代码封装，不要“堆放”在一起，就是在业务管理层**Action中请不要出现业务逻辑实施层**Service中的代码，执行sql语句进行数据访问的Dao层一般都是会封装好的；

建包也要注意归类，不要动不动就建一个package，要将所有的类进行归类，可以按功能属性归到一个package下，如工具类**Utils的package包，也可以按照功能模块分类，如UserModule，这个package包里面可以有子目录，存放的类是人员模块的所有实体类、业务管理类、业务实施类以及一些相关的代码的类；

说到更新系统的规范，一定要做好备份记录是肯定的了，数据库执行脚本时候也要做好相关的数据库备份或者某一张表结构和数据备份等，需要做的是可以建一个单独的数据库脚本更新文档，每次所执行的数据库脚本进行记录，有迹可循，如：

代码不规范，同事两行泪；