BeetlSQL 2.10中文文档：高效全功能DAO工具

beetl

sql

需积分: 5 25 浏览量更新于2024-07-15 收藏 1.4MB PDF 举报

身份认证购VIP最低享 7 折!

30元优惠券

"BeetlSQL是一个全面的DAO（数据访问对象）工具，结合了Hibernate和Mybatis的优点，适用于依赖SQL并需要自动化SQL生成的项目。它提供了高开发效率、良好的维护性和其他辅助功能，如拦截器和主从数据库支持。BeetlSQL的SQL模板基于Beetl语言，使得编写和调试SQL更加简单。此外，它还支持数据模型的多种类型，包括Pojo、Map和List，并能自动生成POJO类和SQL模板，减少编码工作。在性能方面，BeetlSQL优于JPA和MyBatis，且跨数据库平台兼容性良好。" BeetlSQL的核心特点： 1. **开发效率**：无需额外注解，内置大量预定义SQL，简化CRUD操作，减少约50%的开发工作。支持多种数据模型，包括Pojo、Map和List混合模型，以及SQL模板的便捷编写和调试。 2. **维护性**：SQL语句以Markdown格式集中管理，易于读写和调试。它可以自动生成DAO接口，简化数据库与代码的关联。同时，通过Interceptor功能，可进行SQL调试和性能诊断。 3. **灵活性**：支持一对一、一对多、多对多的关系映射，不引入复杂的ORM概念，简化数据映射。跨数据库平台兼容，减少了开发者适配不同数据库的工作。 4. **性能**：性能表现出色，比JPA和MyBatis更快，内置主从数据库支持。快速入门指南： 2.1. **安装**：可以通过Maven添加依赖，或者手动下载jar包放入classpath。BeetlSQL依赖于Beetl库，确保两个库的版本匹配。 2.2. **准备工作**：确保有一个可用的数据库，如MySQL，BeetlSQL支持多种数据库，包括MySQL、Postgres、Oracle、SQL Server、H2、SQLite和DB2。 2.3. **配置**：在项目中配置数据库连接信息，例如JDBC URL、用户名、密码等。 2.4. **创建实体类**：定义Java实体类，这些类将与数据库表对应。 2.5. **创建模板**：编写SQL模板，这些模板可以基于Beetl语法，用于执行各种数据库操作。 2.6. **使用**：通过DAO接口或直接调用SQL模板执行数据库操作。 BeetlSQL允许开发者以SQL为中心进行开发，同时提供自动化和便利性，使项目更加高效和易于维护。对于需要高效、灵活和SQL友好型DAO框架的项目，BeetlSQL是一个值得考虑的选择。其社区和QQ群提供了交流和获取帮助的平台，有助于开发者更好地理解和使用BeetlSQL。

资源详情

资源推荐

3.5.1. 直接执行sql模板语句

一下接口sql变量是sql模板

public List execute(String sql,Class clazz, Object paras)

public List execute(String sql,Class clazz, Map paras)

public int executeUpdate(String sql,Object paras) 返回成功执行条数

public int executeUpdate(String sql,Map paras) 返回成功执行条数

3.5.2. 直接执行JDBC sql语句

查询 public List execute(SQLReady p,Class clazz) SQLReady包含了需要执行的sql语句和参数，clazz是查询

结果，如

public PageQuery execute(SQLReady p, Class clazz, PageQuery pageQuery)

String jdbcSql = " select *from user order by id";

PageQuery query = new PageQuery(1,20);

query = sql.execute(new SQLReady(jdbcSql), User.class, query);

注意:sql参数通过SQLReady 传递，而不是PageQuery。

更新 public int executeUpdate(SQLReady p) SQLReady包含了需要执行的sql语句和参数，返回更新结果

直接使用Connection public T executeOnConnection(OnConnection call),使用者需要实现onConnection方

法的call方法，如调用存储过程

List<User> users = sql.executeOnConnection(new OnConnection<List<User>(){

@Override

public List<User> call(Connection conn) throws SQLException {

CallableStatement cstmt = conn.prepareCall("{ ? = call md5( ? ) }");

ResultSet rs = callableStatement.executeQuery();

return this.sqlManagaer.getDefaultBeanProcessors().toBeanList(rs,User.class);

}

});

3.6. 其他

3.6.1. 强制使用主或者从

如果为SQLManager提供多个数据源，默认第一个为主库，其他为从库，更新语句将使用主库，查询语句使用

从库库

可以强制SQLManager 使用主或者从

public void useMaster(DBRunner f) DBRunner里的beetlsql调用将使用主数据库库

List<User> list = sqlManager.execute(new SQLReady("select * from user where name=? and age = ?","xian

public void useSlave(DBRunner f) DBRunner里的beetlsql调用将使用从数据库库

对于通常事务来说只读事务则从库，写操作事务则总是主库。关于主从支持，参考17章

3.6.2. 生成Pojo代码和SQ片段

用于开发阶段根据表名来生成pojo代码和相应的sql文件

genPojoCodeToConsole(String table), 根据表名生成pojo类，输出到控制台.

genSQLTemplateToConsole(String table),生成查询，条件，更新sql模板，输出到控制台。

genPojoCode(String table,String pkg,String srcPath,GenConfig config) 根据表名，包名，生成路径，还有

配置，生成pojo代码

genPojoCode(String table,String pkg,GenConfig config) 同上，生成路径自动是项目src路径，或者

src/main/java (如果是maven工程)

genPojoCode(String table,String pkg),同上，采用默认的生成配置

genSQLFile(String table), 同上，但输出到工程，成为一个sql模版,sql模版文件的位置在src目录下，或者src

／main／resources（如果是maven）工程.

genALL(String pkg,GenConfig config,GenFilter filter) 生成所有的pojo代码和sql模版，

genBuiltInSqlToConsole(Class z) 根据类来生成内置的增删改查sql语句，并打印到控制台

sql.genAll("com.test", new GenConfig(), new GenFilter(){

public boolean accept(String tableName){

if(tableName.equalsIgnoreCase("user")){

return true;

}else{

return false;

}

// return false

}

});

第一个参数是pojo类包名，GenConfig是生成pojo的配置，GenFilter 是过滤，返回true的才会生成。如果

GenFilter为null，则数据库所有表都要生成

警告

必须当心覆盖你掉你原来写好的类和方法，不要轻易使用genAll，如果你用了，最好立刻将其注释掉，或

者在genFilter写一些逻辑保证不会生成所有的代码好sql模板文件

3.6.3. 悲观锁 lock

SQLManager 提供如下API实现悲观锁，clazz对应的数据库表，主键为pk的记录实现悲观锁

public <T> T lock(Class<T> clazz, Object pk)

相当于sql语句

select * from xxx where id = ? for update

lock 方法必须用在事务环境里才能生效。事务结束后，自动释放

乐观锁实现请参考@Version 注解

4. 命名转化，表和列名映射

Beetlsql 默认提供了三种列明和属性名的映射类，推荐使用UnderlinedNameConversion

DefaultNameConversion 数据库名和java属性名保持一致，如数据库表User，对应Java类也是User，数据

库列是sysytemId,则java属性也是systemId，反之亦然

UnderlinedNameConversion 将数据库下划线去掉，首字母大写，如数据库是SYS_USER（oralce数据库的

表和属性总是大写的), 则会改成SysUser

JPA2NameConversion 支持JPA方式的映射，适合不能用确定的映射关系(2.7.4以前采用

JPANameConversion过于简单，已经不用了)

自定义命名转化，如果以上3个都不合适,可以自己实现一个命名转化。实现DefaultNameConversion实现

方式

因为数据库表和列都忽略大小写区别，所以，实现NameConversion也不需要考虑大小写

一般来讲，都建议数据库以下划线来区分单词，因此，使用UnderlinedNameConversion是个很好的选择

public class DefaultNameConversion extends NameConversion {

@Override

public String getTableName(Class<?> c) {

Table table = (Table)c.getAnnotation(Table.class);

if(table!=null){

return table.name();

}

return c.getSimpleName();

}

@Override

public String getColName(Class<?> c, String attrName) {

return attrName;

}

@Override

public String getPropertyName(Class<?> c, String colName) {

return colName;

}

如果有特殊的表并不符合DefaultNameConversion实现方式，你可以重新实现上面的三个方法

在使用org.beetl.sql.core.JPA2NameConversion作为命令转化规则时，你可以使用以下JPA标签来帮助解析实体

类到数据库的转换:

javax.persistence.Table

javax.persistence.Column

javax.persistence.Transient

规则如下： 1 在类名前使用Table注解映射的表名，例如：@Table(name = "PF_TEST")，表示映射的表名是

PF_TEST； 2 忽略静态变量以及被@Transient注解的属性； 3 默认属性名与库表的字段名保持一致，如果不一

剩余61页未读，继续阅读

ly2008886

粉丝: 0
资源: 6

BeetlSQL 2.10中文文档：高效全功能DAO工具

BeetlSQL 2.10中文文档

beetl中文离线文档.html

beetlSql持久层框架

beetlsql一对多

beetlsql+markdown+执行+ddl

若依框架使用beetlsql

beetlsql框架

对beetl 做运行时编译，byte 输出

用springboot+beetl生成一套根据entity实体类生成的controller,service,mapper的代码模板

beetl调用jeesite4.0 的动态方法

java 非spring集成enjoy模板引擎

beetl2官方文档

Could not find beetl-core:beetl-core:3.15.3.RELEASE.

spring blade

idea关于beetl插件

springboot+mybatis+beetl

kingbase group_concat

java 集成enjoy模板引擎

beetl调用jeesite4.0 的静态方法

jeecgboot完整版源码

最新资源