com.github.ozuo.mbg.extend.plugins

类 MybatisLombokPlugin

java.lang.Object

org.mybatis.generator.api.PluginAdapter

com.github.ozuo.mbg.extend.plugins.MybatisLombokPlugin

所有已实现的接口:

org.mybatis.generator.api.Plugin

public class MybatisLombokPlugin
extends org.mybatis.generator.api.PluginAdapter

自定义lombok插件 java实体类会增加lombok注解 并自定义注释

从以下版本开始:

2020/10/22 14:07

作者:

zuoyx

嵌套类概要

从接口继承的嵌套类/接口 org.mybatis.generator.api.Plugin

org.mybatis.generator.api.Plugin.ModelClassType

字段概要

从类继承的字段 org.mybatis.generator.api.PluginAdapter

context, properties

构造器概要

构造器

构造器和说明
MybatisLombokPlugin()

方法概要

限定符和类型	方法和说明
boolean	clientGenerated(org.mybatis.generator.api.dom.java.Interface interfaze, org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedTable introspectedTable) mapper.java mapper接口
boolean	modelBaseRecordClassGenerated(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedTable introspectedTable) 实体类 entity.java 增加@Data注解 增加类注释
boolean	modelFieldGenerated(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.Plugin.ModelClassType modelClassType) 实体类 entity.java 字段注释
boolean	modelGetterMethodGenerated(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.Plugin.ModelClassType modelClassType)
boolean	modelSetterMethodGenerated(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.Plugin.ModelClassType modelClassType)
boolean	sqlMapDocumentGenerated(org.mybatis.generator.api.dom.xml.Document document, org.mybatis.generator.api.IntrospectedTable introspectedTable) 自定义mapper.xml内容 添加字段sql语句，效果例： * <sql id="BaseColumns"> * id, name, create_time, update_time * </sql> * <sql id="AliasColumns"> * t.id, t.name, t.create_time, t.update_time * </sql>
boolean	validate(List<String> list) 验证参数是否有效

从类继承的方法 org.mybatis.generator.api.PluginAdapter

clientBasicCountMethodGenerated, clientBasicDeleteMethodGenerated, clientBasicInsertMethodGenerated, clientBasicSelectManyMethodGenerated, clientBasicSelectOneMethodGenerated, clientBasicUpdateMethodGenerated, clientCountByExampleMethodGenerated, clientCountByExampleMethodGenerated, clientDeleteByExampleMethodGenerated, clientDeleteByExampleMethodGenerated, clientDeleteByPrimaryKeyMethodGenerated, clientDeleteByPrimaryKeyMethodGenerated, clientInsertMethodGenerated, clientInsertMethodGenerated, clientInsertSelectiveMethodGenerated, clientInsertSelectiveMethodGenerated, clientSelectAllMethodGenerated, clientSelectAllMethodGenerated, clientSelectByExampleWithBLOBsMethodGenerated, clientSelectByExampleWithBLOBsMethodGenerated, clientSelectByExampleWithoutBLOBsMethodGenerated, clientSelectByExampleWithoutBLOBsMethodGenerated, clientSelectByPrimaryKeyMethodGenerated, clientSelectByPrimaryKeyMethodGenerated, clientUpdateByExampleSelectiveMethodGenerated, clientUpdateByExampleSelectiveMethodGenerated, clientUpdateByExampleWithBLOBsMethodGenerated, clientUpdateByExampleWithBLOBsMethodGenerated, clientUpdateByExampleWithoutBLOBsMethodGenerated, clientUpdateByExampleWithoutBLOBsMethodGenerated, clientUpdateByPrimaryKeySelectiveMethodGenerated, clientUpdateByPrimaryKeySelectiveMethodGenerated, clientUpdateByPrimaryKeyWithBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated, contextGenerateAdditionalJavaFiles, contextGenerateAdditionalJavaFiles, contextGenerateAdditionalXmlFiles, contextGenerateAdditionalXmlFiles, getContext, getProperties, initialized, modelExampleClassGenerated, modelPrimaryKeyClassGenerated, modelRecordWithBLOBsClassGenerated, providerApplyWhereMethodGenerated, providerCountByExampleMethodGenerated, providerDeleteByExampleMethodGenerated, providerGenerated, providerInsertSelectiveMethodGenerated, providerSelectByExampleWithBLOBsMethodGenerated, providerSelectByExampleWithoutBLOBsMethodGenerated, providerUpdateByExampleSelectiveMethodGenerated, providerUpdateByExampleWithBLOBsMethodGenerated, providerUpdateByExampleWithoutBLOBsMethodGenerated, providerUpdateByPrimaryKeySelectiveMethodGenerated, setContext, setProperties, sqlMapBaseColumnListElementGenerated, sqlMapBlobColumnListElementGenerated, sqlMapCountByExampleElementGenerated, sqlMapDeleteByExampleElementGenerated, sqlMapDeleteByPrimaryKeyElementGenerated, sqlMapExampleWhereClauseElementGenerated, sqlMapGenerated, sqlMapInsertElementGenerated, sqlMapInsertSelectiveElementGenerated, sqlMapResultMapWithBLOBsElementGenerated, sqlMapResultMapWithoutBLOBsElementGenerated, sqlMapSelectAllElementGenerated, sqlMapSelectByExampleWithBLOBsElementGenerated, sqlMapSelectByExampleWithoutBLOBsElementGenerated, sqlMapSelectByPrimaryKeyElementGenerated, sqlMapUpdateByExampleSelectiveElementGenerated, sqlMapUpdateByExampleWithBLOBsElementGenerated, sqlMapUpdateByExampleWithoutBLOBsElementGenerated, sqlMapUpdateByPrimaryKeySelectiveElementGenerated, sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated, sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MybatisLombokPlugin

public MybatisLombokPlugin()

方法详细资料

validate

public boolean validate(List<String> list)

验证参数是否有效

参数:

list - 参数列表

返回:

boolean

modelBaseRecordClassGenerated

public boolean modelBaseRecordClassGenerated(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                             org.mybatis.generator.api.IntrospectedTable introspectedTable)

实体类 entity.java 增加@Data注解 增加类注释

指定者:

modelBaseRecordClassGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

modelBaseRecordClassGenerated 在类中 org.mybatis.generator.api.PluginAdapter

参数:

topLevelClass - 类

introspectedTable - 表数据

返回:

boolean

modelFieldGenerated

public boolean modelFieldGenerated(org.mybatis.generator.api.dom.java.Field field,
                                   org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                   org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                                   org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                   org.mybatis.generator.api.Plugin.ModelClassType modelClassType)

实体类 entity.java 字段注释

指定者:

modelFieldGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

modelFieldGenerated 在类中 org.mybatis.generator.api.PluginAdapter

参数:

field - 属性字段

topLevelClass - 类

introspectedColumn - 表列数据

introspectedTable - 表数据

modelClassType - 类型

返回:

boolean

clientGenerated

public boolean clientGenerated(org.mybatis.generator.api.dom.java.Interface interfaze,
                               org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable)

mapper.java mapper接口

指定者:

clientGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

clientGenerated 在类中 org.mybatis.generator.api.PluginAdapter

参数:

interfaze - mapper接口类

topLevelClass - 实体类

introspectedTable - 表数据

返回:

boolean

modelSetterMethodGenerated

public boolean modelSetterMethodGenerated(org.mybatis.generator.api.dom.java.Method method,
                                          org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                          org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                                          org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                          org.mybatis.generator.api.Plugin.ModelClassType modelClassType)

指定者:

modelSetterMethodGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

modelSetterMethodGenerated 在类中 org.mybatis.generator.api.PluginAdapter

modelGetterMethodGenerated

public boolean modelGetterMethodGenerated(org.mybatis.generator.api.dom.java.Method method,
                                          org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                          org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                                          org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                          org.mybatis.generator.api.Plugin.ModelClassType modelClassType)

指定者:

modelGetterMethodGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

modelGetterMethodGenerated 在类中 org.mybatis.generator.api.PluginAdapter

sqlMapDocumentGenerated

public boolean sqlMapDocumentGenerated(org.mybatis.generator.api.dom.xml.Document document,
                                       org.mybatis.generator.api.IntrospectedTable introspectedTable)

自定义mapper.xml内容 添加字段sql语句，效果例：

* <sql id="BaseColumns"> * id, name, create_time, update_time * </sql> * <sql id="AliasColumns"> * t.id, t.name, t.create_time, t.update_time * </sql>

指定者:

sqlMapDocumentGenerated 在接口中 org.mybatis.generator.api.Plugin

覆盖:

sqlMapDocumentGenerated 在类中 org.mybatis.generator.api.PluginAdapter

参数:

document - xml文档对象

introspectedTable - 表数据

返回:

boolean