BeetlSQL 2.10中文文档

### BeetlSQL 2.10 特点与功能详解 #### 一、BeetlSQL的特点 BeetSql是一个全面而强大的DAO工具，它融合了Hibernate与Mybatis的优点，特别适合那些认为SQL语言处于核心地位，同时也希望利用工具自动生成大量常用SQL的应用程序。 - **开发效率**: 使用BeetSql时，开发者无需手动添加复杂的注解，框架会自动应用大量的内置SQL，从而显著提高开发效率。 - **灵活性与易用性**: 支持多种查询和更新方式，包括但不限于自动生成SQL、通过SQL ID进行操作等，使得处理数据库操作更为灵活且易于上手。 - **高性能**: 由于其设计的核心理念是以SQL为中心，因此在性能方面相比传统的ORM框架有着明显的优势。 - **社区支持**: 拥有活跃的社区支持，如官方网站(ibeetl.com)及多个交流群组(QQ群)，便于用户获取帮助和支持。 #### 二、五分钟快速入门 ##### 2.1 安装 BeetSql的安装非常简单，可以通过Maven或Gradle等构建工具轻松集成到项目中。 ##### 2.2 准备工作 在开始使用之前，确保已经配置好数据库连接，并导入了BeetSql的相关依赖。 ##### 2.3 代码示例 下面是一个简单的查询示例： ```java // 获取SQLManager实例 SqlManager sqlManager = SqlManager.create(config); // 执行查询 List<User> users = sqlManager.getMapper(UserMapper.class).findAll(); ``` ##### 2.4 SQL文件示例 BeetSql支持将SQL语句存储在外部文件中，例如`.md`文件，便于管理和维护。 ```markdown # 用户查询 ## 查询所有用户 select * from t_user; ``` ##### 2.5 代码与SQL生成 BeetSql提供了丰富的API来生成SQL语句，同时还支持自动生成POJO类和SQL片段，极大地提高了开发效率。 #### 三、BeetlSQL使用说明 ##### 3.1 获得SQLManager `SqlManager`是BeetSql的核心组件之一，用于管理SQL执行上下文。 ##### 3.2 查询API - **简单查询(自动生成SQL)**: 对于简单的查询操作，BeetSql能够自动根据实体类生成SQL。 - **单表查询**: 提供了专门的API来执行单表查询。 - **Template查询**: 允许通过模板字符串来构造SQL。 - **通过SQL ID查询**: 如果SQL语句存储在外部文件中，可以通过SQL ID来执行相应的查询。 - **指定范围查询**: 支持分页查询和其他类型的范围查询。 ##### 3.3 翻页查询API BeetSql提供了便捷的翻页查询功能，支持各种常见的分页场景。 ##### 3.4 更新API - **自动生成SQL**: 对于简单的更新操作，BeetSql能够自动根据实体类生成SQL。 - **通过SQL ID更新(删除)**: 可以通过SQL ID来执行更新或删除操作。 ##### 3.5 直接执行SQL模板 - **直接执行SQL模板语句**: 支持直接执行存储在模板中的SQL语句。 - **直接执行JDBC SQL语句**: 允许直接执行原始的JDBC SQL语句，增强了灵活性。 ##### 3.6 其他功能 - **强制使用主/从库**: 在有主从复制的环境中，可以指定SQL执行的具体数据库。 - **生成POJO代码和SQL片段**: Beetsql提供了一种机制来自动生成POJO类和SQL片段，加快了开发速度。 - **悲观锁(lock)**: 支持悲观锁机制，确保数据的一致性和完整性。 #### 四、命名转换与表列映射 BeetSql提供了强大的命名转换功能，可以自定义表名和字段名之间的映射规则，简化了实体类与数据库表之间的映射关系。 #### 五、复合主键 对于拥有复合主键的表，BeetSql也提供了相应的解决方案，使得处理复合主键变得更加容易。 #### 六、使用MAPPER 通过定义Mapper接口，可以更加优雅地处理数据库操作。BeetSql支持内置的CRUD操作，并允许自定义复杂查询。 - **内置CRUD**: 提供了通用的增删改查操作，简化了日常的数据库交互。 - **SQLID查询**: 可以通过SQL ID执行特定的SQL查询。 - **PAGEQUERY查询**: 支持更复杂的分页查询操作。 - **更新语句**: 包括插入、更新和删除等操作。 - **使用JDBCSQL**: 允许直接使用JDBC SQL语句。 #### 七、BeetlSQL注解 BeetSql还支持一系列注解来增强实体类的功能，例如： - `@AUTOID`: 自动为字段分配ID。 - `@TAIL`: 指定字段的后缀。 - `@IGNORE`: 忽略某些字段不参与映射。 - `@ENUMMAPPING`: 枚举类型映射。 - `@TABLE`: 表明实体类对应的数据库表。 - `@TABLETEMPLATE`: 定义表名模板。 - `@VERSION`: 版本控制。 #### 八、BeetlSQL数据模型 BeetSql的数据模型设计简洁高效，易于理解和使用。 #### 九、Markdown方式管理 BeetSql支持使用Markdown文件来管理SQL语句，使得SQL脚本更加易于阅读和维护。 #### 十、SQL注释 BeetSql支持在SQL语句中添加注释，方便后期维护和理解。 #### 十一、配置BeetSql BeetSql提供了丰富的配置选项，以满足不同应用场景的需求，如开发模式与生产模式的区别、名称转换策略等。 - **开发模式与生产模式**: 可以根据不同的部署环境调整配置。 - **NAMECONVERSION**: 名称转换规则。 - **模板字符集**: 指定模板使用的字符集。 - **翻页起始参数**: 设置翻页查询的起始参数。 - **自定义方法和标签函数**: 扩展BeetSql的功能。 - **ISEMPTY和ISNOTEMPTY**: 判断变量是否为空。 #### 十二、SQL模板基于Beetl实现 BeetSql的SQL模板采用了Beetl引擎，提供了丰富的模板语法，如变量、算术表达式、控制语句等。 #### 十三、Beetl入门 BeetSql采用了Beetl模板引擎，以下是一些基本的Beetl概念： - **定界符号**: 定义模板的特殊字符。 - **变量**: 如何定义和使用变量。 - **算数表达式**: 支持基本的数学运算。 - **逻辑表达式**: 支持条件判断。 - **控制语句**: 支持if、for等控制结构。 - **访问变量属性**: 访问对象的属性。 - **判断对象非空**: 判断对象是否存在。 - **调用方法**: 调用对象的方法。 - **自定义方法**: 定义自己的模板方法。 - **内置方法**: Beetsql提供的内置方法。 - **标签功能**: 支持自定义标签。 #### 十四、DEBUG功能 BeetSql提供了调试功能，帮助开发者更好地定位问题。 #### 十五、缓存功能 为了提高性能，BeetSql支持缓存机制，可以有效地减少对数据库的访问次数。 #### 十六、INTERCEPTOR功能 BeetSql支持拦截器，可以用来扩展框架的功能，如日志记录、性能监控等。 #### 十七、内置支持主从数据库 BeetSql原生支持主从数据库架构，可以在多服务器环境中实现读写分离。 #### 十八、SHARDING-JDBC支持 BeetSql与Sharding-JDBC等分布式数据库中间件兼容良好，支持水平分片等特性。 #### 十九、跨数据库平台 BeetSql支持多种数据库平台，如MySQL、Oracle等，使得移植成本大大降低。 #### 二十、代码生成 BeetSql提供了一套完善的代码生成工具，可以自动生成POJO类和SQL脚本。 - **生成POJO和MD文件**: 自动生成实体类和SQL脚本。 - **生成更多的代码**: 除了基础的实体类外，还可以生成其他的辅助代码。 #### 二十一、直接使用SQLRESULT 可以直接使用SQLRESULT对象来处理查询结果。 #### 二十二、BeetlSQL与其他框架的对比 BeetSql在很多方面都优于传统的ORM框架，尤其是在性能和灵活性方面。 #### 二十三、ORM BeetSql支持ORM查询，可以方便地进行对象关系映射。 - **SQL语句里的ORM查询**: 在SQL语句中直接使用ORM语法。 - **ORM注解**: 通过注解来增强实体类的功能。 #### 二十四、集成与DEMO BeetSql可以轻松地集成到Spring、Spring Boot等框架中。 - **SPRING集成和DEMO**: 如何在Spring项目中使用BeetSql。 - **SPRINGBOOT集成**: Spring Boot项目的集成指南。 - **SPRINGBOOT集成多数据源**: 多数据源的配置示例。 - **JFINAL集成和DEMO**: JFinal框架下的集成示例。 #### 二十五、高级部分 BeetSql还提供了许多高级特性，如事务管理、自定义Bean处理器等。 - **QUERY对象**: 高级查询API。 - **RESULTSET结果集到BEAN的转化**: 将结果集转化为Java对象。 - **RESULTSET结果集到MAP的转化**: 将结果集转化为Map对象。 - **PREPAREDSTATEMENT**: 使用PreparedStatement执行SQL。 - **自定义BEANPROCESSOR**: 定制化的对象处理逻辑。 - **事务管理**: 事务的开启与回滚。 - **设置自己的BASEMAPPER**: 定义基类Mapper。 - **性能测试**: 性能评估工具。 - **内置SQL语句生成**: 自动生成SQL语句。 BeetSql是一款功能强大、易于使用的DAO工具，它不仅融合了Hibernate与Mybatis的优点，还针对实际应用场景进行了优化，非常适合追求高性能和高开发效率的项目使用。