一、需要先创建工程

  1. 先在pom.xml文件里面把依赖添加上去
  2. 把配置文件复制过来
  3. 确定包路径（逆向工程的时候需要）
  4. 导入Mybatis工具类
  5. 创建dao层和bean类存放位置的包


二、设计数据库：


三、逆向工程配置：


generatorConfig.xml：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE generatorConfiguration
  3.         PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  5. <!-- 配置生成器 -->
  6. <generatorConfiguration>
  7.     <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3">
  8.         <property name="autoDelimitKeywords" value="false"/>
  9.         <!-- 生成的Java文件的编码 -->
  10.         <property name="javaFileEncoding" value="UTF-8"/>
  11.         <!-- 格式化java代码 -->
  12.         <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
  13.         <!-- 格式化XML代码 -->
  14.         <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
  16.         <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
  17.         <property name="beginningDelimiter" value="`"/>
  18.         <property name="endingDelimiter" value="`"/>
  20.         <!-- 自定义lombok增强 -->
  21.         <plugin type="plugins.LombokPlugin" >
  22.             <property name="hasLombok" value="true"/>
  23.         </plugin>
  25.         <!--通过type属性改成自己注解解析器-->
  26.         <commentGenerator  type="plugins.MyCommentGenerator">
  27.             <property name="suppressDate" value="true"/>
  28.             <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
  29.             <!--<property name="suppressAllComments" value="true" />-->
  30.             <property name="addRemarkComments" value="true" />
  31.         </commentGenerator>
  37.           <!-- 数据库连接信息ps:需要手动更改
  38.         <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/mybatis?useUnicode=true&amp;characterEncoding=UTF-8"
  39.                         userId="root"
  40.                         password="123456">
  41.             <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
  42.         </jdbcConnection>
  49.         <!-- java类型处理器-->
  50.         <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
  51.             <property name="forceBigDecimals" value="false"/>
  52.         </javaTypeResolver>
  55.            <!-- 需要手动更改
  56.         <!-- java模型创建器，是必须要的元素 -->
  57.         <javaModelGenerator targetPackage="com.xxgc.mybatis.pojo" targetProject="src/main/java">
  58.             <property name="constructorBased" value="false"/>
  59.             <property name="enableSubPackages" value="true"/>
  60.             <property name="trimStrings" value="true"/>
  61.             <property name="immutable" value="false"/>
  62.             <property name="trimStrings" value="true"/>
  63.         </javaModelGenerator>
  67.         <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
  68.             <property name="enableSubPackages" value="true"/>
  69.         </sqlMapGenerator>
  71.         <javaClientGenerator targetPackage="com.xxgc.mybatis.dao" type="XMLMAPPER" targetProject="src/main/java">
  72.             <property name="enableSubPackages" value="true"/>
  73.         </javaClientGenerator>
  76. <!--        要生成的表-->
  77.         <table tableName="users"/>
  78.         <table tableName="money"/>
  79.     </context>
  80. </generatorConfiguration>


3.1 判断数据库连接是否正确：

  1. <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/mybatis?useUnicode=true&amp;characterEncoding=UTF-8"
  2.                 userId="root"
  3.                 password="123456">
  4.     <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
  5. </jdbcConnection>

3.2 判断映射类包路径：

  1. <!-- java模型创建器，是必须要的元素 -->
  2. <javaModelGenerator targetPackage="com.xxgc.mybatis.entity" targetProject="src/main/java">
  3.     <property name="constructorBased" value="false"/>
  4.     <property name="enableSubPackages" value="true"/>
  5.     <property name="trimStrings" value="true"/>
  6.     <property name="immutable" value="false"/>
  7.     <property name="trimStrings" value="true"/>
  8. </javaModelGenerator>

3.3 dao层包路径：

  1. <javaClientGenerator targetPackage="com.xxgc.mybatis.dao" type="XMLMAPPER" targetProject="src/main/java">
  2.     <property name="enableSubPackages" value="true"/>
  3. </javaClientGenerator>

3.4 查看要生成的表：

  1. <!--要生成的表-->
  2. <table tableName="users"/>
  3. <table tableName="money"/>

四、 在java包下创建包 plugins （在下面创建两个类：[MyCommentGenerator](https://gitee.com/ringo-tyl/mybatis-reverse-engineering/blob/master/src/main/java/plugins/MyCommentGenerator.java)）

LombokPlugin.java:

  1. package plugins;
  3. import org.mybatis.generator.api.IntrospectedColumn;
  4. import org.mybatis.generator.api.IntrospectedTable;
  5. import org.mybatis.generator.api.PluginAdapter;
  6. import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
  7. import org.mybatis.generator.api.dom.java.Interface;
  8. import org.mybatis.generator.api.dom.java.Method;
  9. import org.mybatis.generator.api.dom.java.TopLevelClass;
  11. import java.text.SimpleDateFormat;
  12. import java.util.Date;
  13. import java.util.List;
  15. /**
  16.  * @ClassName LombokPlugin
  17.  * @Description: TODO
  18.  * @Author 唐哥
  19.  * @Date 2021/10/25
  20.  * @Version V1.0
  21.  **/
  22. @SuppressWarnings("unused")
  23. public class LombokPlugin extends PluginAdapter {
  25.     @Override
  26.     public boolean validate(List<String> list) {
  27.         return true;
  28.     }
  30.     @Override
  31.     public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  32.         //实体类的import
  33.         topLevelClass.addImportedType("java.io.Serializable");
  34.         topLevelClass.addImportedType("lombok.Data");
  35.         topLevelClass.addImportedType("lombok.Builder");
  36.         topLevelClass.addImportedType("lombok.NoArgsConstructor");
  37.         topLevelClass.addImportedType("lombok.AllArgsConstructor");
  39.         //实体类的注解
  40.         topLevelClass.addAnnotation("@Data");
  41.         topLevelClass.addAnnotation("@Builder");
  42.         topLevelClass.addAnnotation("@NoArgsConstructor");
  43.         topLevelClass.addAnnotation("@AllArgsConstructor");
  45.         //实体类的注释
  46.         topLevelClass.addJavaDocLine("/**");
  47.         topLevelClass.addJavaDocLine(" * @唐哥");
  48.         topLevelClass.addJavaDocLine(" * @date " + new SimpleDateFormat("yyyy/MM/dd/hh:mm").format(new Date()));
  49.         topLevelClass.addJavaDocLine(" */");
  51.         //接口
  52.         topLevelClass.addSuperInterface(new FullyQualifiedJavaType("java.io.Serializable"));
  53.         return true;
  54.     }
  56.     @Override
  57.     public boolean clientGenerated(Interface anInterface, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  58.         //Mapper文件的注释
  59.         anInterface.addJavaDocLine("/**");
  60.         anInterface.addJavaDocLine(" * @唐哥");
  61.         anInterface.addJavaDocLine(" * @date " + new SimpleDateFormat("yyyy/MM/dd/hh:mm").format(new Date()));
  62.         anInterface.addJavaDocLine(" */");
  63.         return true;
  64.     }
  66.     @Override
  67.     public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
  68.         //不生成getter
  69.         return false;
  70.     }
  72.     @Override
  73.     public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
  74.         //不生成setter
  75.         return false;
  76.     }
  77. }



MyCommentGenerator.java:

  1. package plugins;
  3. import org.mybatis.generator.api.CommentGenerator;
  4. import org.mybatis.generator.api.IntrospectedColumn;
  5. import org.mybatis.generator.api.IntrospectedTable;
  6. import org.mybatis.generator.api.dom.java.*;
  7. import org.mybatis.generator.api.dom.xml.XmlElement;
  9. import java.util.Properties;
  11. /**
  12.  * 注解解析器
  13.  * @ClassName MyCommentGenerator
  14.  * @Description: TODO
  15.  * @Author 唐哥
  16.  * @Date 2021/10/25
  17.  * @Version V1.0
  18.  **/
  19. public class MyCommentGenerator implements CommentGenerator {
  20.     @Override
  21.     public void addConfigurationProperties(Properties properties) {
  23.     }
  25.     @Override
  26.     public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
  28.     }
  30.     @Override
  31.     public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
  33.     }
  35.     @Override
  36.     public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  38.     }
  40.     @Override
  41.     public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
  43.     }
  45.     @Override
  46.     public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) {
  48.     }
  50.     @Override
  51.     public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
  53.     }
  55.     @Override
  56.     public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
  58.     }
  60.     @Override
  61.     public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
  63.     }
  65.     @Override
  66.     public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
  68.     }
  70.     @Override
  71.     public void addJavaFileComment(CompilationUnit compilationUnit) {
  73.     }
  75.     @Override
  76.     public void addComment(XmlElement xmlElement) {
  78.     }
  80.     @Override
  81.     public void addRootComment(XmlElement xmlElement) {
  83.     }
  84. }

启动类 Generator.java：

  1. package main;
  3. import org.mybatis.generator.api.MyBatisGenerator;
  4. import org.mybatis.generator.config.Configuration;
  5. import org.mybatis.generator.config.xml.ConfigurationParser;
  6. import org.mybatis.generator.exception.XMLParserException;
  7. import org.mybatis.generator.internal.DefaultShellCallback;
  9. import java.io.File;
  10. import java.util.ArrayList;
  12. /**
  13.  * 用于生成逆向工程
  14.  *
  15.  */
  16. public class Generator {
  17.     //加载配置文件
  18.     public void mybatisGenerator() throws Exception {
  19.         ArrayList<String> warnings = new ArrayList<>();
  20.         File file = new File("./src/main/resources/generatorConfig.xml");
  21.         ConfigurationParser parser = new ConfigurationParser(warnings);
  23.         Configuration configuration = parser.parseConfiguration(file);
  24.         DefaultShellCallback defaultShellCallback = new DefaultShellCallback(true);
  25.         MyBatisGenerator myBatisGenerator = new MyBatisGenerator(configuration, defaultShellCallback, warnings);
  26.         myBatisGenerator.generate(null);
  30.     }
  31.     public static void main(String[] args) throws Exception {
  32.         System.out.println("开始逆向工程");
  33.         Generator generator = new Generator();
  34.         generator.mybatisGenerator();
  36.         System.out.println("结束逆向工程");
  37.     }
  38. }