开发规范

基于阿里开发规范

命名

命名带单位

数组用s 集合用list/set

crontroller和菜单对应

如何写好一个api

路径映射

只用post

@api注解 dto vo 除了通用模板 不要使用继承 即使重复拷贝也可以 使用静态内部类 @apimodel名字使用 外部类名-内部类名

定义Basedto通用传参,JsonResponse通用返回

@validate @valid注解验证

@log注解日志

@tableAlias注解,指定表的别名,用于前端通用排序。

分页和排序交由前端指定 后端使用pagehelper.startpage处理 所有表需要提前定义别名 如果是自连接 主表必须使用别名xx 从表使用xx1 xx2等

一对多分页的通用做法 查询一表然后在resultmap中指定select查询多表

代码中循环查询也可以接受 优先推荐第一种

传参规范

禁止使用012  用枚举字符串代替

使用标准basedto和JsonResponse结构

日期传参用 2023-03-06 12:03:56标准格式,如果没有时间 手动添加,比如选择日期 但传参时应为日期+时间

日期范围最后添加23:59:59



前端规范

表格需要处理排序和分页



服务规范

文件服务 添加存储路径 断点续传 md5判定等功能

日志服务 添加文件日志功能

mybatisgenerator改进,增加别名,增加selectone,增加batchinsert

验证pagehelper排序是否覆盖sql原有排序

mybatis拦截器处理delstatus 兼容delflag 根据反射判断字段名称进行处理


数据库规范

相同模块的表使用相同的前缀,例如:dms_xxx

索引命名统一使用 

    * idx_索引列1_索引列2的命名方式

    * uni_索引列1_索引列2的命名方式

所有表必须有别名

定义表结构并定义别名

id, created_at,created_by,updated_at,updated_by,del_status

数据库尽可能使用datetime类型 不要使用long类型 除非不满足

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • 前言 本开发规范基于《阿里巴巴Java开发手册终极版》修改,并集成我们自己的项目开发规范,整合而成。 为表示对阿里...
    4ea0af17fd67阅读 5,622评论 0 5
  • 阿里巴巴 JAVA 开发手册 1 / 32 Java 开发手册 版本号 制定团队 更新日期 备 注 1.0.0 阿...
    糖宝_阅读 7,492评论 0 5
  • 文档版本说明v1.0 基础版本v1.1 补充规范,增加规范等级 一、代码流程规范 (一) java代码处理 【强制...
    tonyZj阅读 958评论 0 2
  • 无规矩不成方圆,编码规范就如同协议,有了Http、TCP等各种协议,计算机之间才能有效地通信,同样的,有了一致的编...
    sherlockyb阅读 5,015评论 1 5
  • 后端开发规范 SOA服务接口规范1、SOA接口命名提供出去后不能变更,废弃接口使用@deprecated进行标记2...
    felixfeijs阅读 1,419评论 0 0