MyBatis Generator最佳实践
针对MyBatis3
关于实体类的modelType,建议使用defaultModelType="flat",只有一个对象的情况下管理毕竟方便,使用也简单。
关于注释<commentGenerator>,不管你是否要重写自己的注释生成器,有一点不能忘记,那就是注释中一定要保留@mbggenerated,MBG通过该字符串来判断代码是否为代码生成器生成的代码,有该标记的的代码在重新生成的时候会被删除,不会重复。不会在XML中出现重复元素。
使用MBG生成的代码时,建议尽可能不要去修改自动生成的代码,而且要生成带有@mbggenerated,这样才不会在每次重新生成代码的时候需要手动修改好多内容。
仍然是注释相关,在<commentGenerator>中,建议一定要保留suppressAllComments属性(使用默认值false),一定要取消(设为true)时间戳suppressDate,避免重复提交SVN。
<jdbcConnection>建议将JDBC驱动放到项目的classpath下,而不是使用<classPathEntry>来引入jar包,主要考虑到所有开发人员的统一性。
当数据库字段使用CHAR时,建议在<javaModelGenerator>中设置<property name="trimStrings" value="true" />,可以自动去掉不必要的空格。
在<javaClientGenerator>中,建议设置type="XMLMAPPER",不建议使用注解或混合模式,比较代码和SQL完全分离易于维护。
建议尽可能在<table>中配置<generatedKey>,避免手工操作,以便于MBG重复执行代码生成。
如果有其他有价值的经验,会继续补充。
综合以上信息,这里给出一个Mysql
的简单配置:
<?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> <context id="MysqlContext" targetRuntime="MyBatis3" defaultModelType="flat"> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <commentGenerator> <property name="suppressDate" value="true"/> </commentGenerator> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password=""> </jdbcConnection> <javaModelGenerator targetPackage="test.model" targetProject="src\main\java"> <property name="trimStrings" value="true" /> </javaModelGenerator> <sqlMapGenerator targetPackage="test.xml" targetProject="src\main\resources"/> <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="src\main\java"/> <table tableName="%"> <generatedKey column="id" sqlStatement="Mysql"/> </table> </context> </generatorConfiguration>
<table>
这里用的通配符匹配全部的表,另外所有表都有自动增长的id
字段。如果不是所有表的配置都一样,可以做针对性的配置。
改动: 去掉来不建议使用Example查询的建议,Example在单表操作上优势明显,可以看个人情况使用。
参考