MyBatis(二)

二.配置文件实现CRUD

接下来通过一个案例来讲解 MyBatis 的相关知识点。

如上图所示产品原型,里面包含了品牌数据的查询按条件查询添加删除批量删除修改 等功能,而这些功能其实就是对数据库表中的数据进行CRUD操作。接下来我们就使用Mybatis完成品牌数据的增删改查操作。以下是我们要完成功能:

2.1 环境准备

1.数据库表(tb_brand)及数据准备

2.实体类Brand准备

在 com.itheima.pojo 包下创建 Brand 实体类。

3.编写测试用例

测试代码需要在 test 的 java 目录下创建包及测试用例。项目结构如下:

3.安装MyBatisX插件

MyBatisX简介

MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生。

主要功能

主要用于XML映射配置文件接口方法间相互跳转、根据接口方法生成 statement

安装方式

点击 file ,选择 settings ,就能看到如下图所示界面

插件效果

红色头绳的表示映射配置文件,蓝色头绳的表示mapper接口。在mapper接口点击红色头绳的小鸟图标会自动跳转 到对应的映射配置文件,在映射配置文件中点击蓝色头绳的小鸟图标会自动跳转到对应的mapper接口。

也可以在 mapper接口中定义方法,自动生成映射配置文件中的 statement ,如图所示

2.2 查询所有

1.查询所有介绍

下图所示就页面上展示的数据,而这些数据需要从数据库进行查询。接下来我们就来讲查询所有数据功能,而实现该功能 我们分以下步骤进行实现:

2.编写 Mapper 接口及接口中的方法

在 com.itheima.mapper 包写创建名为 BrandMapper 的接口。并在该接口中定义 List selectAll() 方法。

3.编写SQL语句

在 reources 下创建 com/itheima/mapper 目录结构,并在该目录下创建名为 BrandMapper.xml 的映射配置文件

4.编写测试方法

在 MybatisTest 类中编写测试查询所有的方法

执行测试方法结果如下:

从上面结果我们看到了问题,有些数据封装成功了,而有些数据并没有封装成功。为什么这样呢?

这个问题可以通过两种方式进行解决: 

  • 给字段起别名 

  • 使用resultMap定义字段和属性的映射关系

注意:现在我们感觉测试这部分代码写起来特别麻烦,我们可以先忍忍。以后我们只会写上面的第 3 步的代码,其他的都不需要我们来完成。

5.起别名解决上述问题

从上面结果可以看到 brandName 和 companyName 这两个属性的数据没有封装成功,查询实体类表中的字段发现,在实体类中属性名是 brandName 和 companyName,而表中的字段名为 brand_name 和 company_name ,如下图所示 。那么我们只需要保持这两部分的名称一致这个问题就迎刃而解。

我们可以在写 sql 语句时给这两个字段起别名,将别名定义成和属性名一致即可。

而上面的SQL语句中的字段列表书写麻烦,如果表中还有更多的字段,同时其他的功能也需要查询这些字段时就显得我们的代码不够精炼。Mybatis提供了 sql 片段可以提高 sql 的复用性。

SQL片段:

1.将需要复用的SQL片段抽取到 sql 标签中, id 属性值是唯一标识,引用时也是通过该值进行引用。

2. 在原sql语句中进行引用 使用 include 标签引用上述的 SQL 片段,而 refid 指定上述 SQL 片段的id值。

6.使用 resultMap 解决上述问题

起别名 + sql片段的方式可以解决上述问题,但是它也存在问题。如果还有功能只需要查询部分字段,而不是查询所有字段, 那么我们就需要再定义一个 SQL 片段,这就显得不是那么灵活。 那么我们也可以使用 resultMap 来定义字段和属性的映射关系的方式解决上述问题,实际开发中一般采用这种方式。

步骤如下:

第一步:在映射配置文件中使用 resultMap 定义 字段 和 属性 的映射关系

在 resultMap 中只需要定义字段名和属性名不一样的映射,而一样的则不需要专门定义出来。

第二步:SQL语句正常编写

2.3 查询详情

2.3.1 查询详情介绍

有些数据的属性比较多,在页面表格中无法全部实现,而只会显示部分,而其他属性数据的查询可以通过查看详情来进行查询,如上图所示。

2.3.2 查看详情功能实现步骤

第一步:编写接口方法

在 BrandMapper 接口中定义根据 id 查询数据的方法

第二步:编写SQL语句

在 BrandMapper.xml 映射配置文件中编写 statement ,使用 resultMap 而不是使用 resultType。下面 SQL 中的 #{id} 先这样写,一会再详细讲解

第三步:编写测试方法

在 test/java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

执行测试方法结果如下:

2.3.3 参数占位符

查询到的结果很好理解就是 id 为 1 的这行数据。而这里我们需要看控制台显示的 SQL 语句,能看到使用 ?进行占位。说明我们在映射配置文件中的写的 #{id} 最终会被 ?进行占位。接下来我们就聊聊映射配置文件中的参数占位符。

mybatis提供了两种参数占位符

开发中建议使用 #{} 参数占位符,不要使用 ${} 占位符

  • #{} :执行SQL时,会将 #{} 占位符替换为 ?,将来自动设置参数值。从上述例子可以看出使用 #{} 底层使用的是 PreparedStatement

  • ${} :拼接SQL。底层使用的是 Statement,会存在SQL注入问题。如下图将映射配置文件中的 #{} 替换成 ${} 来看效 果

重新运行查看结果如下:

2.3.4 parameterType

对于有参数的 mapper 接口方法,我们在映射配置文件中应该配置 parameterType 来指定参数类型。但是该属性可以省略。

<select id="selectById" parameterType="int" resultMap="brandResultMap">
    select *
    from tb_brand where id = ${id};
</select>

2.3.5 SQL语句的特殊字段

以后肯定会在SQL语句中写一下特殊字符,比如某一个字段大于某个值,如下图

可以看出报错了,因为映射配置文件是 xml 类型的问题,而 > < 等这些字符在 xml 中有特殊含义,所以此时我们需要将这些符号进行转义,可以使用以下两种方式进行转义

  • 转义字符:下图的 &lt; 就是 < 的转义字符。

  • 使用 <![CDATA[内容]]>

2.4 多条件查询

我们经常会遇到如上图所示的多条件查询,将多条件查询的结果展示在下方的数据列表中。而我们做这个功能需要分析最终的SQL语句应该是什么样,思考两个问题

  • 条件表达式

  • 如何连接

条件字段 企业字段 和 品牌名称 需要进行模糊查询,所以条件应该是:

简单的分析后,我们来看功能实现的步骤:

第一步:编写接口方法

List<Brand> selectByCondition(Brand brand);

在 BrandMapper 接口中定义多条件查询的方法。而该功能有三个参数,我们就需要考虑定义接口时,参数应该如何定义。Mybatis 针对多参数有多种实现,使用 @Param("参数名称") 标记每一个参数,在映射配置文件中就需要使用 #{参数名称} 进行占位。

List<Brand> selectByCondition(@Param("status") int status, 
                              @Param("companyName") String companyName,
                              @Param("brandName") String brandName);

将多个参数封装成一个实体对象,将该实体对象作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时,里面的内容必须和实体类属性名保持一致。

将多个参数封装到 map 集合中,将map集合作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时,里面的内容必须和map集合中键的名称一致。

List<Brand> selectByCondition(Map map);

第二步:编写SQL语句

BrandMapper.xml 映射配置文件中编写 statement,使用 resultMap 而不是使用 resultType

<select id="selectByCondition" resultMap="brandResultMap">
    select *
    from tb_brand
    where status = #{status}
    and company_name like #{companyName}
    and brand_name like #{brandName}
</select>

第三步:编写测试方法

在 test 的 java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testSelectByCondition() throws IOException {
    //接收参数
    int status = 1;
    String companyName = "华为";
    String brandName = "华为";
​
    // 处理参数
    companyName = "%" + companyName + "%";
    brandName = "%" + brandName + "%";
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
​
    //4. 执行方法
    //方式一 :接口方法参数使用 @Param 方式调用的方法
    //List<Brand> brands = brandMapper.selectByCondition(status, companyName, brandName);
    
    //方式二 :接口方法参数是 实体类对象 方式调用的方法
    //封装对象
    /* Brand brand = new Brand();
        brand.setStatus(status);
        brand.setCompanyName(companyName);
        brand.setBrandName(brandName);*/
    
    //List<Brand> brands = brandMapper.selectByCondition(brand);
    
    //方式三 :接口方法参数是 map集合对象 方式调用的方法
    Map map = new HashMap();
    map.put("status" , status);
    map.put("companyName", companyName);
    map.put("brandName" , brandName);
    List<Brand> brands = brandMapper.selectByCondition(map);
    System.out.println(brands);
​
    //5. 释放资源
    sqlSession.close();
}

2.5 动态SQL

上述功能实现存在很大的问题。用户在输入条件时,肯定不会所有的条件都填写,这个时候我们的SQL语句就不能那样写的,例如用户如果只输入企业名称时,SQL语句就是

select * from tb_brand where company_name like #{companName}

而用户如果输入了 当前状态 和 企业名称 时,SQL语句又不一样

select * from tb_brand where status = #{status} and company_name like #{companName}

针对上述情况,Mybatis 对通过动态SQL来进行解决,动态SQL可通过以下标签来实现:

  • if

  • choose (when, otherwise)

  • trim (where, set)

  • foreach

1. if 标签

if 标签代表进行条件判断,在 test 属性中定义逻辑表达式

<select id="selectByCondition" resultMap="brandResultMap">
    select *
    from tb_brand
    where
        <if test="status != null">
            and status = #{status}
        </if>
        <if test="companyName != null and companyName != '' ">
            and company_name like #{companyName}
        </if>
        <if test="brandName != null and brandName != '' ">
            and brand_name like #{brandName}
        </if>
</select>

如上的这种 SQL 语句就会根据传递的参数值进行动态的拼接。如果此时 status 和 companyName有值那么就会值拼接这两个条件。执行结果如下:

但是它也存在问题,如果此时给的参数值是

Map map = new HashMap();
// map.put("status" , status);
map.put("companyName", companyName);
map.put("brandName" , brandName);

拼接的SQL语句就变成了

select * from tb_brand where and company_name like ? and brand_name like ?

而上面的语句中 where 关键后直接跟 and 关键字,这就是一条错误的SQL语句。这个就可以使用 where 标签解决

2.where 标签

where 标签的作用如下所示。另外,使用where标签时,需要给每个条件前都加上 and 关键字。

  • 替换 where 关键字

  • 会动态的去掉第一个条件前的 and

  • 如果所有的参数没有值则不加where关键字

<select id="selectByCondition" resultMap="brandResultMap">
    select *
    from tb_brand
    <where>
        <if test="status != null">
            and status = #{status}
        </if>
        <if test="companyName != null and companyName != '' ">
            and company_name like #{companyName}
        </if>
        <if test="brandName != null and brandName != '' ">
            and brand_name like #{brandName}
        </if>
    </where>
</select>

3.动态SQL示例

下面是单个条件的动态SQL实现步骤

如上图所示,在查询时只能选择 品牌名称当前状态企业名称 这三个条件中的一个,但是用户到底选择哪儿一个,我们并不能确定。这种就属于单个条件的动态SQL语句。这种需求需要使用到 chose(when,otherwise)标签实现, 而 chose 标签类似于Java 中的 switch 语句。下面通过一个案例来使用这些标签

第一步:编写接口方法

BrandMapper 接口中定义单条件查询的方法。

/**
  * 单条件动态查询
  * @param brand
  * @return
  */
List<Brand> selectByConditionSingle(Brand brand);

第二步:编写SQL语句

BrandMapper.xml 映射配置文件中编写 statement,使用 resultMap 而不是使用 resultType

<select id="selectByConditionSingle" resultMap="brandResultMap">
    select *
    from tb_brand
    <where>
        <choose><!--相当于switch-->
            <when test="status != null"><!--相当于case-->
                status = #{status}
            </when>
            <when test="companyName != null and companyName != '' "><!--相当于case-->
                company_name like #{companyName}
            </when>
            <when test="brandName != null and brandName != ''"><!--相当于case-->
                brand_name like #{brandName}
            </when>
        </choose>
    </where>
</select>

第三步:编写测试方法

在 test 的 java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testSelectByConditionSingle() throws IOException {
    //接收参数
    int status = 1;
    String companyName = "华为";
    String brandName = "华为";
​
    // 处理参数
    companyName = "%" + companyName + "%";
    brandName = "%" + brandName + "%";
​
    //封装对象
    Brand brand = new Brand();
    //brand.setStatus(status);
    brand.setCompanyName(companyName);
    //brand.setBrandName(brandName);
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    List<Brand> brands = brandMapper.selectByConditionSingle(brand);
    System.out.println(brands);
​
    //5. 释放资源
    sqlSession.close();
}

执行测试方法结果如下:

2.6 添加数据

1.添加数据的步骤

如上图是我们平时在添加数据时展示的页面,而我们在该页面输入想要的数据后添加 提交 按钮,就会将这些数据添加到数据库中。接下来我们就来实现添加数据的操作:

第一步:编写接口方法

BrandMapper 接口中定义添加方法。

 /**
   * 添加
   */
void add(Brand brand);

第二步:编写SQL语句

BrandMapper.xml 映射配置文件中编写添加数据的 statement

<insert id="add">
    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>

第三步:编写测试方法

test/java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testAdd() throws IOException {
    //接收参数
    int status = 1;
    String companyName = "波导手机";
    String brandName = "波导";
    String description = "手机中的战斗机";
    int ordered = 100;
​
    //封装对象
    Brand brand = new Brand();
    brand.setStatus(status);
    brand.setCompanyName(companyName);
    brand.setBrandName(brandName);
    brand.setDescription(description);
    brand.setOrdered(ordered);
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true); //设置自动提交事务,这种情况不需要手动提交事务了
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.add(brand);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

执行结果如下:

2.添加数据后返回主键

在数据添加成功后,有时候需要获取插入数据库数据的主键。比如:添加订单和订单项,如下图就是京东上的订单。

订单数据存储在订单表中,订单项存储在订单项表中。

添加订单数据

添加订单项数据,订单项中需要设置所属订单的id

明白了什么时候 主键返回 。接下来我们简单模拟一下,在添加完数据后打印id属性值,能打印出来说明已经获取到了。我们将上面添加品牌数据的案例中映射配置文件里 statement 进行修改,如下:

<insert id="add" useGeneratedKeys="true" keyProperty="id">
    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>

在 insert 标签上添加的属性:

  • useGeneratedKeys:是够获取自动增长的主键值。true表示获取

  • keyProperty :指定将获取到的主键值封装到哪个属性里

2.7 修改数据

如图所示是修改页面,用户在该页面书写需要修改的数据,点击 提交 按钮,就会将数据库中对应的数据进行修改。注意一点,如果哪儿个输入框没有输入内容,我们是将表中数据对应字段值替换为空白还是保留字段之前的值?答案肯定是保留之前的数据。接下来我们就具体来实现

1.编写接口方法

BrandMapper 接口中定义修改方法。下述方法参数 Brand 就是封装了需要修改的数据,而 id 肯定是有数据的,这也是和添加方法的区别。

 /**
   * 修改
   */
void update(Brand brand);

2.编写SQL语句

BrandMapper.xml 映射配置文件中编写修改数据的 statement。其中,set 标签可以用于动态包含需要更新的列,忽略其它不更新的列。

<update id="update">
    update tb_brand
    <set>
        <if test="brandName != null and brandName != ''">
            brand_name = #{brandName},
        </if>
        <if test="companyName != null and companyName != ''">
            company_name = #{companyName},
        </if>
        <if test="ordered != null">
            ordered = #{ordered},
        </if>
        <if test="description != null and description != ''">
            description = #{description},
        </if>
        <if test="status != null">
            status = #{status}
        </if>
    </set>
    where id = #{id};
</update>

3.编写测试方法

在 test 的 java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testUpdate() throws IOException {
    //接收参数
    int status = 0;
    String companyName = "波导手机";
    String brandName = "波导";
    String description = "波导手机,手机中的战斗机";
    int ordered = 200;
    int id = 6;
​
    //封装对象
    Brand brand = new Brand();
    brand.setStatus(status);
    //        brand.setCompanyName(companyName);
    //        brand.setBrandName(brandName);
    //        brand.setDescription(description);
    //        brand.setOrdered(ordered);
    brand.setId(id);
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    int count = brandMapper.update(brand);
    System.out.println(count);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

执行测试方法结果如下:

从结果中SQL语句可以看出,只修改了 status 字段值,因为我们给的数据中只给 Brand 实体对象的 status 属性设置值了。这就是 set 标签的作用。

2.8 删除数据

如上图所示,每行数据后面都有一个 删除 按钮,当用户点击了该按钮,就会将改行数据删除掉。那我们就需要思考,这种删除是根据什么进行删除呢?是通过主键id删除,因为id是表中数据的唯一标识。接下来就来实现该功能。

1.编写接口方法

BrandMapper 接口中定义根据id删除方法。

/**
  * 根据id删除
  */
void deleteById(int id);

2.编写SQL语句

BrandMapper.xml 映射配置文件中编写删除一行数据的 statement

<delete id="deleteById">
    delete from tb_brand where id = #{id};
</delete>

3.编写测试方法

test/java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法。如果运行过程只要没报错,直接到数据库查询数据是否还存在。

 @Test
public void testDeleteById() throws IOException {
    //接收参数
    int id = 6;
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.deleteById(id);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

2.9 批量删除

如上图所示,用户可以选择多条数据,然后点击上面的 删除 按钮,就会删除数据库中对应的多行数据。

1.编写接口方法

BrandMapper 接口中定义删除多行数据的方法。参数是一个数组,数组中存储的是多条数据的 id。

/**
  * 批量删除
  */
void deleteByIds(int[] ids);

2.编写SQL语句

BrandMapper.xml 映射配置文件中编写删除多条数据的 statement。编写SQL时需要遍历数组来拼接SQL语句。Mybatis 提供了 foreach 标签供我们使用

foreach 标签:用来迭代任何可迭代的对象。如数组,集合。

collection 属性:mybatis 会将数组参数,封装为一个Map集合。

  • 默认:array = 数组

  • 使用@Param注解改变map集合的默认key的名称

item 属性:本次迭代获取到的元素。

separator 属性:集合项迭代之间的分隔符。foreach 标签不会错误地添加多余的分隔符。也就是最后一次迭代不会加分隔符。

open 属性:该属性值是在拼接SQL语句之前拼接的语句,只会拼接一次

close 属性:该属性值是在拼接SQL语句拼接后拼接的语句,只会拼接一次

<delete id="deleteByIds">
    delete from tb_brand where id
    in
    <foreach collection="array" item="id" separator="," open="(" close=")">
        #{id}
    </foreach>
    ;
</delete>

示例

假如数组中的 id 数据是 {1,2,3},那么拼接后的 sql 语句就是:

delete from tb_brand where id in (1,2,3);

3.编写测试方法

test/java 下的 com.itheima.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testDeleteByIds() throws IOException {
    //接收参数
    int[] ids = {5,7,8};
​
    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取 Mapper 接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.deleteByIds(ids);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

2.10 Mybatis 参数传递

Mybatis 接口方法中可以接收各种各样的参数,如下:

多个参数:以后接口参数是多个时,在每个参数上都使用 @Param 注解。这样代码的可读性更高。

单个参数:单个参数又可以是如下类型

  • POJO 类型

  • Map 集合类型

  • Collection 集合类型

  • List 集合类型

  • Array 类型

  • 其他类型

2.10.1 多个参数

如下面的代码,就是接收两个参数,而接收多个参数需要使用 @param 注解,那么为什么要加该注解呢?

User select(@Param("username") String username,@Param("password") String password);
<select id="select" resultType="user">
    select *
    from tb_user
    where 
        username=#{username}
        and password=#{password}
</select>

上面这个问题要弄明白就必须来研究 Mybatis 底层对于这些参数是如何处理的。

1.我们在接口方法中定义多个参数,Mybatis 会将这些参数封装成 Map 集合对象,值就是参数值,Mybatis 需要在 SQL 语句中通过键得到 Map 集合中的值,而键在没有使用 @Param 注解时有以下命名规则:

  • 以 arg 开头 :第一个参数就叫 arg0,第二个参数就叫 arg1,以此类推。如:

    map.put("arg0",参数值1);

    map.put("arg1",参数值2);

  • 以 param 开头 : 第一个参数就叫 param1,第二个参数就叫 param2,依次类推。如:

    map.put("param1",参数值1);

    map.put("param2",参数值2);

代码验证:

在 UserMapper 接口中定义如下方法

User select(String username,String password);

在 UserMapper.xml 映射配置文件中定义SQL

<select id="select" resultType="user">
    select *
    from tb_user
    where 
        username=#{arg0}
        and password=#{arg1}
</select>

或者

<select id="select" resultType="user">
    select *
    from tb_user
    where 
        username=#{param1}
        and password=#{param2}
</select>

运行代码结果如下

在映射配合文件的 SQL 语句中使用 arg 开头的和 param 书写,代码的可读性会变的特别差,所以建议使用 @Param 注解。 

2.在接口方法参数上使用 @Param 注解,Mybatis 会将 arg 开头的键名替换为对应注解的属性值。

代码验证:

在 接口中定义如下方法,在 username 参数前加上 @Param 注解

User select(@Param("username") String username, String password);

Mybatis 在封装 Map 集合时,键名就会变成如下:

  • map.put("username",参数值1);

  • map.put("arg1",参数值2);

  • map.put("param1",参数值1);

  • map.put("param2",参数值2);

在 UserMapper.xml 映射配置文件中定义 SQL

<select id="select" resultType="user">
    select *
    from tb_user
    where 
        username=#{username}
        and password=#{param2}
</select>

运行程序结果没有报错。而如果将 #{} 中的 username 还是写成 arg0 

<select id="select" resultType="user">
    select *
    from tb_user
    where 
        username=#{arg0}
        and password=#{param2}
</select>

运行程序则可以看到错误

2.10.2 单个参数

POJO 类型:直接使用。要求 属性名参数占位符 名称 一致

Map 集合类型:直接使用。要求 map 集合的 键名参数占位符 名称 一致

Collection 集合类型:Mybatis 会将集合封装到 map 集合中,如下:

  • map.put("arg0",collection集合);

  • map.put("collection",collection集合);

List 集合类型:Mybatis 会将集合封装到 map 集合中,如下:

  • map.put("arg0",list集合);

  • map.put("collection",list集合);

  • map.put("list",list集合);

Array 类型:Mybatis 会将集合封装到 map 集合中,如下:

  • map.put("arg0",数组);

  • map.put("array",数组);

其他类型:比如 int 类型,参数占位符名称叫什么都可以。尽量做到见名知意

==可以使用 @Param 注解替换map集合中默认的 arg 键名。==

2.11 Mapper注解

1.使用代码获取代理对象

在MyBatis中,利用编程式进行数据查询,主要就是下面几行代码:

//获取SqlSession对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream().build(inputStream);
SqlSession session = sqlSessionFactory.openSession();
//获取Mapper代理对象
UserMapper userMapper = session.getMapper(UserMapper.class);
//利用代理对象实现增删改查
List<LwUser> userList = userMapper.listUserByUserName("孤狼1号");

2.使用 @Mapper 注解获取代理对象

上述获取 Mapper 接口的代理对象非常麻烦,我们可以将 Mybatis 提供的 @Mapper 注解放到Mapper 接口的上面,将代理对象注册为 Spring 的 Bean,在使用的时候,直接从IOC容器中取即可。

@Mapper
public interface UserMapper extends BaseMapper<User> {

    @Select("select * from tb_user")
    List<User> getAll();

}

三.注解实现CRUD

使用注解开发会比配置文件开发更加方便。注解是用来替换映射配置文件方式配置的,所以使用了注解,就不需要再映射配置文件中书写对应的 statement如下就是使用注解进行开发

@Select(value = "select * from tb_user where id = #{id}")
public User select(int id);

Mybatis 针对 CURD 操作都提供了对应的注解,已经做到见名知意。如下:

  • 查询 :@Select

  • 添加 :@Insert

  • 修改 :@Update

  • 删除 :@Delete

接下来我们做一个案例来使用 Mybatis 的注解开发

代码实现:

第一步:将之前案例中 UserMapper.xml 中的根据 id 查询数据的 statement 注释掉

第二步:UserMapper 接口的 selectById 方法上添加注解

第三步:运行测试程序也能正常查询到数据

注意:在官方文档中入门中有这样的一段话:注解完成简单功能,配置文件完成复杂功能。而我们之前写的动态 SQL 就是复杂的功能,如果使用注解的话,就需要使用到 Mybatis 提供的SQL构建器来完成,而对应的代码如下,可以看出下述代码将 java 代码和 SQL 语句融到了一块,使得代码的可读性大幅度降低。

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

真滴book理喻

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值