MyBatis逆向工程Generator和IDE Plugin

x33g5p2x  于2021-10-28 转载在 其他  
字(6.5k)|赞(0)|评价(0)|浏览(492)

逆向工程

mybatis逆向工程的作用是根据数据库里的表结构自动生成实体类,映射文件,和接口。
和hibernate的自动建表相反。

逆向工程需要的jar包:

  1. mybatis-3.2.3.jar
  2. mybatis-generator-core-1.3.2.jar
  3. mysql-connector-java-8.0.27-bin.jar
  4. log4j-1.2.17.jar

如果是Maven项目可以在pom文件中导入依赖:

  1. <!--mysbatis-->
  2. <dependency>
  3. <groupId>org.mybatis</groupId>
  4. <artifactId>mybatis</artifactId>
  5. <version>3.5.7</version>
  6. </dependency>
  7. <!--generator-->
  8. <dependency>
  9. <groupId>org.mybatis.generator</groupId>
  10. <artifactId>mybatis-generator-core</artifactId>
  11. <version>1.4.0</version>
  12. </dependency>
  13. <!--mysql-->
  14. <dependency>
  15. <groupId>mysql</groupId>
  16. <artifactId>mysql-connector-java</artifactId>
  17. <version>8.0.27</version>
  18. </dependency>
  19. <!--log4j-->
  20. <dependency>
  21. <groupId>log4j</groupId>
  22. <artifactId>log4j</artifactId>
  23. <version>1.2.17</version>
  24. </dependency>

配置log4j

log4j.properties

  1. log4j.rootLogger=DEBUG, Console
  2. #Console
  3. log4j.appender.Console=org.apache.log4j.ConsoleAppender
  4. log4j.appender.Console.layout=org.apache.log4j.PatternLayout
  5. log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
  6. log4j.logger.java.sql.ResultSet=INFO
  7. log4j.logger.org.apache=INFO
  8. log4j.logger.java.sql.Connection=DEBUG
  9. log4j.logger.java.sql.Statement=DEBUG
  10. log4j.logger.java.sql.PreparedStatement=DEBUG

另外加上一个启动类GeneratorSqlmap和一个稍微改动的配置文件 -generatorConfig,xml文件

使用Generator生成代码

GeneratorSqlmap启动类

java代码是通用的,只要修改你的配置文件的路径即可:

  1. public class GeneratorSqlmap {
  2. public void generator() throws Exception{
  3. List<String> warnings = new ArrayList<String>();
  4. boolean overwrite = true;
  5. //指定 逆向工程配置文件
  6. File configFile = new File("generatorConfig.xml");
  7. ConfigurationParser cp = new ConfigurationParser(warnings);
  8. Configuration config = cp.parseConfiguration(configFile);
  9. DefaultShellCallback callback = new DefaultShellCallback(overwrite);
  10. MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
  11. callback, warnings);
  12. myBatisGenerator.generate(null);
  13. }
  14. public static void main(String[] args) throws Exception {
  15. try {
  16. GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
  17. generatorSqlmap.generator();
  18. } catch (Exception e) {
  19. e.printStackTrace();
  20. }
  21. }
  22. }
配置文件 generatorConfig

xml模板:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  3. <generatorConfiguration>
  4. <context id="testTables" targetRuntime="MyBatis3">
  5. <commentGenerator>
  6. <!-- 是否去除自动生成的注释 true:是 : false:否 -->
  7. <property name="suppressAllComments" value="true"/>
  8. </commentGenerator>
  9. <!--数据库连接的信息:驱动类、连接地址、用户名、密码 -->
  10. <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/demo1?useSSL=false&amp;serverTimezone=UTC&amp;allowPublicKeyRetrieval=true" userId="root" password="root">
  11. </jdbcConnection>
  12. <!-- 默认false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer,为 true时把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal -->
  13. <javaTypeResolver>
  14. <property name="forceBigDecimals" value="false"/>
  15. </javaTypeResolver>
  16. <!-- targetProject:生成PO类的位置 -->
  17. <javaModelGenerator targetPackage="com.demo.pojo" targetProject=".\src">
  18. <!-- enableSubPackages:是否让schema作为包的后缀 -->
  19. <property name="enableSubPackages" value="false"/>
  20. <!-- 从数据库返回的值被清理前后的空格 -->
  21. <property name="trimStrings" value="true"/>
  22. </javaModelGenerator>
  23. <!-- targetProject:mapper映射文件生成的位置 -->
  24. <sqlMapGenerator targetPackage="com.demo.mapper" targetProject=".\src">
  25. <!-- enableSubPackages:是否让schema作为包的后缀 -->
  26. <property name="enableSubPackages" value="false"/>
  27. </sqlMapGenerator>
  28. <!-- targetPackage:mapper接口生成的位置 -->
  29. <javaClientGenerator type="XMLMAPPER" targetPackage="com.demo.mapper" targetProject=".\src">
  30. <!-- enableSubPackages:是否让schema作为包的后缀 -->
  31. <property name="enableSubPackages" value="false"/>
  32. </javaClientGenerator>
  33. <!-- 指定数据库表 -->
  34. <table schema="" tableName="mysql"></table>
  35. </context>
  36. </generatorConfiguration>

需要改动的地方有:

<jdbcConnection>自定义数据库名,用户名和密码
<javaModelGenerator>实体类路径。没有会新建
<sqlMapGenerator >映射文件的路径
<javaClientGenerator >接口的路径
<table>需要映射的数据库的表名

注意:映射文件一般与接口的路径一致

数据据表:

运行效果:

项目结构:

实体类:

接口:

映射文件:

这个就有点多,足足300多行了

插件启动maven-generator

如果使用maven项目就可以省去编写Java启动类,使用maven插件和配置文件.xml即可
在pow中加上如下代码来添加插件:

  1. <plugin>
  2. <groupId>org.mybatis.generator</groupId>
  3. <artifactId>mybatis-generator-maven-plugin</artifactId>
  4. <version>1.3.2</version>
  5. <configuration>
  6. <verbose>true</verbose>
  7. <overwrite>true</overwrite>
  8. <configurationFile>${project.basedir}/generatorConfig.xml</configurationFile>
  9. </configuration>
  10. <dependencies>
  11. <dependency>
  12. <groupId>mysql</groupId>
  13. <artifactId>mysql-connector-java</artifactId>
  14. <version>8.0.27</version>
  15. </dependency>
  16. </dependencies>
  17. </plugin>

配置完generatorConfig,找到IDE 上的该插件点击运行,效果是一样的:

注意事项

1.修改配置文件时,如果不想生成example使用

  1. <context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">

代替

  1. <context id="testTables" targetRuntime="MyBatis3">

2.重构时,多次运行逆向工程,除了.java文件是覆盖的,.xml文件都是累加的。所以,要重构就的将已存在的映射.xml文件删除或者清理成下面的样子:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
  3. <mapper namespace="" >
  4. </mapper>

3 .如果使用maven插件,<plugin>外层不可以用<pluginManagement>标签包裹,否则插件不显示。

4.如果使用maven插件,里面的<artifactId>mysql-connector-java</artifactId>不能省,即使上面配置了也不行,不然就告你驱动找不到!
除了这样配置,还可以在generatorConfig.xml里面配置驱动jar的路径,
如:<classPathEntry location="d:\mshu\mysql-connector-java-5.1.6-bin.jar"/>
哪个方便就用哪个吧。

IDE Plugin之Free MyBatis plugin

free-idea-mybais是一款增强idea对mybatis支持的插件,主要功能如下:

  • 生成mapper xml文件
  • 快速从代码跳转到mapper及从mapper返回代码
  • mybatis自动补全及语法错误提示
  • 集成mybatis generator gui界面
  • 根据数据库注解,生成swagger mode注解

使用Free MyBatis plugin插件生成代码

安装Free MyBatis plugin插件

由于Free MyBatis plugin插件依赖于idea,需要在先在idea里面先连接到数据库:

选需要生成代码的数据库,点击generator

功能面板

点击ok即可自动生成

pojo:


mapper接口:

mapper映射文件:

相关文章