在IDEA中使⽤MyBatisGenerator逆向⼯程⽣成代码
本⽂介绍⼀下⽤Maven⼯具如何⽣成Mybatis的代码及映射的⽂件。
⼀、配置l ⽂件
在l增加以下插件:
<build>
<finalName>zsxt</finalName>
<plugins>
<plugin>
<groupId&ator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
bigdecimal格式化两位小数<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>
配置好Maven插件,下⾯需要配置插件需要配置⽂件
⼆、在maven项⽬下的src/main/resources ⽬录下建⽴名为 Maven的项⽬配置⽂件存放路径如下图:l和generator.properties配置⽂件,Maven的项⽬配置⽂件存放路径如下图:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-////DTD MyBatis Generator Configuration 1.0//EN"
"/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--导⼊属性配置-->
<properties resource="generator.properties"></properties>
<!--指定特定数据库的jdbc驱动jar包的位置-->
<classPathEntry location="${jdbc.driverLocation}"/>
<context id="default" targetRuntime="MyBatis3">
<!-- optional,旨在创建class时,对注释进⾏控制 -->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--jdbc的数据库连接 -->
<jdbcConnection
driverClass="${jdbc.driverClass}"
connectionURL="${tionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
</jdbcConnection>
<!-- ⾮必需,类型处理器,在数据库类型和java类型之间的转换控制-->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- Model模型⽣成器,⽤来⽣成含有主键key的类,记录类以及查询Example类
targetPackage 指定⽣成的model⽣成所在的包名
targetProject 指定在该项⽬下所在的路径
-->
<javaModelGenerator targetPackage="st.model"
targetProject="src/main/java">
<!-- 是否允许⼦包,即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="false"/>
<!-- 是否对model添加构造函数 -->
<property name="constructorBased" value="true"/>
<!-- 是否对类CHAR类型的列的数据进⾏trim操作 -->
<property name="trimStrings" value="true"/>
<!-- 建⽴的Model对象是否不可改变即⽣成的Model对象不会有 setter⽅法,只有构造⽅法 -->
<property name="immutable" value="false"/>
</javaModelGenerator>
<!--Mapper映射⽂件⽣成所在的⽬录为每⼀个数据库的表⽣成对应的SqlMap⽂件 -->
<sqlMapGenerator targetPackage="st.mapper"
targetProject="src/main/java">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!-- 客户端代码,⽣成易于使⽤的针对Model对象和XML配置⽂件的代码
type="ANNOTATEDMAPPER",⽣成Java Model 和基于注解的Mapper对象
type="MIXEDMAPPER",⽣成基于注解的Java Model 和相应的Mapper对象
type="XMLMAPPER",⽣成SQLMap XML⽂件和独⽴的Mapper接⼝
-->
<javaClientGenerator targetPackage="st.dao"
targetProject="src/main/java" type="XMLMAPPER">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--tableName:指定了表名
domainObjectName:指定了实体类的名称
-
->
<table tableName="user" domainObjectName="user"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
</context>
</generatorConfiguration>
generator.propertites代码如下:
jdbc.driverLocation=D:\\IdeaProjects\\mybatisnixiangPro\\mavenSeting&res\\Repository\\mysql-conn\\mysql-connector-java-5.1.30.jar jdbc.sql.jdbc.Driver
jdbc.userId=root
jdbc.password=
三、在Intellij IDEA添加⼀个“Run运⾏”选项,使⽤maven运⾏mybatis-generator-maven-plugin插件
点击菜单run中Edit Configurations,会出现
点击+号,选择maven,会出现
在name和Commond line分别填上如上图所⽰,apply和ok 最后点击generator,⽣成model,mapper,dao
逆向⼯程⽣成结果如下:
由于之前配置出现⼀些问题,所以了⼀份l配置的详解:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-////DTD MyBatis Generator Configuration 1.0//EN"
"/dtd/mybatis-generator-config_1_0.dtd">
<!-- 配置⽣成器 -->
<generatorConfiguration>
<!-- 可以⽤于加载配置项或者配置⽂件,在整个配置⽂件中就可以使⽤${propertyKey}的⽅式来引⽤配置项
resource:配置资源加载地址,使⽤resource,MBG从classpath开始,⽐如com/myproject/generatorConfig.properties
url:配置资源加载地质,使⽤URL的⽅式,⽐如file:///C:/myfolder/generatorConfig.properties.
注意,两个属性只能选址⼀个;
另外,如果使⽤了mybatis-generator-maven-plugin,那么在l中定义的properties都可以直接在l中使⽤
<properties resource="" url="" />
-
->
<!-- 在MBG⼯作的时候,需要额外加载的依赖包
location属性指明加载jar/zip包的全路径
<classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />
-->
<!--
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="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="ator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="ator.api.dom.DefaultXmlFormatter"/>
<!-- beginningDelimiter和endingDelimiter:指明数据库的⽤于标记数据库对象名的符号,⽐如ORACLE就是双引号,MYSQL默认是`反引号; --> <property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 必须要有的,使⽤这个配置链接数据库
@TODO:是否可以扩展
-->
<jdbcConnection driverClass="sql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
<!-- 这⾥⾯可以设置property属性,每⼀个property属性都设置到配置的Driver上 -->
</jdbcConnection>
<!-- java类型处理器
⽤于处理DB中的类型到Java中的类型,默认使⽤JavaTypeResolverDefaultImpl;
注意⼀点,默认会先尝试使⽤Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型;
-->
<javaTypeResolver type="pes.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._batis.domain" targetProject="src/main/java">
<!-- for MyBatis3/MyBatis3Simple
⾃动为每⼀个⽣成的类创建⼀个构造⽅法,构造⽅法包含了所有的field;⽽不是使⽤setter;
-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基础上,根据数据库的schema再⽣成⼀层package,最终⽣成的类放在这个package下,默认为false -->
<property name="enableSubPackages" value="true"/>
<!-- 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._batis.domain.BaseDomain"/>
<!-- 设置是否在getter⽅法中,对String类型字段调⽤trim()⽅法 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- ⽣成SQL map的XML⽂件⽣成器,
注意,在Mybatis3之后,我们可以使⽤l⽂件+Mapper接⼝(或者不⽤mapper接⼝),
或者只使⽤Mapper接⼝+Annotation,所以,如果 javaClientGenerator配置中配置了需要⽣成XML的话,这个元素就必须配置
targetPackage/targetProject:同javaModelGenerator
-->
<sqlMapGenerator targetPackage="com._batis.mapper" targetProject="src/main/resources">
<!-- 在targetPackage的基础上,根据数据库的schema再⽣成⼀层package,最终⽣成的类放在这个pa
ckage下,默认为false -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 对于mybatis来说,即⽣成Mapper接⼝,注意,如果没有配置该元素,那么默认不会⽣成Mapper接⼝
targetPackage/targetProject:同javaModelGenerator
type:选择怎么⽣成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._batis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
<!-- 在targetPackage的基础上,根据数据库的schema再⽣成⼀层package,最终⽣成的类放在这个package下,默认为false -->
<property name="enableSubPackages" value="true"/>
<!-- 可以为所有⽣成的接⼝添加⼀个⽗接⼝,但是MBG只负责⽣成,不负责检查
<property name="rootInterface" value=""/>
-->
</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="userinfo">
<!-- 参考 javaModelGenerator 的 constructorBased属性-->
<property name="constructorBased" value="false"/>
<!-- 默认为false,如果设置为true,在⽣成的SQL中,table名字不会加上catalog或schema; -->
<property name="ignoreQualifiersAtRuntime" value="false"/>
<!-- 参考 javaModelGenerator 的 immutable 属性 -->
<property name="immutable" value="false"/>
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论