《springboot实战》第九章 springboot 整合MyBatis - xml、注解篇

小灰灰 2023-09-25 22:23 61阅读 0赞

## 系列文章目录 ##

[第一章 SpringBoot起步][SpringBoot]  
[第二章 springboot 配置文件、多环境配置、运行优先级][springboot]  
[第三章 springboot 统一日志][springboot 1]  
[第四章 SpringBoot加载静态文件资源][SpringBoot 1]  
[第五章 springboot 拦截器][springboot 2]  
[第六章 实现自定义全局异常处理][Link 1]  
[第七章 springboot 数据库应用][springboot 3]  
[第八章 springboot 整合Druid][springboot _Druid]  
[第九章 springboot 整合MyBatis - xml、注解篇][springboot _MyBatis - xml]  
[第十一章 整合Mybatis plus][_Mybatis plus]  
[第十二章 SpringBoot整合swagger-bootstrap-ui][SpringBoot_swagger-bootstrap-ui]

--------------------

#### 文章目录 ####

*  系列文章目录
 *  前言
 *  1、添加mybatis依赖
 *  2、定义bean
 *  3、查询数据 - select
 *   *  3.1、定义Mapper
     *  3.2、定义xml
     *  3.3、动态查询语句定义
     *  3.4、配置文件
 *  4、新增数据 - insert
 *  5、注解形式

![在这里插入图片描述][a8cf9b3c27114e969796fec68fd375b1.png]

--------------------

## 前言 ##

MyBatis 是一个半自动化的 ORM 框架，所谓半自动化是指 MyBatis 只支持将数据库查出的数据映射到 POJO 实体类上，而实体到数据库的映射则需要我们自己编写 SQL 语句实现。  
官网：https://mybatis.net.cn/index.html

## 1、添加mybatis依赖 ##

<dependency>
       <groupId>org.mybatis.spring.boot</groupId>
       <artifactId>mybatis-spring-boot-starter</artifactId>
       <version>2.2.0</version>
    </dependency>

## 2、定义bean ##

package com.xxx.springboot.entity;
    
    /**
     * 房子信息
     */
    public class HouseInfo {
        
        /**
         * 主键
         */
        private Integer id;
    
        /**
         * 名称
         */
        private String name;
    
        /**
         * 户型
         */
        private String type;
    
        /**
         * 地址
         */
        private String address;
    
        public Integer getId() {
        
            return id;
        }
    
        public void setId(Integer id) {
        
            this.id = id;
        }
    
        public String getName() {
        
            return name;
        }
    
        public void setName(String name) {
        
            this.name = name;
        }
    
        public String getType() {
        
            return type;
        }
    
        public void setType(String type) {
        
            this.type = type;
        }
    
        public String getAddress() {
        
            return address;
        }
    
        public void setAddress(String address) {
        
            this.address = address;
        }
    }

## 3、查询数据 - select ##

使用 Mapper 进行开发时，需要遵循以下规则：

*  mapper 映射文件中 namespace 必须与对应的 mapper 接口的完全限定名一致。
 *  mapper 映射文件中 statement 的 id 必须与 mapper 接口中的方法的方法名一致
 *  mapper 映射文件中 statement 的 parameterType 指定的类型必须与 mapper 接口中方法的参数类型一致。
 *  mapper 映射文件中 statement 的 resultType 指定的类型必须与 mapper 接口中方法的返回值类型一致。

### 3.1、定义Mapper ###

package com.xxx.springboot.mapper;
    import com.xxx.springboot.entity.HouseInfo;
    import org.apache.ibatis.annotations.Mapper;
    import java.util.List;
    /**
     * 房屋信息mapper类
     */
    @Mapper
    public interface HouseInfoMapper {
        
        List<HouseInfo> queryHouseInfo();
    }

### 3.2、定义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.xxx.springboot.mapper.HouseInfoMapper">
        
        <resultMap id="BaseResultMap" type="HouseInfo">
            <id column="id" jdbcType="INTEGER" property="id"/>
            <result column="name" property="name" jdbcType="VARCHAR"/>
            <result column="type" property="type" jdbcType="VARCHAR"/>
            <result column="address" property="address" jdbcType="VARCHAR"/>
        </resultMap>
        
        <select id="queryHouseInfo" resultMap="BaseResultMap">
            select * from house_info
        </select>
    </mapper>

### 3.3、动态查询语句定义 ###

元素属性

<table> 
 <thead> 
  <tr> 
   <th align="left">属性</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">id</td> 
   <td align="left">在命名空间中唯一的标识符，可以被用来引用这条语句。</td> 
  </tr> 
  <tr> 
   <td align="left">parameterType</td> 
   <td align="left">将会传入这条语句的参数的类全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过类型处理器（TypeHandler）推断出具体传入语句的参数，默认值为未设置（unset）。</td> 
  </tr> 
  <tr> 
   <td align="left">resultType</td> 
   <td align="left">期望从这条语句中返回结果的类全限定名或别名。 注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。</td> 
  </tr> 
  <tr> 
   <td align="left">resultMap</td> 
   <td align="left">对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性，如果你对其理解透彻，许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。</td> 
  </tr> 
  <tr> 
   <td align="left">flushCache</td> 
   <td align="left">将其设置为 true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：false。</td> 
  </tr> 
  <tr> 
   <td align="left">useCache</td> 
   <td align="left">将其设置为 true 后，将会导致本条语句的结果被二级缓存缓存起来，默认值：对 select 元素为 true。</td> 
  </tr> 
  <tr> 
   <td align="left">timeout</td> 
   <td align="left">这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。</td> 
  </tr> 
 </tbody> 
</table>

<select id="queryHouseInfo" resultMap="BaseResultMap">
        select * from house_info
        <where>
            
            <if test="name != null and name != ''">
                and name = #{name}
            </if>
            <if test="type != null and type != ''">
                and type = #{type}
            </if>
            <if test="address != null and address != ''">
                and address like concat('%',#{address},'%')
            </if>
        </where>
    
    </select>

### 3.4、配置文件 ###

mybatis:
      #指定mapper.xml的位置
      mapper-locations: classpath:mybatis/mapper/*.xml
      #实体类的位置
      type-aliases-package: com.hqyj.springboot.entity

## 4、新增数据 - insert ##

<insert id="insertHouserInfo" useGeneratedKeys="true" keyProperty="id">
        insert into house_info(name,type,address) values(#{name},#{type},#{address})
    </insert>
    
    <insert id="batchInsertHouserInfo" useGeneratedKeys="true" keyProperty="id">
        insert into house_info(name,type,address) values
        <foreach collection="list" item="houseInfo" separator=",">
            (#{houseInfo.name},#{houseInfo.type},#{houseInfo.address})
        </foreach>
    </insert>

/**
     * 新增房屋信息数据
     * @param houseInfo
     * @return
     */
    public int insertHouserInfo(HouseInfo houseInfo);
    /**
     * 新增房屋信息数据
     * @param listHouse
     * @return
     */
    public int batchInsertHouserInfo(List<HouseInfo> listHouse);

<insert id="insertHouserInfoExt" >
        insert into house_info(name,type,address) values(#{name},#{type},#{address})
    </insert>

/**
     * 新增房屋信息数据
     * @param name
     * @param type
     * @param address
     * @return
     */
    public int insertHouserInfoExt(@Param("name") String name, @Param("type")String type, @Param("address")String address );

## 5、注解形式 ##

在Mapper方法上加注解，废弃xml配置方式

@Select
    @Mapper
    public interface OrderMapper {
        
        /**
         * 订单查询
         * @return
         */
        @Select("SELECT\n" +
                "\ta.id,\n" +
                "\ta.orderNo\n" +
                "FROM\n" +
                "\tgoods_order a")
        @Results(id="orderMap",value = {
        
                @Result(column = "id",property = "id",id = true),
                @Result(column = "orderNo",property = "orderNo"),
                @Result(column = "id",property = "listOrderDetail",
                many = @Many(select = "getOrderDetailByOrderId",fetchType = FetchType.LAZY))
    
        })
        List<Order> queryOrder();
    
        @Select("select id orderDetailId,order_id orderId,good_name goodName from goods_order_detail where id = #{orderId}")
        List<OrderDetail> getOrderDetailByOrderId(@Param("orderId") Integer orderId);
    }
    
    
    @Update("<script>" +
            "update t_emp" +
            "    <set >" +
            "      <if test=\"empName != null\" >" +
            "        emp_name = #{empName,jdbcType=VARCHAR},\n" +
            "      </if>" +
            "      <if test=\"empTel != null\" >" +
            "        emp_tel = #{empTel,jdbcType=VARCHAR}," +
            "      </if>" +
            "      <if test=\"empEducation != null\" >" +
            "        emp_education = #{empEducation,jdbcType=VARCHAR}," +
            "      </if>" +
            "      <if test=\"empBirthday != null\" >" +
            "        emp_birthday = #{empBirthday,jdbcType=DATE}," +
            "      </if>" +
            "      <if test=\"fkDeptId != null\" >" +
            "        fk_dept_id = #{fkDeptId,jdbcType=INTEGER}," +
            "      </if>" +
            "    </set>" +
            "    where emp_id = #{empId,jdbcType=INTEGER}" +
            "</script>")
    int updateByPrimaryKeySelective(Employee record);

[SpringBoot]: https://blog.csdn.net/s445320/article/details/129921683
[springboot]: https://blog.csdn.net/s445320/article/details/129933138
[springboot 1]: https://blog.csdn.net/s445320/article/details/129949778
[SpringBoot 1]: https://blog.csdn.net/s445320/article/details/129952680
[springboot 2]: https://blog.csdn.net/s445320/article/details/129953402
[Link 1]: https://blog.csdn.net/s445320/article/details/130248527
[springboot 3]: https://blog.csdn.net/s445320/article/details/129958603
[springboot _Druid]: https://blog.csdn.net/s445320/article/details/129989045
[springboot _MyBatis - xml]: https://blog.csdn.net/s445320/article/details/130012383
[_Mybatis plus]: https://blog.csdn.net/s445320/article/details/130130130
[SpringBoot_swagger-bootstrap-ui]: https://blog.csdn.net/s445320/article/details/130419460
[a8cf9b3c27114e969796fec68fd375b1.png]: https://img-blog.csdnimg.cn/a8cf9b3c27114e969796fec68fd375b1.png