## 代码生成
BeetlSQL提供了弹性的代码生机制,可以根据数据库的定义生成java代码,文档,业务代码,BeetlSQL自身提供了一套生成模板,用户可以复用或者修改这些模板,或者提供新的模板,比如生成Controller代码
`SourceConfig`是核心类,接收参数SQLManager以及一组SourceBuilder,前者用于获取metadata,后者是具体执行生成过程
```java
public SourceConfig(SQLManager sqlManager,List<SourceBuilder> sourceBuilder) {
this(sqlManager,false);
this.sourceBuilder = sourceBuilder;
}
public void gen(String tableName, BaseProject project){}
public void genAll(BaseProject project, SourceFilter sourceFilter){}
```
gen或者genAll方法用于开始执行,每个tableName都会传递给sourceBuilder集合,一次运行
SourceBuilder 需要实现如下方法,执行具体的生成动作
```java
public abstract void generate(BaseProject project, SourceConfig config,Entity entity);
```
参数BaseProject提供了生成的基本信息,比如BaseProject的子类ConsoleOnlyProject,会提供一个基于System.out的输出流,因此生成的代码都打印在控制台,而SimpleMavenProject 则提供一个文件路径,代码会按照包名保存到相应的工程文件里
Entity 对象则是目标表或者视图的描述,包含了java属性,类型,数据库的列名,类型,备注等信息,足够生成一个java类
用户通常需要完成SourceBuilder来实现代码生成,生成到文件,控制台,还是其他地方则是通过BaseProject决定
如下是一个根据表生成数据库表的描述文档
```java
public class MDDocBuilder extends BaseTemplateSourceBuilder {
public static String mapperTemplate="doc.btl.md";
public MDDocBuilder() {
super("doc");
}
@Override
public void generate(BaseProject project, SourceConfig config, Entity entity) {
//BeetlSQl中的配置
Beetl beetl = ((BeetlTemplateEngine)config.getSqlManager().getSqlTemplateEngine()).getBeetl();
//模板
Template template = groupTemplate.getTemplate(mapperTemplate);
template.binding("tableName", entity.getTableName());
template.binding("comment", entity.getComment());
template.binding("colsMap", entity.getTableDesc().getColsDetail());
template.binding("table", entity.getTableDesc());
String mdFileName = StringKit.toLowerCaseFirstOne(entity.getName())+".doc..md";
Writer writer = project.getWriterByName(this.name,mdFileName);
template.renderTo(writer);
}
```
对应的模板doc.btl.md 如下
```markdown
## ${tableName}
**说明**
${isEmpty(comment)?"无注释":comment}
**表信息**
<%
var ids = table.idNames;
%>
* 主键 ${ids}
* 表注释
| 名称 | 数据类型 | 长度 | 说明 |
| :--: | :--- | :------: | :----: |
<% for(col in colsMap){
var name = col.key;
if(@ids.contains(name)){
name="*"+name;
}
var detail = col.value;
var dbType =@org.beetl.sql.clazz.kit.JavaType.jdbcTypeId2Names.get(detail.sqlType);
%>
|${name} | ${dbType}| ${detail.size} | ${detail.remark} |
<%}%>
```
- BeetlSQL 3 指南
- 数据访问框架
- 适合用户
- 编译源码
- 直接看代码
- 闲大赋介绍
- BeetlSQL3 特点
- 数据库访问工具的痛点
- BeetlSQL3 例子
- 基础例子
- 结果集映射
- 翻页查询
- 演示like,batchUpdate,in 操作
- 自动fetch
- 多数据库
- 代码生成框架
- 安装BeetlSQL
- 直接安装
- 框架集成
- 编译源码
- 快速开始
- 环境准备
- 环境搭建
- 使用BeetlSQL
- 按照主键查寻
- 更新
- 按照模板查询
- 执行SQL
- 执行模板SQL
- 使用Query
- 使用Mapper
- 使用模板文件
- SQLManager
- 内置语句
- 内置查询API
- template查询
- 更新操作
- 执行SQL
- 执行模板SQL
- 把SQL放到文件里
- 翻页查询
- SQLResult
- Stream查询
- 存储过程调用
- NameConversion(重要)
- DBStyle
- Inerceptor
- SQLManagerExtend
- 强制使用数据源
- Mapper
- 实现Mapper
- @Sql
- @Update @BatchUpdate
- @Template
- 参数名称
- 参数返回值
- 执行SQL文件
- 翻页查询
- @SqlProvider
- @SpringData
- @SubQuery
- @InheritMapper
- @Call
- StreamData
- Default Method
- 定义自己的BaseMapper
- 限制Java代码中SQL长度
- 数据模型
- POJO
- 不严格的POJO
- 交集(重要)
- @Table 注解
- @Column 注解
- 主键
- RowMapper
- ResultSetMapper
- Json配置映射
- Json自动映射
- XML支持
- 自动Fetch
- AttributeConvert
- BeanConvert
- 枚举
- 混合模型
- Map模型
- 动态模型
- 模型其他注解
- 安全扩展注解
- BeetlSql 单表查询工具Query
- Query使用方式和风格介绍
- Query主要操作简介
- 查询器获取
- SELECT简单的条件查询
- 复杂的条件查询
- 查询字段智能处理
- 健壮的变量
- 自定义实现
- INSERT操作
- UPDATE操作
- DELETE操作
- single查询和unique
- COUNT查询
- GROUP分组查询和Having子句
- 分页查询
- ORDER BY 排序
- page分页查询
- 方法调用顺序
- Markdown文件
- Beetl 入门
- 定界符号
- 变量
- 算数表达式
- 逻辑表达式
- 控制语句
- 访问变量属性
- 判断对象非空(重要)
- 调用方法
- 自定义方法
- 内置方法
- 标签功能
- 附录
- Idea 插件
- 代码生成
- 多库使用
- 业务主从库
- 主从库延迟问题
- 多个业务库
- 合并多个业务库 1
- 合并多个业务库 2
- 单表多租户
- 每个租户一个表
- 多库多租户
- 使用ShardingSphere
- Saga(试验)
- 关于Saga的一些认识
- 关于隔离性
- BeetlSQL Saga
- SagaMapper
- Saga 多库事务实现
- Saga 微服务 实现
- 配置 Saga Server
- Swagger
- BeetlSQL 性能
- 测试方法
- 最新
- 2021-11-21
- 2020-9-28
- Spring 快速开始
- 环境准备
- 环境搭建
- SpringBoot 快速开始
- 环境准备
- 环境搭建
- 扩展BeetlSQL3
- 完整配置
- BaseMapper定制
- 代码生成
- SQLExecutor定制
- 第三方
- MetadataManager
- JFinal集成
- ExecuteContext
- 参考ACT
- 数据库表到Java对象
- Solon
- NameConversion
- ViewType
- RowMapper
- ResultSetMapper
- AttributeConvert
- BeanConvert
- Fetch
- 代码生成
- 扩展BeetlSQL3
- BaseMapper定制
- SQLExecutor定制
- MetadataManager
- ExecuteContext
- 数据库表到Java对象
- NameConversion
- ViewType
- RowMapper
- ResultSetMapper
- AttributeConvert
- BeanConvert
- Fetch
- 代码生成
- BeetlSQL 多数据库支持
- 多库之间的不同
- 跨库支持实现
- DBStyle
- MySqlStyle 例子
- H2Style例子
- ClickHouseStyle例子
- HBaseStyle例子
- DruidStyle例子
- MetadataManager
- BeanProcessor
- 与BeetlSQL2的区别
- 使用区别