Package org.miaixz.bus.mapper.annotation

Annotation Interface KeySql

@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface KeySql
主键策略，用于替换 JPA 中的复杂用法
Since:
Java 17+
Author:
Kimi Liu

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Registry
    dialect
    优先级第二，根据配置的数据库类型取回主键，忽略其他配置
    Class<? extends GenId>
    genId
    Java 方式生成主键，可以和发号器一类的服务配合使用
    Class<? extends GenSql>
    genSql
    生成 SQL，初始化时执行，优先级低于 sql
    ORDER
    order
    和 sql 可以配合使用，默认使用全局配置中的 ORDER
    String
    sql
    取主键的 SQL
    boolean
    useGeneratedKeys
    是否使用 JDBC 方式获取主键，优先级最高，设置为 true 后，不对其他配置校验

  • Element Details

    • useGeneratedKeys

      boolean useGeneratedKeys
      是否使用 JDBC 方式获取主键，优先级最高，设置为 true 后，不对其他配置校验
      Returns:
      the boolean
      Default:
      false

    • dialect

      Registry dialect
      优先级第二，根据配置的数据库类型取回主键，忽略其他配置
      Returns:
      the object
      Default:
      NULL

    • sql

      String sql
      取主键的 SQL
      Returns:
      the string
      Default:
      ""

    • genSql

      Class<? extends GenSql> genSql
      生成 SQL，初始化时执行，优先级低于 sql
      Returns:
      the class
      Default:
      org.miaixz.bus.mapper.support.GenSql.NULL.class

    • order

      ORDER order
      和 sql 可以配合使用，默认使用全局配置中的 ORDER
      Returns:
      the object
      Default:
      DEFAULT

    • genId

      Class<? extends GenId> genId
      Java 方式生成主键，可以和发号器一类的服务配合使用
      Returns:
      the class
      Default:
      org.miaixz.bus.mapper.support.GenId.NULL.class