从代码生成提及，带你深刻理解 mybatis generator 源码
枯燥的任务
这一切都要从多年前提及。html
那时候刚入职一家新公司，项目经理给我分配了一个比较简单的工做，为全部的数据库字段整理一张元数据表。java
由于不少接手的项目文档都不全，因此须要统一整理一份基本的字典表。mysql
若是是你，你会怎么处理这个任务呢？git
重复的工做
一开始我是直接准备人工把全部的字段整理一遍，而后整理出对应的 SQL 插入到元数据库管理表中。github
meta_table 元数据表信息web
meta_field 元数据字段信息sql
一开始还有点激情，后来就是无尽的重复，感受十分无聊。数据库
因而，我本身动手写了一个开源的小工具。markdown
元数据管理
metadata 能够自动将全部的表信息和字段信息存入元数据表中，便于统一查阅。
(注释须要保证库自己已经包含了对于表和字段的注释)
数据库表设计
一开始实现了 3 种常见的数据库：mysql oracle sql-server。
以 mysql 为例，对应的建表语句为：
drop table if exists meta_field; drop table if exists meta_model; /*==============================================================*/ /* Table: meta_field */ /*==============================================================*/ create table meta_field ( ID int not null auto_increment comment '自增加主键', uid varchar(36) comment '惟一标识', name varchar(125) comment '名称', dbObjectName varchar(36) comment '数据库表名', alias varchar(125) comment '别名', description varchar(255) comment '描述', isNullable bool comment '是否可为空', dataType varchar(36) comment '数据类型', createTime datetime comment '建立时间', updateTime datetime comment '更新时间', primary key (ID) ) auto_increment = 1000 DEFAULT CHARSET=utf8; alter table meta_field comment '元数据字段表'; /*==============================================================*/ /* Table: meta_model */ /*==============================================================*/ create table meta_model ( ID int not null auto_increment comment '自增加主键', uid varchar(36) comment '惟一标识', name varchar(125) comment '名称', dbObjectName varchar(36) comment '数据库表名', alias varchar(125) comment '别名', description varchar(255) comment '描述', category varchar(36) comment '分类', isVisible bool comment '是否可查询', isEditable bool comment '是否可编辑', createTime datetime comment '建立时间', updateTime datetime comment '更新时间', primary key (ID) ) DEFAULT CHARSET=utf8; alter table meta_model comment '元数据实体表';
数据初始化
metadata 是一个 web 应用，部署启动后，页面指定数据库链接信息，就能够完成全部数据的初始化。
以测试脚本
CREATE DATABASE `metadata-test` DEFAULT CHARACTER SET UTF8; USE `metadata-test`; CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '惟一标识', `username` varchar(255) DEFAULT NULL COMMENT '用户名', `password` varchar(255) DEFAULT NULL COMMENT '密码', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=UTF8 COMMENT='用户表';
为例，能够将对应的表和字段信息所有初始化到对应的表中。
一切看起来都很棒，几分钟就搞定了。不是吗？
代码自动生成
原本 metadata 没有意外的话，我几乎不会再去修改他了。
直接前不久，我基于 mybatis-plus-generator 实现了一个代码自动生成的低代码平台。
开源地址以下：
我发现了 metadata 这个应用虽然做为 web 应用还不错，可是自己的复用性不好，我没法在这个基础上实现一个代码生成工具。
因而，就诞生了实现一个最基础的 jdbc 元数据管理工具的想法。
他山之石，能够攻玉。
咱们就直接以 MPG 的源码为例，学习而且改造。
数据库元数据
核心原理
元数据管理最核心的一点在于全部的数据库自己就有元数据管理。
咱们以 mysql 为例，查看全部表信息。
show table status;
以下：
+------+--------+---------+------------+------+----------------+-------------+-----------------+--------------+-----------+----------------+---------------------+-------------+------------+-----------------+----------+----------------+--------------+ | Name | Engine | Version | Row_format | Rows | Avg_row_length | Data_length | Max_data_length | Index_length | Data_free | Auto_increment | Create_time | Update_time | Check_time | Collation | Checksum | Create_options | Comment | +------+--------+---------+------------+------+----------------+-------------+-----------------+--------------+-----------+----------------+---------------------+-------------+------------+-----------------+----------+----------------+--------------+ | word | InnoDB | 10 | Compact | 0 | 0 | 16384 | 0 | 0 | 0 | 1 | 2021-07-22 19:39:13 | NULL | NULL | utf8_general_ci | NULL | | 敏 感词表 | +------+--------+---------+------------+------+----------------+-------------+-----------------+--------------+-----------+----------------+---------------------+-------------+------------+-----------------+----------+----------------+--------------+ 1 row in set (0.00 sec)
对应的字段信息查看
show full fields from word;
输出以下：
mysql> show full fields from word; +-------------+------------------+-----------------+------+-----+-------------------+-----------------------------+---------------------------------+--------------------+ | Field | Type | Collation | Null | Key | Default | Extra | Privileges | Comment | +-------------+------------------+-----------------+------+-----+-------------------+-----------------------------+---------------------------------+--------------------+ | id | int(10) unsigned | NULL | NO | PRI | NULL | auto_increment | select,insert,update,references | 应用自增主键 | | word | varchar(128) | utf8_general_ci | NO | UNI | NULL | | select,insert,update,references | 单词 | | type | varchar(8) | utf8_general_ci | NO | | NULL | | select,insert,update,references | 类型 | | status | char(1) | utf8_general_ci | NO | | S | | select,insert,update,references | 状态 | | remark | varchar(64) | utf8_general_ci | NO | | | | select,insert,update,references | 配置描述 | | operator_id | varchar(64) | utf8_general_ci | NO | | system | | select,insert,update,references | 操做员名称 | | create_time | timestamp | NULL | NO | | CURRENT_TIMESTAMP | | select,insert,update,references | 建立时间戳 | | update_time | timestamp | NULL | NO | | CURRENT_TIMESTAMP | on update CURRENT_TIMESTAMP | select,insert,update,references | 更新时间戳 | +-------------+------------------+-----------------+------+-----+-------------------+-----------------------------+---------------------------------+--------------------+ 8 rows in set (0.01 sec)
能够获取到很是全面的信息，代码生成就是基于这些基本信息，生成对应的代码文本。
其中，word 的建表语句以下：
create table word
(
id int unsigned auto_increment comment '应用自增主键' primary key,
word varchar(128) not null comment '单词',
type varchar(8) not null comment '类型',
status char(1) not null default 'S' comment '状态',
remark varchar(64) not null comment '配置描述' default '',
operator_id varchar(64) not null default 'system' comment '操做员名称',
create_time timestamp default CURRENT_TIMESTAMP not null comment '建立时间戳',
update_time timestamp default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '更新时间戳'
) comment '敏感词表' ENGINE=Innodb default charset=UTF8 auto_increment=1;
create unique index uk_word on word (word) comment '惟一索引';
拓展性
虽然上面介绍元数据获取，是以 mysql 为例。
可是咱们在实现工具的时候，必定要考虑对应的可拓展性。
能够是 mysql，也能够是常见的 oracle/sql-server。
每一种数据库的获取方式都是不一样的，因此须要根据配置不一样，实现也要不一样。
获取到元数据以后，处理的方式也能够很是多样化。
能够控台输出，能够入库，能够生成对应的 markdown/html/pdf/word/excel 不一样形式的文档等。
易用性
好的工具，应该对用户屏蔽复杂的实现细节。
用户只须要简单的指定配置信息，想要获取的表，处理方式便可。
至于如何实现，用户能够不关心。
源码实现
接下来，咱们结合 MPG 的源码，抽取最核心的部分进行讲解。
获取数据库链接
如何根据链接信息获取 connection？
但愿常用 mybatis 等工具的你还记得：
public class DbConnection implements IDbConnection {
/**
* 驱动链接的URL
*/
private String url;
/**
* 驱动名称
*/
private String driverName;
/**
* 数据库链接用户名
*/
private String username;
/**
* 数据库链接密码
*/
private String password;
//getter&setter
@Override
public Connection getConnection() {
Connection conn = null;
try {
Class.forName(driverName);
conn = DriverManager.getConnection(url, username, password);
} catch (ClassNotFoundException | SQLException e) {
throw new JdbcMetaException(e);
}
return conn;
}
}
IDbConnection 接口的定义很是简单：
public interface IDbConnection {
/**
* 获取数据库链接
* @return 链接
* @since 1.0.0
*/
Connection getConnection();
}
这样便于后期替换实现，你甚至可使用数据库链接池：
元数据查询脚本
对于不一样的数据库，查询的方式不一样。
以 mysql 为例，实现以下：
public class MySqlQuery extends AbstractDbQuery {
@Override
public DbType dbType() {
return DbType.MYSQL;
}
@Override
public String tablesSql() {
return "show table status";
}
@Override
public String tableFieldsSql() {
return "show full fields from `%s`";
}
@Override
public String tableName() {
return "NAME";
}
@Override
public String tableComment() {
return "COMMENT";
}
@Override
public String fieldName() {
return "FIELD";
}
@Override
public String fieldType() {
return "TYPE";
}
@Override
public String fieldComment() {
return "COMMENT";
}
@Override
public String fieldKey() {
return "KEY";
}
@Override
public boolean isKeyIdentity(ResultSet results) throws SQLException {
return "auto_increment".equals(results.getString("Extra"));
}
@Override
public String nullable() {
return "Null";
}
@Override
public String defaultValue() {
return "Default";
}
}
其中 show table status 用于查看全部的表元数据；show full fields from %s 能够查看具体表的字段元数据。
nullable() 和 defaultValue() 这两个属性是老马新增的，MPG 中是没有的，由于代码生成不关心这两个字段。
核心实现
作好上面的准备工做以后，咱们能够开始进行核心代码编写。
@Override
public List<TableInfo> getTableList(TableInfoContext context) {
// 链接
Connection connection = getConnection(context);
DbType dbType = DbTypeUtils.getDbType(context.getDriverName());
IDbQuery dbQuery = DbTypeUtils.getDbQuery(dbType);
// 构建元数据查询 SQL
String tableSql = buildTableSql(context);
// 执行查询
List<TableInfo> tableInfoList = queryTableInfos(connection, tableSql, dbQuery, context);
return tableInfoList;
}
具体数据库实现
具体数据库的实现是不一样的，能够根据 driverName 获取。
DbTypeUtils 的实现以下：
/**
* @author binbin.hou
* @since 1.0.0
*/
public final class DbTypeUtils {
private DbTypeUtils(){}
/**
* 根据驱动获取 dbType
* @param driverName 驱动信息
* @return 结果
* @since 1.1.0
*/
public static DbType getDbType(final String driverName) {
DbType dbType = null;
if (driverName.contains("mysql")) {
dbType = DbType.MYSQL;
} else if (driverName.contains("oracle")) {
dbType = DbType.ORACLE;
} else if (driverName.contains("postgresql")) {
dbType = DbType.POSTGRE_SQL;
} else {
throw new JdbcMetaException("Unknown type of database!");
}
return dbType;
}
/**
* 获取对应的数据库查询类型
* @param dbType 数据库类型
* @return 结果
* @since 1.0.0
*/
public static IDbQuery getDbQuery(final DbType dbType) {
IDbQuery dbQuery = null;
switch (dbType) {
case ORACLE:
dbQuery = new OracleQuery();
break;
case SQL_SERVER:
dbQuery = new SqlServerQuery();
break;
case POSTGRE_SQL:
dbQuery = new PostgreSqlQuery();
break;
default:
// 默认 MYSQL
dbQuery = new MySqlQuery();
break;
}
return dbQuery;
}
}
表数据查询 sql
根据对应的 IDbQuery 构建表数据查询的 sql。
/**
* 构建 table sql
* @param context 上下文
* @return 结果
* @since 1.0.0
*/
private String buildTableSql(final TableInfoContext context) {
// 获取 dbType & DbQuery
final String jdbcUrl = context.getDriverName();
DbType dbType = DbTypeUtils.getDbType(jdbcUrl);
IDbQuery dbQuery = DbTypeUtils.getDbQuery(dbType);
String tablesSql = dbQuery.tablesSql();
if (DbType.POSTGRE_SQL == dbQuery.dbType()) {
//POSTGRE_SQL 使用
tablesSql = String.format(tablesSql, "public");
}
// 简化掉 oracle 的特殊处理
return tablesSql;
}
直接获取对应的 tablesSql 便可，很是简答。
表信息构建
直接根据构建好的 tableSql 查询，而后构建最基本的表信息。
try(PreparedStatement preparedStatement = connection.prepareStatement(tablesSql);) {
List<TableInfo> tableInfoList = new ArrayList<>();
ResultSet results = preparedStatement.executeQuery();
TableInfo tableInfo;
while (results.next()) {
String tableName = results.getString(dbQuery.tableName());
if (StringUtil.isNotEmpty(tableName)) {
String tableComment = results.getString(dbQuery.tableComment());
tableInfo = new TableInfo();
tableInfo.setName(tableName);
tableInfo.setComment(tableComment);
tableInfoList.add(tableInfo);
} else {
System.err.println("当前数据库为空！！！");
}
}
} catch (SQLException e) {
throw new JdbcMetaException(e);
}
此处省去对表信息的过滤。
字段信息构建
表信息构建为完成后，构建具体的字段信息。
try {
String tableFieldsSql = dbQuery.tableFieldsSql();
if (DbType.POSTGRE_SQL == dbQuery.dbType()) {
tableFieldsSql = String.format(tableFieldsSql, "public", tableInfo.getName());
} else {
tableFieldsSql = String.format(tableFieldsSql, tableInfo.getName());
}
PreparedStatement preparedStatement = connection.prepareStatement(tableFieldsSql);
ResultSet results = preparedStatement.executeQuery();
while (results.next()) {
TableField field = new TableField();
// 省略 ID 相关的处理
// 省略自定义字段查询
// 处理其它信息
field.setName(results.getString(dbQuery.fieldName()));
field.setType(results.getString(dbQuery.fieldType()));
String propertyName = getPropertyName(field.getName());
DbColumnType dbColumnType = typeConvert.getTypeConvert(field.getType());
field.setPropertyName(propertyName);
field.setColumnType(dbColumnType);
field.setComment(results.getString(dbQuery.fieldComment()));
field.setNullable(results.getString(dbQuery.nullable()));
field.setDefaultValue(results.getString(dbQuery.defaultValue()));
fieldList.add(field);
}
} catch (SQLException e) {
throw new JdbcMetaException(e);
}
字段信息的实现也比较简单，直接根据对应的 sql 进行查询，而后构建便可。
结果的处理
在通过大量的删减以后，咱们能够获取最基础的表元数据信息。
可是要怎么处理这个列表信息呢？
咱们能够定义一个接口：
public interface IResultHandler {
/**
* 处理
* @param context 上下文
* @since 1.0.0
*/
void handle(final IResultHandlerContext context);
}
context 的属性比较简单，目前就是 List<TableInfo>。
咱们能够实现一个控台输出：
public class ConsoleResultHandler implements IResultHandler {
@Override
public void handle(IResultHandlerContext context) {
List<TableInfo> tableInfoList = context.tableInfoList();
for(TableInfo tableInfo : tableInfoList) {
// 数据
System.out.println("> " + tableInfo.getName() + " " + tableInfo.getComment());
System.out.println();
List<TableField> tableFields = tableInfo.getFields();
System.out.println("| 序列 | 列名 | 类型 | 是否为空 | 缺省值 | 描述 |");
System.out.println("|:---|:---|:---|:---|:---|:---|");
String format = "| %d | %s | %s | %s | %s | %s |";
int count = 1;
for (TableField field : tableFields) {
String info = String.format(format, count, field.getName(),
field.getType(), field.getNullable(), field.getDefaultValue(),
field.getComment());
System.out.println(info);
count++;
}
System.out.println("\n\n");
}
}
}
在控台输出对应的 markdown 字段信息。
你也能够实现本身的 html/pdf/word/excel 等等。
测试验证
咱们前面写了这么多主要是原理实现。
那么工具是否好用，仍是要体验一下。
测试代码
JdbcMetadataBs.newInstance()
.url("jdbc:mysql://127.0.0.1:3306/test")
.includes("word")
.execute();
指定输出 test.word 的表信息。
效果
对应的日志以下：
> word 敏感词表 | 序列 | 列名 | 类型 | 是否为空 | 缺省值 | 描述 | |:---|:---|:---|:---|:---|:---| | 1 | id | int(10) unsigned | NO | null | 应用自增主键 | | 2 | word | varchar(128) | NO | null | 单词 | | 3 | type | varchar(8) | NO | null | 类型 | | 4 | status | char(1) | NO | S | 状态 | | 5 | remark | varchar(64) | NO | | 配置描述 | | 6 | operator_id | varchar(64) | NO | system | 操做员名称 | | 7 | create_time | timestamp | NO | CURRENT_TIMESTAMP | 建立时间戳 | | 8 | update_time | timestamp | NO | CURRENT_TIMESTAMP | 更新时间戳 |
这个就是简单的 markdown 格式，实际效果以下：
word 敏感词表
| 序列 | 列名 | 类型 | 是否为空 | 缺省值 | 描述 |
|---|---|---|---|---|---|
| 1 | id | int(10) unsigned | NO | null | 应用自增主键 |
| 2 | word | varchar(128) | NO | null | 单词 |
| 3 | type | varchar(8) | NO | null | 类型 |
| 4 | status | char(1) | NO | S | 状态 |
| 5 | remark | varchar(64) | NO | 配置描述 | |
| 6 | operator_id | varchar(64) | NO | system | 操做员名称 |
| 7 | create_time | timestamp | NO | CURRENT_TIMESTAMP | 建立时间戳 |
| 8 | update_time | timestamp | NO | CURRENT_TIMESTAMP | 更新时间戳 |
这样，咱们就拥有了一个最简单的 jdbc 元数据管理工具。
固然，这个只是 v1.0.0 版本，后续还有许多特性须要添加。
小结
MPG 基本上每个使用 mybatis 必备的工具，大大提高了咱们的效率。
知道对应的实现原理，可让咱们更好的使用它，而且在其基础上，实现本身的脑洞。
我是老马，期待与你的下次重逢。
备注：涉及的代码较多，文中作了简化。若你对源码感兴趣，能够關註{老马啸西风}，後臺回復{代码生成}便可得到。
相关文章
- 1. mybatis-generator生成代码
- 2. Mybatis generator代码生成
- 3. IDEA MyBatis Generator 生成代码
- 4. MyBatis Generator生成代码小工具，Mybatis的代码生成器
- 5. 详解 使用MyBatis Generator****生成代码
- 6. mybatis自动生成代码mybatis-generator
- 7. 使用mybatis-generator生成Mybatis代码
- 8. MyBatis代码生成器——MyBatis Generator
- 9. MyBatis干货----------MyBatis Generator代码生成器
- 10. Android EventBus源代码解析 带你深刻理解EventBus
- 更多相关文章...
- • Markdown 代码 - Markdown 教程
- • Eclipse 代码模板 - Eclipse 教程
- • IntelliJ IDEA代码格式化设置
- • Scala 中文乱码解决
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. 跳槽面试的几个实用小技巧，不妨看看！
- 2. Mac实用技巧 |如何使用Mac系统中自带的预览工具将图片变成黑白色?
- 3. Mac实用技巧 |如何使用Mac系统中自带的预览工具将图片变成黑白色?
- 4. 如何使用Mac系统中自带的预览工具将图片变成黑白色?
- 5. Mac OS非兼容Windows软件运行解决方案——“以VMware & Microsoft Access为例“
- 6. 封装 pyinstaller -F -i b.ico excel.py
- 7. 数据库作业三ER图待完善
- 8. nvm安装使用低版本node.js(非命令安装)
- 9. 如何快速转换图片格式
- 10. 将表格内容分条转换为若干文档
欢迎关注本站公众号,获取更多信息
相关文章
- 1. mybatis-generator生成代码
- 2. Mybatis generator代码生成
- 3. IDEA MyBatis Generator 生成代码
- 4. MyBatis Generator生成代码小工具，Mybatis的代码生成器
- 5. 详解 使用MyBatis Generator****生成代码
- 6. mybatis自动生成代码mybatis-generator
- 7. 使用mybatis-generator生成Mybatis代码
- 8. MyBatis代码生成器——MyBatis Generator
- 9. MyBatis干货----------MyBatis Generator代码生成器
- 10. Android EventBus源代码解析 带你深刻理解EventBus