关于JAVA开发的命名规范小结

来源:互联网 发布:淘宝优惠券搜索软件 编辑:程序博客网 时间:2024/05/22 16:56

每次写代码之前总是会想一个这样的问题,我的代码是不是规范的,是不是大家都是这样的,所以也会畏手畏脚。所以还是总结了一套比较规范的命名方式,希望能够保持一个良好的编程风格。


1.关于数据库(mysql),以图书管理系统为例:

数据库命名方式:全部小写,用下划线分隔开来,以项目名开头,后面还可以加上一些其他的东西。比如我的TestMaven项目:test_maven

数据表命名方式:全部小写,数据库名开头,后面带表名,下划线分隔开。比如test_maven_user

数据表字段命名:建议采取驼峰写法。比如用户名字段userName

对于主外键,我的建议是取名相同。比如test_maven_user表中的字段userId和test_maven_borrow表中的字段userId,一个是主键,一个是外键。


tips:每个字段的注释一定要打,另外的建议就是主键ID除非你确定需求改动不大,一律采用varchar,因为开发的时候主键ID不是简简单单的唯一标识符而已,可能一个id会附带很多信息,所以varchar类型没错的。当然,有些主键ID还是可以int自增的,比如说书籍类型表,这个的话Int类型绝对是够了,而且一般也就是标识符,携带信息的可能性不大。


对于mysql,varchar长度不管中文英文都是一一对应的,即若是varchar(100)意味着中英文都可以放置100个

关于日期类型:date--->YYYY-MM-DD  datetime--->YYYY-MM-DD HH:MM:SS 按需求选择相应时间类型


2.关于java代码

项目名:大写开头,全部大写。例如:TestMaven

包名:com.公司名.项目名.xxx.类名。除了类名,全部小写

类名:大写开头,全部大写

方法名,变量名:驼峰写法,小写开头,后面全大写

常量名:所有字母大写,中间下划线分割开来。例如:MAX_SIZE


对于实体类,属性名与数据库相应字段对应即可。

每个页面的JS,CSS,,HTML最好分开来,为了复用性。


原创粉丝点击