利于复用资料的项目文件命名规范

利于复用资料的项目文件命名规范

需求场景:

项目重构或者新建项目的时候,往往需要复制重用一些旧项目的数据表和类文件的资料。

如何让旧的项目资料能快速复用融合到新项目中?有规范约束的、有稳定规律的资料,复用流程是最简单,最快速的。

比如,一般项目的数据表前缀都是以产品名称的缩写字母来命名的,比如:淘宝=tb, 京东=jd。它们的数据表名称分别为:tb_product_goods, jd_product_goods。 但是太过于个性化强调的前缀不利于新建同类不同名的项目时的资料复用。而且,好的前缀不仅利于资料快速复用,而且对于项目开发中的Bug修正和代码维护,都能很方便快速地查找定位到具体文件。

所以,根据个人平时的项目开发经验,总结了一些规范心得。

数据库表名前缀规范:

规范约定:权限类=auth, 系统类=sys, 电商类=eb, 财务类=fin(financial), 文章类=art, 通用类=comm, 统计类=stat, 日志类没有前缀而只有后缀(log)

示例:auth_admin=管理员表, auth_admin_group=管理员分组表, auth_admin_rule=管理员权限规则表, sys_config=系统配置表, eb_product_goods=商品表,fin_recharge=充值表, stat_recharge_success=充值成功统计中间表, auth_admin_login_log=管理员登录日志表, art_article=文章表

备注:如果要定制而不使用通用数据表,在表名最前面添加厂商前缀,例如(淘宝=tb_):tb_auth_admin, tb_eb_product_goods, tb_fin_recharge

MVC 类名前缀规范:

规范约定:权限类=Auth, 系统类=Sys, 电商类=Eb, usr=用户类, 文章类=Art, 通用类=Comm, 统计类=Stat, 日志类没有前缀而只有后缀(Log)

示例:AuthAdminController=管理员控制器类, SysConfigController=系统配置控制器类, EbProductGoodsController=商品控制器类, EbProductCategoryModel=商品分类模型类, FinRechargeModel=充值模型类, ArtArticleModel=文章模型类, StatRechargeModel=充值统计报表模型, AuthAdminLoginLogModel=管理员登录日志模型类

备注:如果要定制而不使用通用类,在类名最前面添加厂商前缀,例如(淘宝=Tb):TbAuthAdminController, TbEbProductGoodsController, TbFinRechargeModel

posted on 2021-03-10 12:24  sochishun  阅读(189)  评论(0编辑  收藏  举报