mybatis使用总结

傷城~ 2022-12-25 00:53 115阅读 0赞

## 前言 ##

mybatis作为一门市面上使用比较多的持久层框架，熟练掌握其使用是每一个开发人员必备的技能，下面就mybatis在开发使用中常用的技术点做一下汇总，以便后续使用中迅速查阅

## 1、参数输入类型 ##

mybatis支持多种参数类型，对应的标签即为parameterType，参数类型支持：简单类型，POJO类型，Map类型，List类型(数组),其中Map类型和POJO相似，数组类型的在动态sql中使用较多

**简单类型**

根据用户ID查询一个用户，这里parameterType为int类型

<select id="findUserById" parameterType="int" resultType="com.congge.demo1.User">
    		SELECT * FROM user WHERE id = #{id}
    	</select>

对应的接口

User findUserById(int id);

通过用户名查询用户

<select id="findUserByName" resultType="com.congge.demo1.User">
    		SELECT * FROM `user` WHERE `name` = #{name}
    	</select>

对应的接口

User findUserByName(String name);

如果入参比较多的情况下，可以考虑将入参使用map或者一个对象进行封装一下，使代码看起来更优雅，如下，通过多个条件查询用户信息（当然很多情况下，parameterType也可以省略）

@Test
        public void testFindUserByMap() {
            try{
                String resource = "demo1/SqlMapConfig.xml";
                InputStream inputStream = Resources.getResourceAsStream(resource);
                // 构建sqlSessionFactory
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
                SqlSession sqlSession = sqlSessionFactory.openSession();
                UserDao mapper = sqlSession.getMapper(UserDao.class);
                Map<String,Object> params= new HashMap<>();
                params.put("username","zhaoyun");
                params.put("sex","nan");
                User user = mapper.findUserByMap(params);
                System.out.println(user);
            }catch (Exception e){
                e.printStackTrace();
            }
        }

<select id="findUserByMap" parameterType="map" resultType="com.congge.demo1.User">
    		SELECT * FROM `user` WHERE `username` = #{username} and sex = #{sex}
    	</select>

![在这里插入图片描述][20201129201817218.png]  
**模糊匹配**

模糊匹配是业务中经常会碰到的场景，常用于入参为字符串类型的字段中，下面举两种比较常用的场景

需求1，模糊查询姓名中以李开头的用户

@Test
        public void testFindUserByLike() {
            try{
                String resource = "demo1/SqlMapConfig.xml";
                InputStream inputStream = Resources.getResourceAsStream(resource);
                // 构建sqlSessionFactory
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
                SqlSession sqlSession = sqlSessionFactory.openSession();
                UserDao mapper = sqlSession.getMapper(UserDao.class);
                String name = "李";
                List<User> user = mapper.findUserByLike(name);
                System.out.println(user);
            }catch (Exception e){
                e.printStackTrace();
            }
        }

<select id="findUserByLike" resultType="com.congge.demo1.User">
    		SELECT * FROM `user` WHERE `username` like concat('%',#{name},'%')
    	</select>

需求2，同时模糊匹配多个字段

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nY29uZ3lpNDIw_size_16_color_FFFFFF_t_70]

另一个比较常见的场景就是，一个输入框，支持多个字段的模糊匹配，对于字段比较多的后管系统中，会经常遇到，比如数据表中有上面这样一条数据，要查询username或者address中包含张的数据，可以参照下面的写法

<select id="findUserByMultiLike" resultType="com.kkb.mybatis.demo1.User">
    		SELECT * FROM `user` WHERE (`username` like concat('%',#{name},'%') or address like concat('%',#{name},'%'))
    	</select>

## 2、返回结果类型 ##

mybatis支持的返回结果的数据类型也非常灵活，常用的Java类型基本上都支持，Map类型，POJO类型

需求1，查询用户名，并统计当前数据库中的用户数量

<select id="findUserNameById" resultType="string">
    		SELECT username FROM `user` WHERE id = #{id}
    	</select>

<select id="findUserCount" resultType="int">
    		SELECT count(1) FROM `user`
    	</select>

返回结果为Map类型的，通常用于数据表中的字段特别多，而我们只需要查询部分字段的时候可以使用Map的方式进行返回

<select id="findPartParams" resultType="map">
    		SELECT username,address
    		FROM `user` where id= #{id}
    	</select>

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

更常见的是以POJO类型的格式返回，相对于Map的格式，使用POJO再获取结果集的时候更方便，无需要考虑为空的情况

<select id="findUserById" parameterType="int" resultType="com.kkb.mybatis.demo1.User">
    		SELECT * FROM `user` WHERE id = #{id}
    	</select>

## 3、resultType与resultMap ##

项目中使用过mybatis开发的伙伴应该对这2个标签应该很熟悉吧，如果使用mybatis的generator代码生成工具时，生成的mapper.xml文件一般都是resultMap类型的，在上面的演示代码中，大家可以看到，包括POJO类型的返回值在内，我都使用的是resultType，这里有一个小小的建议，应该说是开发上的规范问题

*  简单的数据类型，可以直接使用resultType
 *  POJO类型的，建议使用resultMap
 *  自定义的简单POJO类型的，这两种都可以使用

为什么这么说呢，我们知道数据库的表的字段和Java中的对象属性再进行对应的时候，需要借助“外力”的，这个外力就是映射，如果明确指定了字段到属性的映射关系，mybatis解析的时候效率会更好

如果使用了resultMap，则需要我们在mapper.xml文件的头部定义表的字段与对象属性之间的映射关系，参考如下代码，

这样一来，我们再次根据ID查询一条数据的时候就可以这样写

<select id="findById" parameterType="int" resultMap="baseMap">
    		SELECT * FROM `user` WHERE id = #{id}
    	</select>

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

## 4、一对一映射与一对多映射 ##

在实际开发过程中，关联查询是经常遇到的，关联查询常见的使用场景主要是一对一和一对多关联

为什么需要在mybatis这使用这种关联查询呢？我碰到的场景是，在返回的结果包装对象中，存在一些嵌套的对象，举例来说，用户和订单可以认为是一对多的关系，我们在封装给前端的结果集中，得到的数据格式期望是用户信息+订单列表，那么采用mybatis的一对多映射就很方便了

下面来看一个实例，数据库中有一张订单表，并初始化了几条数据  
![在这里插入图片描述][20201129214817849.png]

对应Java中的类

public class Order {
    
        private int id;
        private String orderName;
        private String createUser;
        private int orderStatus;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public String getOrderName() {
            return orderName;
        }
    
        public void setOrderName(String orderName) {
            this.orderName = orderName;
        }
    
        public String getCreateUser() {
            return createUser;
        }
    
        public void setCreateUser(String createUser) {
            this.createUser = createUser;
        }
    
        public int getOrderStatus() {
            return orderStatus;
        }
    
        public void setOrderStatus(int orderStatus) {
            this.orderStatus = orderStatus;
        }
    }

在mapper.xml中可以这样写

public class UserExtend{
    
        private int id;
        private String username;
        private Date birthday;
        private String sex;
        private String address;
    
        private List<Order> orders;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public Date getBirthday() {
            return birthday;
        }
    
        public void setBirthday(Date birthday) {
            this.birthday = birthday;
        }
    
        public String getSex() {
            return sex;
        }
    
        public void setSex(String sex) {
            this.sex = sex;
        }
    
        public String getAddress() {
            return address;
        }
    
        public void setAddress(String address) {
            this.address = address;
        }
    
        public List<Order> getOrders() {
            return orders;
        }
    
        public void setOrders(List<Order> orders) {
            this.orders = orders;
        }
    
    
    }

对应的sql

<select id="selectUserOrders" resultMap="baseExtendMap">
    		  select *
    		  from `user` , `order` where `user`.username=`order`.create_user and `user`.username = #{username}
    	</select>

一对一就更简单了，只需要在嵌套的对象里面通过association 标签包装即可

## 5、动态sql ##

相比其他的持久层ORM框架，mybatis的一个强大之处在于其灵活的动态sql语句，开发者可以根据自己的需要，灵活的定制sql，或者说为了让sql层面的代码更加健壮，可以考虑使用动态sql

**需求1，根据条件动态查询用户**

<select id="selectByParams" resultMap="baseMap">
    		select * from `user`
    		<where>
    			1=1
    			<if test="username != null and username != ''">
    				and username = #{username}
    			</if>
    			<if test="sex != null and sex != ''">
    				and sex = #{sex}
    			</if>
    			<if test="address != null and address != ''">
    				and address = #{address}
    			</if>
    		</where>
    	</select>

**需求2，动态更新字段**

<update id="updateFields" parameterType="map">
    		update `user`
    		<trim prefix="set" suffixOverrides=",">
    			<if test="username != null and username != ''">
    				username = #{username},
    			</if>
    			<if test="sex != null and sex != ''">
    				sex = #{sex}
    			</if>
    		</trim>
    		where id = #{id}
    	</update>

**需求3，动态SQL:choose(when,otherwise) 语句**

有时候，我们不想用到所有的查询条件，只想选择其中的一个，查询条件有一个满足即可，使用 choose 标签可以解决此类问题，类似于 Java 的 switch 语句

<select id="selectUserByChoose"  resultMap="baseMap" parameterType="com.congge.demo.User">
          select * from user
          <where>
              <choose>
                  <when test="id !='' and id != null">
                      id=#{id}
                  </when>
                  <when test="username !='' and username != null">
                      and username=#{username}
                  </when>
                  <otherwise>
                      and sex=#{sex}
                  </otherwise>
              </choose>
          </where>
      </select>

\*\*需求4，批量查询foreach \*\*

经常碰见需要根据某个字段的条件批量查询数据的情况，比如我们要查询订单状态为1和2的所有订单

<select id="queryOrders" parameterType="list" resultMap="orderMap">
    		select * from `order` where order_status in
    		<foreach collection="list" item="item" index="index">
    			#{item}
    		</foreach>
    	</select>

**foreach 使用数组类型**

<select id="queryOrdersArr" resultMap="orderMap">
    	select * from order where order_status in
    	<foreach collection="array" index="index" item="item" open="(" separator="," close=")">
    		#{item}
    	</foreach>
    </select>

**foreach使用map**

<select id="queryUsersMap" resultMap="baseMap">
    		select * from users WHERE
    		<foreach collection="map" index="key" item="value"  separator="=">
    			${key} = #{value}
    		</foreach>
    	</select>

**关于mybatis中开发常用到的一些技术点基本上就总结到这里，另外像一级二级缓存，虽然也提供了但是实际用的并不多，有兴趣的同学可以继续深入研究，本篇到此结束最后感谢观看！**

[20201129201817218.png]: /images/20221120/22ec10de1fdc4f0a9aa67de022c39bc6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nY29uZ3lpNDIw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201129203209935.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5nY29uZ3lpNDIw,size_16,color_FFFFFF,t_70
[20201129204623622.png]: https://img-blog.csdnimg.cn/20201129204623622.png
[20201129213526584.png]: https://img-blog.csdnimg.cn/20201129213526584.png
[20201129214817849.png]: https://img-blog.csdnimg.cn/20201129214817849.png