mybatis-extension-plugin 扩展生成插件

青旅半醒 2023-02-09 14:24 28阅读 0赞

### **[mybatis-extension-plugin][]** ###

地址：

** [https://github.com/uinio/mybatis-extension-plugin][mybatis-extension-plugin]**

**  **GitHub支持一下 点击star ☆

--------------------

**简介**

*  支持Mybatis3 和 mybatis-dynamic-sql
 *  注意:需要先学习mybatis-generator-maven-plugin的使用和xml配置 
 *  参考官方 [http://mybatis.org/generator/running/runningWithMaven.html][http_mybatis.org_generator_running_runningWithMaven.html]
 *  提供 Entity,Dao 扩展。
 *  提供 Service,Controller 生成

--------------------

添加依赖(示例)

<dependencies>
            <dependency>
                <groupId>com.github.uinio</groupId>
                <artifactId>mybatis-extension-plugin</artifactId>
                <version>1.4.0</version>
                <optional>true</optional>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.4.0</version>
                    <executions>
                        <execution>
                            <id>Generate MyBatis Artifacts</id>
                            <phase>deploy</phase>
                            <goals>
                                <goal>generate</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                    <dependencies>
                        
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>8.0.20</version>
                        </dependency>
                        
                        <dependency>
                            <groupId>com.github.uinio</groupId>
                            <artifactId>mybatis-extension-plugin</artifactId>
                            <version>1.4.0</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>

--------------------

插件使用

> LombokPlugin (lombok生成)

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>data</td> 
   <td>false</td> 
   <td>包含getter,setter,toString,equalsAndHashCode,requiredArgsConstructor</td> 
  </tr> 
  <tr> 
   <td>getter</td> 
   <td>false</td> 
   <td>getter</td> 
  </tr> 
  <tr> 
   <td>setter</td> 
   <td>false</td> 
   <td>getter</td> 
  </tr> 
  <tr> 
   <td>toString</td> 
   <td>false</td> 
   <td>toString</td> 
  </tr> 
  <tr> 
   <td>equalsAndHashCode</td> 
   <td>false</td> 
   <td>equalsAndHashCode</td> 
  </tr> 
  <tr> 
   <td>builder</td> 
   <td>false</td> 
   <td>builder</td> 
  </tr> 
  <tr> 
   <td>noArgsConstructor</td> 
   <td>false</td> 
   <td>noArgsConstructor</td> 
  </tr> 
  <tr> 
   <td>allArgsConstructor</td> 
   <td>false</td> 
   <td>allArgsConstructor</td> 
  </tr> 
  <tr> 
   <td>requiredArgsConstructor</td> 
   <td>false</td> 
   <td>requiredArgsConstructor</td> 
  </tr> 
 </tbody> 
</table>

<plugin>元素是<context>元素的子元素。可以在上下文中指定任意数量的插件。

示例

--------------------

> DomainPlugin (实体类扩展)

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>serializable</td> 
   <td>false</td> 
   <td>是否实现Serializable</td> 
  </tr> 
  <tr> 
   <td>dateSerialize</td> 
   <td>false</td> 
   <td>日期序列化只支持JDK8日期类型</td> 
  </tr> 
  <tr> 
   <td>json</td> 
   <td>null</td> 
   <td>日期反序列化只支持JDK8日期类型(选项: fastJson , jackson )</td> 
  </tr> 
 </tbody> 
</table>

<plugin>元素是<context>元素的子元素。可以在上下文中指定任意数量的插件。

示例

--------------------

> RepositoryPlugin (数据访问对象DAO扩展）

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>suppressAllComments</td> 
   <td>false</td> 
   <td>是否去掉生成的注释</td> 
  </tr> 
  <tr> 
   <td>repository</td> 
   <td>null</td> 
   <td>Dao父类,默认为null</td> 
  </tr> 
 </tbody> 
</table>

<plugin>元素是<context>元素的子 元素。可以在上下文中指定任意数量的插件。

示例

--------------------

> ServicePlugin (Service生成)

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>targetProject</td> 
   <td>null</td> 
   <td>生成路径例如:src/main/java</td> 
  </tr> 
  <tr> 
   <td>targetPackage</td> 
   <td>null</td> 
   <td>生成所在包路径例如:org.example.service</td> 
  </tr> 
  <tr> 
   <td>basicService</td> 
   <td>null</td> 
   <td>service接口父类, 默认为null</td> 
  </tr> 
  <tr> 
   <td>basicServiceImpl</td> 
   <td>null</td> 
   <td>serviceImpl父类, 默认为null</td> 
  </tr> 
 </tbody> 
</table>

示例

<plugin>元素是<context>元素的子元素。可以在上下文中指定任意数量的插件。

--------------------

> ControllerPlugin (Controller生成)

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>默认值</th> 
   <th>简介</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>targetProject</td> 
   <td>null</td> 
   <td>生成路径例如:src/main/java</td> 
  </tr> 
  <tr> 
   <td>targetPackage</td> 
   <td>null</td> 
   <td>生成所在包路径例如:org.example.controller</td> 
  </tr> 
  <tr> 
   <td>rest</td> 
   <td>false</td> 
   <td>true为@RestController,false为@Controller</td> 
  </tr> 
  <tr> 
   <td>respond</td> 
   <td>null</td> 
   <td>controller返回结果集 默认为null</td> 
  </tr> 
 </tbody> 
</table>

<plugin>元素是<context>元素的子元素。可以在上下文中指定任意数量的插件。 示例

生成展示(部份代码)

@Slf4j
    @RestController
    @RequestMapping("example")
    public class ExampleController {
    
        @Autowired
        private ExampleService exampleService;
        
        @GetMapping("findAll")
        public Respond findAll() {
           return null;
        }
        //...
    }

--------------------

> 生成

*  idea打开右侧  maven->plugins->mybatis-generator->  mybatis-generator:generator  点击执行
 *  或 mvn mybatis-generator:generator

[mybatis-extension-plugin]: https://github.com/uinio/mybatis-extension-plugin
[http_mybatis.org_generator_running_runningWithMaven.html]: http://mybatis.org/generator/running/runningWithMaven.html