首页手记 Mybatis代码生成器项目实战：轻松入门与实践

Mybatis代码生成器项目实战：轻松入门与实践

标签：

Java SSM 数据库

概述

Mybatis代码生成器是一种自动化工具，能够根据数据库表结构自动生成Mybatis所需的Mapper接口、XML映射文件以及实体类等文件，极大地提高了开发效率。本文将详细介绍Mybatis代码生成器的配置方法、实战案例以及如何优化生成的代码，帮助读者更好地理解和使用Mybatis代码生成器项目实战。

Mybatis代码生成器简介

Mybatis代码生成器是一种自动化工具，它通过分析数据库表结构来自动生成相应的Mybatis代码文件。这些代码文件通常包括Mapper接口、XML映射文件、实体类等。Mybatis代码生成器能够显著减少开发人员手动编写这些文件的时间，从而提高开发效率。

1.1 什么是Mybatis代码生成器

Mybatis代码生成器是一种自动化工具，它通过分析数据库表结构来自动生成Mybatis所需的Mapper接口、XML映射文件以及实体类等文件。使用Mybatis代码生成器可以显著减少手动编写代码的工作量，提高开发效率。

1.2 代码生成器的作用和优势

代码生成器的主要作用是提高开发效率，减少重复性劳动。使用代码生成器可以节省大量时间，特别是在处理复杂数据库表结构时。具体的优势包括：

提高开发效率：自动生成代码，减少了手动编写代码的工作量。
减少错误：自动化生成的代码减少了人为错误的可能性。
维护性：如果数据库结构发生变化，可以重新生成代码，保持代码与数据库的一致性。
一致性：生成的代码遵循一致的编码风格和规范，有助于团队协作。

1.3 常用的Mybatis代码生成器工具介绍

目前常用的Mybatis代码生成器工具多种多样，其中比较常见的有Mybatis Generator和Mybatis Plus代码生成器。以下是对这两种工具的简单介绍。

Mybatis Generator (MBG):
Mybatis Generator是一个开放源代码的Mybatis代码生成工具。它通过解析数据库表结构来自动生成Mybatis所需的Mapper接口、XML映射文件以及实体类等文件。MBG支持多种数据库类型，如MySQL、Oracle、SQL Server等。
Mybatis Plus代码生成器:
Mybatis Plus是一款Mybatis的增强工具，它提供了代码生成器功能。Mybatis Plus的代码生成器不仅能够生成Mapper接口和实体类，还提供了一些额外的功能，如分页查询、乐观锁等，支持多种数据库类型。

这两种工具都有各自的特点和优势，可以根据项目需求选择合适的代码生成器。

准备工作

在使用Mybatis代码生成器之前，需要进行一些准备工作，包括安装环境搭建、下载和引入代码生成器插件、以及数据库配置与连接设置。

2.1 安装环境搭建

首先需要搭建一个Java开发环境，并安装必要的开发工具。具体步骤如下：

安装Java环境:
- 下载并安装Java开发工具包（JDK），确保Java环境变量配置正确。可以通过命令java -version检查Java版本。
- 检查Java版本，确保安装成功。
安装Maven:
- 下载并安装Maven，配置Maven环境变量。
- 在终端中运行mvn --version命令验证Maven是否安装成功。
搭建IDE环境:
- 安装并配置开发工具，如IntelliJ IDEA、Eclipse等。
- 确保开发工具中已安装Maven插件。

2.2 下载和引入代码生成器插件

下载并引入合适的Mybatis代码生成器插件。这里以Mybatis Generator为例：

下载Mybatis Generator:
- 可以从Mybatis Generator的GitHub仓库下载源码并编译，或直接从Maven仓库下载。

引入Maven依赖:
在项目的pom.xml文件中添加Mybatis Generator的依赖：

<dependencies>
   <dependency>
       <groupId>org.mybatis.generator</groupId>
       <artifactId>mybatis-generator-core</artifactId>
       <version>1.3.7</version>
   </dependency>
</dependencies>

2.3 数据库配置与连接设置

配置数据库连接信息，确保代码生成器能够正确连接到数据库。具体步骤如下：

创建数据库:

使用数据库工具（如MySQL Workbench、SQL Server Management Studio等）创建数据库。

添加一些测试表，例如：

CREATE DATABASE testdb;
USE testdb;

CREATE TABLE users (
id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

配置数据库连接信息:
在项目的src/main/resources目录下创建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="DB2Tables" targetRuntime="MyBatis3">
       <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                       connectionURL="jdbc:mysql://localhost:3306/testdb"
                       userId="root"
                       password="password">
       </jdbcConnection>
       <javaTypeResolver>
           <property name="unambiguousTypeForceJDBCToJavaType" value="true"/>
       </javaTypeResolver>
       <commentGenerator>
           <property name="suppressAllComments" value="true"/>
       </commentGenerator>
       <table tableName="users" enableCounting="true" lazyLoading="false">
           <columnOverride column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
       </table>
   </context>
</generatorConfiguration>

Mybatis代码生成器配置详解

配置文件是代码生成器的核心部分，通过配置文件，可以定义生成的代码文件的具体内容和格式。本节将详细介绍如何配置Mybatis代码生成器。

3.1 配置文件解析

配置文件通常是一个XML文件，用于定义数据库连接信息、生成文件存储位置、生成的Java包名等。Mybatis Generator的配置文件名为generatorConfig.xml，其基本结构如下：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="unambiguousTypeForceJDBCToJavaType" value="true"/>
        </javaTypeResolver>
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <table tableName="users" enableCounting="true" lazyLoading="false">
            <columnOverride column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
        </table>
    </context>
</generatorConfiguration>

3.2 常用配置参数说明

以下是配置文件中一些常用的配置参数说明：

context:
- id: 用于标识不同的配置环境，可设置多个。
- targetRuntime: 生成代码的目标版本，如MyBatis3。
jdbcConnection:
- driverClass: 数据库驱动类名。
- connectionURL: 数据库连接URL。
- userId: 数据库用户名。
- password: 数据库密码。
javaTypeResolver:
- unambiguousTypeForceJDBCToJavaType: 是否强制使用JDBC类型转换Java类型。
commentGenerator:
- suppressAllComments: 是否省略所有注释。
table:
- tableName: 需要生成的表名。
- enableCounting: 是否生成计数查询方法。
- lazyLoading: 是否启用懒加载。

3.3 自定义模板文件

代码生成器支持使用自定义模板文件来自定义生成的代码格式。Mybatis Generator使用Velocity模板引擎，模板文件通常位于src/main/resources/templates目录下。

例如，可以自定义生成的Mapper接口模板文件，示例代码如下：

<#if table.comment?? && !table.comment??>
    /**
     * ${table.comment}
     */
<#else>
    /**
     * ${table.name} mapper
     */
</#if>
package ${table.javaModelPackage};

import java.util.List;

public interface ${table.interfaceName} {
    /**
     * 查询所有数据
     * @return
     */
    List<${table.javaModelType}> selectAll();

    /**
     * 根据ID查询数据
     * @param id
     * @return
     */
    ${table.javaModelType} selectById(Integer id);

    /**
     * 插入数据
     * @param entity
     * @return
     */
    int insert(${table.javaModelType} entity);

    /**
     * 更新数据
     * @param entity
     * @return
     */
    int update(${table.javaModelType} entity);

    /**
     * 根据ID删除数据
     * @param id
     * @return
     */
    int deleteById(Integer id);
}

生成Mybatis代码实战

生成Mybatis代码是开发中的一个重要环节。通过Mybatis代码生成器，可以自动生成Mapper接口、XML映射文件、实体类等代码文件。本节将详细介绍如何生成这些代码文件。

4.1 生成Mapper接口及XML文件

生成Mapper接口及XML映射文件是代码生成器的主要功能之一。通过配置文件可以指定需要生成的表和对应的文件名，代码生成器会根据表结构生成相应的Java接口和XML文件。

示例代码：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="unambiguousTypeForceJDBCToJavaType" value="true"/>
        </javaTypeResolver>
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <table tableName="users">
            <columnOverride column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
        </table>
    </context>
</generatorConfiguration>

4.2 生成实体类

实体类用于表示数据库中的表结构，代码生成器可以根据表结构自动生成对应的实体类。实体类通常包含表中所有字段的属性及对应的getter和setter方法。

示例代码：

package com.example.entity;

public class User {
    private Long id;
    private String name;
    private String email;
    private Timestamp created_at;

    // Getter and Setter methods
}

4.3 处理关联关系的代码生成

当表之间存在关联关系时，例如一对一、一对多、多对多关系，代码生成器可以自动处理这些关联关系，并生成相应的代码。这需要在配置文件中指定表之间的关联关系。

示例代码：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="unambiguousTypeForceJDBCToJavaType" value="true"/>
        </javaTypeResolver>
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <table tableName="users">
            <columnOverride column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
            <tableGenerator table="user_roles" column="userId">
                <columnOverride column="roleId" jdbcType="INT" javaType="Integer"/>
            </tableGenerator>
        </table>
    </context>
</generatorConfiguration>

代码生成后的项目整合

生成的代码文件需要整合到现有的项目中，进行调试和运行。本节将详细介绍如何将生成的代码文件整合到项目中，并提供一些调试和运行的技巧。

5.1 将生成的代码整合到现有项目中

将生成的代码文件整合到现有项目中，通常包括以下几个步骤：

拷贝生成的文件:
- 将生成的Mapper接口、XML映射文件和实体类等文件拷贝到项目的相应目录下。

配置Mybatis配置文件:

在Mybatis的配置文件mybatis-config.xml中配置生成的Mapper文件路径。

<mappers>
   <mapper resource="com/example/mapper/UserMapper.xml"/>
   <mapper resource="com/example/mapper/RoleMapper.xml"/>
</mappers>

修改项目依赖:
- 确保项目依赖中包含生成的实体类和Mapper接口的包路径。

5.2 调试与运行生成的代码

调试和运行生成的代码时，需要注意以下几点：

检查数据库连接:
- 确保数据库连接信息正确，并且数据库中的表结构与生成的代码文件对应。

测试生成的Mapper接口:

编写单元测试代码，验证生成的Mapper接口的正确性。

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.apache.ibatis.session.defaults.DefaultSqlSessionFactory;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;

public class MapperTest {

   @Test
   public void testSelectAll() throws IOException {
       String resource = "mybatis-config.xml";
       InputStream inputStream = Resources.getResourceAsStream(resource);
       SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
       SqlSession session = sqlSessionFactory.openSession();
       UserMapper mapper = session.getMapper(UserMapper.class);
       List<User> users = mapper.selectAll();
       System.out.println(users);
   }
}

异常处理:
- 在代码中添加适当的异常处理机制，确保在数据库操作出现异常时能够正确处理。

5.3 常见问题及解决方法

在使用代码生成器的过程中，可能会遇到一些常见问题，以下是一些常见的问题及解决方法：

配置文件错误:
- 确保配置文件中的表名、包名等信息正确无误。
- 检查配置文件的语法是否正确。
数据库连接失败:
- 检查数据库连接URL、用户名、密码是否正确。
- 确保数据库服务已启动。
生成代码格式不符合要求:
- 自定义模板文件，修改生成代码的格式和风格。
生成的代码无法运行:
- 检查生成的代码是否与项目中的其他代码兼容。
- 确保生成的代码文件路径正确，并且在项目中可用。

实战案例分享

在实际项目中使用Mybatis代码生成器可以显著提高开发效率，减少手工编写代码的工作量。本节将分享一些实际项目的应用示例，并介绍如何优化生成的代码。

6.1 实际项目中的应用示例

一个实际项目中应用Mybatis代码生成器的例子可以是一个电商系统。该系统需要频繁地与数据库进行交互，包括商品信息管理、用户信息管理、订单管理等。通过使用Mybatis代码生成器，可以自动生成所有相关的Mapper接口、XML映射文件和实体类，从而大大减少开发工作量。

6.2 如何优化生成的代码

优化生成的代码可以从以下几个方面入手：

自定义模板:
- 通过自定义模板文件，可以优化生成代码的格式和风格，使其更符合项目编码规范。
配置参数优化:
- 根据项目的实际需求，调整配置文件中的参数，例如启用懒加载、生成计数查询等。
静态代码检查:
- 使用静态代码检查工具（如SonarQube、Checkstyle等），对生成的代码进行检查和优化。
手动调整:
- 对于生成的代码中不合理的地方，手动进行调整和优化。

6.3 总结与展望

通过本篇文章的学习，我们了解了Mybatis代码生成器的基本概念、配置方法以及如何将生成的代码整合到实际项目中。Mybatis代码生成器能够显著提高开发效率，减少重复性劳动。未来，随着技术的发展，代码生成器将会变得越来越智能，能够更好地适应各种复杂场景。

希望本篇文章能够帮助读者更好地理解和使用Mybatis代码生成器，提高开发效率。如果需要进一步学习Mybatis相关知识，推荐访问慕课网，获取更多详细的教程和实战案例。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

偶然的你

手记
篇

粉丝

10

获赞与收藏

51

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19187 313

Java 并发原理入门教程

26个小节 38860 566

Java 入门教程

50个小节 340923 3155

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

Mybatis代码生成器项目实战：轻松入门与实践

Mybatis代码生成器简介

1.1 什么是Mybatis代码生成器

1.2 代码生成器的作用和优势

1.3 常用的Mybatis代码生成器工具介绍

准备工作

2.1 安装环境搭建

2.2 下载和引入代码生成器插件

2.3 数据库配置与连接设置

Mybatis代码生成器配置详解

3.1 配置文件解析

3.2 常用配置参数说明

3.3 自定义模板文件

生成Mybatis代码实战

4.1 生成Mapper接口及XML文件

4.2 生成实体类

4.3 处理关联关系的代码生成

代码生成后的项目整合

5.1 将生成的代码整合到现有项目中

5.2 调试与运行生成的代码

5.3 常见问题及解决方法

实战案例分享

6.1 实际项目中的应用示例

6.2 如何优化生成的代码

6.3 总结与展望

阅读免费教程