xbatis

https://xbatis.cn/zh-CN/
Admin
xbatis is a lightweight ORM framework based on MyBatis for Java applications, featuring chainable...
Tokens:67,278
Snippets:685
Trust Score:0
Update:1 month ago
Show doc for...
Tokens:
Raw
### SQL Query Example

Source: https://xbatis.cn/zh-CN/function/core/QueryChain.html

Example of a complex SQL query structure.

```sql
    select t.id from sys_user t where (t.id=1 and t.id=2) or (t.id=3 and t.id=4) or id=3;
```

--------------------------------

### 使用 get 进行动态条件查询

Source: https://xbatis.cn/zh-CN/function/base/get-query.html

通过 Lambda 表达式构建动态 Where 条件进行单条记录查询。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;
    
    public void getById() {
       SysUser sysUser= sysUserMapper.get(where->{
           where.eq(SysUser::getId,1);
       });
    }
}
```

--------------------------------

### Apply @Table Annotation

Source: https://xbatis.cn/zh-CN/install/ai-help.html

Example of using the @Table annotation to configure database case rules.

```java
@Table(databaseCaseRule = DatabaseCaseRule.UPPERCASE)
public class SysUser { }
```

--------------------------------

### MybatisMapper CRUD Operations

Source: https://xbatis.cn/zh-CN/install/ai-help.html

The MybatisMapper interface provides standard CRUD operations including get, list, save, update, and delete, supporting Lambda-based query building.

```APIDOC
## MybatisMapper<T>

### Description
Provides generic CRUD capabilities for entities. Supports single-mapper patterns and chain-based DSL for complex queries and updates.

### Methods
- **Query**: get, list, listAll, listByIds, cursor, exists, count, mapWithKey, page
- **Insert**: save, saveOrUpdate, saveBatch, saveModel, saveModelBatch
- **Update**: update, updateBatch, update(model, where), update(list, forceFields)
- **Delete**: deleteById, deleteByIds, delete(entity), delete(where), deleteAll

### Usage Example
```java
// Chain-based DSL usage
QueryChain.of(mybatisBasicMapper, SysUser.class)
        .eq(SysUser::getId, 1)
        .list();

UpdateChain.of(mybatisBasicMapper, SysUser.class)
        .set(SysUser::getUserName, "basic")
        .eq(SysUser::getId, 1)
        .execute();
```
```

--------------------------------

### 配置 Spring Boot 3 Maven 依赖

Source: https://xbatis.cn/zh-CN/install/ai-help.html

在 pom.xml 中引入 xbatis-spring-boot3-starter 及其父依赖。

```xml
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>cn.xbatis</groupId>
      <artifactId>xbatis-spring-boot-parent</artifactId>
      <version>1.10.8</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>cn.xbatis</groupId>
    <artifactId>xbatis-spring-boot3-starter</artifactId>
  </dependency>
</dependencies>
```

--------------------------------

### 实现 get 方法

Source: https://xbatis.cn/zh-CN/function/core/customizePager.html

在 Pager 类中实现 get 方法以获取分页元数据，如页码和每页条数。

```java
public class Pager<T> implements IPager<T> {

    @Override
    public <V> void set(PagerField<V> field, V value) {
        if (PagerField.TOTAL == field) {
            //设置总条数
            this.setTotal((Integer) value);
            return;
        }
        if (PagerField.RESULTS == field) {
            //设置List结果
            this.setResults((List) value);
            return;
        }
        throw new RuntimeException("not support field: " + field);
    }
    
    @Override
    public <V> V get(PagerField<V> field) {
        if (PagerField.IS_EXECUTE_COUNT == field) {
            //返回是否执行count查询 ,isExecuteCount改成你自己的方法或字段
            return (V) this.isExecuteCount();
        }
        if (PagerField.NUMBER == field) {
            //返回页码 ,getNumber改成你自己的方法或字段
            return (V) this.getNumber();
        }
        if (PagerField.SIZE == field) {
            //返回每页条数 ,getSize改成你自己的方法或字段
            return (V) this.getSize();
        }
        throw new RuntimeException("not support field: " + field);
    }
}
```

--------------------------------

### 配置 Maven 依赖

Source: https://xbatis.cn/zh-CN/start/springboot2-start.html

在 pom.xml 中引入 xbatis-spring-boot-parent 和 xbatis-spring-boot-starter 依赖。

```xml
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>cn.xbatis</groupId>
            <artifactId>xbatis-spring-boot-parent</artifactId>
            <version>1.10.8</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>cn.xbatis</groupId>
        <artifactId>xbatis-spring-boot-starter</artifactId>
    </dependency>
</dependencies>
```

--------------------------------

### 配置 Spring Boot 2 Maven 依赖

Source: https://xbatis.cn/zh-CN/install/ai-help.html

在 Spring Boot 2 环境下使用 xbatis-spring-boot-starter 依赖。

```xml
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>cn.xbatis</groupId>
      <artifactId>xbatis-spring-boot-parent</artifactId>
      <version>1.10.8</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>cn.xbatis</groupId>
    <artifactId>xbatis-spring-boot-starter</artifactId>
  </dependency>
</dependencies>
```

--------------------------------

### 配置 Maven 镜像

Source: https://xbatis.cn/zh-CN/commonProblem.html

在 settings.xml 中添加华为或腾讯镜像以解决 Maven 下载失败的问题。

```xml
<mirrors>
    <mirror>
        <id>HW</id>
        <mirrorOf>central</mirrorOf>
        <url>https://repo.huaweicloud.com/repository/maven/</url>
    </mirror>
    <mirror>
        <id>TX</id>
        <mirrorOf>central</mirrorOf>
        <url>https://mirrors.cloud.tencent.com/nexus/repository/maven-public/</url>
    </mirror>
</mirrors>
```

--------------------------------

### Configure ColumnConfig

Source: https://xbatis.cn/zh-CN/function/core/codeAutoCreate.html

Initializes column-level configurations within the generator setup.

```java
new GeneratorConfig(...).columnConfig(columnConfig->{

        });
```

--------------------------------

### 配置 Spring Boot 3 Maven 依赖

Source: https://xbatis.cn/zh-CN/start/quickstart.html

在 Spring Boot 3 项目中引入 xbatis-spring-boot-starter 及其对应的 Spring Boot 3 版本父依赖。

```xml
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>cn.xbatis</groupId>
            <artifactId>xbatis-spring-boot-parent</artifactId>
            <version>1.10.8-spring-boot3</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>cn.xbatis</groupId>
        <artifactId>xbatis-spring-boot-starter</artifactId>
    </dependency>
</dependencies>
```

--------------------------------

### 配置全局更新监听器

Source: https://xbatis.cn/zh-CN/function/annotation/OnUpdate.html

在项目启动时通过 XbatisGlobalConfig 设置全局的更新监听逻辑。

```java
XbatisGlobalConfig.setGlobalOnUpdateListener(o ->
    //处理业务逻辑
);
```

--------------------------------

### 自定义动态值配置

Source: https://xbatis.cn/zh-CN/function/core/dynamicValue.html

通过实现 ConfigurationCustomizer 并在项目启动时注册自定义动态值逻辑。需注意处理不同字段类型以避免类型不一致异常。

```java
@Configuration
public class XbatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return (configuration) -> {
            XbatisGlobalConfig.setDynamicValue("{KEY}", (clazz,type) -> {
                if (type == LocalDateTime.class) {
                    return LocalDateTime.now();
                } else if (type == LocalDate.class) {
                    return LocalDate.now();
                } else if (type == Date.class) {
                    return new Date();
                } else if (type == Long.class) {
                    return System.currentTimeMillis();
                } else if (type == Integer.class) {
                    return (int) (System.currentTimeMillis() / 1000);
                }
                throw new RuntimeException("Inconsistent types");
            });
        }
    }
}
```

--------------------------------

### 配置 application.yml

Source: https://xbatis.cn/zh-CN/start/springboot2-start.html

在 application.yml 文件中设置数据库连接信息。

```yaml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dbName
    username: dbusername
    password: dbpassword
```

--------------------------------

### 配置全局插入监听器

Source: https://xbatis.cn/zh-CN/function/annotation/OnInsert.html

在项目启动时通过 XbatisGlobalConfig 设置全局插入监听逻辑。

```java
XbatisGlobalConfig.setGlobalOnInsertListener(o ->
    //处理业务逻辑
);
```

--------------------------------

### 配置 JDBC 与连接池依赖

Source: https://xbatis.cn/zh-CN/start/springboot2-start.html

添加 MySQL 驱动和 HikariCP 连接池依赖以支持数据库连接。

```xml
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
</dependency>

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
</dependency>
```

--------------------------------

### 配置 P6Spy SQL 分析

Source: https://xbatis.cn/zh-CN/function/core/routingDatasource.html

通过 YAML 启用 P6Spy 并添加 Maven 依赖。

```yaml
spring:
  ds:
    p6spy: false
```

```xml
<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>
```

--------------------------------

### 基于实体类更新

Source: https://xbatis.cn/zh-CN/function/base/update.html

使用完整的实体类对象进行更新操作。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;
    
    public void update() {
        SysUser sysUser = new SysUser();
        sysUser.setId(1);
        sysUser.setUserName("demo");
        sysUserMapper.update(sysUser);
    }
}
```

--------------------------------

### 配置XbatisConfig的ConfigurationCustomizer Bean

Source: https://xbatis.cn/zh-CN/intro/howConfigStartup.html

推荐的启动配置方式，通过实现ConfigurationCustomizer接口自定义全局配置。

```java
@Configuration
public class XbatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return (configuration) -> {
            //启动配置都写在这
            ....
            //例如 XbatisGlobalConfig.setXXXX(xxx)
        };
    }
}
```

--------------------------------

### 配置 Service 实现类生成

Source: https://xbatis.cn/zh-CN/function/core/codeAutoCreate.html

通过 serviceImplConfig 方法配置 Service 实现类的注入选项及包名后缀。

```java
new GeneratorConfig(...).serviceImplConfig(serviceImplConfig->{
        serviceImplConfig.injectDao(true);
});
```

--------------------------------

### 配置全局更新监听器

Source: https://xbatis.cn/zh-CN/intro/howConfigStartup.html

设置全局更新操作的监听器以处理业务逻辑。

```java
@Configuration
public class XbatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return (configuration) -> {
            XbatisGlobalConfig.setGlobalOnUpdateListener(o ->{
                    //处理业务逻辑
            });
        };
    }
}
```

--------------------------------

### 配置逻辑删除局部开关

Source: https://xbatis.cn/zh-CN/function/core/logicDelete.html

通过 try-with-resources 或工具类在局部范围内控制逻辑删除的启用与禁用。

```java
try (LogicDeleteSwitch ignored = LogicDeleteSwitch.with(false)) {
    logicDeleteTestMapper.getById(1);
}
```

```java
LogicDeleteTest logicDeleteTest = LogicDeleteUtil.execute(false, () -> {
    return logicDeleteTestMapper.getById(1);
});
```

--------------------------------

### 配置 DaoImplConfig

Source: https://xbatis.cn/zh-CN/function/core/codeAutoCreate.html

设置 Dao 实现类的生成选项，包括父类继承及包名定义。

```java
new GeneratorConfig(...).daoImplConfig(daoImplConfig->{
        daoImplConfig.enable(true);
});
```

--------------------------------

### Configure Maven Dependencies for XBatis

Source: https://xbatis.cn/zh-CN/start/springboot4-start.html

Add the XBatis parent and starter dependencies to your project's pom.xml file.

```xml
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>cn.xbatis</groupId>
            <artifactId>xbatis-spring-boot-parent</artifactId>
            <version>1.10.8-spring-boot4</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>cn.xbatis</groupId>
        <artifactId>xbatis-spring-boot-starter</artifactId>
    </dependency>
</dependencies>
```

--------------------------------

### 引入 Maven 依赖

Source: https://xbatis.cn/zh-CN/function/core/ddlAuto.html

在项目中添加 xbatis-ddl-auto 依赖以启用 DDL 自动化功能。

```xml
<dependency>
    <groupId>cn.xbatis</groupId>
    <artifactId>xbatis-ddl-auto</artifactId>
    <version>1.0.2</version>
</dependency>
```

--------------------------------

### 执行查询并触发自动注入

Source: https://xbatis.cn/zh-CN/function/annotation/putValue.html

在 Service 层使用 QueryChain 进行查询，框架会自动根据配置注入对应的枚举名称。

```java
@Service
public class Test{

    @Autowired
    private SysUserMapper sysUserMapper;

    public void demo() {
        Pager<SysUserVo> pager = QueryChain.of(sysUserMapper)
                .eq(SysUser::getId,1)
                .like(SysUser::getUserName,"xxx")
                .returnType(SysUserVo.class)
                .paging(Pager.of(1,10));
    }
}
```

--------------------------------

### 实现Dao层

Source: https://xbatis.cn/zh-CN/intro/singleMapper.html

使用BasicDaoImpl实现Dao层，并注入MybatisBasicMapper。

```java
@Repository
public class SysRoleDaoImpl extends BasicDaoImpl<SysRole, Integer> implements SysRoleDao {

    @Autowired
    public SysRoleDaoImpl(MybatisBasicMapper mybatisBasicMapper) {
        super(mybatisBasicMapper);
    }

    @Override
    protected MybatisBasicMapper getMapper() {
        return (MybatisBasicMapper) this.mapper;
    }

}
```

--------------------------------

### 解决 Spring Boot 版本冲突

Source: https://xbatis.cn/zh-CN/commonProblem.html

在 pom.xml 的 dependencyManagement 中显式配置 spring-boot-dependencies 版本以解决冲突。

```xml
<dependencyManagement>
    <dependencies>
        <!-- 最好在最前面 加 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.7.18</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
```

--------------------------------

### 配置 SQL 优化选项

Source: https://xbatis.cn/zh-CN/intro/sql-optimize.html

通过 optimizeOptions 方法配置 join、count 和 order by 的优化策略，支持针对特定表禁用或全局禁用优化。

```java
Pager<SysUser> pager=QueryChain.of(sysUserMapper)
    .like(SysUser::getUserName,'abc')
    //方式1：指定某个表join是否优化    
    .optimizeOptions(optimizeOptions -> optimizeOptions.disableOptimizeJoin(SysRole.class))
    //方式2：指定部位是否优化    
    .optimizeOptions(optimizeOptions -> optimizeOptions.optimizeJoin(false).optimizeOptions.optimizeCount(false).optimizeOrderBy(false))
    //方式3：全部禁止    
    .optimizeOptions(optimizeOptions -> optimizeOptions.disableAll())
    .paging(Pager.of(1));
```

--------------------------------

### 配置连接池属性

Source: https://xbatis.cn/zh-CN/function/core/routingDatasource.html

针对 Hikari、Druid 或其他数据源，在对应节点下添加连接池特有配置。

```yaml
spring:
  ds:
    primary: master
    routing:
      master:
        username: root
        password: 123456
        url: jdbc:h2:mem:druidDB;INIT=RUNSCRIPT FROM 'classpath:h2-schema.sql' 
        hikari:
          minimum-idle: 1
          maximum-pool-size: 10  
          ... 其他配置
```

```yaml
spring:
  ds:
    primary: master
    routing:
      master:
        username: root
        password: 123456
        url: jdbc:h2:mem:druidDB;INIT=RUNSCRIPT FROM 'classpath:h2-schema.sql' 
        druid:
          initial-size: 1
          max-active: 10
          ... 其他配置
```

```yaml
spring:
  ds:
    primary: master
    routing:
      master:
        username: root
        password: 123456
        url: jdbc:h2:mem:druidDB;INIT=RUNSCRIPT FROM 'classpath:h2-schema.sql' 
        other:
          initial-size: 1
          max-active: 10
          ... 其他配置
```

```yaml
spring:
  datasource:
    dbcp2:
      connection-init-sqls: select 1
```

```yaml
spring:
  ds:
    routing:
        other:
          connection-init-sqls: select 1
```

--------------------------------

### 基于 Model 类更新

Source: https://xbatis.cn/zh-CN/function/base/update.html

使用 Model 类对象进行更新，仅修改模型中定义的字段。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;
    
    public void update() {
        SysUserModel sysUser = new SysUserModel();
        sysUser.setId(1);
        sysUser.setUserName("demo");
        sysUserMapper.update(sysUser);
    }
}
```

--------------------------------

### 全局插入监听器配置

Source: https://xbatis.cn/zh-CN/function/annotation/OnInsert.html

在项目启动时配置全局插入监听器，对所有插入操作生效。

```APIDOC
## 全局插入监听器

### 描述
通过 XbatisGlobalConfig 设置全局监听器，在项目启动时进行配置。

### 示例
```java
XbatisGlobalConfig.setGlobalOnInsertListener(o ->
    //处理业务逻辑
);
```
```

--------------------------------

### Configure Solon YAML for Data Sources and Mappers

Source: https://xbatis.cn/zh-CN/start/solon-start.html

Define your database connection settings and mapper scanning rules in the application.yml file.

```yaml
# 配置数据源
ds:
  # 与数据库名可用保持一致
  schema: rock
  jdbcUrl: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&autoReconnect=true&rewriteBatchedStatements=true
  driverClassName: com.mysql.cj.jdbc.Driver
  username: root
  password: 123456

# 规则 mybatis.数据源名称;数据源名称 是 数据源 Bean的名称
mybatis.master:
  mappers:       #支持包名 或 类名（大写开头 或 *）或 xml（.xml结尾）；支持目录 ** 或 * 占位符
    - "test.UserMapper"
    - "demo4021.**.mapper"
    - "demo4021.**.mapper.*" #这个表达式同上效果
    - "classpath:demo4021/**/mapper.xml"
    - "classpath:demo4021/**/mapping/*.xml"
```

--------------------------------

### 设置逻辑删除拦截器

Source: https://xbatis.cn/zh-CN/function/annotation/logicDelete.html

在项目启动时配置拦截器，以便在执行删除操作时自动填充额外字段。

```java
    //项目启动时设置
    XbatisGlobalConfig.setLogicDeleteInterceptor((entity, update) -> {
        //设置操作人 123
        update.set(update.$(entity, "deleteUserId"), 123);
    });
```

--------------------------------

### 使用 dbAdapt 在 QueryChain 中适配数据库

Source: https://xbatis.cn/zh-CN/function/core/supportMutiDb.html

在链式查询中通过 dbAdapt 根据数据库类型动态拼接查询条件。

```java
SysUser sysUser = QueryChain.of(sysUserMapper)
        .select(SysUser::getId)
        // dbAdapt((query, selector) 可以多次
        .dbAdapt((query, selector) -> {
            selector.when(DbType.H2, (dbType) -> {
                    //H2 拼接 id = 3
                    query.eq(SysUser::getId, 3);
                }).when(DbType.MYSQL, (dbType) -> {
                    //MYSQL 拼接 id = 3
                    query.eq(SysUser::getId, 2);
                }).otherwise((dbType) -> {
                    //其他 拼接 id = 3
                    query.eq(SysUser::getId, 1);
                });
        })
        .get();
```

--------------------------------

### 使用 QueryChain 进行链路查询

Source: https://xbatis.cn/zh-CN/function/base/get-query.html

利用 QueryChain 构建复杂的查询逻辑，适用于更灵活的场景。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void update() {
        SysUser sysUser= QueryChain.of(sysUserMapper)
                .eq(SysUser::getId, 1)
                .get();
    }
}
```

--------------------------------

### 配置 ORM 函数计算字段

Source: https://xbatis.cn/zh-CN/function/annotation/resultCalcField.html

支持使用 ORM 函数进行复杂逻辑计算，方括号内的内容会被解析为对应的 SQL。

```java
@ResultCalcField("[count(if(in(id,1,2,3),NULL(),1))]")
private Integer count1;
```

--------------------------------

### Solon 容器 DDL 自动化配置

Source: https://xbatis.cn/zh-CN/function/core/ddlAuto.html

在 Solon 环境下通过 yml 配置文件进行 DDL 自动化设置。

```yaml
mybatis.db1:
  ddlAuto:
    - entityPackages: com.**
      mode: UPDATE
      makerInterface: com.xx.Mysql
      dbType: MYSQL
      dataSource: xxx
  mappers:
    - "com.**.mapper.TestMapper"
```

--------------------------------

### sysUserMapper.executeAndReturningList

Source: https://xbatis.cn/zh-CN/function/core/nativeSQL.html

执行带有RETURNING子句的更新或删除操作，返回列表。

```APIDOC
## sysUserMapper.executeAndReturningList(Class<T> clazz, String sql, Object... args)

### Description
执行带有RETURNING子句的SQL，返回结果列表。

### Parameters
- **clazz** (Class<T>) - 返回类型
- **sql** (String) - 原生SQL语句
- **args** (Object...) - SQL参数

### Example
```java
List<String> user_names = sysUserMapper.executeAndReturningList(String.class, "update t_sys_user set user_name=? where id in (1,2) RETURNING user_name", "xxx");
```
```

--------------------------------

### 配置数据库函数计算字段

Source: https://xbatis.cn/zh-CN/function/annotation/resultCalcField.html

适用于通用的数据库函数，直接在注解中指定 SQL 片段。

```java
@ResultCalcField("count(1)")
private Integer count1;
```

--------------------------------

### batchSave (with batchSize)

Source: https://xbatis.cn/zh-CN/function/core/batchOpt.html

执行批量插入操作，支持指定批量处理条数。

```APIDOC
## public static <M, T> int batchSave(SqlSessionFactory sqlSessionFactory, Class<M> mapperType, Collection<T> list, int batchSize)

### Description
批量插入数据列表。当 batchSize 设置为 1 时，可以获取主键。

### Parameters
- **sqlSessionFactory** (SqlSessionFactory) - Required - Mybatis SqlSessionFactory 实例
- **mapperType** (Class<M>) - Required - Mapper 的 class 类型
- **list** (Collection<T>) - Required - 待插入的数据列表
- **batchSize** (int) - Required - 一次批量处理的条数

### Returns
- **int** - 影响的条数
```

--------------------------------

### 执行修改或删除

Source: https://xbatis.cn/zh-CN/function/core/nativeSQL.html

使用execute方法执行更新或删除操作，返回受影响行数。

```java
int cnt = sysUserMapper.execute("update t_sys_user set role_id=1 where id=1");
```

--------------------------------

### 使用 @Version 注解标记乐观锁字段

Source: https://xbatis.cn/zh-CN/function/annotation/version.html

在实体类字段上添加 @Version 注解，该字段将自动参与乐观锁控制。

```java
@Data
@Table 
public class SysUser {

    @TableId
    private Integer id;

    private String userName;

    private String password;
    
    private Integer roleId;
    
    @Version
    private Integer version;

    private LocalDateTime createTime;
}
```

--------------------------------

### 实现 SQLAuditing 接口

Source: https://xbatis.cn/zh-CN/function/core/audit.html

实现 SQLAuditing 接口以定义自定义的 SQL 审计逻辑。建议在 auditOperation 方法中采用异步方式处理日志记录。

```java
/**
 * SQL 审计
 */
@Component
public class MySQLAuditing implements SQLAuditing{

    /**
     * SQL 审计操作
     *
     * @param sql         sql
     * @param params      sql 参数
     * @param startTime   开始时间（毫秒）
     * @param endTime     结束时间（毫秒）
     * @param queryCount  查询结果总条数; -1 时 应该是查询
     * @param updateCount 新增/修改/删除影响的总条数；-1时 应该非查询
     */
    public void auditOperation(String sql, List<Object> params, long startTime, long endTime, long queryCount, long updateCount) {
        //建议异步存放
    }
}
```

--------------------------------

### sysUserMapper.executeAndReturning

Source: https://xbatis.cn/zh-CN/function/core/nativeSQL.html

执行带有RETURNING子句的更新或删除操作，返回单个结果。

```APIDOC
## sysUserMapper.executeAndReturning(Class<T> clazz, String sql, Object... args)

### Description
执行带有RETURNING子句的SQL，返回单个结果。

### Parameters
- **clazz** (Class<T>) - 返回类型
- **sql** (String) - 原生SQL语句
- **args** (Object...) - SQL参数

### Example
```java
String user_name = sysUserMapper.executeAndReturning(String.class, "update t_sys_user set user_name=? where id=1 RETURNING user_name", "xxx");
```
```

--------------------------------

### 执行嵌套映射查询

Source: https://xbatis.cn/zh-CN/function/annotation/nestedResultEntity.html

通过 QueryChain 进行查询并指定返回类型为包含嵌套映射的 VO 类。

```java
@Service
public class Test{

    @Autowired
    private SysUserMapper sysUserMapper;

    public void demo() {
        Pager<SysUserVo> pager = QueryChain.of(sysUserMapper)
                .select(SysUserVo.class)
                .eq(SysUser::getId,1)
                .like(SysUser::getUserName,"xxx")
                .returnType(SysUserVo.class)
                .paging(Pager.of(1,10));
    }
}
```

--------------------------------

### 枚举类新增操作

Source: https://xbatis.cn/zh-CN/intro/enum.html

将枚举值设置到实体对象中进行保存。

```java
DefaultValueTestMapper mapper = session.getMapper(DefaultValueTestMapper.class);
DefaultValueTest defaultValueTest = new DefaultValueTest();
defaultValueTest.setValue3(TestEnum.X1);
mapper.save(defaultValueTest);
```

--------------------------------

### CASE WHEN 多条件更新

Source: https://xbatis.cn/zh-CN/function/core/db-methods.html

使用 Methods.conditionChain() 构建包含多个逻辑条件的 CASE WHEN 更新。

```java
UpdateChain.of(sysUserMapper)
        .set(SysUser::getUserName, GetterFields.of(SysUser::getId, SysUser::getUserName), cs -> {
            Case cased = Methods.case_();
            cased.when(Methods.conditionChain().and(cs[0].eq(1)).or(cs[0].eq(2)), 2);
            cased.else_(cs[1]);
            return cased;
        })
        
        .in(SysUser::getId, 1, 2, 3)
        .execute();
```

```sql
    sql:  update sys_user set user_name = case when id=1 or id=2 then 2 else 1 end where id in (1,2,3);
```

--------------------------------

### 根据实体类删除数据

Source: https://xbatis.cn/zh-CN/function/base/delete.html

通过传入实体对象实例来执行删除操作。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;
    
    public void delete() {
        SysUserModel sysUser = sysUserMapper.getById(1);
        sysUserMapper.delete(sysUser);
    }
}
```

--------------------------------

### 配置枚举字段到实体类

Source: https://xbatis.cn/zh-CN/intro/enum.html

在实体类中使用枚举类型字段，xbatis 会自动处理映射。

```java
@Table
@Data
public class DefaultValueTest {

    @TableId
    private Integer id;

    @TableField(defaultValue = "{BLANK}")
    private String value1;

    @TableField(defaultValue = "1", updateDefaultValue = "2")
    private Integer value2;

    @TableField(defaultValue = "{NOW}")
    private LocalDateTime createTime;

    private TestEnum value3;
}
```

--------------------------------

### Configure POJO Checks in Solon

Source: https://xbatis.cn/zh-CN/install/ai-help.html

Set up POJO check parameters within the solon.yml configuration file using the mybatis.master.pojoCheck section.

```yaml
mybatis.master:
  pojoCheck:
    basePackages: com.example.**.pojo
    modelPackages: com.example.**.model
    resultEntityPackages: com.example.**.vo
    conditionTargetPackages: com.example.**.condition
    orderByTargetPackages: com.example.**.orderby
  mappers:
    - "com.example.mapper"
```

--------------------------------

### 配置多个 DDL 扫描

Source: https://xbatis.cn/zh-CN/function/core/ddlAuto.html

在 Spring 环境下支持配置多个 @XbatisDDLAutoScan 注解。

```java
@XbatisDDLAutoScan(entityPackages = "com.xxx.entity")
@XbatisDDLAutoScan(entityPackages = "com.xxx.entity")
```

--------------------------------

### 配置 MyBatis 原生属性

Source: https://xbatis.cn/zh-CN/function/xbatis-conf.html

xbatis 支持标准的 Spring Boot YAML 配置方式。

```yaml
mybatis:
  configuration:
    databaseId: MYSQL
```

--------------------------------

### 配置 Action 控制器生成

Source: https://xbatis.cn/zh-CN/function/core/codeAutoCreate.html

通过 actionConfig 方法配置控制器的生成选项，包括 Swagger 支持及 CRUD 方法的启用。

```java
new GeneratorConfig(...).actionConfig(actionConfig->{
        actionConfig.enable(true);
});
```

--------------------------------

### 单列动态SQL构建

Source: https://xbatis.cn/zh-CN/demo/dynamic.html

演示在select、where、groupBy和orderBy中对单列应用动态函数处理。

```java
List<SysUser> list=QueryChain.of(sysUserMapper)
        .select(SysUser::getName,c -> c.left(4).as(SysUserVo::getFirstName)) //select单列 调用 left(name,4)
        .from(SysUser.class)
        .like(SysUser::getName,"xx")
        .and(SysUser::getName,c -> c.in("admin","admin2")) // where 单列 name in ('admin','admin2')
        .groupBy(SysUser::getName,c->c.left(4)) // group by 单列 调用 left(name,4)
        .orderBy(SysUser::getName,c->c.left(4)) // order by 单列 调用 left(name,4)
        .list();
```

--------------------------------

### 执行代码生成

Source: https://xbatis.cn/zh-CN/function/core/codeAutoCreate.html

在 main 方法中实例化 FastGenerator 并调用 create 方法，支持通过 JDBC 连接或数据源生成。

```java
// 根据数据库链接生成
new FastGenerator(new GeneratorConfig(
        "jdbc:mysql://xxx.xx.x:3306/数据库名字",
        "用户名",
                          "密码")
        .basePackage("com.test")//根包路径
        ).create();

or

//根据数据源生成
new FastGenerator(new GeneratorConfig(
        DbType.H2,//数据库类型
                  dataSource)
        .basePackage("com.test")//根包路径
        ).create();
```

--------------------------------

### 使用QueryChain进行count查询

Source: https://xbatis.cn/zh-CN/function/base/count-query.html

利用QueryChain构建复杂的查询链路并执行count操作。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void count() {
        Integer count= QueryChain.of(sysUserMapper)
                .like(SysUser::getUserName,"abc")
                .count();
    }
}
```

--------------------------------

### 切换 AND 或 OR 逻辑

Source: https://xbatis.cn/zh-CN/function/core/QueryChain.html

展示如何切换查询条件的拼接逻辑，并提供对应的 SQL 示例。

```java
    SysUser sysUser = QueryChain.of(sysUserMapper)
        .select(SysUser::getId)
        .from(SysUser.class)
        .or()
        .eq(SysUser::getId,1)
        .eq(SysUser::getId,2)
        .and()
        .eq(SysUser::getId,3)
        .get();
```

```sql
    select t.id from sys_user t where t.id=1 or t.id=2 and t.id=3
```

--------------------------------

### 配置全局动态值

Source: https://xbatis.cn/zh-CN/intro/howConfigStartup.html

为注解或默认值配置动态生成逻辑，支持多种数据类型。

```java
@Configuration
public class XbatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return (configuration) -> {
            XbatisGlobalConfig.setDynamicValue("{KEY}", (clazz,type) -> {
                if (type == LocalDateTime.class) {
                    return LocalDateTime.now();
                } else if (type == LocalDate.class) {
                    return LocalDate.now();
                } else if (type == Date.class) {
                    return new Date();
                } else if (type == Long.class) {
                    return System.currentTimeMillis();
                } else if (type == Integer.class) {
                    return (int) (System.currentTimeMillis() / 1000);
                }
                throw new RuntimeException("Inconsistent types");
            });
        };
    }
}
```

--------------------------------

### Spring Boot 应用 DDL 自动化配置

Source: https://xbatis.cn/zh-CN/function/core/ddlAuto.html

通过 @XbatisDDLAutoScan 注解在 Spring Boot 应用中启用 DDL 自动扫描。

```java
@XbatisDDLAutoScan(entityPackages = "com.xxx.entity")
public class ApiApplication {
    public static void main(String[] args) {
        try {
            SpringApplication.run(ApiApplication.class, args);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

```java
@Profile("dev")
@Configuration
@XbatisDDLAutoScan(entityPackages = "com.xxx.entity")
public class XbatisDDLAutoScanConfig {
}
```

--------------------------------

### 设置全局插入与更新监听器

Source: https://xbatis.cn/zh-CN/install/ai-help.html

配置全局监听器以在插入或更新实体时自动填充字段，如创建人或更新人信息。

```java
XbatisGlobalConfig.setGlobalOnInsertListener(entity -> {
    // 统一填充创建人等
});
XbatisGlobalConfig.setGlobalOnUpdateListener(entity -> {
    // 统一填充更新人等
});
```

--------------------------------

### Specify Database Type in Configuration

Source: https://xbatis.cn/zh-CN/install/ai-help.html

Explicitly declare the databaseId in the configuration to optimize startup performance by avoiding auto-detection.

```yaml
mybatis:
  configuration:
    databaseId: MYSQL   # 参见 db-support.md 获取可用 ID
```

--------------------------------

### 配置全局插入监听器

Source: https://xbatis.cn/zh-CN/intro/howConfigStartup.html

设置全局插入操作的监听器以处理业务逻辑。

```java
@Configuration
public class XbatisConfig {

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return (configuration) -> {
            XbatisGlobalConfig.setGlobalOnInsertListener(o ->{
                    //处理业务逻辑
            });
        };
    }
}
```

--------------------------------

### 原生 SQL 批量修改

Source: https://xbatis.cn/zh-CN/function/base/update.html

执行批量更新操作，支持指定更新的列。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void updateBatch() {
        List<SysUser> list = ... ;
        sysUserMapper.updateBatch(list);
        
        //如需指定update set 列，则
        sysUserMapper.updateBatch(list,SysUser::getUserName,SysUser::getPassword);
    }
}
```

--------------------------------

### 全连接查询示例

Source: https://xbatis.cn/zh-CN/function/base/join-query.html

使用 JoinMode.FULL 参数执行全连接查询。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void page() {
        Pager<SysUser> pager= QueryChain.of(sysUserMapper)
                .join(JoinMode.FULL, SysUser::getRoleId, SysRole::getId)
                .like(SysUser::getUserName,"abc")
                .paging(Pager.of(1));
    }
}
```

--------------------------------

### 开启 Seata 分布式事务配置

Source: https://xbatis.cn/zh-CN/function/core/routingDatasource.html

在 YAML 配置文件中启用 Seata 支持。

```yaml
spring:
  ds:
    aop:
      enabled: true
      order: 1
    seata: true
    seata-mode: at
```

--------------------------------

### 启用 JDBC 配置加密

Source: https://xbatis.cn/zh-CN/function/core/routingDatasource.html

在 YAML 中开启加密功能并配置数据源。

```yaml
spring:
  ds:
    jdbc-config-decrypt: true
    primary: master
    routing:
      master:
        name: master
        type: com.zaxxer.hikari.HikariDataSource
        url: 加密后的地址
        username: 加密后的username
        passowrd: 加密后的password
        hikari:
          minimum-idle: 1
          maximum-pool-size: 10
```

--------------------------------

### CASE WHEN 单条件更新

Source: https://xbatis.cn/zh-CN/function/core/db-methods.html

使用 Methods.case_() 构建简单的 CASE WHEN 条件更新逻辑。

```java
UpdateChain.of(sysUserMapper)
        .set(SysUser::getUserName, GetterFields.of(SysUser::getId, SysUser::getUserName), cs -> {
            Case cased = Methods.case_();
            cased.when(cs[0].eq(1), 2);
            cased.else_(cs[1]);
            return cased;
        })
        .in(SysUser::getId, 1, 2, 3)
        .execute();
```

```sql
    sql:  update sys_user set user_name = case when id=1 then 2 else 1 end where id in (1,2,3);
```

--------------------------------

### 使用数据库函数与 SQL 模板

Source: https://xbatis.cn/zh-CN/install/ai-help.html

通过 Methods 类调用内置数据库函数，并使用 tpl、fTpl 或 cTpl 构建自定义 SQL 片段。

```java
QueryChain.of(sysUserMapper)
    .select(SysUser::getRoleId, c -> Methods.tpl("count({0})+{1}", c, "1"))
    .and(GetterFields.of(SysUser::getId, SysUser::getId),
         cs -> Methods.cTpl("{0}+{1}={2}", cs[0], cs[1], 2));
```

--------------------------------

### 多个新增冲突处理

Source: https://xbatis.cn/zh-CN/intro/saveIgnoreOrUpdate.html

使用 save 方法处理 List 集合新增，支持在冲突时选择忽略或覆盖。

```java
import java.util.ArrayList;

public void test() {


    MultiPk entity = new MultiPk();
    entity.setId1(1);
    entity.setId2(2);
    entity.setName("12");
    List<MultiPk> list = new ArrayList<>();
    list.add(entity);
    
    mapper.save(list, strategy -> {
        //忽略
        strategy.onConflict(action -> action.doNothing());
        //或者覆盖
        strategy.onConflict(action -> action.doUpdate(update -> update.overwriteAll()));
    });
}
```

--------------------------------

### batch

Source: https://xbatis.cn/zh-CN/function/core/batchOpt.html

执行自定义逻辑的批量操作。

```APIDOC
## public static <M, T> int batch(SqlSessionFactory sqlSessionFactory, Class<M> mapperType, Collection<T> list, int batchSize, MybatisBatchBiConsumer<SqlSession, M, T> batchFunction)

### Description
通过自定义的 batchFunction 执行批量操作。

### Parameters
- **sqlSessionFactory** (SqlSessionFactory) - Required - Mybatis SqlSessionFactory 实例
- **mapperType** (Class<M>) - Required - Mapper 的 class 类型
- **list** (Collection<T>) - Required - 数据列表
- **batchSize** (int) - Required - 一次批量处理的条数
- **batchFunction** (MybatisBatchBiConsumer) - Required - 自定义操作方法

### Returns
- **int** - 影响的条数
```

--------------------------------

### 使用QueryChain进行链式游标查询

Source: https://xbatis.cn/zh-CN/function/base/cursor-query.html

利用QueryChain构建复杂的查询链路，支持链式调用如limit等操作。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void cursor() {
        Cursor<SysUser> cursor= QueryChain.of(sysUserMapper)
                .like(SysUser::getUserName,"abc")
                .limit(10)
                .cursor();
    }
}
```

--------------------------------

### 使用 QueryChain 进行链式列表查询

Source: https://xbatis.cn/zh-CN/function/base/list-query.html

利用 QueryChain 构建复杂的查询场景，支持链式调用如 limit 等操作。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void list() {
        List<SysUser> list= QueryChain.of(sysUserMapper)
                .like(SysUser::getUserName,"abc")
                .limit(10)
                .list();
    }
}
```

--------------------------------

### 批量新增冲突处理

Source: https://xbatis.cn/zh-CN/intro/saveIgnoreOrUpdate.html

使用 saveBatch 方法进行批量新增，通过 strategy 参数定义冲突时的处理行为。

```java
import java.util.ArrayList;

public void test() {


    MultiPk entity = new MultiPk();
    entity.setId1(1);
    entity.setId2(2);
    entity.setName("12");
    List<MultiPk> list = new ArrayList<>();
    list.add(entity);
    
    mapper.saveBatch(list, strategy -> {
        //忽略
        strategy.onConflict(action -> action.doNothing());
        //或者覆盖
        strategy.onConflict(action -> action.doUpdate(update -> update.overwriteAll()));
    });
}
```

--------------------------------

### 使用 UpdateChain 动态更新

Source: https://xbatis.cn/zh-CN/function/base/update.html

构建复杂的更新场景，支持链式调用设置条件和更新内容。

```java
public class Demo {
    @Autowired
    private SysUserMapper sysUserMapper;

    public void update() {
        UpdateChain.of(sysUserMapper)
                .update(SysUser.class)
                .set(SysUser::getUserName, "new userName")
                .eq(SysUser::getId, 1)
                .execute();
    }
}
```

--------------------------------

### 执行分表查询

Source: https://xbatis.cn/zh-CN/function/core/tableSplit.html

在执行数据库操作时，必须在查询条件中包含分表 key。

```java
SysUser sysUser = sysUserMapper.get(where -> {
    where.eq(SysUser::getId, 1).eq(sysUser::getGroupId, 12);
});
```

--------------------------------

### sysUserMapper.execute

Source: https://xbatis.cn/zh-CN/function/core/nativeSQL.html

执行原生SQL进行更新或删除操作。

```APIDOC
## sysUserMapper.execute(String sql, Object... args)

### Description
执行原生SQL更新或删除语句，返回受影响行数。

### Parameters
- **sql** (String) - 原生SQL语句
- **args** (Object...) - SQL参数

### Example
```java
int cnt = sysUserMapper.execute("update t_sys_user set role_id=1 where id=1");
```
```
Tokens:
Raw