mybatis-generator自定义插件，生成@KeySql

1.目的及说明

        mybatis-generator生成实体类时，为主键字段添加@KeySql，获取序列。

格式为 @KeySql(sql = "SELECT xxx.NEXTVAL FROM DUAL", order = ORDER.BEFORE)

        此处序列格式为：表名+前缀。前缀为“SEQ_” 

效果如下：

2.步骤

2.1自定义插件MyJavaModelPlugin extends PluginAdapter

主要代码如下，拼接需要的信息

完整代码如下所示：

import java.util.List;
import java.util.Properties;

import org.apache.commons.lang3.StringUtils;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.Plugin;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.TopLevelClass;

import lombok.Data;
import lombok.EqualsAndHashCode;

@Data
@EqualsAndHashCode(callSuper=false)
public class MyJavaModelPlugin extends PluginAdapter {

	private String seq_prefix;

	private String seq_suffix;

	private boolean useKeySql; // 用来控制是否需要添加@KeySql

	@Override
	public boolean validate(List<String> warnings) {
		return true;
	}

	@Override
	public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn,
			IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) {

		List<IntrospectedColumn> primaryKeyColumns = introspectedTable.getPrimaryKeyColumns();
		if (!this.useKeySql) {
			return true;
		}
		if (StringUtils.isAllBlank(seq_prefix, seq_suffix)) {
			System.out.println("prefix和suffix均为null，不需要添加KeySql");
			return true;
		}
		String seq = null;
		for (IntrospectedColumn column : primaryKeyColumns) {
			if (introspectedColumn == column) {
				seq = introspectedTable.getFullyQualifiedTableNameAtRuntime();
				if (StringUtils.isNotBlank(seq_prefix)) {
					seq = seq_prefix + seq;
				}
				if (StringUtils.isNotBlank(seq_suffix)) {
					seq += seq_suffix;
				}
				String sql = "SELECT " + seq + ".NEXTVAL FROM DUAL";
				String keySql = "@KeySql(sql = \"" + sql + "\", order = ORDER.BEFORE)";

				field.addAnnotation(keySql);

				// 添加 keySql 注释相关引用
				topLevelClass.addImportedType("tk.mybatis.mapper.annotation.KeySql");
				topLevelClass.addImportedType("tk.mybatis.mapper.code.ORDER");
			}
		}

		return true;
	}

	@Override
	public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
		return true;
	}

	/**
	 * mapper 文件添加@Mapper注解
	 */
	@Override
	public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass,
			IntrospectedTable introspectedTable) {
		interfaze.addAnnotation("@Mapper");
		FullyQualifiedJavaType mapperImport = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Mapper");
		interfaze.addImportedType(mapperImport);
		return true;
	}

	@Override
	public void setProperties(Properties properties) {
		super.setProperties(properties);
		this.seq_prefix = getProperty("seq_prefix");
		this.seq_suffix = getProperty("seq_suffix");
		this.useKeySql = Boolean.valueOf(getProperty("useKeySql"));
	}

	public String getProperty(String key) {
		return this.properties.getProperty(key);
	}


}

2.2generatorConfig.xml中添加配置

代码如下：

		<plugin type="com.zy.just.base.custom.MyJavaModelPlugin">
			<property name="useKeySql" value="true"/>
			<property name="seq_prefix" value = "SEQ_"/>
			<property name="seq_suffix" value=""/>
		</plugin>

说明：如果不需要生成@KeySql.可在generatorConfig.xml中修改useKeySql=false