如何用IDEA创建一个mybatis项目框架,用mybatis插件自动生成核心配置文件、mapper映射文件、实体类和接口。
1、首先打开IDEA,选择新建项目,如下选择maven-quickstart,只需要提供maven管理包,所以选择quickstart即可。
2、在pom.xml导入依赖包和导入第三方插件mybatis.generator
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.15</version>
</dependency>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
3、 创建资源包,用于链接数据库(也可以不用,直接在配置文件中写,规范起见创建资源包)放于resources资源文件夹下。
resources/db.properties
内容如下:
jdbc.driverLocation=C:\\Users\\DELL\\.m2\\repository\\mysql\\mysql-connector-java\\8.0.15\\mysql-connector-java-8.0.15.jar
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/liuyan?characterEncoding=UTF-8&serverTimezone=UTC
jdbc.userId=user
jdbc.password=***
这里需要注意,第三行url中的/3306后面要改成自己数据库的schema,
第一行driverlocation要根据自己的电脑修改,一般是改Users后面的名称。
4、在资源目录resources下,创建生成器generator的配置文件generatorConfig.xml(名字不能错),用于自动生成mybatis配置文件、DAO接口等。
代码如下,各项标签作用都有备注,一般不用大的改动,需要改动的地方在最后<table>标签,用于指明需要导入的表和对应的实体类名。
<?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="db.properties"></properties>
<!--指定特定数据库的jdbc驱动jar包的位置-->
<classPathEntry location="${jdbc.driverLocation}"/>
<!--classPathEntry location="/Users/apple/.m2/repository/mysql/mysql-connector-java/8.0.15/mysql-connector-java-8.0.15.jar"/ -->
<context id="default" targetRuntime="MyBatis3">
<!-- optional,旨在创建class时,对注释进行控制 -->
<!--suppressDate是去掉生成日期那行注释,suppressAllComments是去掉所有的注解;另外,commentGenerator还可以配置一个type,设置自己的注解生成器,默认使用的是org.mybatis.generator.internal.DefaultCommentGenerator;-->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--jdbc的数据库连接 -->
<jdbcConnection
driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.connectionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
</jdbcConnection>
<!-- Model模型生成器,用来生成含有主键key的类,记录类以及查询Example类,属性targetPackage 指定生成的model生成所在的包名
属性targetProject 指定在该工程下包所在的路径-->
<javaModelGenerator targetPackage="com.dhu.pojo"
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="main.resources.mapper"
targetProject="src">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator targetPackage="com.dao"
targetProject="src/main/java" type="XMLMAPPER">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--tableName:指定了表名 domainObjectName:指定了实体类的名称 -->
<table tableName="usertable" domainObjectName="User"
enableCountByExample="false"
enableUpdateByExample="false"
enableDeleteByExample="false"
enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
</context>
</generatorConfiguration>
5、 接下来就是运行插件了,在IDEA中配置一个“Run”,使用maven运行mybatis-generator-maven-plugin插件。创建步骤如下:
命令:mybatis-generator:generate -e
其他不用改,输入命令行确认即可。
RUN运行
运行完成后的目录如下:
到此已经完成了自动生成功能,已经完成了mapper接口、Entity实体类、mapper映射文件的生成。
如果还想用于生成其他表的映射,在generatorConfig.xml中修改<table>内容,再次RUN运行即可。