【原创文章，转载请注明原文章地址，谢谢！】
前面已经了解了MyBatis Generator Plugin的相关知识，包括生命周期和主要的方法，我们就先来看两个MBG提供的内置的Plugin，然后我们自己来完成一个我们的Plugin。
org.mybatis.generator.plugins.ToStringPlugin##
前面我们已经介绍了ToStringPlugin插件的作用，是为KeyClass，Record Class和BlobClass提供toString方法的。首先我们了解一下ToStringPlugin的用法。
在generatorConfig.xml中加上配置：
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
在做配置的时候，注意一点就是这个插件是不需要配置参数的。运行MBG，查看生成的代码
在KeyClass中生成的toString方法：
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(getClass().getSimpleName());
sb.append(" [");
sb.append("Hash = ").append(hashCode());
sb.append("]");
return sb.toString();
}
在recordClass中生成的toString方法：
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(getClass().getSimpleName());
sb.append(" [");
sb.append("Hash = ").append(hashCode());
sb.append(", username=").append(username);
sb.append(", password=").append(password);
sb.append(", email=").append(email);
sb.append(", age=").append(age);
sb.append(", deptId=").append(deptId);
sb.append(", admin=").append(admin);
sb.append("]");
return sb.toString();
}
在看代码之前，首先我们要自己做一些分析，第一，我们要明确，我们看这个ToStringPlugin插件的目的是什么，很明显，我们学习这个插件，就可以很明确的学习到几个内容：
- 很明显我们能学习到怎么在生成的Java代码中添加方法；
- 那么第二个问题，就是我们能够学习到怎么去遍历生成的类中的属性和属性的值；
- 推广开来，我们从这个ToStringPlugin中基本能够了解MBG中对于Java类的一个DOM封装的结构；
明确了我们的看代码的目标，接下来还要自己去设想一下这个Plugin的实现方法，虽然我们对MBG的代码结构不是很了解，但是我们大概能够通过MBG Plugin的生命周期想到，我们应该会扩展生成keyClass和生成recordClass和生成blobClass的方法，在这个方法中，添加一个方法的DOM，并且在这个DOM里面遍历当前类的属性，并拼装对应的StringBuilder；
OK，下面才正式进去ToStringPlugin的代码看看：
public class ToStringPlugin extends PluginAdapter {
首先该类确实是继承了插件的适配类
public boolean validate(List<String> warnings) {
return true;
}
其次，实现了validate方法，validate方法是所有的plugin都必须实现的方法，一般在该方法中对参数进行验证，因为ToStringPlugin没有参数，所以直接返回了true；
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
generateToString(introspectedTable, topLevelClass);
return true;
}
实现了modelBaseRecordClassGenerated方法，该方法就是前面提到，在MBG生成record类的时候调用的插件的方法，在该方法中，传入两个参数，
一个是topLevelClass，该类的实例就是表示当前正在生成的类的DOM结构，
-
第二个introspectedTable是代表的runtime环境，包含了所有context中的配置，一般从这个类中去查询生成对象的一些规则；
可以看到，这个方法仅仅只是调用了generateToString方法，很好理解，因为要为三个类生成toString方法，所以抽取了一下，另外，这个方法总是返回了true，让后面的实现了相同方法的插件能正常运行；public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { generateToString(introspectedTable, topLevelClass); return true; }
实现了modelBaseRecordClassGenerated方法，该方法就是前面提到，在MBG生成key Class类的时候调用的插件的方法，也只是调用了generateToString方法，
public boolean modelRecordWithBLOBsClassGenerated(
TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
generateToString(introspectedTable, topLevelClass);
return true;
}
实现了modelBaseRecordClassGenerated方法，该方法就是前面提到，在MBG生成blob Class类的时候调用的插件的方法；
到此，三个方法的实现和我们之前预想的一致，接下来就是看具体怎么添加方法：
/**
* 具体生成toString方法
* @param introspectedTable
* @param topLevelClass
*/
private void generateToString(IntrospectedTable introspectedTable,
TopLevelClass topLevelClass) {
//首先创建一个Method对象，注意，这个Method是org.mybatis.generator.api.dom.java.Method，
//这个Method是MBG中对对象DOM的一个抽象；因为我们要添加方法，所以先创建一个；
Method method = new Method();
//设置这个方法的可见性为public，代码已经在一步一步构建这个方法了
method.setVisibility(JavaVisibility.PUBLIC);
//设置方法的返回类型，这里注意一下的就是，returnType是一个FullyQualifiedJavaType；
//这个FullyQualifiedJavaType是MGB中对Java中的类型的一个DOM封装，这个类在整个MBG中大量使用；
//FullyQualifiedJavaType提供了几个静态的方法，比如getStringInstance，就直接返回了一个对String类型的封装；
method.setReturnType(FullyQualifiedJavaType.getStringInstance());
//设置方法的名称，至此，方法签名已经装配完成；
method.setName("toString"); //$NON-NLS-1$
//判断当前MBG运行的环境是否支持Java5（这里就可以看出来IntrospectedTable类的作用了，主要是查询生成环境的作用）
if (introspectedTable.isJava5Targeted()) {
//如果支持Java5，就在方法上面生成一个@Override标签；
method.addAnnotation("@Override"); //$NON-NLS-1$
}
//访问上下文对象（这个context对象是在PluginAdapter初始化完成后，通过setContext方法设置进去的，
//通过getCommentGenerator方法得到注释生成器，并调用addGeneralMethodComment为当前生成的方法添加注释；
//因为我们没有提供自己的注释生成器，所以默认的注释生成器只是说明方法是通过MBG生成的，对应的是哪个表而已；
//这句代码其实非常有意义，通过这句代码，我们基本就可能了解到MBG中对于方法注释的生成方式了；
context.getCommentGenerator().addGeneralMethodComment(method,
introspectedTable);
//OK，调用addBodyLine开始为方法添加代码了
//可以看到，确实，只是简单的把要生成的代码通过String拼装到了method的body中而已；
//想到了什么？确实，我想到了Servelt的输出方法。MBG默认的方法体具体的实现，就是像Servlet那样通过String输出的；
//所以，这才会为我们后面准备用Velocity来重写MBG提供了依据，我们只是给MBG添加一个MVC的概念；
method.addBodyLine("StringBuilder sb = new StringBuilder();"); //$NON-NLS-1$
method.addBodyLine("sb.append(getClass().getSimpleName());"); //$NON-NLS-1$
method.addBodyLine("sb.append(\" [\");"); //$NON-NLS-1$
method.addBodyLine("sb.append(\"Hash = \").append(hashCode());"); //$NON-NLS-1$
//接下来要准备拼装类的字段了；
StringBuilder sb = new StringBuilder();
//通过topLevelClass得到当前类的所有字段，注意，这里的Field是org.mybatis.generator.api.dom.java.Field
//这个Field是MBG对字段的一个DOM封装
for (Field field : topLevelClass.getFields()) {
//得到字段的名称；
String property = field.getName();
//重置StringBuilder；
sb.setLength(0);
//添加字段的输出代码；
sb.append("sb.append(\"").append(", ").append(property) //$NON-NLS-1$ //$NON-NLS-2$
.append("=\")").append(".append(").append(property) //$NON-NLS-1$ //$NON-NLS-2$
.append(");"); //$NON-NLS-1$
//把这个字段的toString输出到代码中；所以才看到我们最后生成的代码结果中，每一个字段在toString方法中各占一行；
method.addBodyLine(sb.toString());
}
method.addBodyLine("sb.append(\"]\");"); //$NON-NLS-1$
method.addBodyLine("return sb.toString();"); //$NON-NLS-1$
//把拼装好的方法DOM添加到topLevelClass中，完成方法添加；
topLevelClass.addMethod(method);
}
我已经把该方法涉及到的有价值的内容用注释详细标注出来了，基本上，通过这个方法，我们已经能够完成绝大情况的为Java类添加方法的情况了；
接下来，我们再分析一个插件org.mybatis.generator.plugins.MapperConfigPlugin，来看看怎么添加额外的XML和处理XML的生成。
