# mybatis-generator-plugin-ext

**Repository Path**: lapuda858/mybatis-generator-plugin-ext

## Basic Information

- **Project Name**: mybatis-generator-plugin-ext
- **Description**: mybatis generator plugin 扩展，扩展常用方法，与实体类的注释，当前支持mysql ,oracle
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2020-07-01
- **Last Updated**: 2022-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mybatis-generator-plugin-ext

#### 介绍
基于mybatis-generator-maven-plugin 1.4.0 进行扩展，当前支持mysql ,oracle，主要了扩展常用方法，与实体类的注释，
项目代码简单易懂，可根据实际应用灵活扩展。
扩展方法如下：
- `selectOne`
- `selectList`
- `insertBatch`
- `deleteBatchIds`
- `selectBatchIds`

实体类注释

```
/** 
 * @Description: 人员
 * @WARNING This class was generated by MyBatis Generator, do not modify.
 */
public class Person implements Serializable {

    private String id;

    /** 姓名 */
    private String name;

    /** 年龄 */
    private String age;

    /** 备注 */
    private String bz;
```

#### 使用教程
##### 写在前面：使用本插件应该对mybatis generator plugin 有所了解，基本使用方法。

1. 将代码clone到本地，使用maven install到本地仓库
2. 在将要使用的项目上进行引用，应用方式如下， **注意在plugin中引用哦** 

```
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
        <configurationFile>src/main/resources/gen/generatorConfiguration.xml</configurationFile>
    </configuration>
    <dependencies>
        <dependency>
            <artifactId>mybatis-generator-plugin-ext</artifactId>
            <groupId>mybatis.generator.plugin</groupId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</plugin>
```
3. 在对应的`generatorConfiguration.xml`配置文件添加如下配置， **注意位置** 
    1. 在`<context>` 节点下添加插件配置，其中`<property>`的`type`属性支持`mysql`与`oracle`
    ```
    <plugin type="mybatis.generator.plugin.plugins.CustomPlugin">
	<property name="type" value="oracle" />
    </plugin>`
    ```
    2.`<commentGenerator>`节点添加type属性,如下：
     ```
    <commentGenerator type="mybatis.generator.plugin.plugins.CustomComment">
	<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
	<property name="suppressAllComments" value="true" />
    </commentGenerator>
    ```
#### 完整配置文件

```
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
	<properties resource="gen\config.properties"/>
	<!--<classPathEntry location="src/main/resources/gen/mysql-connector-java-5.1.45.jar"/>-->
	<classPathEntry location="src/main/resources/gen/ojdbc6-11.2.0.3.jar"/>

	<context id="sqlserverTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
	<!-- 生成的pojo，将implements Serializable -->
	<plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
	<plugin type="mybatis.generator.plugin.plugins.CustomPlugin">
		<property name="type" value="oracle" />
	</plugin>
	<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
	<commentGenerator type="mybatis.generator.plugin.plugins.CustomComment">
		<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
		<property name="suppressAllComments" value="true" />
	</commentGenerator>

	<!-- 数据库链接URL、用户名、密码 -->
	<jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}">
		<!-- 设置 useInformationSchema 属性为 true 针对MySQL获取表注释-->
		<property name="useInformationSchema" value="true" />
		<!-- 针对oracle 获取表注解信息-->
		<property name="remarksReporting" value="true"></property>
	</jdbcConnection>

	<javaTypeResolver>
		<property name="forceBigDecimals" value="false" />
	</javaTypeResolver>

	<javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java" >
		<property name="enableSubPackages" value="true" />
		<property name="trimStrings" value="true" />
	</javaModelGenerator>

	<!--对应的mapper.xml文件 -->
	<sqlMapGenerator targetPackage="com.example.demo.mapper" targetProject="src/main/java">
		<property name="enableSubPackages" value="true" />
	</sqlMapGenerator>

	<!-- 对应的Mapper接口类文件 -->
	<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.mapper" targetProject="src/main/java">
		<property name="enableSubPackages" value="true" />
	</javaClientGenerator>

	<!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
	<table tableName="person" domainObjectName="Person"></table>

	</context>
</generatorConfiguration>
```

#### MyBatis Generator中文文档
网上找的一篇博客
> https://www.cnblogs.com/yjbjingcha/p/8427562.html
#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request