Mybatis逆向工程的使用

1、引入依赖

    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.2</version>
    </dependency>

     <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.48</version>
    </dependency>

2、自定义注释生成器

package com.wwz.util;

import org.mybatis.generator.api.CommentGenerator;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.springframework.util.StringUtils;

import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.util.Date;
import java.util.Properties;

/**
 * @author: wuwenzhi
 * @created: 2019/8/29.
 * @updater:
 * @description: mybatis代码生成器注释生成器
 */
public class MyCommentGenerator implements CommentGenerator {

	private Properties properties;
	private boolean suppressDate;
	private boolean suppressAllComments;
	private boolean addRemarkComments;
	private SimpleDateFormat dateFormat;

	public MyCommentGenerator() {
	}

	public MyCommentGenerator(Properties properties) {
		super();
		properties = new Properties();
	}

	@Override
	public void addConfigurationProperties(Properties properties) {

	}

	/**
	 * 属性注释
	 */
	@Override
	public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
		// 如果阻止生成所有注释，直接返回
		if (suppressAllComments) {
			return;
		}

		// 文档注释开始
		field.addJavaDocLine("/**");
		// 获取数据库字段的备注信息
		String remarks = introspectedColumn.getRemarks();

		// 根据参数和备注信息判断是否添加备注信息
		if ((remarks != null) && (remarks.length() != 0)) {
			field.addJavaDocLine("* " + remarks);
		}

		// 由于 Java 对象名和数据库字段名 可能不一样，注释中保留数据库字段名
		field.addJavaDocLine("* " + introspectedColumn.getActualColumnName());
		field.addJavaDocLine("*/");
	}

	/**
	 * 静态属性注释
	 */
	@Override
	public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
		// 如果阻止生成所有注释，直接返回
		if (suppressAllComments) {
			return;
		}

		// 文档注释开始
		field.addJavaDocLine("/**");
		field.addJavaDocLine("* " + LocalDateTime.now());
		field.addJavaDocLine("*/");
	}

	@Override
	public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
		if (suppressAllComments) {
			return;
		}
		topLevelClass.addJavaDocLine("/**");
		topLevelClass.addJavaDocLine("* @author: MyBatis Generator");
		topLevelClass.addJavaDocLine("* @created: " + (new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date()));
		topLevelClass.addJavaDocLine("* @description: " + introspectedTable.getFullyQualifiedTable());
		topLevelClass.addJavaDocLine("*/");
	}

	@Override
	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {

	}

	@Override
	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) {

	}

	@Override
	public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {

	}

	/**
	 * get方法注释
	 */
	@Override
	public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
		// 如果阻止生成所有注释，直接返回
		if (suppressAllComments) {
			return;
		}
		// 文档注释开始
		method.addJavaDocLine("/**");
		// 由于 Java 对象名和数据库字段名 可能不一样，注释中保留数据库字段名
		method.addJavaDocLine("* " + introspectedColumn.getActualColumnName());
		method.addJavaDocLine("*/");
	}

	/**
	 * set方法注释
	 */
	@Override
	public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
		// 如果阻止生成所有注释，直接返回
		if (suppressAllComments) {
			return;
		}
		// 文档注释开始
		method.addJavaDocLine("/**");
		// 由于 Java 对象名和数据库字段名 可能不一样，注释中保留数据库字段名
		method.addJavaDocLine("* " + introspectedColumn.getActualColumnName());
		method.addJavaDocLine("*/");
	}

	@Override
	public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {

	}

	@Override
	public void addJavaFileComment(CompilationUnit compilationUnit) {

	}

	@Override
	public void addComment(XmlElement xmlElement) {

	}

	@Override
	public void addRootComment(XmlElement xmlElement) {

	}
}

3、创建配置文件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>

    <context id="MySqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <!-- 注释生成器 -->
        <commentGenerator type="com.wwz.util.MyCommentGenerator">
            <!--<property name="suppressAllComments" value="true" />-->
            <property name="suppressDate" value="true"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <!-- Mysql数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/booksystem"
                        userId="root"
                        password="wwzdjj1314">
        </jdbcConnection>
        <!-- Oracle数据库
            <jdbcConnection driverClass="oracle.jdbc.OracleDriver"
                connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:yycg"
                userId="yycg"
                password="yycg">
            </jdbcConnection>
        -->

        <!-- targetProject：生成POJO类的位置 -->
        <javaModelGenerator targetPackage="com.wwz.entity" targetProject="src\main\java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- targetProject：mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="mapper"  targetProject="src\main\resources">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- targetProject：mapper接口生成的的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.wwz.mapper"  targetProject="src\main\java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!-- 指定数据表 -->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="MySql"/>
        </table>

    </context>
</generatorConfiguration>

4、启动类，这里以类的主函数运行

package com.wwz.util;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * @author: wuwenzhi
 * @created: 2019/8/30.
 * @updater:
 * @description: mybatis代码生成器启动类
 */
public class GeneratorRun {
	public static void main(String[] args) {
		try {
			List<String> warnings = new ArrayList<String>();
			boolean overwrite = true;
			File configFile = new File("src/main/resources/generatorConfig.xml");
			ConfigurationParser cp = new ConfigurationParser(warnings);
			Configuration config = cp.parseConfiguration(configFile);
			DefaultShellCallback callback = new DefaultShellCallback(overwrite);
			MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
			myBatisGenerator.generate(null);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}