首页手记 Mybatis官方生成器学习入门指南

Mybatis官方生成器学习入门指南

标签：

Java 设计模式数据库

概述

本文介绍了Mybatis官方生成器学习入门指南，包括Mybatis的基本特性和核心概念，详细讲解了Mybatis官方生成器的作用、安装与配置方法以及基本使用步骤。通过配置XML文件和运行生成器，开发者可以快速生成Mybatis的Java模型对象、Mapper接口以及XML映射文件，提高开发效率。

Mybatis官方生成器学习入门指南

Mybatis简介

Mybatis是什么

Mybatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。Mybatis 可以使用简单的 XML 或注解进行配置和原始映射，将接口和 Java 的 POJOs (Plain Old Java Objects，普通的 Java 对象) 映射成数据库中的记录。

Mybatis的基本特点

Mybatis 的基本特点包括：

简单易用：Mybatis 的 API 使用简单，只需要基本的 Java 开发知识就可以使用 Mybatis。
灵活性：Mybatis 允许在 SQL 语句中使用参数，使得 SQL 语句更具灵活性。
性能优良：Mybatis 使用了直接的 JDBC 调用，但是省略了 JDBC 的准备工作以及结果集的转化部分。
易于维护：Mybatis 的 XML 映射文件将 SQL 语句和 Java 代码完全分离，使得维护起来更加方便。
支持存储过程：Mybatis 支持存储过程，并且可以将存储过程映射成 Java 方法。
支持高级映射：Mybatis 支持自定义 SQL 语句，允许自定义存储过程和高级映射。

Mybatis的核心概念

Mybatis 的核心概念包括：

SqlSessionFactory：SqlSessionFactory 是 Mybatis 的核心接口，用于创建 SqlSession 实例。
SqlSession：SqlSession 是 Mybatis 进行数据库交互的入口，提供了包括增删改查、事务管理等数据库操作的接口。
Mapper：Mapper 是 Mybatis 中用于定义数据操作的接口，这些接口中的方法对应具体的 SQL 语句。
Configuration：Configuration 是 Mybatis 的配置信息，包含数据库连接、表映射等配置信息。
Executor：Executor 是 Mybatis 的执行器，负责执行 SQL 语句并返回结果。
Mapped Statements：Mapped Statements 定义了 SQL 语句及其参数映射规则，通常在 XML 映射文件中定义。
Parameter Map：Parameter Map 定义了参数映射规则，用于将 Java 对象映射到 SQL 语句中的参数。
Result Map：Result Map 定义了结果映射规则，用于将 SQL 语句返回的结果集映射到 Java 对象。

生成器简介

Mybatis生成器的作用

Mybatis生成器（Mybatis Generator）是一个工具，用于根据数据库表生成 Mybatis 的 Java 模型对象、映射文件（XML）以及对应的 Mapper 接口。使用生成器可以节省手动编写这些代码的时间，提高开发效率。

生成器的安装与配置

要使用 Mybatis生成器，首先需要安装 Mybatis Generator。Mybatis Generator 可以通过 Maven 或 Gradle 插件安装，也可以直接下载 JAR 包使用。

Maven 安装

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

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

Gradle 安装

在项目的 build.gradle 文件中添加 Mybatis Generator 依赖：

dependencies {
    compile 'org.mybatis.generator:mybatis-generator-core:1.3.7'
}

配置 XML 文件

创建一个名为 generatorConfig.xml 的配置文件，用于定义生成器的配置信息：

<generatorConfiguration>
    <context id="testContext" targetRuntime="MYBATIS3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <classPathEntry path="path/to/mysql-connector-java.jar"/>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" 
            connectionURL="jdbc:mysql://localhost:3306/testdb" 
            userId="root" 
            password="password"/>

        <javaModelGenerator targetPackage="com.example.model" 
            targetProject="src/main/java"/>
        <sqlMapGenerator targetPackage="com.example.mapper" 
            targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" 
            targetProject="src/main/java"/>

        <table tableName="user" domainObjectName="User">
            <columnOverride column="id" javaType="Long"/>
            <columnOverride column="create_time" javaType="java.util.Date"/>
        </table>
    </context>
</generatorConfiguration>

生成器的基本使用方法

生成器的基本使用方法包括以下几个步骤：

准备数据库和 Java 项目环境：确保数据库和 Java 项目环境已经准备好。
配置生成器的 XML 文件：根据实际需求配置生成器的 XML 文件。
运行生成器生成代码：使用 Maven 或 Gradle 命令运行生成器生成代码。
检查生成的代码是否正确：检查生成的 Java 模型对象、Mapper 接口以及 XML 映射文件是否正确。

生成器的使用步骤

准备数据库和Java项目环境

确保数据库和 Java 项目环境已经准备好，包括数据库连接信息、数据库表结构以及 Java 项目的基本结构。

准备数据库

创建一个数据库表，例如用户表：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `email` varchar(255) NOT NULL,
  `create_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

准备 Java 项目环境

在 Java 项目中创建基本的目录结构，例如：

src/main/java/com/example/model
src/main/java/com/example/mapper
src/main/resources

配置生成器的XML文件

编辑 generatorConfig.xml 文件，配置生成器的相关参数。以下是一个示例配置：

<generatorConfiguration>
    <context id="testContext" targetRuntime="MYBATIS3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <classPathEntry path="path/to/mysql-connector-java.jar"/>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" 
            connectionURL="jdbc:mysql://localhost:3306/testdb" 
            userId="root" 
            password="password"/>

        <javaModelGenerator targetPackage="com.example.model" 
            targetProject="src/main/java"/>
        <sqlMapGenerator targetPackage="com/example/mapper" 
            targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" 
            targetProject="src/main/java"/>

        <table tableName="user" domainObjectName="User">
            <columnOverride column="id" javaType="Long"/>
            <columnOverride column="create_time" javaType="java.util.Date"/>
        </table>
    </context>
</generatorConfiguration>

运行生成器生成代码

使用 Maven 或 Gradle 命令运行生成器生成代码。例如，使用 Maven 命令：

mvn mybatis-generator:generate

或者使用 Gradle 命令：

gradle mybatisGenerator

检查生成的代码是否正确

检查生成的 Java 模型对象、Mapper 接口以及 XML 映射文件是否正确。例如，生成的 User 类：

package com.example.model;

import java.util.Date;

public class User {
    private Long id;
    private String name;
    private String email;
    private Date createTime;

    // getters and setters...
}

生成的 UserMapper 接口：

package com.example.mapper;

import com.example.model.User;

public interface UserMapper {
    int deleteByPrimaryKey(Long id);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Long id);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

生成的 UserMapper.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.example.mapper.UserMapper">
    <resultMap id="BaseResultMap" type="com.example.model.User">
        <id column="id" jdbcType="INTEGER" property="id" />
        <result column="name" jdbcType="VARCHAR" property="name" />
        <result column="email" jdbcType="VARCHAR" property="email" />
        <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    </resultMap>

    <sql id="Base_Column_List">
        id, name, email, create_time
    </sql>

    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Long">
        SELECT
        <include refid="Base_Column_List" />
        FROM user
        WHERE id = #{id,jdbcType=INTEGER}
    </select>

    <!-- 更多 SQL 语句 -->
</mapper>

生成器的使用示例

通过配置和运行生成器，可以快速生成 Mybatis 的 Java 模型对象、Mapper 接口以及 XML 映射文件。接下来展示如何使用生成的代码进行 CRUD 操作：

插入数据

User user = new User();
user.setName("张三");
user.setEmail("zhangsan@example.com");
user.setCreateTime(new Date());

userMapper.insert(user);

查询数据

User user = userMapper.selectByPrimaryKey(1L);
System.out.println("Name: " + user.getName());
System.out.println("Email: " + user.getEmail());

更新数据

user.setName("李四");
user.setCreateTime(new Date());
userMapper.updateByPrimaryKey(user);

删除数据

userMapper.deleteByPrimaryKey(1L);

调整生成器的输出目录

可以通过修改 targetProject 参数来调整生成器的输出目录。例如：

<javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>
<sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>
<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>

自定义生成的模型对象

可以通过配置 domainObjectName 参数来自定义生成的模型对象名称。例如：

<table tableName="user" domainObjectName="User">
    <columnOverride column="id" javaType="Long"/>
    <columnOverride column="create_time" javaType="java.util.Date"/>
</table>

自定义生成的Mapper接口和XML文件

可以通过配置 mapper 参数来自定义生成的 Mapper 接口和 XML 文件的包名。例如：

<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>

常见问题与解决方案

生成器运行时出现的常见错误

常见的错误包括配置文件格式不正确、数据库连接失败等。解决这些问题的方法包括：

检查配置文件：确保 XML 配置文件格式正确，没有语法错误。
检查数据库连接：确保数据库连接信息正确，包括数据库 URL、数据库用户名和密码。
检查日志信息：查看生成器的日志信息，定位错误原因。

解决配置问题的技巧

解决配置问题的技巧包括：

使用默认配置：使用 Mybatis Generator 提供的默认配置作为参考。
逐个修改配置：逐个修改配置参数，逐步验证配置是否正确。
阅读官方文档：查阅 Mybatis Generator 官方文档，了解每个配置参数的作用。

生成器不支持的一些功能

Mybatis Generator 不支持的一些功能包括：

自定义 SQL 语句：生成器不支持自定义 SQL 语句，需要手动编写。
存储过程：生成器不支持生成存储过程的代码。
自定义注解：生成器不支持自定义注解，需要手动添加注解。

总结与进阶资源

Mybatis生成器的学习总结

Mybatis生成器是一个强大的工具，可以帮助开发者快速生成 Mybatis 的 Java 模型对象、Mapper 接口以及 XML 映射文件。通过配置 XML 文件，可以灵活地控制生成的代码内容。此外，生成器还支持自定义模型对象名称、输出目录等高级配置，方便开发者根据实际需求定制生成的代码。

进一步学习Mybatis的推荐资源

推荐学习 Mybatis 的资源包括：

慕课网：提供丰富的 Mybatis 在线课程，适合不同层次的开发者学习。
官方文档：Mybatis 官方文档详细介绍了 Mybatis 的各个特性和使用方法。
社区论坛：Mybatis 社区和论坛提供了丰富的问答和经验分享，可以帮助开发者解决实际问题。

关于Mybatis社区和文档的推荐

Mybatis 官方网站：提供了 Mybatis 的最新版本、文档、下载等信息。
Mybatis GitHub：Mybatis 项目的 GitHub 仓库，包含源码、文档和 Issue 问题。
Mybatis 社区：Mybatis 社区提供了丰富的问答和经验分享，帮助开发者解决问题。

通过上述资源，可以更好地学习和使用 Mybatis，提高开发效率。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

呼唤远方

手记
篇

粉丝

82

获赞与收藏

367

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19360 315

Java 并发原理入门教程

26个小节 39076 568

Java 入门教程

50个小节 342182 3164

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空