开发插件 · Java 开源项目中文文档

# 开发插件插件可用于修改或添加到由MyBatis Generator 生成的对象。插件必须实现`org.mybatis.generator.api.Plugin`接口。插件接??口包含许多在代码生成过程的不同阶段被调用的方法。任何特定的插件通常不需要实现整个接口。因此，大多数插件应扩展适配器类`org.mybatis.generator.api.PluginAdapter` 。适配器类提供基本的插件支持，并为大多数的接口方法（类似于Swing适配器类）提供了空操作的方法。 MyBatis Generator 提供了几个插件（都在包`org.mybatis.generator.plugins`下）。所提供的插件展示了不同类型的可以通过插件完成的任务。插件的源代码是可以下载的，也可以在线浏览[这里](http://mybatis.googlecode.com/svn/sub-projects/generator/trunk/core/mybatis-generator-core/src/main/java/org/mybatis/generator/plugins/) 。 ## 插件的生命周期插件有一个生命周期。插件在代码生成过程的初始化期间创建并且在这个过程中的不同阶段被调用。下面的列表显示了插件的基本生命周期： 1. 插件通过默认的构造函数创建 2. `setContext`方法被调用 3. `setProperties`方法被调用 4. `validate`方法被调用。如果该方法返回`false` ，那么插件中的其他方法都不会再被调用。 5. 对于配置中的每个表： 1. `initialized`方法被调用 2. Java客户端的方法：1,2 1. `clientXXXMethodGenerated(Method, TopLevelClass, IntrospectedTable)` - 当Java客户端实现类生成的时候这些方法被调用. 2. `clientXXXMethodGenerated(Method, Interface, IntrospectedTable)` -当Java客户端接口生成的时候这些方法被调用。 3. `clientGenerated(Interface, TopLevelClass, IntrospectedTable)`方法被调用 3. 模型方法：1 1. `modelFieldGenerated`, `modelGetterMethodGenerated`, `modelSetterMethodGenerated` for each field in the class 2. `modelExampleClassGenerated(TopLevelClass, IntrospectedTable)` 3. `modelPrimaryKeyClassGenerated(TopLevelClass, IntrospectedTable)` 4. `modelBaseRecordClassGenerated(TopLevelClass, IntrospectedTable)` 5. `modelRecordWithBLOBsClassGenerated(TopLevelClass, IntrospectedTable)` 4. SQL映射方法：1 1. `sqlMapXXXElementGenerated(XmlElement, IntrospectedTable)` - 当生成SQL映射的每个元素的时候这些方法被调用 2. `sqlMapDocumentGenerated(Document, IntrospectedTable)` 3. `sqlMapDocument(GeneratedXmlFile, IntrospectedTable)` 5. `contextGenerateAdditionalJavaFiles(IntrospectedTable)`方法被调用 6. `contextGenerateAdditionalXmlFiles(IntrospectedTable)`方法被调用 6. `contextGenerateAdditionalJavaFiles()`方法被调用 7. `contextGenerateAdditionalXmlFiles()`方法被调用 **注意事项:** 1 -这些方法将被包装的代码生成器调用。如果您提供一个自定义的代码生成器，那么这些方法将仅在自定义代码生成调用它们时调用。 2 -Java客户端的方法只有当配置Java客户端生成器的时候会被调用。 ## 编写插件实现一个插件，最好的办法是扩展`org.mybatis.generator.api.PluginAdapter`类并只需要覆盖您需要的插件方法。插件接口方法可用于修改默认生成的代码，或添加其他生成的代码。Examples of things 可以通过插件实现的是： * 给生成的方法添加自定义注解 * 给生成的类添加其他方法 * 给生成的XML文件添加其他元素 * 生成额外的Java文件 * 生成额外的XML文件 `contextXXX`方法总是会被调用。其他方法通过包代码生成器调用 - 且仅当表中的一个规则将会生成一个特定元素时。例如，如果该表没有主键， `modelPrimaryKeyClassGenerated(TopLevelClass, IntrospectedTable)`方法将不会被调用。方法返回一个`boolean`可用于绕过生成代码。如果任意这些方法返回`false` ，则相关的项目不会被添加到生成的代码中。如果配置了多个插件，那么第一个插件从方法返回false将导致MyBatis Generator停止调用所有其他插件的方法。如果您有一个关于插件的想法，可以自由的在用户列表问有关的问题。我们在这里提供帮助！