mybatis是一个简单易用的优秀框架,但是我们可以让它更优秀的为我们服务,今天介绍的就是mybatis的一个神奇插件,使用它可以减少我们很多工作量,无需我们手动编写代码就可以实现自动生成。不过这里自动生成的都是简单方法,如果需要更复杂的sql语句或者实现,还是需要手动去添加的,但是已经为我们减少了很大一部分的工作量了。
话不多说,开始讲解。
mybatis的代码自动生成
首先开一下我们在使用插件前需要做什么。
第一,要先在数据库中建好表,并设计好表结构,字段等等,总之就是表要建好,因为这个插件是根据表的内容生成代码的,所以表的内容不能有问题。
第二,要在maven项目的pom文件中配置好插件信息。如下
依赖的包
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.42</version>
</dependency>
插件信息
<!-- mvn mybatis-generator:generate -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
</configuration>
<dependencies>
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.42</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.6.1</version>
<configuration>
<source>1.5</source>
<target>1.5</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
插件配置中需要注意两点,一个是对配置文件位置的引用
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
另外一个是数据库驱动。
接下来是准备配置文件。
配置文件有两个,放在resources文件夹下
第一个
generatorConfig.properties
jdbc_driverPath=D:/Maven/m2/mysql/mysql-connector-java/5.1.42/mysql-connector-java-5.1.42.jar
jdbc_driverClassName=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/csdn?useUnicode=true&characterEncoding=UTF-8&useSSL=false
jdbc_username=root
jdbc_password=""
targetProject=E:/CSDN_Blog/SSM/src/main/java
modelPackage=com.ptteng.POJO
mapperPackage=com.ptteng.Dao
mappingPackage=mapping
这里需要注意的是数据库连接配置,帐密配置,当前项目的文件路径配置,尤为注意的是项目路径不要带中文,不然会出现中文乱码的错误;然后下面三个配置分别对应实体类所在文件夹,dao所在文件夹以及mapping.xml所在文件夹。
第二个文件、
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="mybatis-generator/generatorConfig.properties" />
<classPathEntry location="${jdbc_driverPath}" />
<context id="my" targetRuntime="MyBatis3">
<commentGenerator>
<property name="suppressDate" value="false" />
<!-- 下面一行用于取消注释的生成 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<jdbcConnection driverClass="${jdbc_driverClassName}" connectionURL="${jdbc_url}" userId="${jdbc_username}" password="${jdbc_password}" />
<javaModelGenerator targetPackage="${modelPackage}" targetProject="${targetProject}">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<sqlMapGenerator targetPackage="${mappingPackage}" targetProject="${targetProject}">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<javaClientGenerator targetPackage="${mapperPackage}" targetProject="${targetProject}" type="XMLMAPPER">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!--schema数据库名,tableName表名,domainObjectName生成的Dao名-->
<table schema="csdn" tableName="person" domainObjectName="Person"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
<!--<columnRenamingRule searchString="^D_" replaceString=""/> -->
</table>
</context>
</generatorConfiguration>
这个文件里面的信息相信你都能看懂,不过我还是简单提一下。
<properties resource="mybatis-generator/generatorConfig.properties" />
<classPathEntry location="${jdbc_driverPath}" />
这块是引用刚才的配置文件,以及配置jdbc_driver的路径。
<jdbcConnection driverClass="${jdbc_driverClassName}" connectionURL="${jdbc_url}" userId="${jdbc_username}" password="${jdbc_password}" />
配置jdbc连接信息
<javaModelGenerator targetPackage="${modelPackage}" targetProject="${targetProject}">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
实体类信息
<sqlMapGenerator targetPackage="${mappingPackage}" targetProject="${targetProject}">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
mapping配置文件信息
<javaClientGenerator targetPackage="${mapperPackage}" targetProject="${targetProject}" type="XMLMAPPER">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
mapper信息(就是dao)
<!--schema数据库名,tableName表名,domainObjectName生成的Dao名-->
<table schema="csdn" tableName="person" domainObjectName="Person"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
<!--<columnRenamingRule searchString="^D_" replaceString=""/> -->
</table>
这部分是关键,和数据库关联的表的相关信息,不要配错,可以一次配置多张表。
完成上面的步骤后,启动插件就可以了。
什么?你说你不知道怎么启动?
好吧好吧,我就讲一遍啊。
双击即可。
当然你如果觉得这种方式不符合你的逼格,那么你可能希望在cmd上使用命令行的方式运行,你就可以使用命令java -jar 自动jar包 -configfile 配置的xml文件 -overwrite
拉到吧,有方便的方法不用,非要用麻烦的,有病吧,喂
看一下我的生成结果
Eclipse如何使用这个自动插件
首先pom.xml
中还是把mybatis-generator-maven-plugin
这个插件配置好,然后如何启动这个插件是个问题,找了一些都说要安装离线插件什么的,这不是我想要的,经过不懈努力终于让我找到我想要的了。
配置和在IDEA中一样,不用改动,只不过在使用这个插件的时候需要一点骚操作。
右键项目 ——> Run as ——> Maven build;然后在弹出的框中,找到goals并输入mybatis-generator:generate
然后刷新项目就出现自动生成出来的代码了。