后端项目开发：代码生成的思想与实现

晓风残月淡

已于 2023-12-25 16:59:55 修改

阅读量589

点赞数

分类专栏：软件项目开发最佳实践文章标签： oracle 数据库

于 2023-08-25 00:13:26 首次发布

本文链接：https://blog.csdn.net/qq_40610003/article/details/132483938

版权

软件项目开发最佳实践专栏收录该内容

18 篇文章

订阅专栏

代码生成要解决什么问题？

大部分项目里其实有很多代码都是重复的，几乎每个基础模块的代码都有增删改查的功能，而这些功能都是大同小异，如果这些功能都要自己去写，将会大大浪费我们的精力降低效率。所以，这种重复性的代码可以使用代码生成，提高开发效率。

以传统的MVC开发架构为例，会有controller，service，model，repository的四层划分，简单的单表的增删查改，若采用手动编码，就要关注4x4=16处代码的编写。这是每个模块几乎避免不了的部分。若数据库表增加了一个字段，那又要关注4x4=16处代码的对错。

代码生成不能解决什么问题？

代码生成不能生成所有类型的代码。它最适合生成简单、重复性高的代码。对于复杂多变、独特的代码，代码生成可能不适用。

如何进行代码生成？

开发人员可以通过定义模板和规则，快速生成大量的代码。

在领域驱动设计中，开发人员可以设计符合现实情况的实体与行为，这是代码经常动刀的位置，可能不适合进行代码生成。

若使用JPA的技术可以根据实体自动生成数据库表。但是该种方式不适合多表关联查询，同时有点风险。（如果已有的数据库表结构与JPA实体定义不一致，自动生成表时可能会导致数据丢失或冲突）

在中国，报表的查询需求也是一大重点。所以建议使用mybatis的ORM框架，这个也是中国使用人数占大多数的技术栈。恰好有个代码生成工具——mybatis-generate可以提前设计好数据库表，再根据数据库表生成相应的代码。

因此，我们不得不基于数据库表驱动的方式进行代码生成。

若觉得使用mybatis-generate的工具不够灵活，那么可以选择使用Velocity工具自行编辑template模板生成对应的代码文件。

长远打算的话，我建议还是用Velocity自行配置代码模板。

一、数据库表结构

若采用数据驱动设计的方式构建生成代码，则需要设计数据库表。

根据数据库表的组织形式，数据库表结构分为：

单表结构（不包含任意外键）

没有任何外键的单表结构

新建数据库表结构（单表）

drop table if exists sys_student;
create table sys_student (
  student_id           int(11)         auto_increment    comment '编号',
  student_name         varchar(30)     default ''        comment '学生名称',
  student_age          int(3)          default null      comment '年龄',
  student_hobby        varchar(30)     default ''        comment '爱好（0代码 1音乐 2电影）',
  student_sex          char(1)         default '0'       comment '性别（0男 1女 2未知）',
  student_status       char(1)         default '0'       comment '状态（0正常 1停用）',
  student_birthday     datetime                          comment '生日',
  primary key (student_id)
) engine=innodb auto_increment=1 comment = '学生信息表';

树表结构(表中含父ID字段)

自身与自身有上下层级关系的树表结构

新建数据库表结构（树表）

drop table if exists sys_product;
create table sys_product (
  product_id        bigint(20)      not null auto_increment    comment '产品id',
  parent_id         bigint(20)      default 0                  comment '父产品id',
  product_name      varchar(30)     default ''                 comment '产品名称',
  order_num         int(4)          default 0                  comment '显示顺序',
  status            char(1)         default '0'                comment '产品状态（0正常 1停用）',
  primary key (product_id)
) engine=innodb auto_increment=1 comment = '产品表';

主子表结构

数据与其他表有关联关系的主子表结构，是一对多的关系
新建数据库表结构（主子表）

-- ----------------------------
-- 客户表
-- ----------------------------
drop table if exists sys_customer;
create table sys_customer (
  customer_id           bigint(20)      not null auto_increment    comment '客户id',
  customer_name         varchar(30)     default ''                 comment '客户姓名',
  phonenumber           varchar(11)     default ''                 comment '手机号码',
  sex                   varchar(20)     default null               comment '客户性别',
  birthday              datetime                                   comment '客户生日',
  remark                varchar(500)    default null               comment '客户描述',
  primary key (customer_id)
) engine=innodb auto_increment=1 comment = '客户表';


-- ----------------------------
-- 商品表
-- ----------------------------
drop table if exists sys_goods;
create table sys_goods (
  goods_id           bigint(20)      not null auto_increment    comment '商品id',
  customer_id        bigint(20)      not null                   comment '客户id',
  name               varchar(30)     default ''                 comment '商品名称',
  weight             int(5)          default null               comment '商品重量',
  price              decimal(6,2)    default null               comment '商品价格',
  date               datetime                                   comment '商品时间',
  type               char(1)         default null               comment '商品种类',
  primary key (goods_id)
) engine=innodb auto_increment=1 comment = '商品表';

分析

单表

以学生表为例，对于管理学生列表，只需要单表查询学生信息就够了。但是在表中含有状态、性别等表现为选择类型的字段时，有三种实现方式：枚举类型，字典表和数字表示

使用枚举类型：可以为状态、性别等字段创建对应的枚举类型，在数据库中存储对应的枚举值。在Java代码中，将枚举类型与数据库字段进行映射，可以方便地进行查询和处理。
使用字典表：可以创建一个字典表，用于存储状态、性别等选择类型的所有可能取值。在学生表中，将状态、性别等字段设计为外键，关联字典表的主键。这样可以在查询学生信息时，通过关联查询获取对应的状态、性别等具体值。
使用字符或数字表示：可以直接在学生表中使用字符或数字表示状态、性别等选择类型的值。例如，使用字符 ‘0’ 表示男性，‘1’ 表示女性，‘2’ 表示未知。这种方式简单直接，但可读性较差，需要在代码中进行相应的解析和转换。

枚举类型和字典表可以提供更好的可读性和扩展性，但可能增加一定的复杂性。使用字符或数字表示则较为简单，但可读性较差。

二、视图表现形式

尽管是根据数据表的字段来自动生成代码，但要符合现实的业务逻辑的话，还是要根据用例来定义各种模板和规则。

数据库表的设计是要根据视图页面的各种呈现方式来进行的。

考虑各种数据在视图中的展现方式：

表格(table)。针对大量数据的查询问题，应该设计表格的视图形式。表格以不同的维度进行分类、排序、展示，方便用户快速查找和定位数据。表格的展现方式更适合于数据量较大的数据库表，例如用户表、客户表、订单表、产品表等
列表（List）。列表是将数据以一维线性的方式展示，通常用于展示数据的列表、目录、菜单等。列表的表现方式更适合于数据量较少的表，例如角色表、权限表、部门表、用户表等。
树状图(tree)。针对层级关系的问题，应该设计树状图的视图形式。数据库表例如部门表、分类表、工作事项表会采用此展现方式。
甘特图(Gantt chart)。针对时间进度展示的问题，应该设计甘特图的视图形式。方便用户在时间进度的维度来管理和决策。数据库表例如项目进度表等含时间字段的表会采用此表现形式。
看板(board)。针对流转状态的问题，应该设计看板的视图形式。方便用户管理决策，并且通过简单的拖拽变更状态，进一步助力用户提效。数据库表中的工作流表、工单表、任务表通常会采用看板的展现方式，以便用户根据工作的不同状态进行查看和管理。
表单（form）。表单在网页中主要负责数据采集功能。表单通常由表单标题、表单域、表单按钮等组成。表单域用于输入数据，表单按钮用于提交表单。表单可以用于收集用户的个人信息、订单信息等。

参考资料：
B端界面设计：查询表格页面
 B端界面设计：页面分类设计