# xbatis

> 一款好用的 ORM 框架！

基于 mybatis 扩展的ORM框架，超方便、学习成本低、优雅的API、方便扩展、功能强大！！！

## Table of Contents

### 简介

- [xbatis 是什么](/zh-CN/intro/whatIs.md)
- [十大亮点：](/zh-CN/intro/highLights.md)
- [Xbatis 和同类框架「功能」对比](/zh-CN/intro/comparison.md)
- [快速开始](/zh-CN/start/quickstart.md)
- [快速开始](/zh-CN/start/springboot2-start.md)
- [快速开始](/zh-CN/start/springboot3-start.md)
- [快速开始](/zh-CN/start/springboot4-start.md)
- [solon 是什么？](/zh-CN/start/solon-start.md)
- [启动时安全检查](/zh-CN/intro/safeTypeCheck.md)
- [DDL 自动化（DDL自动化（自动建表、索引、列新增、序列））](/zh-CN/function/core/ddlAuto.md)
- [如何配置xbatis启动配置 和 全局配置](/zh-CN/intro/howConfigStartup.md)
- [如何与其他mybatis ORM框架共存，例如 MP（mybatis-plus）、Mybatis-Flex](/zh-CN/intro/mybatis-xx-coexist.md)
- [xbatis 支持的数据库类型](/zh-CN/intro/db-support.md)
- [交流群](/zh-CN/intro/contactUs.md)
- [常见问题](/zh-CN/commonProblem.md)
- [单个Mapper模式](/zh-CN/intro/singleMapper.md)
- [新增/批量新增，重复时忽略或修改](/zh-CN/intro/saveIgnoreOrUpdate.md)
- [数据库分表](/zh-CN/function/core/tableSplit.md)
- [如何自定义自己的Pager类](/zh-CN/function/core/customizePager.md)
- [原生sql操作](/zh-CN/function/core/nativeSQL.md)
- [Mapper方法拦截器](/zh-CN/function/core/methodInterceptor.md)
- [Untitled](/zh-CN/function/annotation/annotation.md)
- [Xbatis AI Agent 知识库](/zh-CN/install/ai-help.md)
- [内置的 TypeHandler类](/zh-CN/function/core/typeHandler.md)
- [xbatis 日志设置](/zh-CN/intro/logSetting.md)

### 常规说明

- [忽略null值，忽略空字符串，自动对字符串trim操作](/zh-CN/intro/conditionIgnore.md)
- [MVC 说明](/zh-CN/intro/mvc.md)
- [枚举类支持](/zh-CN/intro/enum.md)
- [SQL自动优化](/zh-CN/intro/sql-optimize.md)
- [省力写法-必看](/zh-CN/intro/fast-dev.md)

### 基础功能

- [新增(save)](/zh-CN/function/base/save.md)
- [修改(update)](/zh-CN/function/base/update.md)
- [删除(delete)](/zh-CN/function/base/delete.md)

### 基础查询

- [查询(query)](/zh-CN/function/base/get-query.md)
- [查询(query)](/zh-CN/function/base/list-query.md)
- [count查询(query count)](/zh-CN/function/base/count-query.md)
- [分页查询](/zh-CN/function/base/page-query.md)
- [联表查询](/zh-CN/function/base/join-query.md)
- [exists查询(query exists)](/zh-CN/function/base/exists-query.md)
- [游标cursor查询(query cursor)](/zh-CN/function/base/cursor-query.md)
- [mapWithKey(query)](/zh-CN/function/base/mapWithKey-query.md)

### 复杂例子

- [复杂的join 例子](/zh-CN/demo/join.md)
- [Untitled](/zh-CN/demo/other-hard.md)
- [动态select/where/group by/order by/列组合](/zh-CN/demo/dynamic.md)

### 核心功能

- [QueryChain - 链路查询](/zh-CN/function/core/QueryChain.md)
- [数据库函数](/zh-CN/function/core/db-methods.md)
- [SQL模板](/zh-CN/function/core/sql-template.md)
- [@Paging XML分页注解](/zh-CN/function/annotation/paging.md)
- [逻辑删除](/zh-CN/function/core/logicDelete.md)
- [多租户](/zh-CN/function/core/tenant.md)
- [乐观锁](/zh-CN/function/core/version.md)
- [xbatis 动态值](/zh-CN/function/core/dynamicValue.md)
- [批量操作](/zh-CN/function/core/batchOpt.md)
- [xml + 动态where](/zh-CN/function/core/xml_Where.md)
- [xml + 动态query](/zh-CN/function/core/xml_Query.md)
- [代码生成器](/zh-CN/function/core/codeAutoCreate.md)
- [动态数据源](/zh-CN/function/core/routingDatasource.md)
- [同时支持不同数据库](/zh-CN/function/core/supportMutiDb.md)
- [对象转条件，动态对象条件](/zh-CN/function/core/objToCondition.md)
- [对象转排序，动态对象排序](/zh-CN/function/core/objToOrderBy.md)

### 实体类注解

- [@Table 注解](/zh-CN/function/annotation/table.md)
- [@TableId 注解](/zh-CN/function/annotation/tableId.md)
- [@TableField 注解](/zh-CN/function/annotation/tableField.md)

### 实体类扩展注解

- [ForeignKey 外键注解（已不推荐，现有更好的方式表达JOIN）](/zh-CN/function/annotation/foreignKey.md)
- [@LogicDelete 逻辑删除注解](/zh-CN/function/annotation/logicDelete.md)
- [TenantId 多租户注解](/zh-CN/function/annotation/tenantId.md)
- [Version 乐观锁注解](/zh-CN/function/annotation/version.md)
- [OnInsert 注解](/zh-CN/function/annotation/OnInsert.md)
- [OnUpdate 注解](/zh-CN/function/annotation/OnUpdate.md)

### Model类注解

- [@ModelEntityField 注解 Model字段与实体类映射 - 字段映射](/zh-CN/function/annotation/modelEntityField.md)

### VO映射注解

- [ResultEntity 注解 VO映射](/zh-CN/function/annotation/resultEntity.md)
- [ResultEntityField 注解 VO映射 - 字段映射](/zh-CN/function/annotation/resultEntityField.md)
- [NestedResultEntity 注解 VO映射 - 内嵌类映射](/zh-CN/function/annotation/nestedResultEntity.md)
- [NestedResultEntityField 注解 VO映射 - 内嵌类字段映射](/zh-CN/function/annotation/nestedResultEntityField.md)
- [@ResultField - 列映射](/zh-CN/function/annotation/resultField.md)
- [ResultCalcField 注解 VO映射 - 字段映射](/zh-CN/function/annotation/resultCalcField.md)

### VO类/属性干预注解

- [PutEnumValue 注解 VO注入枚举值](/zh-CN/function/annotation/putEnumValue.md)
- [PutValue 注解 VO注入动态值](/zh-CN/function/annotation/putValue.md)
- [CreatedEvent 注解 VO创建后的事件](/zh-CN/function/annotation/createdEvent.md)

### 其他注解

- [Ignore 忽略注解](/zh-CN/function/annotation/ignore.md)
- [Ignores 忽略注解](/zh-CN/function/annotation/ignores.md)
- [@Fetch - 轮询拉取数据注解](/zh-CN/function/annotation/fetch.md)
- [TypeHandler 数据包装注解](/zh-CN/function/annotation/typeHandler.md)
- [@Paging XML分页注解](/zh-CN/function/annotation/paging.md)

### 其他

- [xbatis 配置](/zh-CN/function/xbatis-conf.md)

### Other

- [SQL 审计](/zh-CN/function/core/audit.md)
- [Untitled](/zh-CN/function/core/where-methods.md)
- [Untitled](/zh-CN/install/java-demo-code.md)
- [Untitled](/zh-CN/install/jdbc-conf.md)
- [Untitled](/zh-CN/install/springboot2-maven.md)
- [Untitled](/zh-CN/install/jdbc-maven.md)
- [Untitled](/zh-CN/install/springboot3-maven.md)
- [Untitled](/zh-CN/install/springboot4-maven.md)
- [Xbatis ORM 框架 Skill 文档](/xbatis-skill.md)
- [xml resultMap 动态继承官方配置](/zh-CN/intro/resultMapExtend.md)
- [开源作品案例](/zh-CN/intro/projects.md)
- [支持开源](/zh-CN/sponsor.md)
- [更新日志](/zh-CN/intro/changeList.md)