# mybatis-generator-plugins

**Repository Path**: gavincook/mybatis-generator-plugins

## Basic Information

- **Project Name**: mybatis-generator-plugins
- **Description**: mybatis生成器插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-01-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 概述
mybatis-generator（代码生成器）插件。提供了一系列增强扩展插件。
## 使用方式
### 1. maven
```xml
<dependency>
  <groupId>me.gavincook</groupId>
  <artifactId>mybatis-generator-plugins</artifactId>
  <version>1.0.8</version>
</dependency>
```

### 2. 源码构建
```bash
git clone git@gitee.com:gavincook/mybatis-generator-plugins.git
cd mybatis-generator-plugins
mvn clean package
```

## 插件列表
### 1. me.gavincook.mybatis.plugins.PaginationPlugin
分页插件。会为查询条件扩展offset偏移量和limit每页大小两个属性，来支撑分页。插件允许配置默认的分页大小，使用属性pageSize进行配置。
```xml
<plugin type="me.gavincook.mybatis.plugins.PaginationPlugin">
  <property name="pageSize" value="15"/>
</plugin>
```

### 2. me.gavincook.mybatis.plugins.ExampleCriteriaEnhancePlugin
查询条件增强，将条件addCriterion(String condition, Object value, String property)方法由protected修改为public。当需要对字段进行
函数操作过滤时非常有用。如：`concat(second_author, ',') like '%唐,%'`
```xml
<plugin type="me.gavincook.mybatis.plugins.ExampleCriteriaEnhancePlugin">
</plugin>
```

### 3. me.gavincook.mybatis.plugins.BatchInsertPlugin
批量插入插件。该插件有两个属性配置：
* pluginOn：布尔值，控制插件是否打开。
* ignoreColumns：批量插入时需要忽略的字段，多个字段名用英文逗号分隔。 使用时，直接调用xxMapper#batchInsert即可。
上述两个配置均可使用插件配置，也可以使用表配置。

```xml
<plugin type="me.gavincook.mybatis.plugins.BatchInsertPlugin">
      <property name="pluginOn" value="true"/>
    </plugin>
```
### 4. me.gavincook.mybatis.plugins.RenameMapperClassPlugin
重命名mapper类名插件。
该插件有两个属性配置：
* searchString：需要替换的字符串，支持正则匹配。
* replaceString：需要替换为的字符串。
如，下面代码片段则会将类名的`DOExample`替换为`Condition`：
```xml
<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
  <property name="searchString" value="DOExample$"/>
  <property name="replaceString" value="Condition"/>
</plugin>
```

### 5. me.gavincook.mybatis.plugins.RenameMapperXmlPlugin
重命名mapper xml文件名插件。
该插件有两个属性配置：
* searchString：需要替换的字符串，支持正则匹配。
* replaceString：需要替换为的字符串。
如，下面代码片段则会将类名的`DO`后缀去掉：
```xml
<plugin type="me.gavincook.mybatis.plugins.RenameMapperXmlPlugin">
  <property name="searchString" value="DO"/>
  <property name="replaceString" value=""/>
</plugin>
```

### 6. me.gavincook.mybatis.plugins.MapperConfigurationPlugin
mybatis配置文件生成插件。有如下三个属性：
* baseConfig： 基础配置，也即不包括`<mappers>`部分配置。常用于有一些自定的配置，如：
```xml
<settings>
     <setting name="logImpl" value="LOG4J"/>
     <setting name="callSettersOnNulls" value="true"/><!-- 用于映射value为空的字段 -->
  </settings>
```
*  targetProject: 目标工程，必须配置。
*  targetPackage: 目标包名，必须配置。
```xml
<plugin type="me.gavincook.mybatis.plugins.MapperConfigurationPlugin">
      <property name="baseConfig"
        value="&#x000A;
 &lt;settings&gt;&#x000A;
    &lt;setting name=&quot;logImpl&quot; value=&quot;LOG4J&quot;/&gt;&#x000A;
    &lt;setting name=&quot;callSettersOnNulls&quot; value=&quot;true&quot;/&gt;&lt;!-- 用于映射value为空的字段 --&gt;&#x000A;
 &lt;/settings&gt;&#x000A;
"/>
      <property name="fileName" value="mybatis-configuration.xml"/>
      <property name="targetPackage" value="resources"/>
      <property name="targetProject" value="${basedir}/src/main"/>
    </plugin>
```