开发说明
在开发前,需要了解项目的基本结构和规范,以便更好的进行开发。请熟悉Goframe框架的使用,以及项目的基本结构。
核心业务目录说明
- API定义: 在API目录中进行定义,在版本下,如V1目录下,创建模块目录,进行api文件的定义。
- 业务逻辑实现: 在internal目录中进行俱体的业务功能实现。其中主要实现的有controller、logic两个目录的内容。
- 业务Model: 在internal下的dao、model中的do、entity目录是由gf gen 工具自动生成的。对于model的结构体的自定义放在model下的对应文件中
每个独立完整的功能,建议创建独立的功能目录,在controller、logic等下面。
数据表设计约定
业务数据表要求必须有的默认字段为:
sql
`tenant_id` varchar(20) NOT NULL COMMENT '租户ID',
`dept_id` bigint(20) NOT NULL COMMENT '所属机构',
`created_dept` bigint(20) DEFAULT NULL COMMENT '创建部门',
`created_by` bigint(20) DEFAULT NULL COMMENT '创建者',
`created_at` datetime DEFAULT NULL COMMENT '创建时间',
`updated_by` bigint(20) DEFAULT NULL COMMENT '更新者',
`updated_at` datetime DEFAULT NULL COMMENT '更新时间',
`deleted_by` bigint(20) DEFAULT NULL COMMENT '删除人',
`deleted_at` datetime DEFAULT NULL COMMENT '删除时间',
`status` char(1) DEFAULT '0' COMMENT '部门状态(0正常 1停用)',
开发步骤
- 第一步: 在hack/config.yaml中配置对应的表名
- 第二步: 使用gf gen dao命令生成对应的ENTITY DO
- 第三步: 在logic新建某个业务单元,例如system,编写对应的业务实现
- 第四步: 使用gf gen service 实现对应的接口
- 第五步: 定义相关返回结构体, 返回API将数据返回给前端