# mybatis_generator

**Repository Path**: liviluo/mybatis_generator

## Basic Information

- **Project Name**: mybatis_generator
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-13
- **Last Updated**: 2022-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mybatis 代码自动生成工具（mysql版）
此方法只适用于mysql数据库，oracle数据库请查看[oracle分支](https://gitee.com/liviluo/mybatis_generator/tree/oracle/)

## 生成命令
```text
mybatis-generator:generate
```

## 步骤
1. 添加maven插件`pom.xml`
```xml
	<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
            <configuration>
                <!-- 在控制台打印执行日志 -->
                <verbose>true</verbose>
                <!-- 重复生成时会覆盖之前的文件 -->
                <overwrite>true</overwrite>
                <configurationFile>src/main/resources/mybatis/generatorConfig.xml</configurationFile>
            </configuration>
            <dependencies>
                <!-- 数据库连接选择8.0以上的，因为用的mysql8.0 -->
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.28</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>
```

2. 代码生成配置`generatorConfig.xml`
```xml
<generatorConfiguration>
    <!-- 引入配置文件 -->
    <properties resource="application.properties"/>
    <!-- context 是逆向工程的主要配置信息 -->
    <!-- id：起个名字 -->
    <!-- targetRuntime：设置生成的文件适用于那个 mybatis 版本 -->
    <context id="default" targetRuntime="MyBatis3">
        <!--optional,指在创建class时，对注释进行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <!--jdbc的数据库连接 wg_insert 为数据库名字 -->
        <jdbcConnection driverClass="${driverClassName}"
                        connectionURL="${url}" userId="${username}" password="${password}">
            <!-- 解决table schema中有多个重名的表生成表结构不一致问题 -->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!--非必须，类型处理器，在数据库类型和java类型之间的转换控制 -->
        <javaTypeResolver>
            <!-- 默认情况下数据库中的 decimal，bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
            <!-- 不是 double 和 long 类型 -->
            <!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
        <!-- targetPackage：生成的实体类所在的包 -->
        <!-- targetProject：生成的实体类所在的硬盘位置 -->
        <javaModelGenerator targetPackage="${entity.location}"
                            targetProject="src/main/java">
            <!-- 是否允许子包 -->
            <property name="enableSubPackages" value="false" />
        </javaModelGenerator>
        <!-- targetPackage 和 targetProject：生成的 mapper 文件的包和位置 -->
        <sqlMapGenerator targetPackage="${mapper.xml.location}"
                         targetProject="src/main/resources">
            <!-- 针对数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage 和 targetProject：生成的 interface 文件的包和位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="${mapper.location}" targetProject="src/main/java">
            <!-- 针对 oracle 数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- tableName是数据库中的表名，domainObjectName是生成的JAVA模型名，后面的参数不用改，要生成更多的表就在下面继续加table标签 -->
        <table tableName="${table.name}" domainObjectName="${entity.name}"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>
```
3. 将数据信息和生成代码的位置和名称配置到`application.propreties`，方便更改
```text
# 数据库连接信息
driverClassName = com.mysql.cj.jdbc.Driver
url = jdbc:mysql://localhost:3306/shop-demo?useUnicode=true;characterEncoding=utf-8
username = livi
password = 123456

# 数据表名
table.name = user
# 生成实体和mapper的名称
entity.name = User
# 生成实体存放的位置
entity.location = com.shop.model
# 生成mapper接口存放的位置
mapper.location = com.shop.mapper
# 生成xml的位置
mapper.xml.location = mybatis/mapper
```