Mybatis自动生成实体类的项目内部插件(二)
之前记录了简单版的自动生成实体类和对应的xml格式的文件和mapper接口,但是弊端就是生成的实体类没有数据库自带的中文注释,而且只能生成xml文件,不能生成通用的mapper接口。
结合了Mybatis的自动生成插件和tk.mybatis的优缺点,自动生成带注释的实体类和xml格式或者注解格式。
1.新建maven项目,并且建好相应包与文件
generator.properties
#数据库驱动jar包地址
jdbc.driverLocation=D:\\oxy\\MyRepository\\mysql\\mysql-connector-java\\5.1.43\\mysql-connector-java-5.1.43.jar
jdbc.driverClass=com.mysql.jdbc.Driver
#数据库名及账号密码
jdbc.url=jdbc:mysql://127.0.0.1:3306/zs?useUnicode=true&characterEncoding=UTF-8&useSSL=true
jdbc.userId=root
jdbc.password=123456
#指定javaBean生成的位置
javaModelGenerator.targetPackage=com.test.entity
#指定sql映射文件生成的位置
sqlMapGenerator.targetPackage=mapper
#生成XxxMapper接口
javaClientGenerator.targetPackage=com.test.mapper
注意事项:
将此文件的配置信息,配置为自己的,例如驱动包位置、数据库等信息
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="generator.properties"/>
<!--指定数据库jdbc驱动jar包的位置-->
<classPathEntry location="${jdbc.driverLocation}"/>
<!-- 一个数据库一个context -->
<context id="Tables" targetRuntime="MyBatis3">
<!--先注释一运行(生成有注释的实体类)、再复制实体类包到本地文件下;再注释二和取消注释一运行(防止覆盖)-->
<!--一-->
<!--生成对应没有注释的实体类、xml类Mapper -->
<commentGenerator>
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--二-->
<!--生成对应有注释的实体类、注解类mapper-->
<!--<plugin type="tk.mybatis.mapper.generator.MapperPlugin">-->
<!--<property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>-->
<!--<!– caseSensitive默认false,当数据库表名区分大小写时,可以将该属性设置为true –>-->
<!--<property name="caseSensitive" value="true"/>-->
<!--</plugin>-->
<!-- jdbc连接 -->
<jdbcConnection driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.url}" userId="${jdbc.userId}" password="${jdbc.password}"/>
<!-- 类型转换 -->
<javaTypeResolver>
<!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
<property name="forceBigDecimals" value="true"/>
</javaTypeResolver>
<!-- 01 指定javaBean生成的位置 -->
<!-- targetPackage:指定生成的model生成所在的包名 -->
<!-- targetProject:指定在该项目下所在的路径 -->
<javaModelGenerator targetPackage="${javaModelGenerator.targetPackage}"
targetProject="src/main/java">
<!-- 是否允许子包,即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="false"/>
<!-- 是否对model添加构造函数 -->
<property name="constructorBased" value="true"/>
<!-- 是否针对string类型的字段在set的时候进行trim调用 -->
<property name="trimStrings" value="true"/>
<!-- 建立的Model对象是否 不可改变 即生成的Model对象不会有 setter方法,只有构造方法 -->
<property name="immutable" value="false"/>
<property name="overwrite" value="false"/>
</javaModelGenerator>
<!-- 02 指定sql映射文件生成的位置 -->
<sqlMapGenerator targetPackage="${sqlMapGenerator.targetPackage}"
targetProject="src/main/resources">
<!-- 是否允许子包,即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 03 生成XxxMapper接口 -->
<!-- type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 -->
<!-- type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 -->
<!-- type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
<javaClientGenerator targetPackage="${javaClientGenerator.targetPackage}"
targetProject="src/main/java" type="XMLMAPPER">
<!-- 是否在当前路径下新加一层schema,false路径com.oop.eksp.user.model, true:com.oop.eksp.user.model.[schemaName] -->
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!-- 配置表信息 -->
<!-- schema即为数据库名 -->
<!-- tableName为对应的数据库表 -->
<!-- domainObjectName是要生成的实体类 -->
<!-- enable*ByExample是否生成 example类 -->
<table schema="" tableName="student" domainObjectName="Student"
enableCountByExample="false" enableDeleteByExample="false"
enableSelectByExample="false" enableUpdateByExample="false">
<!--实体属性遵循驼峰命名-->
<property name="useActualColumnNames" value="false"/>
</table>
</context>
</generatorConfiguration>
注意事项:
1.文件内注释很清晰,需要设置的属性可以根据需要打开注释
2.数据库需要自动生成的表,每个表都需要复制下面的配置信息进行配置,有几个表就复制几段。(1:数据库表;2:实体类)
先注释一运行(生成有注释的实体类)、再复制实体类包到本地文件下;再注释二和取消注释一运行(覆盖生成的mapper接口,如若需要的是注解式开发就将mapper包和mapper文件复制下来,我这里需要的是xml方式,所以覆盖的是注解文件)
一般这种自动生成的代码都是在别的工程生成好的,再复制到现有的开发工程。
点击运行Maven命令:
说在最后的话:编写实属不易,若喜欢或者对你有帮助记得点赞+关注或者收藏哦~