Mybatis代码生成器教程：快速入门指南

Mybatis代码生成器教程介绍了如何利用代码生成器自动生成Mybatis的Mapper接口、Mapper XML文件和实体类，从而减少开发人员的工作量并提高代码一致性。文章详细讲解了准备工作、配置代码生成器以及使用生成器生成Mybatis代码的步骤。通过本教程，你可以快速掌握Mybatis代码生成器的使用方法。

什么是Mybatis代码生成器

Mybatis代码生成器是一种工具，可以自动生成Mybatis的Mapper接口、Mapper XML文件和实体类。这些自动生成的代码能显著减少开发人员的工作量，并提高代码的一致性和质量。

代码生成器的作用和优势

1. 减少手工编写代码：使用代码生成器可以自动生成Mybatis相关代码，减少开发人员的手动编码工作。
2. 提高代码一致性：生成的代码遵循统一的模板和规范，有助于维护代码风格的一致性。
3. 加快开发速度：自动生成代码可以缩短开发周期，使开发人员能够更快地完成任务。
4. 简化数据库操作：通过生成的代码，开发人员可以直接从数据库中读取数据，无需手动编写复杂的SQL语句。

安装Java开发环境

1. 安装Java JDK：下载并安装适合的Java开发工具包（JDK），例如Oracle JDK或OpenJDK。
2. 配置环境变量：将JDK的bin目录添加到系统的PATH环境变量中。例如，如果JDK安装在C:\Program Files\Java\jdk1.8.0_281，则在环境变量中添加C:\Program Files\Java\jdk1.8.0_281\bin。

export JAVA_HOME=/usr/local/jdk
export PATH=$JAVA_HOME/bin:$PATH

1. 验证安装：打开命令行工具，执行java -version，确保安装成功。

java -version

下载并配置Mybatis框架

1. 下载Mybatis：从官方网站下载Mybatis的最新版本，或者通过Maven依赖管理获取。
2. 配置本地库：将下载的Mybatis jar包放入本地Maven库中，或在项目中添加Maven依赖。

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>

1. 配置数据库连接：在项目的配置文件中配置数据库连接信息，例如application.properties。

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

获取并安装Mybatis代码生成器插件

1. 下载代码生成器插件：从GitHub或其他代码托管平台下载Mybatis代码生成器插件，例如Mybatis Generator。
2. 配置生成器：根据插件文档配置生成器的配置文件，例如generatorConfig.xml。

<generatorConfiguration>
    <classPathEntry location="C:\Program Files\Java\mysql-connector-java-8.0.21.jar"/>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverType="MySQL">
            <property name="connectionURL" value="jdbc:mysql://localhost:3306/mydatabase"/>
            <property name="driverClass" value="com.mysql.cj.jdbc.Driver"/>
            <property name="password" value="root"/>
            <property name="userId" value="root"/>
        </jdbcConnection>
        <javaModelGenerator targetPackage="com.example.model" targetProject="/path/to/project/src/main/java"/>
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="/path/to/project/src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="/path/to/project/src/main/java"/>
    </context>
</generatorConfiguration>

配置数据库连接信息

在配置文件中指定数据库连接信息，包括数据库类型、URL、用户名和密码等。

<jdbcConnection driverType="MySQL">
    <property name="connectionURL" value="jdbc:mysql://localhost:3306/mydatabase"/>
    <property name="driverClass" value="com.mysql.cj.jdbc.Driver"/>
    <property name="password" value="root"/>
    <property name="userId" value="root"/>
</jdbcConnection>

配置生成代码的规则和模板

定义生成代码的规则和模板，包括生成实体类的位置、生成Mapper接口的位置等。

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

导入数据库表信息

向代码生成器配置文件中添加具体的数据库表信息，例如：

<table tableName="users" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
</table>

生成Mapper接口、Mapper XML文件和实体类

执行代码生成器命令，生成所需的Mapper接口、Mapper XML文件和实体类。例如：

java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml

生成的文件结构如下：

src/main/java/com/example/model/User.java
src/main/resources/com/example/mapper/UserMapper.xml
src/main/java/com/example/mapper/UserMapper.java

如何在项目中引入生成的代码

将生成的代码引入到项目中，确保项目能够正确编译和运行。

1. 引入生成的实体类：在业务代码中引入生成的实体类，例如User.java。

import com.example.model.User;

public class UserService {
    public User getUserById(int id) {
        // 使用Mybatis进行数据库操作
    }
}

1. 引入生成的Mapper接口：在业务代码中引入生成的Mapper接口，例如UserMapper.java。

import com.example.mapper.UserMapper;

public class UserService {
    private UserMapper userMapper;

    public User getUserById(int id) {
        return userMapper.selectByPrimaryKey(id);
    }
}

1. 配置Mybatis的Mapper扫描：在项目的配置文件中配置Mybatis的Mapper扫描，确保Mapper接口能够被正确注入。

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
</bean>

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    <property name="basePackage" value="com.example.mapper"/>
</bean>

代码的常见修改和优化

1. 修改Mapper接口：根据实际需求修改生成的Mapper接口，添加或修改方法。

public interface UserMapper {
    User selectByPrimaryKey(Integer id);
    void insert(User record);
    int updateByPrimaryKey(User record);
}

1. 优化SQL语句：根据实际需求优化生成的SQL语句，例如添加索引、优化查询条件。

<select id="selectByPrimaryKey" parameterType="int" resultType="com.example.model.User">
    SELECT * FROM users WHERE id = #{id}
</select>

1. 增加事务管理：在业务代码中增加事务管理，确保数据库操作的原子性和一致性。

@Transactional
public void updateUser(User user) {
    userMapper.updateByPrimaryKey(user);
}

常见错误提示

1. 数据库连接失败：检查数据库连接信息是否正确，确保数据库服务已启动。
2. 生成代码失败：检查配置文件是否正确配置，确保数据库表信息正确无误。
3. 编译错误：检查生成的代码是否符合Java规范，确保项目依赖库配置正确。

解决方法和技巧

1. 数据库连接失败：

   • 检查数据库URL、用户名和密码是否正确。
   • 确保数据库驱动类路径正确，例如mysql-connector-java-8.0.21.jar。

2. 生成代码失败：

   • 检查配置文件中的<table>标签是否正确配置，确保表名和字段名正确。
   • 检查数据库表结构是否符合生成器的要求，例如主键字段必须存在。
3. 编译错误：
   • 检查生成的代码是否符合Java规范，例如类名、方法名是否正确。
   • 确保项目依赖库配置正确，例如添加Mybatis、JDBC驱动等依赖。

通过以上步骤，你可以快速入门Mybatis代码生成器，并在实际开发中应用。更多详细信息和高级用法请参考Mybatis官方文档或代码生成器插件的文档。