Mybatis如何配置generator代码生成器插件

来源:互联网 发布:个人收支软件app 编辑:程序博客网 时间:2024/06/09 19:24

1.新建maven项目,在pom.xml文件中添加maven编译插件maven-compiler-plugin和mybatis-generator-maven-plugin插件:

注意: mybatis-generator-maven-plugin插件需要单独配置数据库链接。

<build>        <plugins>            <plugin>                <groupId>org.apache.maven.plugins</groupId>                <artifactId>maven-compiler-plugin</artifactId>                <version>2.2</version>                <configuration>                    <source>1.7</source>                    <target>1.7</target>                </configuration>            </plugin>                        <plugin>                <groupId>org.mybatis.generator</groupId>                <artifactId>mybatis-generator-maven-plugin</artifactId>                <version>1.3.2</version>                <configuration>                    <verbose>true</verbose>                    <overwrite>false</overwrite>                </configuration>                <!--插件需要单独配置数据库链接-->                <dependencies>                    <dependency>                        <groupId>mysql</groupId>                        <artifactId>mysql-connector-java</artifactId>                        <version>5.1.21</version>                    </dependency>                </dependencies>            </plugin>        </plugins>    </build>

2.在src/main/resource资源文件中添加代码生成器的配置文件generatorConfig.xml
注意:要修改该文件中关于数据库连接的配置、生成文件位置路径的配置、以及对应DB表名。

generatorConfig.xml内容如下:

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><!-- 配置生成器 --><generatorConfiguration><context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"><!-- 自动识别数据库关键字,默认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" /><!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; --><property name="beginningDelimiter" value="`" /><property name="endingDelimiter" value="`" /><commentGenerator><property name="suppressDate" value="true" /><property name="suppressAllComments" value="true" /></commentGenerator><!-- 必须要有的,使用这个配置链接数据库 @TODO:是否可以扩展 --><jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///test" userId="root" password="admin"><!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 --></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><!-- java模型创建器,是必须要的元素 负责:1,key类(见context的defaultModelType);2,java类;3,查询类targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制; targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录 --><javaModelGenerator targetPackage="com.pingan.groupinsure.base.domain" targetProject="src/main/java"><!-- for MyBatis3/MyBatis3Simple 自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter; --><property name="constructorBased" value="false" /><!-- for MyBatis3 / MyBatis3Simple 是否创建一个不可变的类,如果为true, 那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类 --><property name="immutable" value="false" /><!-- 设置是否在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="com.pingan.groupinsure.base.mapper" targetProject="src/main/resources"><!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --><property name="enableSubPackages" value="true" /></sqlMapGenerator><!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口 targetPackage/targetProject:同javaModelGeneratortype:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下): 1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中; 3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER --><javaClientGenerator targetPackage="com.pingan.groupinsure.base.mapper" type="XMLMAPPER" targetProject="src/main/java"><!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --><property name="enableSubPackages" value="true" /><!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,不负责检查 <property name="rootInterface"value=""/> --></javaClientGenerator><table tableName="employees"><!-- 参考 javaModelGenerator 的 constructorBased属性 --><property name="constructorBased" value="false" /><generatedKey column="employee_id" sqlStatement="JDBC" /></table></context></generatorConfiguration>

3.配置好之后如何运行呢?
方法一:使用cmd命令行。(前提是配置了mvn)
在pom.xml这一级目录的命令行窗口执行mvn mybatis-generator:generate即可生成。

cmd


方式二:在Eclipse中配置命令。



之后在Eclipse菜单栏的小蜘蛛图标中就可以看到刚刚配置的命令了:




方式三:在intellij IDEA中,pom.xml中配置插件之后,直接点击右侧maven project中该插件即可生成。



大功告成。代码生成器会生成3个文件,如类文件Employees.java  Mapper接口文件EmployeesMapper.java,以及Mybatis映射文件EmployeesMapper.xml.

1 0
原创粉丝点击