3-使用MyBatis实现CRUD

Posted 2023-05-11 念念念北

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了3-使用MyBatis实现CRUD相关的知识，希望对你有一定的参考价值。

使用MyBatis实现CRUD

1. 配置文件实现 CRUD

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

查询

查询所有数据

查询详情

条件查询

添加

修改

修改全部字段

修改动态字段

删除

删除一个

批量删除

1.1 环境准备

数据库表（tb_brand）及数据准备

-- 删除tb_brand表
drop table if exists tb_brand;
-- 创建tb_brand表
create table tb_brand
(
    -- id 主键
    id           int primary key auto_increment,
    -- 品牌名称
    brand_name   varchar(20),
    -- 企业名称
    company_name varchar(20),
    -- 排序字段
    ordered      int,
    -- 描述信息
    description  varchar(100),
    -- 状态：0：禁用  1：启用
    status       int
);
-- 添加数据
insert into tb_brand (brand_name, company_name, ordered, description, status)
values (\'三只松鼠\', \'三只松鼠股份有限公司\', 5, \'好吃不上火\', 0),
       (\'华为\', \'华为技术有限公司\', 100, \'华为致力于把数字世界带入每个人、每个家庭、每个组织，构建万物互联的智能世界\', 1),
       (\'小米\', \'小米科技有限公司\', 50, \'are you ok\', 1);

实体类 Brand

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

public class Brand 
    // id 主键
    private Integer id;
    // 品牌名称
    private String brandName;
    // 企业名称
    private String companyName;
    // 排序字段
    private Integer ordered;
    // 描述信息
    private String description;
    // 状态：0：禁用  1：启用
    private Integer status;

    //省略 setter and getter。自己写时要补全这部分代码

编写测试用例

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

安装 MyBatisX 插件

MybatisX 是一款基于 IDEA 的快速开发插件，为效率而生。
主要功能
- XML 映射配置文件和接口方法间相互跳转
- 根据接口方法生成 statement
安装方式

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

注意：安装完毕后需要重启 IDEA

插件效果

红色头绳的表示映射配置文件，蓝色头绳的表示 mapper 接口。

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

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

1.2 查询所有数据

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

编写接口方法：Mapper 接口

参数：无

查询所有数据功能是不需要根据任何条件进行查询的，所以此方法不需要参数。

结果：List

我们会将查询出来的每一条数据封装成一个 Brand 对象，而多条数据封装多个 Brand 对象，需要将这些对象封装到 List 集合中返回。

执行方法、测试

1.2.1 编写接口方法

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

public interface BrandMapper 

    /**
     * 查询所有
     */
    List<Brand> selectAll();

1.2.2 编写 SQL 语句

在 reources 下创建 com/itheima/mapper 目录结构，并在该目录下创建名为 BrandMapper.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.itheima.mapper.BrandMapper">
    <select id="selectAll" resultType="brand">
        select *
        from tb_brand;
    </select>
</mapper>

1.2.3 编写测试方法

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

@Test
public void testSelectAll() throws IOException 
    //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.selectAll();
    System.out.println(brands);

    //5. 释放资源
    sqlSession.close();

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

执行测试方法结果如下：

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

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

给字段起别名
使用 resultMap 定义字段和属性的映射关系

1.2.4 起别名解决上述问题

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

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

<select id="selectAll" resultType="brand">
    select
    id, brand_name as brandName, company_name as companyName, ordered, description, status
    from tb_brand;
</select>

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

SQL 片段：

将需要复用的 SQL 片段抽取到 sql 标签中
```
<sql id="brand_column">
	id, brand_name as brandName, company_name as companyName, ordered, description, status
</sql>
```
id 属性值是唯一标识，引用时也是通过该值进行引用。
在原 sql 语句中进行引用

使用 include 标签引用上述的 SQL 片段，而 refid 指定上述 SQL 片段的 id 值。
```
<select id="selectAll" resultType="brand">
    select
    <include refid="brand_column" />
    from tb_brand;
</select>
```

1.2.5 使用 resultMap 解决上述问题

起别名 + sql 片段的方式可以解决上述问题，但是它也存在问题。如果还有功能只需要查询部分字段，而不是查询所有字段，那么我们就需要再定义一个 SQL 片段，这就显得不是那么灵活。

那么我们也可以使用 resultMap 来定义字段和属性的映射关系的方式解决上述问题。

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

<resultMap id="brandResultMap" type="brand">
    <!--
            id：完成主键字段的映射
                column：表的列名
                property：实体类的属性名
            result：完成一般字段的映射
                column：表的列名
                property：实体类的属性名
        -->
    <result column="brand_name" property="brandName"/>
    <result column="company_name" property="companyName"/>
</resultMap>

注意：在上面只需要定义字段名和属性名不一样的映射，而一样的则不需要专门定义出来。

SQL 语句正常编写

<select id="selectAll" resultMap="brandResultMap">
    select *
    from tb_brand;
</select>

1.2.6 小结

实体类属性名和数据库表列名不一致，不能自动封装数据

起别名：在 SQL 语句中，对不一样的列名起别名，别名和实体类属性名一样
- 可以定义片段，提升复用性
resultMap：定义完成不一致的属性名和列名的映射

而我们最终选择使用 resultMap 的方式。查询映射配置文件中查询所有的 statement 书写如下：

 <resultMap id="brandResultMap" type="brand">
     <!--
            id：完成主键字段的映射
                column：表的列名
                property：实体类的属性名
            result：完成一般字段的映射
                column：表的列名
                property：实体类的属性名
        -->
     <result column="brand_name" property="brandName"/>
     <result column="company_name" property="companyName"/>
</resultMap>



<select id="selectAll" resultMap="brandResultMap">
    select *
    from tb_brand;
</select>

使用MyBatis对表执行CRUD操作

一、使用MyBatis对表执行CRUD操作——基于XML的实现

1、定义sql映射xml文件

　　userMapper.xml文件的内容如下：

 1 <?xml version="1.0" encoding="UTF-8" ?>
 2 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 3 <!-- 为这个mapper指定一个唯一的namespace，namespace的值习惯上设置成包名+sql映射文件名，这样就能够保证namespace的值是唯一的
 4 例如namespace="me.gacl.mapping.userMapper"就是me.gacl.mapping(包名)+userMapper(userMapper.xml文件去除后缀)
 5  -->
 6 <mapper namespace="me.gacl.mapping.userMapper">
 7     <!-- 在select标签中编写查询的SQL语句， 设置select标签的id属性为getUser，id属性值必须是唯一的，不能够重复
 8     使用parameterType属性指明查询时使用的参数类型，resultType属性指明查询返回的结果集类型
 9     resultType="me.gacl.domain.User"就表示将查询结果封装成一个User类的对象返回
10     User类就是users表所对应的实体类
11     -->
12     <!-- 
13         根据id查询得到一个user对象
14      -->
15     <select id="getUser" parameterType="int" 
16         resultType="me.gacl.domain.User">
17         select * from users where id=#{id}
18     </select>
19     
20     <!-- 创建用户(Create) -->
21     <insert id="addUser" parameterType="me.gacl.domain.User">
22         insert into users(name,age) values(#{name},#{age})
23     </insert>
24     
25     <!-- 删除用户(Remove) -->
26     <delete id="deleteUser" parameterType="int">
27         delete from users where id=#{id}
28     </delete>
29     
30     <!-- 修改用户(Update) -->
31     <update id="updateUser" parameterType="me.gacl.domain.User">
32         update users set name=#{name},age=#{age} where id=#{id}
33     </update>
34     
35     <!-- 查询全部用户-->
36     <select id="getAllUsers" resultType="me.gacl.domain.User">
37         select * from users
38     </select>
39     
40 </mapper>

　　单元测试类代码如下：

 1 package me.gacl.test;
 2 
 3 import java.util.List;
 4 import me.gacl.domain.User;
 5 import me.gacl.util.MyBatisUtil;
 6 import org.apache.ibatis.session.SqlSession;
 7 import org.junit.Test;
 8 
 9 public class TestCRUDByXmlMapper {
10 
11     @Test
12     public void testAdd(){
13         //SqlSession sqlSession = MyBatisUtil.getSqlSession(false);
14         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
15         /**
16          * 映射sql的标识字符串，
17          * me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值，
18          * addUser是insert标签的id属性值，通过insert标签的id属性值就可以找到要执行的SQL
19          */
20         String statement = "me.gacl.mapping.userMapper.addUser";//映射sql的标识字符串
21         User user = new User();
22         user.setName("用户孤傲苍狼");
23         user.setAge(20);
24         //执行插入操作
25         int retResult = sqlSession.insert(statement,user);
26         //手动提交事务
27         //sqlSession.commit();
28         //使用SqlSession执行完SQL之后需要关闭SqlSession
29         sqlSession.close();
30         System.out.println(retResult);
31     }
32     
33     @Test
34     public void testUpdate(){
35         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
36         /**
37          * 映射sql的标识字符串，
38          * me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值，
39          * updateUser是update标签的id属性值，通过update标签的id属性值就可以找到要执行的SQL
40          */
41         String statement = "me.gacl.mapping.userMapper.updateUser";//映射sql的标识字符串
42         User user = new User();
43         user.setId(3);
44         user.setName("孤傲苍狼");
45         user.setAge(25);
46         //执行修改操作
47         int retResult = sqlSession.update(statement,user);
48         //使用SqlSession执行完SQL之后需要关闭SqlSession
49         sqlSession.close();
50         System.out.println(retResult);
51     }
52     
53     @Test
54     public void testDelete(){
55         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
56         /**
57          * 映射sql的标识字符串，
58          * me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值，
59          * deleteUser是delete标签的id属性值，通过delete标签的id属性值就可以找到要执行的SQL
60          */
61         String statement = "me.gacl.mapping.userMapper.deleteUser";//映射sql的标识字符串
62         //执行删除操作
63         int retResult = sqlSession.delete(statement,5);
64         //使用SqlSession执行完SQL之后需要关闭SqlSession
65         sqlSession.close();
66         System.out.println(retResult);
67     }
68     
69     @Test
70     public void testGetAll(){
71         SqlSession sqlSession = MyBatisUtil.getSqlSession();
72         /**
73          * 映射sql的标识字符串，
74          * me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值，
75          * getAllUsers是select标签的id属性值，通过select标签的id属性值就可以找到要执行的SQL
76          */
77         String statement = "me.gacl.mapping.userMapper.getAllUsers";//映射sql的标识字符串
78         //执行查询操作，将查询结果自动封装成List<User>返回
79         List<User> lstUsers = sqlSession.selectList(statement);
80         //使用SqlSession执行完SQL之后需要关闭SqlSession
81         sqlSession.close();
82         System.out.println(lstUsers);
83     }
84 }

二、使用MyBatis对表执行CRUD操作——基于注解的实现

　　1、定义sql映射的接口

　　UserMapperI接口的代码如下：

 1 package me.gacl.mapping;
 2 
 3 import java.util.List;
 4 import me.gacl.domain.User;
 5 import org.apache.ibatis.annotations.Delete;
 6 import org.apache.ibatis.annotations.Insert;
 7 import org.apache.ibatis.annotations.Select;
 8 import org.apache.ibatis.annotations.Update;
 9 
10 /**
11  * @author gacl
12  * 定义sql映射的接口，使用注解指明方法要执行的SQL
13  */
14 public interface UserMapperI {
15 
16     //使用@Insert注解指明add方法要执行的SQL
17     @Insert("insert into users(name, age) values(#{name}, #{age})")
18     public int add(User user);
19     
20     //使用@Delete注解指明deleteById方法要执行的SQL
21     @Delete("delete from users where id=#{id}")
22     public int deleteById(int id);
23     
24     //使用@Update注解指明update方法要执行的SQL
25     @Update("update users set name=#{name},age=#{age} where id=#{id}")
26     public int update(User user);
27     
28     //使用@Select注解指明getById方法要执行的SQL
29     @Select("select * from users where id=#{id}")
30     public User getById(int id);
31     
32     //使用@Select注解指明getAll方法要执行的SQL
33     @Select("select * from users")
34     public List<User> getAll();
35 }

　　需要说明的是，我们不需要针对UserMapperI接口去编写具体的实现类代码，这个具体的实现类由MyBatis帮我们动态构建出来，我们只需要直接拿来使用即可。

　　2、在conf.xml文件中注册这个映射接口

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
 3 <configuration>
 4     <environments default="development">
 5         <environment id="development">
 6             <transactionManager type="JDBC" />
 7             <!-- 配置数据库连接信息 -->
 8             <dataSource type="POOLED">
 9                 <property name="driver" value="com.mysql.jdbc.Driver" />
10                 <property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
11                 <property name="username" value="root" />
12                 <property name="password" value="XDP" />
13             </dataSource>
14         </environment>
15     </environments>
16     
17     <mappers>
18         <!-- 注册userMapper.xml文件， 
19         userMapper.xml位于me.gacl.mapping这个包下，所以resource写成me/gacl/mapping/userMapper.xml-->
20         <mapper resource="me/gacl/mapping/userMapper.xml"/>
21         <!-- 注册UserMapper映射接口-->
22         <mapper class="me.gacl.mapping.UserMapperI"/>
23     </mappers>
24     
25 </configuration>

　　单元测试类的代码如下：

 1 package me.gacl.test;
 2 
 3 import java.util.List;
 4 import me.gacl.domain.User;
 5 import me.gacl.mapping.UserMapperI;
 6 import me.gacl.util.MyBatisUtil;
 7 import org.apache.ibatis.session.SqlSession;
 8 import org.junit.Test;
 9 
10 public class TestCRUDByAnnotationMapper {
11 
12     @Test
13     public void testAdd(){
14         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
15         //得到UserMapperI接口的实现类对象，UserMapperI接口的实现类对象由sqlSession.getMapper(UserMapperI.class)动态构建出来
16         UserMapperI mapper = sqlSession.getMapper(UserMapperI.class);
17         User user = new User();
18         user.setName("用户xdp");
19         user.setAge(20);
20         int add = mapper.add(user);
21         //使用SqlSession执行完SQL之后需要关闭SqlSession
22         sqlSession.close();
23         System.out.println(add);
24     }
25     
26     @Test
27     public void testUpdate(){
28         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
29         //得到UserMapperI接口的实现类对象，UserMapperI接口的实现类对象由sqlSession.getMapper(UserMapperI.class)动态构建出来
30         UserMapperI mapper = sqlSession.getMapper(UserMapperI.class);
31         User user = new User();
32         user.setId(3);
33         user.setName("孤傲苍狼_xdp");
34         user.setAge(26);
35         //执行修改操作
36         int retResult = mapper.update(user);
37         //使用SqlSession执行完SQL之后需要关闭SqlSession
38         sqlSession.close();
39         System.out.println(retResult);
40     }
41     
42     @Test
43     public void testDelete(){
44         SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
45         //得到UserMapperI接口的实现类对象，UserMapperI接口的实现类对象由sqlSession.getMapper(UserMapperI.class)动态构建出来
46         UserMapperI mapper = sqlSession.getMapper(UserMapperI.class);
47         //执行删除操作
48         int retResult = mapper.deleteById(7);
49         //使用SqlSession执行完SQL之后需要关闭SqlSession
50         sqlSession.close();
51         System.out.println(retResult);
52     }
53     
54     @Test
55     public void testGetUser(){
56         SqlSession sqlSession = MyBatisUtil.getSqlSession();
57         //得到UserMapperI接口的实现类对象，UserMapperI接口的实现类对象由sqlSession.getMapper(UserMapperI.class)动态构建出来
58         UserMapperI mapper = sqlSession.getMapper(UserMapperI.class);
59         //执行查询操作，将查询结果自动封装成User返回
60         User user = mapper.getById(8);
61         //使用SqlSession执行完SQL之后需要关闭SqlSession
62         sqlSession.close();
63         System.out.println(user);
64     }
65     
66     @Test
67     public void testGetAll(){
68         SqlSession sqlSession = MyBatisUtil.getSqlSession();
69         //得到UserMapperI接口的实现类对象，UserMapperI接口的实现类对象由sqlSession.getMapper(UserMapperI.class)动态构建出来
70         UserMapperI mapper = sqlSession.getMapper(UserMapperI.class);
71         //执行查询操作，将查询结果自动封装成List<User>返回
72         List<User> lstUsers = mapper.getAll();
73         //使用SqlSession执行完SQL之后需要关闭SqlSession
74         sqlSession.close();
75         System.out.println(lstUsers);
76     }
77 }

　　用到的MyBatisUtil工具类代码如下：

 1 package me.gacl.util;
 2 
 3 import java.io.InputStream;
 4 
 5 import org.apache.ibatis.session.SqlSession;
 6 import org.apache.ibatis.session.SqlSessionFactory;
 7 import org.apache.ibatis.session.SqlSessionFactoryBuilder;
 8 
 9 public class MyBatisUtil {
10 
11     /**
12      * 获取SqlSessionFactory
13      * @return SqlSessionFactory
14      */
15     public static SqlSessionFactory getSqlSessionFactory() {
16         String resource = "conf.xml";
17         InputStream is = MyBatisUtil.class.getClassLoader().getResourceAsStream(resource);
18         SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
19         return factory;
20     }
21     
22     /**
23      * 获取SqlSession
24      * @return SqlSession
25      */
26     public static SqlSession getSqlSession() {
27         return getSqlSessionFactory().openSession();
28     }
29     
30     /**
31      * 获取SqlSession
32      * @param isAutoCommit 
33      *         true 表示创建的SqlSession对象在执行完SQL之后会自动提交事务
34      *         false 表示创建的SqlSession对象在执行完SQL之后不会自动提交事务，这时就需要我们手动调用sqlSession.commit()提交事务
35      * @return SqlSession
36      */
37     public static SqlSession getSqlSession(boolean isAutoCommit) {
38         return getSqlSessionFactory().openSession(isAutoCommit);
39     }
40 }

以上是关于3-使用MyBatis实现CRUD的主要内容，如果未能解决你的问题，请参考以下文章

mybatis学习----对表进行CRUD操作

跟着老杜学MyBatis+第3天+使用MyBatis完成CRUD

java之mybatis之使用mybatis实现crud操作

IDEA+Maven使用MyBatis实现CRUD操作