SpringBoot - MyBatis-Plus使用详解7（Mapper的CRUD接口4：多表关联查询）

2020-05-15 发布：hangge 阅读：7381

Mybatis-Plus 由于内置通用 Mapper、通用 Service，无需复杂的配置即可实现单表大部分 CRUD 操作，大大减少了 MyBatis 的代码量。

但如果遇到关联属性的查询（1 对 1，1 对 n ），那么仍然需要我们通过自己写 SQL 的方式去做。这个我们可以使用注解的方式去做，也选择使用 xml 文件的方式，下面分别通过样例进行介绍。

七、Mapper 的 CRUD 接口4：多表关联查询（使用注解）

1，自定义 sql

（1）假设我们有如下两张表：用户表（User）、区域表（Area），其中用户表里通过 area_id 字段关联区域表的 id 主键：

（2）假设我们希望查询 User 时也能获取其所属的区域名称，这里对 User 实体类增加 areaName 属性：

提示：由于 area_name 不是 User 数据库表里的字段，因此需要添加 @TableField 注解，并将 exist 属性设置为 false。

@Data
public class User {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String userName;
    private String passWord;
    private Integer areaId;
    @TableField(exist = false)
    private String areaName;
}

（3）然后在 UserMapper 中添加相关查询方法以及关联查询语句：

public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT user.*, area.area_name FROM user, area " +
            "WHERE user.area_id = area.id and user.id = #{id}")
    User getUserById(int id);
}

（4）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    UserMapper userMapper;

    @RequestMapping("/test")
    public User test(){
        User user = userMapper.getUserById(1);
        return user;
    }
}

2，使用 @One 注解实现一对一关联

（1）这里我们对 User 实体类稍作修改，这次不再是增加 areaName 属性，而是直接增加 area 关联对象：

@Data
public class User {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String userName;
    private String passWord;
    private Integer areaId;
    @TableField(exist = false)
    private Area area;
}

（2）我们对 UserMapper 做如下修改，使用 @Results 注解来映射查询结果集到实体类属性：

提示：

当我们需要通过查询到的一个字段值作为参数，去执行另外一个方法来查询关联的内容，而且两者是一对一关系时，可以使用 @One 注解来便捷的实现。
selectById 方法是 BaseMapper 就提供的，所以我们不需要在 AreaMapper 中手动定义。
@Result(column = "area_id", property = "areaId") 可以不写，也不会报错。但是会导致我们查询结果（User 实体）的 areaId 属性没有值（因为第二个 Result 将 area_id 值作为查询条件传入子查询）。

public interface UserMapper extends BaseMapper<User> {
    @Results({
            @Result(column = "area_id", property = "areaId"),
            @Result(column = "area_id", property = "area",
                    one = @One(select = "com.example.demo.mapper.AreaMapper.selectById"))
    })
    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(int id);
}

（3）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    UserMapper userMapper;

    @RequestMapping("/test")
    public User test(){
        User user = userMapper.getUserById(1);
        return user;
    }
}

3，使用 @Many 注解实现一对多关联

（1）假设我们需要查询一个区域及其下面的所有用户，首先对 Area 实体类稍作修改，增加 users 集合属性：

@Data
public class Area {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String areaName;
    @TableField(exist = false)
    private List<User> users;
}

（2）我们对 AreaMapper 做如下修改，使用 @Results 注解来映射查询结果集到实体类属性：

提示：

@Many 的用法与 @One 类似，只不过如果使用 @One 查询到的结果是多行，会抛出 TooManyResultException 异常，这种时候应该使用的是 @Many 注解，实现一对多的查询。
@Result(column = "id", property = "id") 可以不写，也不会报错。但是会导致我们查询结果（Area 实体）的 id 属性没有值（因为第二个 Result 将 id 值作为查询条件传入子查询）。

public interface AreaMapper extends BaseMapper<Area> {
    @Results({
            @Result(column = "id", property = "id"),
            @Result(column = "id", property = "users",
                    many = @Many(select = "com.example.demo.mapper.UserMapper.selectByAreaId"))
    })
    @Select("SELECT * FROM area WHERE id = #{id}")
    Area getAreaById(int id);
}

（3）由于上面调用了 UserMapper 的 selectByAreaId 方法进行嵌套查询，因此 UserMapper 中要添加该方法：

public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM user WHERE area_id = #{areaId}")
    User selectByAreaId(int areaId);
}

（4）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    AreaMapper areaMapper;

    @RequestMapping("/test")
    public Area test(){
        Area area = areaMapper.getAreaById(1);
        return area;
    }
}

附：多表关联查询（使用 xml 文件）

1，自定义 sql

（1）假设我们有如下两张表：用户表（User）、区域表（Area）,其中用户表里通过 area_id 字段关联区域表的 id 主键：

（2）假设我们希望查询 User 时也能获取其所属的区域名称，这里对 User 实体类增加 areaName 属性：

提示：由于 area_name 不是 User 数据库表里的字段，因此需要添加 @TableField 注解，并将 exist 属性设置为 false。

@Data
public class User {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String userName;
    private String passWord;
    private Integer areaId;
    @TableField(exist = false)
    private String areaName;
}

（3）然后在 UserMapper 中添加相关查询方法：

public interface UserMapper extends BaseMapper<User> {
    User getUserById(int id);
}

（4）接着在 UserMapper 同一个文件夹下创建一个 UserMapper.xml，在里面编写对应的 sql 语句：

<?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.demo.mapper.UserMapper">
    <resultMap type="com.example.demo.model.User" id="BaseResultMap">
    </resultMap>
    <select id="getUserById" resultMap="BaseResultMap">
            SELECT user.*, area.area_name FROM user, area
            WHERE user.area_id = area.id and user.id = #{id}
    </select>
</mapper>

（5）由于在 Maven 工程中，XML 配置文件建议写在 resources 目录下，但上面的 UserMapper.xml 文件写在包下，Maven 在运行时会忽略包下的 XML 文件。因此需要在 pom.xml 文件中重新指明资源文件位置，配置如下：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
    <!-- 重新指明资源文件位置 -->
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
        </resource>
    </resources>
</build>

（6）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    UserMapper userMapper;

    @RequestMapping("/test")
    public User test(){
        User user = userMapper.getUserById(1);
        return user;
    }
}

2，实现一对一关联

（1）这里我们对 User 实体类稍作修改，这次不再是增加 areaName 属性，而是直接增加 area 关联对象：

@Data
public class User {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String userName;
    private String passWord;
    private Integer areaId;
    @TableField(exist = false)
    private Area area;
}

（2）UserMapper 里代码同上面一样，主要对 UserMapper.xml 稍作修改，使用子查询来查询关联的区域：

提示：

selectById 方法是 BaseMapper 本身就提供的，所以我们不需要在 AreaMapper 中手动定义。
resultMap 中的第一个 result 可以不写，也不会报错。但是会导致我们查询结果（User 实体）的 areaId 属性没有值（因为后面将 area_id 值作为查询条件传入子查询）。

<?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.demo.mapper.UserMapper">

    <resultMap type="com.example.demo.model.User" id="BaseResultMap">
        <result property="areaId" column="area_id"/>
        <association property="area" column="area_id"
                     select="com.example.demo.mapper.AreaMapper.selectById"/>
    </resultMap>

    <select id="getUserById" resultMap="BaseResultMap">
        SELECT * FROM user WHERE id = #{id}
    </select>

</mapper>

（3）当然我们也可以使用嵌套结果集来实现相同的效果（嵌套结果集这种方式是单纯使用注解没法做到的）：

<?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.demo.mapper.UserMapper">

    <resultMap type="com.example.demo.model.User" id="BaseResultMap">
        <result property="id" column="id"/>
        <result property="userName" column="user_name"/>
        <result property="passWord" column="pass_word"/>
        <result property="areaId" column="area_id"/>
        <association property="area">
            <id property="id" column="area_id"/>
            <result property="areaName" column="area_name"/>
        </association>
    </resultMap>

    <select id="getUserById" resultMap="BaseResultMap">
        SELECT user.*, area.area_name, area.id as area_id
        FROM user, area
        WHERE user.area_id = area.id and user.id = #{id}
    </select>

</mapper>

（4）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    UserMapper userMapper;

    @RequestMapping("/test")
    public User test(){
        User user = userMapper.getUserById(1);
        return user;
    }
}

3，实现一对多关联

（1）假设我们需要查询一个区域及其下面的所有用户，首先对 Area 实体类稍作修改，增加 users 集合属性：

@Data
public class Area {
    //指定主键使用数据库ID自增策略
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String areaName;
    @TableField(exist = false)
    private List<User> users;
}

（2）我们对 AreaMapper 做如下修改，增加一个查询方法：

public interface AreaMapper extends BaseMapper<Area> {
    Area getAreaById(int id);
}

（3）接着在 AreaMapper 同一个文件夹下创建一个 AreaMapper.xml，在里面编写对应的 sql 语句，这里我们使用嵌套查询来实现：

提示：<result property="id" column="id"/> 可以不写，也不会报错。但是会导致我们查询结果（Area 实体）的 id 属性没有值（因为后面将 id 值作为查询条件传入子查询）。

<?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.demo.mapper.AreaMapper">

    <resultMap type="com.example.demo.model.Area" id="BaseResultMap">
        <result property="id" column="id"/>
        <collection property="users" column="id"
                    select="com.example.demo.mapper.UserMapper.selectByAreaId"/>
    </resultMap>

    <select id="getAreaById" resultMap="BaseResultMap">
        SELECT * FROM area WHERE id = #{id}
    </select>

</mapper>

由于上面调用了 UserMapper 的 selectByAreaId 方法进行嵌套查询，因此 UserMapper 中要添加该方法：

public interface UserMapper extends BaseMapper<User> {
    User selectByAreaId(int id);
}

对应的 UserMapper.xml 中也要增加相应的 SQL 语句：

<mapper namespace="com.example.demo.mapper.UserMapper">

    <resultMap type="com.example.demo.model.User" id="BaseResultMap">
    </resultMap>

    <select id="selectByAreaId" resultMap="BaseResultMap">
        SELECT * FROM user WHERE area_id = #{areaId}
    </select>

</mapper>

（4）当然，我还可以使用嵌套结果集来实现相同的效果（嵌套结果集这种方式是单纯使用注解没法做到的），AreaMapper.xml 代码如下（而 UserMapper 就不用像上面一样增加接口了）：

<?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.demo.mapper.AreaMapper">

    <resultMap type="com.example.demo.model.Area" id="BaseResultMap">
        <id property="id" column="id"/>
        <id property="areaName" column="area_name"/>
        <collection property="users" ofType="com.example.demo.model.User">
            <id property="id" column="user_id"/>
            <result property="userName" column="user_name"/>
            <result property="passWord" column="pass_word"/>
            <result property="areaId" column="area_id"/>
        </collection>
    </resultMap>

    <select id="getAreaById" resultMap="BaseResultMap">
        SELECT area.*, user.id as user_id, user.user_name, user.pass_word, user.area_id
        FROM area, user
        WHERE area.id = user.area_id AND area.id = #{id}
    </select>

</mapper>

（5）最后调用这个方法测试一下：

@RestController
public class HelloController {

    @Autowired
    AreaMapper areaMapper;

    @RequestMapping("/test")
    public Area test(){
        Area area = areaMapper.getAreaById(1);
        return area;
    }
}