mybatis-generator自动生成xml和实体类(mysql为例)

博客介绍了使用MyBatis Generator自动生成XML和实体类的配置过程。包括在pom.xml中引入包与插件,在application.properties配置数据库连接,在bootstrap.properties配置映射地址,在generatorConfig.properties配置构建,在generatorConfig.xml配置映射筛选,最后执行语句完成代码生成。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

pom.xml引入包与插件


    <dependencies>
        <!--springboot的包,与自动构建无关 start -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--springboot的包,与自动构建无关 end-->


        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--alibaba druid 连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.9</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.9</version>
        </dependency>
        <!--mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
    </dependencies>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <!-- mybatis 插件 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.5</version>
                <configuration>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
            <!--使用下边的插件可以跳过测试test中的测试 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>

1.application.properties配置数据库连接

# mysql
spring.datasource.driverClassName = com.mysql.jdbc.Driver
#datasource.type用的是alibaba的连接池,可自行定义
spring.datasource.type = com.alibaba.druid.pool.DruidDataSource
spring.datasource.name = test
spring.datasource.url = jdbc:mysql://IP:3306/数据库名?characterEncoding=utf8
spring.datasource.username = 登录名
spring.datasource.password = 密码
spring.datasource.druid.filters = stat
spring.datasource.druid.maxActive = 20
spring.datasource.druid.minIdle = 1
spring.datasource.druid.initialSize = 1
spring.datasource.druid.maxWait = 60000
spring.datasource.druid.timeBetweenEvictionRunsMillis = 60000
spring.datasource.druid.minEvictableIdleTimeMillis = 300000
spring.datasource.druid.validationQuery = select 'x'
spring.datasource.druid.testWhileIdle = true
spring.datasource.druid.testOnBorrow = false
spring.datasource.druid.testOnReturn = false
spring.datasource.druid.poolPreparedStatements = true
spring.datasource.druid.maxOpenPreparedStatements = 20

2.bootstrap.properties配置映射地址

# mybatis
mybatis.mapper-locations=classpath:mybatis/mappers/*.xml
mybatis.type-aliases-package=com.sixun.shop.model

3.generatorConfig.properties配置构建

#本地mysql-connector-java-8.0.16.jar绝对路径
drive.class.path=D:/apache-maven-3.3.9/repository/mysql/mysql-connector-java/8.0.16/mysql-connector-java-8.0.16.jar

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://IP:3306/数据库名
jdbc.username=登录账号
jdbc.password=登录密码


model.package=com.sixun.shop.model
dao.package=com.sixun.shop.dao
xml.mapper.package=resources/mybatis/mappers
target.project=src/main/java

4.generatorConfig.xml配置映射筛选

<?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="generatorConfig.properties"/>
    <!--数据库驱动包路径 -->
    <classPathEntry location="${drive.class.path}"/>
    <!--
           context:生成一组对象的环境
           id:必选,上下文id,用于在生成错误时提示
           defaultModelType:指定生成对象的样式
               1,conditional:类似hierarchical;
               2,flat:所有内容(主键,blob)等全部生成在一个对象中;
               3,hierarchical:主键生成一个XXKey对象(key class),Blob等单独生成一个对象,其他简单属性在一个对象中(record class)
           targetRuntime:
               1,MyBatis3:默认的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample;
               2,MyBatis3Simple:类似MyBatis3,只是不生成XXXBySample;
           introspectedColumnImpl:类全限定名,用于扩展MBG
       -->
    <context id="MySQLTables" targetRuntime="MyBatis3">
        <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
            一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖
         -->
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

        <!-- 不生成注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!--数据库连接信息 -->
        <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
        <!--<property name="beginningDelimiter" value="`"/>-->
        <!--<property name="endingDelimiter" value="`"/>-->
        <!-- 必须要有的,使用这个配置链接数据库
            @TODO:是否可以扩展
         -->
        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <!-- java类型处理器
            用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl;
            注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型;
        -->
        <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
            <!--
                true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型
                false:默认,
                    scale>0;length>18:使用BigDecimal;
                    scale=0;length[10,18]:使用Long;
                    scale=0;length[5,9]:使用Integer;
                    scale=0;length<5:使用Short;
             -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--生成的model 包路径 -->
        <javaModelGenerator targetPackage="${model.package}" targetProject="${target.project}">
            <!--  for MyBatis3/MyBatis3Simple
                自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter;
             -->
            <!--<property name="constructorBased" value="false"/>-->
            <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
            <property name="enableSubPackages" value="false"/>
            <!-- for MyBatis3 / MyBatis3Simple
                是否创建一个不可变的类,如果为true,
                那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类
                <property name="immutable" value="false"/>
                 设置一个根对象,如果设置了这个根对象,那么生成的keyClass或者recordClass会继承这个类;在Table的rootClass属性中可以覆盖该选项
                注意:如果在key class或者record class中有root class相同的属性,MBG就不会重新生成这些属性了,包括:
                    1,属性名相同,类型相同,有相同的getter/setter方法;
                    <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
            -->
            <!-- 设置是否在getter方法中,对String类型字段调用trim()方法 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成SQL map的XML文件生成器,
            注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),
                或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置
            targetPackage/targetProject:同javaModelGenerator
         -->
        <sqlMapGenerator targetPackage="mappers/" targetProject="src/main/resources/mybatis">
            <property name="enableSubPackages" value="ture"/>
        </sqlMapGenerator>

        <!-- 生成的Dao接口 的包路径 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="${dao.package}" targetProject="${target.project}">
            <property name="enableSubPackages" value="ture"/>
        </javaClientGenerator>

        <!--
           选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素
           选择的table会生成一下文件:
           1,SQL map文件
           2,生成一个主键类;
           3,除了BLOB和主键的其他字段的类;
           4,包含BLOB的类;
           5,一个用户生成动态查询的条件类(selectByExample, deleteByExample),可选;
           6,Mapper接口(可选)

           tableName(必要):要生成对象的表名;
           注意:大小写敏感问题。正常情况下,MBG会自动的去识别数据库标识符的大小写敏感度,在一般情况下,MBG会
               根据设置的schema,catalog或tablename去查询数据表,按照下面的流程:
               1,如果schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询;
               2,否则,如果数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找;
               3,否则,如果数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找;
               4,否则,使用指定的大小写格式查询;
           另外的,如果在创建表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种情况下也会使用给定的大小写来创建表名;
           这个时候,请设置delimitIdentifiers="true"即可保留大小写格式;

           可选:
           1,schema:数据库的schema;
           2,catalog:数据库的catalog;
           3,alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName
           4,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;
           5,enableInsert(默认true):指定是否生成insert语句;
           6,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);
           7,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;
           8,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);
           9,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);
           10,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;
           11,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);
           12,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);
           13,modelType:参考context元素的defaultModelType,相当于覆盖;
           14,delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,如果类似MYSQL这样的数据库,使用的是`(反引号,那么还需要设置context的beginningDelimiter和endingDelimiter属性)
           15,delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false,delimitIdentifiers参考context的属性

           注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写;
        -->



        <-- 实体表配置,需要导出哪些表就配哪些 -->
        <table tableName="填写表名称"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false" >
        </table>
        
    </context>
</generatorConfiguration>

5.执行语句

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值