Mybatis generator修改Mapper.java文件实现详解

下面我会详细讲解“Mybatis generator修改Mapper.java文件实现详解”的完整攻略。

概述

Mybatis generator是一个常用的代码生成工具，可以用于自动生成Mybatis的Mapper XML、Mapper Java以及POJO等文件。通常情况下，使用Mybatis generator可以很方便地生成出需要的代码。但是，有的时候我们需要对生成的Mapper Java文件进行一些修改，以达到特定的需求。本文就是介绍如何利用Mybatis generator修改Mapper.java文件。

实现步骤

步骤一：生成Mapper.xml和Mapper.java文件

首先，我们需要使用Mybatis generator生成Mapper.xml和Mapper.java文件，具体步骤可以参考官网文档。

步骤二：修改Mybatis generator配置文件

在Mybatis generator配置文件中，我们需要指定自定义的Mapper.java文件的路径和名称。具体步骤如下：

打开Mybatis generator配置文件（一般为generatorConfig.xml）
找到对应table节点中的节点，如下所示：

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

修改type属性的值为“ANNOTATEDMAPPER”：

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

对于修改了type属性为“ANNOTATEDMAPPER”的table节点，Mybatis generator会自动生成一个以Mapper.java为后缀的Java文件。

步骤三：对Mapper.java文件进行修改

此时，我们已经生成了目标Mapper Java文件，可以直接在文件中进行修改。还是以上面的示例为例，假设我们需要在Mapper.java文件中添加一个insertSelective方法来插入某些字段，我们可以在Mapper.java文件中加入如下代码：

public interface UserMapper {

    int insertSelective(User record);
}

需要注意的是，上述代码要和Mybatis generator生成的代码一起存在。

示例

示例一：在Mapper.java文件中添加updateNameById方法

假设我们有一张名为user的表，有一些字段，如id、name、age等等。现在，我们需要在Mapper.java文件中添加一个updateNameById方法，可以更改某个id对应的记录的name字段。具体步骤如下：

在Mybatis generator配置文件中，找到对应table节点中的节点，修改type属性的值为“ANNOTATEDMAPPER”；
运行Mybatis generator，生成Mapper.xml和Mapper.java文件；
打开Mapper.java文件，添加updateNameById方法，如下所示：

public interface UserMapper {

    int updateNameById(@Param("id") Integer id, @Param("name") String name);
}

其中，@Param注解是Mybatis中提供的注解，用于解决传递多个参数时，参数名字被替换成arg0、arg1等的问题。

至此，我们已经成功的添加了一个新的方法。

示例二：在Mapper.java文件中添加insertSelective方法

假设我们有一张名为user的表，有一些字段，如id、name、age等等。现在，我们需要在Mapper.java文件中添加一个insertSelective方法，可以插入某些字段。具体步骤如下：

在Mybatis generator配置文件中，找到对应table节点中的节点，修改type属性的值为“ANNOTATEDMAPPER”；
运行Mybatis generator，生成Mapper.xml和Mapper.java文件；
打开Mapper.java文件，添加insertSelective方法，如下所示：

public interface UserMapper {

    int insertSelective(User record);
}