Java开发规范(二)

注释

1、 【强制】格式结构统一使用eclipse模板,禁止自定义。
2、 【强制】类、方法、属性都必须有注释。如果实在来不及,可以先生成TODO。因为可以通过TODO视图,把注解补回来。
3、 【强制】类上必须要有作者,如果有修改,还要添加上修改者,如果有结队也要写上。要有用户名还要有邮箱
例子:

/**
 * 字典
 *
 * @author   ZhuangJunxiang([email protected])
 * @version 2017-03-06
 */

4、 【强制】注释要直译,描述要写算法或者思路或者注意事项。不要在注释上代码里的每一行完全暴露出来,使用者根本不关注实现。
反例:

/**
 * 学生分页查询   #方法里根据没有学生。。。。
 *
 * @param page 分页对象
 * @param studentForm 学生
 * @return 分页对象
 */
public Page> findPageList(Page> page, StudentForm studentForm) {

5、 【强制】方法里禁止写注释。不要有多余的注释,让变量和属性自描述或者抽取方法。如果有算法写到方法注释上。
反例:

//填充基本信息
fillBaseInfo();
//填充账号信息
fillAccoutInfo();

6、 【强制】方法里禁止注释掉代码。统一通过版本控制软件(git)来解决。逻辑是正确的,但是现在暂时不能使用,可以暂时注释,但是必须写上TODO。
TODO格式: TODO 标记人 原因
例子:

//TODO 张三 当前用户还未处理,因为登录还没有调通
//long userId = fetchUser.getCurrentUserId();
long userId = 1L;
....

数据库

这里主要指的是MySQL,其他的数据库也可以借鉴这些准则

1、【强制】统一使用表名命名规范
表名规范:分层+项目名缩写+下划线+实体名(小写字母)【+下划线+实体名(小写字母)+rel】
例子:

表名:bc_course  对应的信息:基础服务层,项目缩写为c里对应的CourseEntity实体对应的表
表名:sc_course_knowledge_rel 对应的信息:综合服务层,项目缩写为c里对应的CourseEntity实体和KnowledgeEntity实体的关系表

分层:

  • 基础服务:b
  • 综合服务:s
  • webapp服务:a
    表的种类:
  • 映射实体的表:前缀_实体名(小写字母)。实体里有多个单词,用下划线隔开。
  • 关系表:前缀实体名1(小写字母)实体名2(小写字母)_rel。同一个实体里有多个单词,拼接在一块
    例子:
bc_course_group -->CourseGroupEntity
sc_coursegroup_coursepack_rel -->CourseGroupEntity和CoursePackEntity的关系表

2、 【强制】统一使用innoDB引擎。
3、 【推荐】表名不要关联其他表名信息
反例:

bc_course
bc_course_video
bc_course_video_study_log

正例:

bc_course
bc_video
bc_study_log

索引

1、 【强制】业务上具有唯一特性的字段,即使是组合字段,必须使用唯一索引。比如: 用户名,编号等。如果没有添加唯一索引,即使在应用层做了非常完善的校验和控制,只要没有唯一索引,必然有脏数据
2、 【强制】唯一索引命名:uk_字段名,普通索引命名:idx_字段名
3、 【强制】禁止对text定义索引。如果有对这类字段搜索的需求,可以通过全文索引方法来实现功能。
4、 【推荐】varchar定义索引长度。一般有搜索的话,用户也不会输入太多字。长度统一10为倍数,不要超过50

字段

1、 【强制】主键禁止使用自增。不同库同步数据的时候,会出问题。影响插入性能。
2、 【强制】字段全部禁止为空。为空的话,很容易在使用的时候出现npe。如果可以不填,通过默认值方法来处理。
3、 【强制】禁止使用外键,只能在概念和应用层次使用外键
外键的字段命名:表名去除前缀+id
4、 【强制】禁止使用枚举、集合类型
5、 【强制】禁止在数据库使用blog存在文件。数据库只存相对的url路径
6、 【强制】类型使用规范

  • 布尔:bit
  • 时间(精确到天):date
  • 时间(精确到秒):datetime
  • 浮点:deciaml
  • 字符串(长度小于10或者长度大于10但是长度相同):char
  • 字符串(长度为10~5000,长度不相同):varchar
  • 字符串(富文本):text
    7、 【强制】必有字段
  • 主键
  • 创建时间
  • 修改时间
  • 假删状态(如果是资源数据必须有,如果是关系数据禁止有)
    8、 【推荐】可以适合添加冗余数据,这样可以增快查询数据。
    冗余类型:
  • 计数器、计分器等统计数据
  • 一旦生成不会修改的数据
    9、 【推荐】字段顺序:自描述-->关联其他表的描述-->功能性-->必有字段

注释

1、 【强制】表名或者字段注释的格式:直译【(补充说明)】
反例:

表名:t_first_login,注释:本表用于处理河北联通卡的临时业务问题,记录已经使用web登录过的卡号

正例:

表名:t_first_login,注释:首次登录(用于处理河北联通卡的临时业务问题,记录已经使用web登录过的卡号)

2、 【强制】禁止带“表”,“数据”等多余的字眼
反例:

表名:aw_input_batch,注释:输入批次表
表名:t_admission_110000,注释:北京院校专业数据

3、 【推荐】如果类型字段,有变更,同步注释
例子:

status   状态(0:成功,1:失败)
//过了一段时间,又多了一个冻结的状态
status   状态(0:成功,1:失败,2:冻结)

sql
1、 【强制】禁止select 。数据库查看执行时间性能没有响应。但是返回的数据量会变大,对网络开销有影响,最终还是会影响性能,而且也会影响数据库的二进步日志
2、 【强制】使用select count(
)。select count(name) 不记录null的行数。而且官方已经澄清过,不影响性能 。
反例:

select count(1)
select count(id)

3、 【强制】使用sum函数时,必须使用IFNULL(sum(),0)。如果sum函数没有查到结果返回null,容易出现npe。
4、 【推荐】禁止出现or。可以通过使用in或者unit all来替换
5、 【推荐】order by的场景,创建索引时order by 后面的字段也必须是组合索引的一部分,并且放在索引顺序的最后,避免出现file_sort
正例:

where a=? and b=? order by c; 索引:a_b_c

6、 【推荐】创建组合索引时,区分度最高的放在最左边
正例:

where a=? and b=?  如果a几乎接近唯一,那么只要建idx_a即可。

7、 【推荐】禁止更新表的所有字段,必须指定要更新的字段

禁止项

原则上,禁止采用这些技术。除非架构上有这些考虑。

  • 存储过程
  • 外键
  • 视图
  • 触发器
  • 分库、分表、分区。(单表行数超过500万行或者单表容量超过2GB,才推荐进行分库分表)

工程|项目

项目

语法:平台-分层职责-服务名称
例子:

# uxuexi是平台,web是分层,course是服务名称(因为是web,所以对应的是子域名),对应的域名是course.uxuexi.com
uxuexi-web-course
# uxuexi是平台,business是分层,sso是服务名称
uxuexi-business-sso
# uxuexi是平台,base是分层,course是服务名称
uxuexi-base-course
# we是平台(因为是通用的,没有对应的域名,所以使用we),business是分层,sso是服务名称
we-business-sso
# we是平台(因为是通用的,没有对应的域名,所以使用we),core是分层,db是服务名称
we-core-db

1、 平台
使用的域名去掉组织后缀。
例子:

域名:www.uxuexi.com
-------
子域名:www
平台名:uxuexi
组织:com

2、 分层职责

  • core(能力层。与具体业务无关,提供能力)
  • base(基础服务层。可以独立存在,有且只有一个具有实际意义的服务,不依赖于其他的服务)
  • business(业务服务层。依赖多个基础服务,一般是一个流程性的服务)
  • webapp(应用层。对互联网用户提供直接服务)
    3、 服务名称
    如果是web项目,使用子域名当作服务名称。其他的项目,根据职责划分来自行命名。

分包

java源码
1、 根目录
语法:域名组织-项目名。如果web层项目,直接使用对应的域名倒置即可。
例子:

# web层项目,直接使用对应的域名倒置即可
项目名:uxuexi-web-course 
根目录为:com.uxuexi.course
# 其他层项目,使用:域名组织+项目名
项目名:uxuexi-business-sso 
根目录为:com.uxuexi.business.sso

2、 java包
语法:分包【+子模块】+文件(类+后缀)。其中子模块是参考业务的包才有,通用功能可以没有子模块。
分包清单:

  • module:http路由,负责根据不同的业务跳转到不同的url。
  • form:负责http参数的封装、验证、传输。负责sql的编写
  • entity:数据库持久对象。数据的持久及对象本身业务的实现
  • dto:接口返回的实体
  • service:逻辑单元。逻辑处理或者叫计算单元
  • util:工具
  • enums:枚举
  • vt:视图标签
    ...
    有子模块的业务包有:module,form,entity,dto,service。如果有通用的逻辑,可以使用common子模块包名
    例子:
包名:module.student.course ,类名:StudentCourseModule
包名:module.user,类名:UserModule
包名:util,类名:StringUtil

资源文件

1、 根目录
resources
2、 sql包
和service及form的包名一致,文件名和java调用的类名一致
例子:

# java 
# com.uxuexi.www 根目录
# module 分包
# student.course 子模块
# StudentCourseViewService.java 文件
com.uxuexi.wwww.module.student.course.StudentCourseViewService.java

# sql
# resources 根目录
# sql 分包
# student.course 子模块
# StudentCourseViewService.sql 文件
resources.sql.student.course.StudentCourseViewService.sql

视图文件

1、 根目录
WEB-INF
2、 视图包
module类单词小写分隔,文件名和module里的方法名一致
例子:

# java 
# com.uxuexi.www 根目录
# module 分包
# student.course 子模块
# StudentCourseModule 文件
# list 方法
com.uxuexi.wwww.module.student.course.StudentCourseModule.list()

# 视图
# WEB-INF 根目录
# student.course 子模块
# list.jsp 文件
WEB-INF.student.course.list.jsp

欢迎加入学习交流群569772982,大家一起学习交流。

你可能感兴趣的:(Java开发规范(二))