作者:追梦1819 原文:https://www.cnblogs.com/yanfei1819/p/10894278.html 版权声明:本文为博主原创文章,转载请附上博文链接!
注意:本章有大量代码,慎入。
MyBatis Generator 是 MyBatis 代码生成器。
MyBatis 是一个ORM 的半自动框架,需要手动维护大量的 mapper.xml 文件和 POJO 类。 MyBatis Generator 为了完善 MyBatis 的这个缺点而出现。自动生成 Java POJOs、map.xml、代理接口、以及常规的 CRUD 方法。
本项目是通过 maven 构建的 SpringBoot 项目。
首先,在pom.xml 文件中引入相关的插件:
<build> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <executions> <execution> <id>Generate MyBatis Artifacts</id> <phase>deploy</phase> <goals> <goal>generate</goal> </goals> </execution> </executions> <configuration> <!-- generator 工具配置文件的位置 --> <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile> <verbose>true</verbose> <overwrite>true</overwrite> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.34</version> </dependency> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.2</version> </dependency> </dependencies> </plugin> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <classifier>exec</classifier> </configuration> </plugin> </plugins> </build>这个引入的插件基本上都能看懂。不过需要特别注意的一点是,mybatis generator 插件单独依赖 MySQL 驱动,所以在插件中必须单独引入 MySQL 驱动包。否则会报错。
其次,根据 pom.xml 文件中指定的 generator 工具配置文件的位置,创建工具配置文件:
<?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> <!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e --> <!-- 引入配置文件 --> <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/> <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 --> <!--<classPathEntry location="D:\generator_mybatis\mysql-connector-java-5.1.24-bin.jar" /> --> <!-- 一个数据库一个context --> <!--defaultModelType="flat" 大数据字段,不分表 --> <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat"> <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表; 一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 --> <property name="autoDelimitKeywords" value="true" /> <!-- 生成的Java文件的编码 --> <property name="javaFileEncoding" value="utf-8" /> <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; --> <property name="beginningDelimiter" value="`" /> <property name="endingDelimiter" value="`" /> <!-- 格式化java代码 --> <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/> <!-- 格式化XML代码 --> <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> <plugin type="org.mybatis.generator.plugins.SerializablePlugin" /> <plugin type="org.mybatis.generator.plugins.ToStringPlugin" /> <!-- 注释 --> <commentGenerator > <property name="suppressAllComments" value="false"/><!-- 是否取消注释 --> <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳--> </commentGenerator> <!-- jdbc连接 --> <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" /> <!-- 类型转换 --> <javaTypeResolver> <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) --> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- 生成实体类地址 --> <javaModelGenerator targetPackage="com.yanfei1819.mybatisgeneratordemo.db.dto" targetProject="${project}" > <property name="enableSubPackages" value="false"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成mapxml文件 --> <sqlMapGenerator targetPackage="mappers" targetProject="${resources}" > <property name="enableSubPackages" value="false" /> </sqlMapGenerator> <!-- 生成mapxml对应client,也就是接口dao --> <javaClientGenerator targetPackage="com.yanfei1819.mybatisgeneratordemo.db.dao" targetProject="${project}" type="XMLMAPPER" > <property name="enableSubPackages" value="false" /> </javaClientGenerator> <!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 --> <table tableName="user" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true"> <property name="useActualColumnNames" value="false" /> <!-- 数据库表主键 --> <generatedKey column="id" sqlStatement="Mysql" identity="true" /> </table> </context> </generatorConfiguration>该配置是 mybatis generator 的主要配置,代码生成的相关信息基本都在此配置文件中。配置文件中也有数据库的信息,此处将数据库信息提出来了,在同级文加下创建 mybatisGeneratorinit.properties 文件:
#dao类和实体类的位置 project =src/main/java #mapper文件的位置 resources=src/main/resources #根据数据库中的表生成对应的pojo类、dao、mapper jdbc_driver =com.mysql.jdbc.Driver jdbc_url=jdbc:mysql://192.168.1.88:3306/test jdbc_user=xxx jdbc_password=xxx最后,在pom.xml文件所在的目录执行如下命令:
mvn mybatis-generator:generate 。
如果是在 IDEA 下的项目,代码生成更加方便:
这跟 maven 的用法有关,感兴趣的可以深入了解。
我们看看生成的代码位置:
文件中都有对应的方法:
UserMapper.java :
package com.yanfei1819.mybatisgeneratordemo.db.dao; import com.yanfei1819.mybatisgeneratordemo.db.dto.User; import java.util.List; public interface UserMapper { int deleteByPrimaryKey(Integer id); int insert(User record); User selectByPrimaryKey(Integer id); List<User> selectAll(); int updateByPrimaryKey(User record); }User.java :
package com.yanfei1819.mybatisgeneratordemo.db.dto; import java.io.Serializable; public class User implements Serializable { /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user.id * * @mbggenerated */ private Integer id; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user.age * * @mbggenerated */ private Integer age; /** * This field was generated by MyBatis Generator. * This field corresponds to the database column user.name * * @mbggenerated */ private String name; /** * This field was generated by MyBatis Generator. * This field corresponds to the database table user * * @mbggenerated */ private static final long serialVersionUID = 1L; // set/get 省略 }UserMapper.xml :
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > <mapper namespace="com.yanfei1819.mybatisgeneratordemo.db.dao.UserMapper" > <resultMap id="BaseResultMap" type="com.yanfei1819.mybatisgeneratordemo.db.dto.User" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> <id column="id" property="id" jdbcType="INTEGER" /> <result column="age" property="age" jdbcType="INTEGER" /> <result column="name" property="name" jdbcType="VARCHAR" /> </resultMap> <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> delete from user where id = #{id,jdbcType=INTEGER} </delete> <insert id="insert" parameterType="com.yanfei1819.mybatisgeneratordemo.db.dto.User" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> <selectKey resultType="java.lang.Integer" keyProperty="id" order="AFTER" > SELECT LAST_INSERT_ID() </selectKey> insert into user (age, `name`) values (#{age,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR}) </insert> <update id="updateByPrimaryKey" parameterType="com.yanfei1819.mybatisgeneratordemo.db.dto.User" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> update user set age = #{age,jdbcType=INTEGER}, `name` = #{name,jdbcType=VARCHAR} where id = #{id,jdbcType=INTEGER} </update> <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> select id, age, `name` from user where id = #{id,jdbcType=INTEGER} </select> <select id="selectAll" resultMap="BaseResultMap" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> select id, age, `name` from user </select> </mapper>该插件与 MyBatis Plus 生成器功能相近。不同的是,MyBatis Plus 代码生成器是用纯粹的代码生成,该插件含有大量的配置。各自有利有弊,喜好看个人。
源码:我的GitHub
MyBatis Generator 官网
转载于:https://www.cnblogs.com/yanfei1819/p/10894278.html