Mybatis Generator 之整合 Lombok

继自定义注释的大胆想法实现后，小编已经开始膨胀，以至于暗中馋上了 Lombok 的身子。别怪小编太下贱，怎奈 Lombok 链式编程等一系列丝滑操作太诱人。

要实现这个伟大的目标，需经历以下几个步骤。

1 pom 中添加 Lombok 

pom.xml

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.24</version>
    <scope>compile</scope>
</dependency>

2 创建插件

LombokPlugin.java

package com.zwj.mybatis.plugin;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.TopLevelClass;

import java.util.List;

/**
 * 在实体中生成 Lombok 注解
 */
public class LombokPlugin extends PluginAdapter {

    @Override
    public boolean validate(List<String> list) {
        return true;
    }

    /**
     * 添加注解的方法
     */
    @Override
    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

        // 添加实体类的 import
        topLevelClass.addImportedType("lombok.Data");
        topLevelClass.addImportedType("lombok.NoArgsConstructor");
        topLevelClass.addImportedType("lombok.AllArgsConstructor");
        topLevelClass.addImportedType("lombok.experimental.Accessors");
        // 添加实体类的 lombok 注解
        topLevelClass.addAnnotation("@Data");
        topLevelClass.addAnnotation("@Accessors(chain = true)");
        topLevelClass.addAnnotation("@NoArgsConstructor");
        topLevelClass.addAnnotation("@AllArgsConstructor");

        return true;
    }

    @Override
    public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        // 不生成 setter
        return false;
    }

    @Override
    public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
        // 不生成 getter
        return false;
    }
}

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="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">
        <!-- 表名前后加上''的分隔符 -->
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />

        <!-- 整合 lombok 插件 -->
        <plugin type="com.zwj.mybatis.plugin.LombokPlugin" />

        <!-- 根据表生成注释 -->
        <commentGenerator type="com.zwj.mybatis.generator.CustomCommentGenerator">
            <!--  定义生成实体类注解所需参数  -->
            <property name="author" value="青城山上学编程" />
            <property name="dateFormat" value="yyyy/MM/dd HH:mm" />
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://192.168.1.188:3307/user-center"
            userId="root" password="123456" />
        <!-- 对于生成的pojo所在包 -->
        <javaModelGenerator targetPackage="org.example.user.domain" targetProject="src\main\java" />
        <!-- 对于生成的mapper所在目录 -->
        <sqlMapGenerator targetPackage="org.example.user.dao" targetProject="src\main\resources" />
        <!-- 配置dao对应的映射 -->
        <javaClientGenerator targetPackage="org.example.user.dao" targetProject="src\main\java"
            type="ANNOTATEDMAPPER" />
        <table tableName="%">
            <!--insert 方法返回主键-->
            <generatedKey column="id" sqlStatement="MySql" identity="true" />
        </table>
    </context>
</generatorConfiguration>

通过 <plugin> 配置插件，type 属性为插件的全路径名。重新运行 main 方法，即可得到集成 Lombok 注解的实体类。

User.java

package org.example.user.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

/**
 * @author: 青城山上学编程
 * @dateTime: 2022/10/09 13:49
 */
@Data
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
public class User {
    /**
     * 自增主键
     */
    private Long id;

    /**
     * 用户名
     */
    private String name;

    /**
     * 密码
     */
    private String password;

    /**
     * 创建时间
     */
    private Long createTime;

    /**
     * 最后更新时间
     */
    private Long updateTime;
}