Eclipse MyBatis Generator自动生成代码实体类及mapper.xml 阳光穿透心脏的1/2处 2022-05-26 02:12 153阅读 0赞 # MyBatis Generator插件安装 # 1、打开Eclipse,按照【Help】 -> 【Eclipse Marketplace...】打开选项; 2、搜索输入MyBatis Generator,点击【Go】,如下图,然后点击右下角的【Install】(如果已经安装,则会出现如下图的两个按钮【Update】【UnInstall】)即开始安装,安装完成后重启Eclipse。 ![70][] 3、验证是否安装成功: 打开Eclipse,【File】 -> 【New】->【Other..】,打开页面,出现【MyBatis】->【MyBatis Genetator Configuration File】选项既为安装成功: ![70 1][] # generatorConfig.xml配置 # 1、创建generatorConfig.xml文件 在根目录下右键New -> MyBatis -> MyBatis Generator Configuration File 即可创建generatorConfig.xml文件 <table> <tbody> <tr> <td><?xml version="1.0" encoding="UTF-8"?><br><!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><br><generatorConfiguration><br> <context id="context1"><br> <jdbcConnection connectionURL="???" driverClass="???" password="???" userId="???" /><br> <javaModelGenerator targetPackage="???" targetProject="???" /><br> <sqlMapGenerator targetPackage="???" targetProject="???" /><br> <javaClientGenerator targetPackage="???" targetProject="???" type="XMLMAPPER" /><br> <table schema="???" tableName="???"><br> <columnOverride column="???" property="???" /><br> </table><br> </context><br></generatorConfiguration></td> </tr> </tbody> </table> 2、修改后的generatorConfig.xml文件 <table> <tbody> <tr> <td><?xml version="1.0" encoding="UTF-8"?> <br><!DOCTYPE generatorConfiguration <br> PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" <br> "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <br> <br><generatorConfiguration> <br> <classPathEntry location="E:\mavenCK\mysql\mysql-connector-java\5.1.29\mysql-connector-java-5.1.29.jar" /> <br> <br> <context id="Mysql2Tables" targetRuntime="MyBatis3"><br> <!-- 指定生成的java文件的编码,没有直接生成到项目时中文可能会乱码 --><br> <property name="javaFileEncoding" value="UTF-8"/><br> <!-- 格式化java代码--><br> <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/><br> <!-- 格式化XML代码--><br> <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/><br> <!-- 注释<br> type路径为实现类的类全路径,重构CommentGenerator类,注释由英文改为中文<br> --><br> <commentGenerator type="com.flight.manager.MyCommentGenerator"><br> <property name="suppressAllComments" value="false" /><!-- 是否取消注释 --><br> <property name="suppressDate" value="false" /> <!-- 是否生成注释代时间戳--><br> </commentGenerator><br> <br> <!-- mysql配置 需要改成自己配置的数据库信息 --><br> <jdbcConnection driverClass="com.mysql.jdbc.Driver" <br> connectionURL="jdbc:mysql://localhost:3306/test" <br> userId="root" <br> password="root"><br> <!-- 针对mysql数据库 --><br> <property name="useInformationSchema" value="true"></property> <br> </jdbcConnection> <br> <!-- Oracle配置<br> <jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver"<br> connectionURL="jdbc:oracle:thin:@远程ip地址或localhost:1521:orcl" userId="用户名"<br> password="密码"><br> 针对oracle数据库<br> <property name="remarksReporting" value="true"></property><br> </jdbcConnection><br> --> <br> <br> <!-- 非必需,类型处理器,在数据库类型和java类型之间的转换控制<br> true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型<br> false:默认,<br> scale>0;length>18:使用BigDecimal;<br> scale=0;length[10,18]:使用Long;<br> scale=0;length[5,9]:使用Integer;<br> scale=0;length<5:使用Short;<br> --><br> <javaTypeResolver > <br> <property name="forceBigDecimals" value="true" /> <br> </javaTypeResolver> <br> <br> <!-- Model模型生成器,用来生成含有主键key的类,记录类 以及查询Example类<br> <span style="color:#000000;"> <span style="color:#FF0000;"> </span><span style="background-color:rgb(255,255,255);"><span style="color:#FF0000;">targetPackage 指定生成的model生成所在的包名,一般都是以项目名开头的路径:flight-manager-web/src/main/java</span><br> targetProject 指定在该项目下所在的路径</span></span><br> --><br> <javaModelGenerator targetPackage="com.flight.manager.model" targetProject="flight-manager-web/src/main/java"><br> <!-- 是否对model添加 构造函数 --><br> <property name="constructorBased" value="false"/><br><br> <!-- 是否允许子包,即targetPackage.schemaName.tableName --><br> <property name="enableSubPackages" value="false"/><br><br> <!-- 建立的Model对象是否 不可改变 即生成的Model对象不会有 setter方法,只有构造方法 --><br> <property name="immutable" value="false"/><br><br> <!-- 给Model添加一个父类 --><br> <!--<property name="rootClass" value="com.flight.manager.Hello"/>--><br><br> <!-- 是否对类CHAR类型的列的数据进行trim操作 --><br> <property name="trimStrings" value="true"/><br> </javaModelGenerator><br> <br> <!-- 生成SQL map的XML文件生成器,<br> 注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),<br> 或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置<br> targetPackage/targetProject:同javaModelGenerator<br> --><br> <sqlMapGenerator targetPackage="com.flight.manager.mapper.xml" targetProject="flight-manager-web/src/main/java"><br> <property name="enableSubPackages" value="false"/><br> </sqlMapGenerator><br> <br> <!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口<br> targetPackage/targetProject:同javaModelGenerator<br> type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):<br> 1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;<br> 2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;<br> 3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;<br> 注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER<br> --><br> <javaClientGenerator type="XMLMAPPER" targetPackage="com.flight.manager.mapper" targetProject="flight-manager-web/src/main/java"><br> <property name="enableSubPackages" value="false"/><br> </javaClientGenerator><br> <br> <br> <!-- 选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素<br> 选择的table会生成一下文件:<br> 1,SQL map文件<br> 2,生成一个主键类;<br> 3,除了BLOB和主键的其他字段的类;<br> 4,包含BLOB的类;<br> 5,一个用户生成动态查询的条件类(selectByExample,deleteByExample),可选;<br> 6,Mapper接口(可选)<br> tableName(必要):要生成对象的表名;<br> 注意:大小写敏感问题。正常情况下,MBG会自动的去识别数据库标识符的大小写敏感度,在一般情况下,MBG会<br> 根据设置的schema,catalog或tablename去查询数据表,按照下面的流程:<br> 1,如果schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询;<br> 2,否则,如果数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找;<br> 3,否则,如果数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找;<br> 4,否则,使用指定的大小写格式查询;<br> 另外的,如果在创建表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种情况下也会使用给定的大小写来创建表名;<br> 这个时候,请设置delimitIdentifiers="true"即可保留大小写格式;<br> <br> 可选:可以以property的形式写在table标签中,也可以直接写在table标签属性中<br> 1,schema:数据库的schema;<br> 2,catalog:数据库的catalog;<br> 3,alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName<br> 4,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;<br> 5,enableInsert(默认true):指定是否生成insert语句;<br> 6,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);<br> 7,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;<br> 8,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);<br> 9,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);<br> 10,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;<br> 11,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);<br> 12,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);<br> 13,modelType:参考context元素的defaultModelType,相当于覆盖;<br> 14,delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,如果类似MYSQL这样的数据库,使用的是`(反引号,那么还需要设置context的beginningDelimiter和endingDelimiter属性)<br> 15,delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false,delimitIdentifiers参考context的属性<br><br> 注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写;<br> --><br> <table tableName="ccs_seat_info_air_bak" domainObjectName="ccsSeatInfoAirBak"><br> <!-- 注意,该属性只针对MyBatis3Simple有用;<br> 如果选择的runtime是MyBatis3Simple,那么会生成一个SelectAll方法,<br> 如果指定了selectAllOrderByClause,那么会在该SQL中添加指定的这个order条件;<br> value的值是字段名<br> <property name="selectAllOrderByClause" value="id,seat"/><br> --><br> <!-- 如果设置为true,生成的model类会直接使用column本身的名字,而不会再使用驼峰命名方法,<br> 比如BORN_DATE,生成的属性名字就是BORN_DATE,而不会是bornDate<br> --><br> <property name="useActualColumnNames" value="false"/><br> <br> <br> <!--ignoreColumn设置一个MGB忽略的列,<br> 如果设置了改列,那么在生成的domain中,生成的SQL中,都不会有该列出现column:指定要忽略的列的名字;<br> 注意,一个table元素中可以有多个ignoreColumn元素<br> <ignoreColumn column="deptId" delimitedColumnName=""/><br> --><br> <br> <!-- 指定是否只生成domain类,<br> 如果设置为true,只生成domain类,<br> 如果还配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素<br> 如果设置为false,生成domain类和domainExample类两个类<br> <property name="modelOnly" value="false"/><br> --><br> <br> <!-- generatedKey用于生成生成主键的方法,<br> 如果设置了该元素,MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素,<br> 该元素可选 column:主键的列名;<br> sqlStatement:要生成的selectKey语句,有以下可选项:<br> Cloudscape:相当于selectKey的SQL为: VALUESIDENTITY_VAL_LOCAL()<br> DB2 :相当于selectKey的SQL为: VALUESIDENTITY_VAL_LOCAL()<br> DB2_MF :相当于selectKey的SQL为:SELECT IDENTITY_VAL_LOCAL()FROM SYSIBM.SYSDUMMY1<br> Derby :相当于selectKey的SQL为:VALUESIDENTITY_VAL_LOCAL()<br> HSQLDB :相当于selectKey的SQL为:CALL IDENTITY()<br> Informix :相当于selectKey的SQL为:selectdbinfo('sqlca.sqlerrd1') from systables where tabid=1<br> MySql :相当于selectKey的SQL为:SELECTLAST_INSERT_ID()<br> SqlServer:相当于selectKey的SQL为:SELECTSCOPE_IDENTITY()<br> SYBASE :相当于selectKey的SQL为:SELECT @@IDENTITY<br> JDBC :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性<br> --><br> <generatedKey column="id" sqlStatement="MySql"/><br> <br> <!--<br> 该元素会在根据表中列名计算对象属性名之前先重命名列名,非常适合用于表中的列都有公用的前缀字符串的时候,<br> 比如列名为:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等;<br> 那么就可以设置searchString为"^CUST_",并使用空白替换,那么生成的Customer对象中的属性名称就不是<br> custId,custName等,而是先被替换为ID,NAME,EMAIL,然后变成属性:id,name,email;<br> 注意,MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的,<br> 如果使用了columnOverride元素,该属性无效;<br> <columnRenamingRule searchString="" replaceString=""/><br> --><br> <br> <!-- 用来修改表中某个列的属性,MBG会使用修改后的列来生成domain的属性;<br> column:要重新设置的列名;<br> 注意,一个table元素中可以有多个columnOverride元素哈~<br> <columnOverride column="username"> --><br> <!-- 使用property属性来指定列要生成的属性名称 --><br> <!-- <property name="property" value="userName"/>--><br> <!-- javaType用于指定生成的domain的属性类型,使用类型的全限定名<br> <property name="javaType" value=""/><br> --><br> <!--jdbcType用于指定该列的JDBC类型<br> <property name="jdbcType" value=""/><br> --><br> <!--typeHandler 用于指定该列使用到的TypeHandler,如果要指定,配置类型处理器的全限定名<br> 注意,mybatis中,不会生成到mybatis-config.xml中的typeHandler<br> 只会生成类似:where id =#{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述<br> <property name="jdbcType" value=""/><br> --><br> <!--参考table元素的delimitAllColumns配置,默认为false<br> <property name="delimitedColumnName" value=""/><br> <br> </columnOverride><br> --><br> <br> </table> <br> </context> <br></generatorConfiguration></td> </tr> </tbody> </table> # # <table> <tbody> <tr> <td><span style="color:#3333FF;">注意:generatorConfig.xml中的<table>标签可以简单写成:<br><table schema="test" tableName="ccs_seat_info_air_bak" domainObjectName="ccsSeatInfoAirBak" enaleCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <br></table><br>其中的属性是控制Mapper中是否生成的SQL语句。<br>常用的属性如下:<br>1,alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName<br> 2,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;<br>3,enableInsert(默认true):指定是否生成insert语句;<br>4,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);<br>5,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;<br>6,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);<br>7,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);<br>8,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;<br>9,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);<br>10,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);</span></td> </tr> </tbody> </table> # 生成实体类及mapper文件 # 选中generatorConfig.xml文件,右键 ->Generate MyBatis/iBATIS Artifacts 点击执行即可完成。 # ps:重写生成注释的类: # 解决生成的注释为英文的问题,重写之后,生成的注释为中文 pom.xml中引入jar包: <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.2</version> <type>jar</type> <scope>provided</scope> </dependency> com.flight.manager.mybatis.generator.MyCommentGenerator generatorConfig.xml文件引用处见commentGenerator属性 <table> <tbody> <tr> <td>package com.flight.manager;<br><br>import java.text.SimpleDateFormat;<br>import java.util.Date;<br>import java.util.Properties;<br><br>import org.mybatis.generator.api.CommentGenerator;<br>import org.mybatis.generator.api.IntrospectedColumn;<br>import org.mybatis.generator.api.IntrospectedTable;<br>import org.mybatis.generator.api.dom.java.Field;<br>import org.mybatis.generator.api.dom.java.InnerClass;<br>import org.mybatis.generator.api.dom.java.InnerEnum;<br>import org.mybatis.generator.api.dom.java.Method;<br>import org.mybatis.generator.api.dom.java.Parameter;<br>import org.mybatis.generator.internal.DefaultCommentGenerator;<br><br>/**<br> * mybatis generator 自定义comment生成器.<br> * 基于MBG 1.3.2. <br> *<br> */<br>public class MyCommentGenerator extends DefaultCommentGenerator implements CommentGenerator{ <br><br> private Properties properties; <br> private Properties systemPro;<br> private boolean suppressDate;<br> private boolean suppressAllComments;<br> private String currentDateStr;<br> <br> public MyCommentGenerator() { <br> super();<br> properties = new Properties();<br> systemPro = System.getProperties();<br> suppressDate = false;<br> suppressAllComments = false;<br> currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());<br> }<br> <br> <br> @Override<br> public void addFieldComment(Field field,<br> IntrospectedTable introspectedTable,<br> IntrospectedColumn introspectedColumn) { <br> // 添加字段注释<br> StringBuffer sb = new StringBuffer();<br> field.addJavaDocLine("/**");<br> if (introspectedColumn.getRemarks() != null)<br> field.addJavaDocLine(" * " + introspectedColumn.getRemarks());<br> sb.append(" * 表字段 : ");<br> sb.append(introspectedTable.getFullyQualifiedTable());<br> sb.append('.');<br> sb.append(introspectedColumn.getActualColumnName());<br> field.addJavaDocLine(sb.toString());<br> field.addJavaDocLine(" * ");<br> field.addJavaDocLine(" */");<br> <br> //添加注解<br> /* @Column(name = "air_ways")<br> * 生成的实体类中没有引入Column类会报错,直接引入就可以了<br> StringBuffer sb1 = new StringBuffer();<br> sb1.append("@Column(name = ");<br> sb1.append("\"");<br> sb1.append(introspectedColumn.getActualColumnName());<br> sb1.append("\"");<br> sb1.append(")");<br> field.addJavaDocLine(sb1.toString());<br> */<br> }<br><br> public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) { <br> if (suppressAllComments) { <br> return;<br> }<br> StringBuilder sb = new StringBuilder();<br> innerClass.addJavaDocLine("/**");<br> sb.append(" * ");<br> sb.append(introspectedTable.getFullyQualifiedTable());<br> sb.append(" ");<br> sb.append(getDateString());<br> innerClass.addJavaDocLine(sb.toString());<br> innerClass.addJavaDocLine(" */");<br> }<br> <br> public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) { <br> if (suppressAllComments) { <br> return;<br> }<br> <br> StringBuilder sb = new StringBuilder();<br> <br> innerEnum.addJavaDocLine("/**");<br> sb.append(" * ");<br> sb.append(introspectedTable.getFullyQualifiedTable());<br> innerEnum.addJavaDocLine(sb.toString());<br> innerEnum.addJavaDocLine(" */");<br> }<br> <br> <br> public void addFieldComment(Field field, IntrospectedTable introspectedTable) { <br> if (suppressAllComments) { <br> return;<br> }<br> <br> StringBuilder sb = new StringBuilder();<br> <br> field.addJavaDocLine("/**");<br> sb.append(" * ");<br> sb.append(introspectedTable.getFullyQualifiedTable());<br> field.addJavaDocLine(sb.toString());<br> field.addJavaDocLine(" */");<br> }<br> <br> public void addGetterComment(Method method, IntrospectedTable introspectedTable,<br> IntrospectedColumn introspectedColumn) { <br> if (suppressAllComments) { <br> return;<br> }<br> <br> method.addJavaDocLine("/**");<br> <br> StringBuilder sb = new StringBuilder();<br> sb.append(" * 获取");<br> sb.append(introspectedColumn.getRemarks());<br> method.addJavaDocLine(sb.toString());<br> <br> sb.setLength(0);<br> sb.append(" * @return ");<br> sb.append(introspectedColumn.getActualColumnName());<br> sb.append(" ");<br> sb.append(introspectedColumn.getRemarks());<br> method.addJavaDocLine(sb.toString());<br> <br> // addJavadocTag(method, false);<br> <br> method.addJavaDocLine(" */");<br> }<br> <br> public void addSetterComment(Method method, IntrospectedTable introspectedTable,<br> IntrospectedColumn introspectedColumn) { <br> if (suppressAllComments) { <br> return;<br> }<br> <br> <br> method.addJavaDocLine("/**");<br> StringBuilder sb = new StringBuilder();<br> sb.append(" * 设置");<br> sb.append(introspectedColumn.getRemarks());<br> method.addJavaDocLine(sb.toString());<br> <br> Parameter parm = method.getParameters().get(0);<br> sb.setLength(0);<br> sb.append(" * @param ");<br> sb.append(parm.getName());<br> sb.append(" ");<br> sb.append(introspectedColumn.getRemarks());<br> method.addJavaDocLine(sb.toString());<br> <br> // addJavadocTag(method, false);<br> <br> method.addJavaDocLine(" */");<br> }<br> <br> public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) { <br> if (suppressAllComments) { <br> return;<br> }<br> <br> StringBuilder sb = new StringBuilder();<br> <br> innerClass.addJavaDocLine("/**");<br> sb.append(" * ");<br> sb.append(introspectedTable.getFullyQualifiedTable());<br> innerClass.addJavaDocLine(sb.toString());<br> <br> sb.setLength(0);<br> sb.append(" * @author ");<br> sb.append(systemPro.getProperty("user.name"));<br> sb.append(" ");<br> sb.append(currentDateStr);<br> <br> innerClass.addJavaDocLine(" */");<br> }<br><br>}</td> </tr> </tbody> </table> [70]: /images/20220526/f0040f2ce62b4288bdd793418c67d6aa.png [70 1]: /images/20220526/0bc7c9e542db4880b7024cbc0ee0994e.png
还没有评论,来说两句吧...