MyBatis使用递归查询来实现多级菜单的功能

MyBatis使用递归查询来实现多级菜单的功能

• 一、前言
• • [1. 什么是递归查询？](#1. 什么是递归查询？)
  • • [2. 目标](#2. 目标)
  • [3. 数据库表结构](#3. 数据库表结构)
  • [4. MyBatis 配置](#4. MyBatis 配置)
  • [5. 代码解析](#5. 代码解析)
  • [6. 实现步骤](#6. 实现步骤)
  • [7. 总结](#7. 总结)

---

一、前言

在这篇文章中，我们将探讨如何使用递归查询来实现多级菜单的功能。具体来说，我们将使用 MyBatis 框架来执行这种递归查询，从而在 Java 应用程序中构建一个层级结构的菜单系统。

1. 什么是递归查询？

递归查询是一种查询技术，它允许数据库根据父子关系自我引用，以获取层级结构的数据。例如，在一个多级菜单系统中，菜单项可能有子菜单项，而这些子菜单项也可能有自己的子菜单项，这种结构需要递归查询来完整地提取所有数据。

2. 目标

我们的目标是实现一个菜单系统，该系统可以处理多级菜单，其中每个菜单项可以有多个子菜单项。我们将使用 MyBatis 框架进行数据映射和查询。

3. 数据库表结构

假设我们有一个名为 menu 的数据库表，其结构如下：

id	name	parentId
1	Menu 1	0
2	Menu 1.1	1
3	Menu 1.2	1
4	Menu 1.1.1	2
5	Menu 2	0

在这个表中，id 是菜单项的唯一标识符，name 是菜单项的名称，parentId 指向父菜单项的 id。

4. MyBatis 配置

在 MyBatis 中，我们需要配置两个主要的元素来实现递归查询：

1. resultMap: 用于定义如何将查询结果映射到 Java 对象。
2. select: 用于定义 SQL 查询语句。

以下是 MyBatis 配置文件的示例：

<?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.MenuMapper">
    <resultMap type="com.example.demo.bean.Menu" id="BaseResultMap">
        <id column="id" property="id"/>
        <result column="name" property="name"/>
        <collection property="children" select="findMenuByParentId" column="id"/>
    </resultMap>
 
    <!-- 级联查询父菜单 -->
    <select id="getAllMenus" resultMap="BaseResultMap" >
        select * from menu where parentId = 0
    </select>
 
    <!-- 级联查询子菜单 -->
    <select id="findMenuByParentId" resultMap="BaseResultMap" >
        select * from menu where parentId = #{id}
    </select>
</mapper>

5. 代码解析

1. <resultMap>

   <resultMap type="com.example.demo.bean.Menu" id="BaseResultMap">
       <id column="id" property="id"/>
       <result column="name" property="name"/>
       <collection property="children" select="findMenuByParentId" column="id"/>
   </resultMap>

   • id 和 result 元素定义了如何将 SQL 查询结果映射到 Menu 类的字段。
   • collection 元素定义了如何递归地获取子菜单。select 属性指定了用于获取子菜单的 SQL 查询方法 findMenuByParentId，column 属性指定了 id 列作为递归查询的键。

2. <select>

   • getAllMenus 查询所有顶级菜单项（parentId 为 0）。

     <select id="getAllMenus" resultMap="BaseResultMap" >
         select * from menu where parentId = 0
     </select>

   • findMenuByParentId 查询指定父菜单项的所有子菜单项。

     <select id="findMenuByParentId" resultMap="BaseResultMap" >
         select * from menu where parentId = #{id}
     </select>

6. 实现步骤

1. 定义 Java 类

   package com.example.demo.bean;
   
   import java.util.List;
   
   public class Menu {
       private int id;
       private String name;
       private List<Menu> children;
   
       // Getters and setters
   }

2. 定义 Mapper 接口

   package com.example.demo.mapper;
   
   import com.example.demo.bean.Menu;
   import org.apache.ibatis.annotations.Select;
   import java.util.List;
   
   public interface MenuMapper {
       @Select("select * from menu where parentId = 0")
       List<Menu> getAllMenus();
   
       @Select("select * from menu where parentId = #{id}")
       List<Menu> findMenuByParentId(int id);
   }

3. 在 Service 或 Controller 中使用 Mapper

   @Service
   public class MenuService {
       @Autowired
       private MenuMapper menuMapper;
   
       public List<Menu> getAllMenus() {
           return menuMapper.getAllMenus();
       }
   }

   @Controller
   public class MenuController {
       @Autowired
       private MenuService menuService;
   
       @GetMapping("/menus")
       @ResponseBody
       public List<Menu> getAllMenus() {
           return menuService.getAllMenus();
       }
   }

7. 总结

通过上述配置和代码示例，我们实现了一个多级菜单的递归查询功能。MyBatis 的递归查询通过在 resultMap 中使用 collection 元素，实现了对父子关系的自动处理。这样的设计使得我们能够轻松地构建和管理层级结构的数据，而无需手动处理复杂的 SQL 逻辑。