基于SpringBoot、Mybatis

背景

我们在日常开发过程，大多数都是使用主流MVC架构，如下图所示。

从图中可以看出，我们主要的业务代码基本都是从Controller->Service->Dao/Mapper，由Dao/Mapper则通过Mybatis连接数据库连接池的方式与数据库进行指令数据交互。

因此，可以知道一张业务表一般可以对应上述一套后台代码，如果业务表众多就会对应多套后台代码，很明显这是重复且麻烦的代码生成工作。基于此，我们考虑能否实现一个与Ideaj代码生成工具有相似功能的工具类，根据我们定义的后台代码模板，来帮助我们个性化生成我们想要的后台代码。

技术路线

我们基于Springboot Gradle构建工程，将工程分为两部分模块。

（1）代码生成器模块：主要基于Freemarker和Velocity模板引擎，对需要的后台代码内容和风格自定义ftl模板。在Generator的主程序中连接数据库，加载模板文件，执行引擎方法，生成数据库表对应的后台代码到指定包路径中；

（2）服务发布模块：基于已生成的后台代码，使用SpringBoot进行发布，发布后通过浏览器访问，验证生成的后台代码是否满足指定业务表的增删改查（全量和分页查询）。

模块解析

（1）公共配置依赖：主要为build.gradle和application.properties配置

build.gradle：

application.properties：

公共包

BaseController.java：

AjaxResult.java：

BaseEntity.java：

HttpStatus.java：

（2）代码生成器模块：该模块核心是定义ftl文件，然后主程序加载并执行模板引擎。

Generator.java

src/main/resources/mybatis-generator.xml：

src/main/resources/templates/ftl/文件

controller.java.ftl：

service.java.ftl：

serviceImpl.java.ftl：

entity.java.ftl：

vo.java.ftl：

* ${table.comment!} *

mapper.java.ftl：

mapper.xml.ftl：

然后启动mysql服务，创建一张t_bill表，并新增4条记录。

CREATE TABLE t_bill(

bill_id INT NOT NULL AUTO_INCREMENT,

bill_title VARCHAR(100) NOT NULL,

bill_author VARCHAR(40) NOT NULL,

bill_date DATE,

PRIMARY KEY ( bill_id )

);

mysql> select * from t_bill;

+---------+------------+-------------+-----------+

| bill_id | bill_title | bill_author | bill_date |

+---------+------------+-------------+-----------+

| 1 | haha | test | NULL |

| 2 | haha | test | NULL |

| 3 | haha | test | NULL |

| 4 | haha55 | test | NULL |

+---------+------------+-------------+-----------+

4 rows in set (0.00 sec)

执行Generator工具类，输入需要创建的子包名、表名，执行结束即可看到工程中自动生成该表的后台代码：

（3）服务发布模块：该模块启动Springboot工程，将生成的后台代码发布到tomcat后通过浏览器访问。

BootApplicationl.java：

然后可通过浏览器访问查询/分页查询方法服务

http://localhost:8080/t-bill/queryList

返回

{"msg":"操作成功","code":200,"data":[{"billId":1,"billTitle":"haha","billAuthor":"test","billDate":null},{"billId":2,"billTitle":"haha","billAuthor":"test","billDate":null},{"billId":3,"billTitle":"haha","billAuthor":"test","billDate":null},{"billId":4,"billTitle":"haha55","billAuthor":"test","billDate":null}]}

http://localhost:8080/t-bill/queryListByPagging?page=1&limit=2

返回

{"msg":"操作成功","code":200,"data":{"count":4,"list":[{"billId":1,"billTitle":"haha","billAuthor":"test","billDate":null},{"billId":2,"billTitle":"haha","billAuthor":"test","billDate":null}]}}

http://localhost:8080/t-bill/queryListByPagging?page=2&limit=2

返回

{"msg":"操作成功","code":200,"data":{"count":4,"list":[{"billId":3,"billTitle":"haha","billAuthor":"test","billDate":null},{"billId":4,"billTitle":"haha55","billAuthor":"test","billDate":null}]}}

也可使用postman等工具测试insert，update，delete服务

http://localhost:8080/t-bill/insertTBill

{

"billId":888,

"billTitle":"888",

"billAuthor":"888",

"LocalDate":null

}

返回

{

"msg": "操作成功",

"code": 200

}

mysql> select * from t_bill;

+---------+------------+-------------+-----------+

| bill_id | bill_title | bill_author | bill_date |

+---------+------------+-------------+-----------+

| 1 | haha | test | NULL |

| 2 | haha | test | NULL |

| 3 | haha | test | NULL |

| 4 | haha55 | test | NULL |

| 888 | 888 | 888 | NULL |

+---------+------------+-------------+-----------+

5 rows in set (0.03 sec)

http://localhost:8080/t-bill/updateTBill

{

"billId":888,

"billTitle":"update888",

"billAuthor":"update888",

"LocalDate":null

}

返回

{

"msg": "操作成功",

"code": 200

}

mysql> select * from t_bill;

+---------+------------+-------------+-----------+

| bill_id | bill_title | bill_author | bill_date |

+---------+------------+-------------+-----------+

| 1 | haha | test | NULL |

| 2 | haha | test | NULL |

| 3 | haha | test | NULL |

| 4 | haha55 | test | NULL |

| 888 | update888 | update888 | NULL |

+---------+------------+-------------+-----------+

5 rows in set (0.00 sec)

http://localhost:8080/t-bill/deleteTBill?id=1

返回

{

"msg": "操作成功",

"code": 200

}

mysql> select * from t_bill;

+---------+------------+-------------+-----------+

| bill_id | bill_title | bill_author | bill_date |

+---------+------------+-------------+-----------+

| 2 | haha | test | NULL |

| 3 | haha | test | NULL |

| 4 | haha55 | test | NULL |

| 888 | update888 | update888 | NULL |

+---------+------------+-------------+-----------+

4 rows in set (0.00 sec)

总结

在构建工程过程中，踩了不少坑下面描述一下避免后面入坑。

1.没有安装mysql，工程中没有配置mysql相关配置，没有引入mysql相关驱动包等导致启动失败。

2.工程使用springboot2.0.7启动，引入mybatis-plus，pageHelper会修改springboot版本，应剔除

3.mybatis-plus，pageHelper的版本没有互相适配导致报jsqlparser错误

4.Application启动类中添加MapperScan扫描，且扫描路径应详细到具体包根路径，扫描引入的jar会出现bean冲突

5.mapper.xml中如果需要动态sql带有特殊字符如#的，在ftl模板中需要对#使用r"{"和r"}"进行转义，