Maven项目使用mybatis generator + tk.mybatis + Lombok自动化生成Mybatis相关代码（二）

最新推荐文章于 2024-06-14 09:45:30 发布
最新推荐文章于 2024-06-14 09:45:30 发布
阅读量1.9k 收藏 7
点赞数
分类专栏： springboot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43054590/article/details/90168272
版权

一、pom.xml配置

1、新增lombok + tk.myBatis的依赖包

 <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>${generator.version}</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.4</version>
        </dependency>

2、下载并安装lombok自动化生成代码的插件

3、pom.xml中配置plugins插件内容

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>${generator.version}</version>
                <configuration>
                    <!-- mybatis用于生成代码的配置文件 -->
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql.version}</version>
                    </dependency>

                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>${tk.mybatis.version}</version>
                    </dependency>

                    <dependency>
                        <groupId>com.chrm</groupId>
                        <artifactId>mybatis-generator-lombok-plugin</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>

                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>${generator.version}</version>
                    </dependency>

                </dependencies>
            </plugin>
        </plugins>
    </build>
  • 注意：引入了tk.mybatis的插件就不能引入mybatis的插件，否则会报错。
<dependency>
        <groupId>com.chrm</groupId>
        <artifactId>mybatis-generator-lombok-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
  </dependency>
  • mybatis-generator-lombok-plugin插件就是我们第二步打包并安装到maven仓库中的jar包。

二、generatorConfig.xml配置

1、在context标签中新增下列配置

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- generator.MapperPlugin插件  -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <!-- value 生成mapper需要继承的基类 -->
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
        </plugin>
        <!-- 整合lombok-->
        <plugin type="com.chrm.mybatis.generator.plugins.LombokPlugin" >
            <property name="hasLombok" value="true"/>
        </plugin>
  • 上面新增的两个插件分别负责整合tk.mybatis和lombok，必须要配置这两项，否则无法生成预期效果的代码。

2、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>
    <properties resource="application.properties"/>

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

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- generator.MapperPlugin插件  -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <!-- value 生成mapper需要继承的基类 -->
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
        </plugin>
        <!-- 整合lombok-->
        <plugin type="com.chrm.mybatis.generator.plugins.LombokPlugin" >
            <property name="hasLombok" value="true"/>
        </plugin>

        <commentGenerator>
            <property name="suppressAllComments" value="true" />
            <property name="suppressDate" value="true"/>
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>

        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
        </jdbcConnection>
        <!-- 生成实体类存放的位置   targetProject:项目原有的目录-->
        <javaModelGenerator targetPackage="com.chuan.demo.dao.entity" targetProject="src/main/java"/>
        <!-- mapper对应的xml文件存放的地方 -->
        <sqlMapGenerator targetPackage="mappers" targetProject="src/main/resources"/>
        <!--mapper接口存放的地方  -->
        <javaClientGenerator targetPackage="com.chuan.demo.dao.mapper" targetProject="src/main/java"
                             type="XMLMAPPER"/>
        <!-- 根据数据库表生成java文件相关的规则  -->

        <table tableName="order_detail" domainObjectName="OrderDetail">
            <!--mysql 配置-->
            <generatedKey column="detail_id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>

        <table tableName="order_master" domainObjectName="OrderMaster">
            <!--mysql 配置-->
            <generatedKey column="order_id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>

        <table tableName="product_category" domainObjectName="ProductCategory">
            <!--mysql 配置-->
            <generatedKey column="category_id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>

        <table tableName="product_info" domainObjectName="ProductInfo">
            <!--mysql 配置-->
            <generatedKey column="product_id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>

        <table tableName="seller_info" domainObjectName="SellerInfo">
            <!--mysql 配置-->
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>


    </context>
</generatorConfiguration>

三、最后运行MBG插件

1、数据库实体类

@Table(name = "order_detail")
@Data
public class OrderDetail {
    @Id
    @Column(name = "detail_id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private String detailId;

    @Column(name = "order_id")
    private String orderId;

    @Column(name = "product_id")
    private String productId;

    /**
     * 商品名称
     */
    @Column(name = "product_name")
    private String productName;

    /**
     * 当前价格,单位分
     */
    @Column(name = "product_price")
    private BigDecimal productPrice;

    /**
     * 数量
     */
    @Column(name = "product_quantity")
    private Integer productQuantity;

    /**
     * 小图
     */
    @Column(name = "product_icon")
    private String productIcon;

    /**
     * 创建时间
     */
    @Column(name = "create_time")
    private Date createTime;

    /**
     * 修改时间
     */
    @Column(name = "update_time")
    private Date updateTime;
}
  • 相对于上一个章节，实体类已经没有了Getter和Setter方法了，并且新增了一些数据库相关的标签进行数据库字段关系的映射。

2、mapper接口方法

package com.chuan.demo.dao.mapper;

import com.chuan.demo.dao.entity.OrderDetail;
import tk.mybatis.mapper.common.Mapper;

public interface OrderDetailMapper extends Mapper<OrderDetail> {
}
  • 相对于上一节的mapper接口，现在的这个mapper接口继承了tk.mybatis.mapper.common.Mapper，没有了上一章节中的四个增删查改方法了；这个接口是tk.mybatis提供的一个数据库操作的接口，包含了很多的数据库操作方法，具体的使用方式我们以后再讨论。

3、XXXMapper.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.chuan.demo.dao.mapper.OrderDetailMapper">
  <resultMap id="BaseResultMap" type="com.chuan.demo.dao.entity.OrderDetail">
    <!--
      WARNING - @mbg.generated
    -->
    <id column="detail_id" jdbcType="VARCHAR" property="detailId" />
    <result column="order_id" jdbcType="VARCHAR" property="orderId" />
    <result column="product_id" jdbcType="VARCHAR" property="productId" />
    <result column="product_name" jdbcType="VARCHAR" property="productName" />
    <result column="product_price" jdbcType="DECIMAL" property="productPrice" />
    <result column="product_quantity" jdbcType="INTEGER" property="productQuantity" />
    <result column="product_icon" jdbcType="VARCHAR" property="productIcon" />
    <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    <result column="update_time" jdbcType="TIMESTAMP" property="updateTime" />
  </resultMap>
</mapper>
  • 这个相对于上一章来说也更加简洁，因为tk.mybatis.mapper.common.Mapper中默认实现了一些基本的数据库操作方法，所以xml文件中也就不会有基本增删查改的语句了；但是我们可以在xml文件中使用复杂的SQL查询语句，总之mybatis的常规使用功能均存在。

4、总结

相对于 mybatis generator + mybatis自动化生成的代码结构来说，本章的mybatis generator + tk.mybatis + Lombok更适合项目开发中的生产环境，可以大大节省开发时间，开发人员只需要关注业务的开发以及数据库表的设计就行了。

注意：当我们在springboot项目中使用tk.mybatis时，我们需要在springboot配置文件application.yml或者application.properties中配置XXXMapper.xml文件的位置，否则xml文件将无法使用。

mybatis:
  mapper-locations: classpath:mappers/*.xml
阿川xiang
关注
  • 0
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis-generator+lombok自动生成mybatis代码
11-27
自己找资料，慢慢高了一个mybatis自动生成代码的类，当然是在mybatis-generator基础之上的，由于项目中有lombok，所以需要对生成的地方进行改造。我将改造后的文件都打包上传了，需要的同学拿去吧 zip包里面包含： generatorConfig.xml mybatis-generator-core-1.3.6.jar mybatis-generator-core-1.3.6-sources.jar pom.xml 直接下载就可以用
mybatis generator插件系列--lombok插件 （减少百分之九十bean代码）
weixin_33918357的博客
09-16 988
经常使用mybatis generator生成代码的你 有没有因为生成的getter/setter而烦恼呢？ 有没有生成后又手动加toString/hashCode/Equals方法呢？ 有没有改一个字段又要手动改写getter/setter/toString/hashCode/Equals呢？ 下面我将介绍一个mybatis generator Lomb...
探索代码精简之道：利用MyBatis Generator Lombok插件
最新发布
gitblog_00027的博客
06-14 409
探索代码精简之道：利用MyBatis Generator Lombok插件 项目地址:https://gitcode.com/softwareloop/mybatis-generator-lombok-plugin 在软件开发的浩瀚宇宙中，重复的getter和setter常被视为代码中的“冗余行星”。今天，我们为你揭示一款神器——MyBatis Generator Lombok插件，它能化繁为简，...
maven插件--MyBatis自动生成代码
eygs8517的博客
10-08 225
1.pom.xml：加入插件配置   Xml代码   plugin>       groupId>org.mybatis.generatorgroupId>       artifactId>mybatis-generator-maven-pluginartifactId>       version>1.3.2version>       configura
使用mybatis插件mybatis-generator(lombok）
weixin_51296247的博客
03-18 732
***/@Override/*** 为实体添加lombok的注解* @return*/@Override//添加domain的import*///添加domain的注解*///添加domain的注释/*** 为实体类字段添加注释* @return*/@Override@Override//不生成getter@Override//不生成setter。
MyBatis-Generator 自动生成Lombok标签 不生成Get/Set方法
04-22
把下载的jar包放在 Maven仓库的 org\mybatis\generator\mybatis-generator-core\1.3.5 下面即可，然后在generatorConfig配置文件中加上<plugin type="org.mybatis.generator.plugins.LombokPlugin" > </plugin> ...
mybatis-generator-yml-maven-plugin：MyBatis Generator yml配置，lombok插件，swagger插件支持
02-04
English | 目的 默认情况下，使用yml配置来简化MyBatis Generator使用的xml配置 ...步骤1：确保您的项目是Maven项目，将mybatis-generator-yml-maven-plugin添加到您的maven pom.xml文件中： <groupId>
mybatis集成自动化代码生成工具
03-27
MyBatis Generator（MBG）是一款强大的自动化代码生成工具，专为MyBatis框架设计，旨在简化开发过程，提高开发效率。它可以根据数据库中的表结构自动生成Java实体类、Mapper接口与XML配置文件，以及Service和...
mybatis generator源码修改
07-13
生成后基本不用再去单独修改代码 新增内容： 1、实体类可配置 Lombok 注解 2、实体类可配置 swagger注解 3、实体类可配置 JPA注解 4、实体类可配置 文件名统一修改 5、可配置 mapper文件名更改 6、可配置 xml文件名...
mybatis-generator-1.3.5.zip官方绿色版
10-13
MyBatis Generator (MBG) 是一款强大的自动化代码生成工具，尤其在开发过程中能显著提高效率。它能够根据数据库表自动生成Java实体类、Mapper接口和XML配置文件，从而减少了手动编写这些重复代码的工作量。在给定的...
mybatis-generator-lombok-1.3.7.jar
06-20
mybatis-generator整合lombok 可直接使用的jar包。生成的实体类省略get set等等方法，使用简单，代码简单明了。使用教程地址 https://blog.csdn.net/qq_40387355/article/details/106866863
SpringBoot+tk.Mybatis+Maven项目搭建（IDEA）
07-05
开发工具：IDEA 简介：使用SpringBoot+tk.Mybatis+Maven搭建的项目demo，可供参考和交流学习。项目文章：https://blog.csdn.net/fakerswe/article/details/80910035
Mybatis Generator 之整合 Lombok
青城山上学编程
10-09 1122
继的大胆想法实现后，小编已经开始膨胀，以至于暗中馋上了 Lombok 的身子。别怪小编太下贱，怎奈 Lombok 链式编程等一系列丝滑操作太诱人。要实现这个伟大的目标，需经历以下几个步骤。
mybatis generator 整合lombok
weixin_30888707的博客
04-11 330
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybat...
mybatis-generator-lombok-plugin 导入jar问题
li953348869的博客
04-03 5544
在使用mybatis自动生成mapper/dao/bean文件时，为了配置自动get/set和bean属性注解，需引入mybatis-generator-lombok-plugin 下载地址：https://github.com/GuoGuiRong/mybatis-generator-lombok-plugin 注意：此时直接在 <dependencies> &...
mybatis generator 搭配lombok ,逆向生成字段类注释
Nba_3210的博客
07-31 1116
逆向生成字段类注释 自定义插 的实现方式有两种： 1，实现接口 **Plugin** 2, 继承抽象类：**PluginAdapter** （已经实现了接口Plugin ,功能更丰富）-推荐使用 自定义插件说明 我使用的是mybatis-generator-core 是 1.3.7 版本。 <dependencies> <dependency> <groupId
代码优化——（lombok和TkMybatis）
lmchhh的博客
10-16 562
一，整合lombok Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具,通过使用对应的注解,可以在编译源码的时候生成对应的方法,例如:setter,getter.toString方法等等. 1.1 整合步骤 第一步:引入lombok依赖 <dependency> <groupId>org.projectlombok&lt...
MybatisGenerator整合lombok遇到的坑
qq_43082330的博客
05-28 1482
最近一直在搞MybatisGenerator逆向工程的使用,单表操作爽翻了,不用自己生成entity、mapper等 数据库映射文件,这篇博客主要记录下,MybatisGenerator整合lombok遇到的坑。 所以教程我都是在网上找的，一步步对着网上教程做的，具体教程大家可以去百度下。 在整合lombok的时候，遇到一个神坑，就是在加入lombok依赖的时候，会新建一个LombokPlug类，编译成class文件后塞入maven导入的本地的仓库里。到这一步都是OK的，但是我在启动的时候一直在报错
mybatis-plus的代码生成器使用方法
04-25
MyBatis-Plus 的代码生成器是一个非常方便的工具，可以帮助我们快速生成 MyBatis 相关的 DAO、Mapper、Entity、Service、Controller 等代码。具体使用方法如下： 1. 引入 MyBatis-Plus 的代码生成器依赖 在 Maven ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值