程序包 com.baomidou.mybatisplus.generator.config.builder

类 Entity.Builder

java.lang.Object
com.baomidou.mybatisplus.generator.config.builder.BaseBuilder
com.baomidou.mybatisplus.generator.config.builder.Entity.Builder
所有已实现的接口:
IConfigBuilder<StrategyConfig>
封闭类:
Entity
public static class Entity.Builder extends BaseBuilder

  • 构造器详细资料

  • 方法详细资料

    • nameConvert

      public Entity.Builder nameConvert(INameConvert nameConvert)
      名称转换实现
      参数:
      nameConvert - 名称转换实现
      返回:
      this

    • superClass

      public Entity.Builder superClass(@NotNull @NotNull Class<?> clazz)
      自定义继承的Entity类全称
      参数:
      clazz - 类
      返回:
      this

    • superClass

      public Entity.Builder superClass(String superEntityClass)
      自定义继承的Entity类全称，带包名
      参数:
      superEntityClass - 类全称
      返回:
      this

    • disableSerialVersionUID

      public Entity.Builder disableSerialVersionUID()
      禁用生成serialVersionUID
      返回:
      this
      从以下版本开始:
      3.5.0

    • enableSerialAnnotation

      public Entity.Builder enableSerialAnnotation()
      启用生成 Serial (需JAVA 14)

      当开启了 Entity.serialVersionUID 时,会增加 Serial 注解在此字段上

      返回:
      this
      从以下版本开始:
      3.5.11

    • enableColumnConstant

      public Entity.Builder enableColumnConstant()
      开启生成字段常量
      返回:
      this
      从以下版本开始:
      3.5.0

    • enableChainModel

      public Entity.Builder enableChainModel()
      开启链式模型
      返回:
      this
      从以下版本开始:
      3.5.0

    • enableLombok

      public Entity.Builder enableLombok()
      开启lombok模型 (默认添加Getter和Setter)

      自3.5.10开始,默认添加ToString搭配,如果想关闭可通过toString(boolean)关闭

      返回:
      this
      从以下版本开始:
      3.5.0

    • enableLombok

      public Entity.Builder enableLombok(@NotNull @NotNull ClassAnnotationAttributes... attributes)
      开启lombok模型 (会把注解属性都加入进去,无论是否启用GlobalConfig.isKotlin())

      注意如果通过此方法开启lombok模型,默认的lombok注解(get,set,toString)都将不会生成,请自行控制添加

      由toString(boolean)控制的也会失效

      使用@Data示例: enableLombok(new ClassAnnotationAttributes("@Data","lombok.Data"))
      参数:
      attributes - 注解属性集合
      返回:
      this
      从以下版本开始:
      3.5.10

    • enableRemoveIsPrefix

      public Entity.Builder enableRemoveIsPrefix()
      开启Boolean类型字段移除is前缀
      返回:
      this
      从以下版本开始:
      3.5.0

    • enableTableFieldAnnotation

      public Entity.Builder enableTableFieldAnnotation()
      开启生成实体时生成字段注解
      返回:
      this
      从以下版本开始:
      3.5.0

    • enableActiveRecord

      public Entity.Builder enableActiveRecord()
      开启 ActiveRecord 模式
      返回:
      this
      从以下版本开始:
      3.5.0

    • versionColumnName

      public Entity.Builder versionColumnName(String versionColumnName)
      设置乐观锁数据库表字段名称
      参数:
      versionColumnName - 乐观锁数据库字段名称
      返回:
      this

    • versionPropertyName

      public Entity.Builder versionPropertyName(String versionPropertyName)
      设置乐观锁实体属性字段名称
      参数:
      versionPropertyName - 乐观锁实体属性字段名称
      返回:
      this

    • logicDeleteColumnName

      public Entity.Builder logicDeleteColumnName(String logicDeleteColumnName)
      逻辑删除数据库字段名称
      参数:
      logicDeleteColumnName - 逻辑删除字段名称
      返回:
      this

    • logicDeletePropertyName

      public Entity.Builder logicDeletePropertyName(String logicDeletePropertyName)
      逻辑删除实体属性名称
      参数:
      logicDeletePropertyName - 逻辑删除实体属性名称
      返回:
      this

    • naming

      public Entity.Builder naming(NamingStrategy namingStrategy)
      数据库表映射到实体的命名策略
      参数:
      namingStrategy - 数据库表映射到实体的命名策略
      返回:
      this

    • columnNaming

      public Entity.Builder columnNaming(NamingStrategy namingStrategy)
      数据库表字段映射到实体的命名策略
      参数:
      namingStrategy - 数据库表字段映射到实体的命名策略
      返回:
      this

    • addSuperEntityColumns

      public Entity.Builder addSuperEntityColumns(@NotNull @NotNull String... superEntityColumns)
      添加父类公共字段
      参数:
      superEntityColumns - 父类字段(数据库字段列名)
      返回:
      this
      从以下版本开始:
      3.5.0

    • addSuperEntityColumns

      public Entity.Builder addSuperEntityColumns(@NotNull @NotNull List<String> superEntityColumnList)

    • addIgnoreColumns

      public Entity.Builder addIgnoreColumns(@NotNull @NotNull String... ignoreColumns)
      添加忽略字段
      参数:
      ignoreColumns - 需要忽略的字段(数据库字段列名)
      返回:
      this
      从以下版本开始:
      3.5.0

    • addIgnoreColumns

      public Entity.Builder addIgnoreColumns(@NotNull @NotNull List<String> ignoreColumnList)

    • addTableFills

      public Entity.Builder addTableFills(@NotNull @NotNull IFill... tableFills)
      添加表字段填充
      参数:
      tableFills - 填充字段
      返回:
      this
      从以下版本开始:
      3.5.0

    • addTableFills

      public Entity.Builder addTableFills(@NotNull @NotNull List<IFill> tableFillList)
      添加表字段填充
      参数:
      tableFillList - 填充字段集合
      返回:
      this
      从以下版本开始:
      3.5.0

    • idType

      public Entity.Builder idType(com.baomidou.mybatisplus.annotation.IdType idType)
      指定生成的主键的ID类型
      参数:
      idType - ID类型
      返回:
      this
      从以下版本开始:
      3.5.0

    • convertFileName

      public Entity.Builder convertFileName(@NotNull @NotNull ConverterFileName converter)
      转换输出文件名称
      参数:
      converter - 转换处理
      返回:
      this
      从以下版本开始:
      3.5.0

    • formatFileName

      public Entity.Builder formatFileName(String format)
      格式化文件名称
      参数:
      format - 格式
      返回:
      this
      从以下版本开始:
      3.5.0

    • fileOverride

      @Deprecated public Entity.Builder fileOverride()
      已过时。
      覆盖已有文件（该方法后续会删除，替代方法为enableFileOverride方法）
      另请参阅:

    • enableFileOverride

      public Entity.Builder enableFileOverride()
      覆盖已有文件
      从以下版本开始:
      3.5.3

    • javaTemplate

      public Entity.Builder javaTemplate(String template)
      指定模板路径
      参数:
      template - 模板路径
      返回:
      this
      从以下版本开始:
      3.5.6

    • kotlinTemplatePath

      public Entity.Builder kotlinTemplatePath(String template)
      指定模板路径
      参数:
      template - 模板路径
      返回:
      this
      从以下版本开始:
      3.5.6

    • disable

      public Entity.Builder disable()
      禁用实体生成
      返回:
      this
      从以下版本开始:
      3.5.6

    • addClassAnnotation

      public Entity.Builder addClassAnnotation(@NotNull @NotNull ClassAnnotationAttributes attributes)
      添加类注解
      参数:
      attributes - 注解属性
      返回:
      this
      从以下版本开始:
      3.5.10

    • tableFieldAnnotationHandler

      public Entity.Builder tableFieldAnnotationHandler(@NotNull @NotNull ITableFieldAnnotationHandler tableFieldAnnotationHandler)
      指定字段注解处理器
      参数:
      tableFieldAnnotationHandler - 字段处理器
      返回:
      this
      从以下版本开始:
      3.5.10

    • tableAnnotationHandler

      public Entity.Builder tableAnnotationHandler(@NotNull @NotNull ITableAnnotationHandler tableAnnotationHandler)
      指定表注解处理器
      参数:
      tableAnnotationHandler - 表注解处理器
      返回:
      this
      从以下版本开始:
      3.5.10

    • toString

      public Entity.Builder toString(boolean toString)
      设置是否生成ToString方法
      参数:
      toString - 是否生成
      返回:
      this
      从以下版本开始:
      3.5.10

    • fieldUseJavaDoc

      public Entity.Builder fieldUseJavaDoc(boolean fieldUseJavaDoc)
      设置字段是否生成文档注释
      参数:
      fieldUseJavaDoc - 是否生成文档注释
      返回:
      this
      从以下版本开始:
      3.5.10

    • importPackageFunction

      public Entity.Builder importPackageFunction(Function<Set<String>,List<String>> importPackageFunction)
      导包处理方法
      参数:
      importPackageFunction - 导包处理
      返回:
      this
      从以下版本开始:
      3.5.11

    • annotationAttributesFunction

      public Entity.Builder annotationAttributesFunction(Function<List<? extends AnnotationAttributes>,List<AnnotationAttributes>> annotationAttributesFunction)
      注解处理方法 (含类与字段)
      参数:
      annotationAttributesFunction - 注解处理
      返回:
      this
      从以下版本开始:
      3.5.11

    • get

      public Entity get()