Mybatis实战教程-入门必看

---

Mybatis是一款优秀的持久层框架。其封装了JDBC操作， 免去了开发人员编写JDBC 代码以及设置参数和获取结果集的重复性工作。通过编写简单的 XML 或Java注解即可映射数据库CRUD操作。下面咱们就开撸吧

• Maven依赖如下

 <dependencies>
        <!--mybatis版本-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.4</version>
        </dependency>

        <!--mysql 连接-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>

        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>compile</scope>
        </dependency>

        <!--log4j-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.12</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.12</version>
        </dependency>

        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
            <scope>provided</scope>
        </dependency>

    </dependencies>

• mybatis-config.xml全局配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <properties resource="dbconfig.properties"/>
    <settings>
        <!--开启驼峰命名规范-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>


    </settings>

    <!--别名配置-->
    <typeAliases>
        <!--下面这种配置只能给每一个类起别名,如bean包下有几十个类,这样配置起来比较繁琐-->
        <!--<typeAlias type="com.wcy.pojo.User" alias="user"/>-->
        <!--批量处理别名,name:指定别名（为当前包下以及下面所有后代包的每个类都起一个默认别名（类名小写））
        注: 如果bean包下面有两个相同的类,为了防止发生别名冲突,可以在类上加一个别名注解
        使用@Alias注解为某个类型指定新的别名-->
        <package name="com.wcy.pojo"/>
    </typeAliases>
    <!--数据源配置-->
    <environments default="test_data_base">
        <environment id="test_data_base">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>

            </dataSource>
        </environment>
    </environments>

    <!--mapper:注册一个映射文件 
    resource：引用类路径下的sql映射文件 
    url：引用网络路径或者磁盘路径下的sql映射文件 
    class：引用(注册)接口 
        1、有sql映射文件，映射文件名必须和文件名同名，并且放在与接口统一目录下 
           2、没有sql映射文件，所有的sql都是利用注解写在接口上-->
    <mappers>
       <mapper resource="mapper/UserMapper.xml"/>
       <mapper resource="mapper/ItemsMapper.xml"/>
       <mapper resource="mapper/OrderMapper.xml"/>
       <mapper resource="mapper/OrderDetailMapper.xml"/>
    </mappers>
</configuration>

更详细的配置可以参考mybatis XML文件配置

• 表结构如下

--用户表
CREATE TABLE tab_user
(
    u_id bigint PRIMARY KEY NOT NULL COMMENT '主键id' AUTO_INCREMENT,
    u_name varchar(20) COMMENT '名称',
    u_address varchar(30) COMMENT '住址',
    u_birthday date COMMENT '生日',
    u_sex int COMMENT '性别'
);
ALTER TABLE tab_user COMMENT = '用户表'
--订单表
CREATE TABLE `tab_order` (
  `id` bigint(20) NOT NULL COMMENT '订单id',
  `USER_ID` int(11) NOT NULL COMMENT '用户id',
  `order_number` varchar(40) NOT NULL COMMENT '订单号',
  `create_time` date DEFAULT NULL COMMENT '创建时间',
  `note` varchar(50) DEFAULT NULL COMMENT '备注',
  PRIMARY KEY (`id`),
  UNIQUE KEY `tab_order_id_uindex` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='订单表'

--订单明细表
CREATE TABLE `tab_order_detail` (
  `id` int(11) NOT NULL COMMENT '主键id',
  `order_id` varchar(20) DEFAULT NULL COMMENT '订单号',
  `items_id` int(11) DEFAULT NULL COMMENT '商品id',
  `items_num` int(11) DEFAULT NULL COMMENT '购买数量',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='订单明细'

--商品表
CREATE TABLE `tab_items` (
  `id` int(11) NOT NULL COMMENT '主键id',
  `name` varchar(20) DEFAULT NULL COMMENT '商品名称',
  `price` decimal(4,2) DEFAULT NULL COMMENT '商品价格',
  `detail` varchar(50) DEFAULT NULL COMMENT '描述信息',
  `pic` varchar(50) DEFAULT NULL COMMENT '图片',
  `create_time` date DEFAULT NULL COMMENT '生产日期',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

• 代码结构如下
  
• 测试类

public class TestDemo {

    SqlSession sqlSession = null;
    @Before
    public void getSessionFactory() throws IOException {
        String resource = "mybatis-config.xml";
        InputStream resourceAsStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory build = new SqlSessionFactoryBuilder().build(resourceAsStream);
        sqlSession = build.openSession();
    }

    @Test
    public void testMysql1() throws IOException {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User byId = mapper.getById(1L);
        System.out.println(byId);

    }

    @Test
    public void testMysql2() throws IOException {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User byId = mapper.selectByCondition(1L,"23123","412434");
        System.out.println(byId);

    }

    @Test
    public void testMysql3() throws IOException {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User byId = mapper.selectByParams("23123","412434");
        System.out.println(byId);

    }

    @Test
    public void testMysql4() throws IOException {
        OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
        Order byId = mapper.findOrderById(1L);
        System.out.println(byId);

    }

    @Test
    public void testMysql6() throws IOException {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = new User();
        user.setUAddress("ceshi");
        user.setUBirthday(new Date());
        user.setUName("test");
        user.setUSex(2);
        Integer byId = mapper.insert(user);
        System.out.println(byId);
        sqlSession.commit();

    }
    @Test
    public void testMysql5() throws IOException {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List byId = mapper.findAll();
        System.out.println(byId);

    }

准备工作已经就绪,下面开始撸代码

单表操作

对一张表进行操作

• Bean对象

@Data
@AllArgsConstructor
@NoArgsConstructor
//@Alias("user")  别名
public class User {

    private Long uId;
    private String uName;
    private String uAddress;
    private Date uBirthday;
    private Integer uSex;
}

• Mapper接口

public interface UserMapper {

    User getById(Long uId);
    User selectByCondition(Long param1,String param2,String param3);
    User selectByParams(@Param("userName") String arg1, @Param("passWord") String arg2);
    List<User> findAll();
}

• Mapper.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接口-->
<mapper namespace="com.wcy.mapper.UserMapper">


    <!--1 单个入参查询,#{参数名} 这里面的参数名可以随便取-->
    <select id="getById" resultType="user" parameterType="Long">
        select * from tab_user where u_id = #{id}
    </select>

    <!--2 如果是多个参数 #{参数名n} 这个参数名只能是arg或者param,其他的就会报错,
            而且这个n,必须和和接口中的参数顺序一致
            如 User selectByCondition(Long param1,String param2,String param3);-->
    <select id="selectByCondition" resultType="user" >
        select * from tab_user where u_id = #{param1} and u_name = #{param2} and u_address = #{param4}
    </select>

    <!--3 多参数查询一般用这种方式的比较多,@Param给参数指定别名
    User selectByParams(@Param("userName") String arg1, @Param("passWord") String arg2);
    -->
    <select id="selectByParams" resultType="user" >
        select * from tab_user where  u_name = #{userName} and u_address = #{passWord}
    </select>

    <!--4 inset  mysql支持主键,
    useGeneratedKeys="true": 使用主键自增策略
    keyProperty="uId" : 指定只做自增后的主键封装到javabean中的哪个字段
    当然mysql也可以使用数据库自身的自增策略

    注: oracle中不支持自增长，通过序列来获取主键值
    <insert id="insert" databaseId="oracle">
        <selectKey keyProperty="uId" order="BEFORE" resultType="Integer">
            select user_sql.nextval from dual
        </selectKey>
        insert into tab_user(u_name,u_address,U_birthday,u_sex)  values (#{uName},#{uAddress},#{uBirthday},#{uSex})
    </insert>
    -->
    <insert id="insert" useGeneratedKeys="true" parameterType="user" keyProperty="uId">
        insert into tab_user(u_name,u_address,U_birthday,u_sex)  values (#{uName},#{uAddress},#{uBirthday},#{uSex})
    </insert>


    <!--我们也可以通过resultMap标签来指定映射关系-->
    <resultMap id="findAllResultMap" type="user" autoMapping="true">
        <!--这条是主键,一定要写-->
        <id column="u_id" property="uId"/>
        <result column="u_name" property="uName"/>
        <result column="u_address" property="uAddress"/>
        <result column="u_birthday" property="uBirthday"/>
        <result column="u_sex" property="uSex"/>
    </resultMap>

    <!--autoMapping="true" 除主键以为的字段映射可以不用写-->
    <!--<resultMap id="findAllResultMap" type="user" autoMapping="true">-->
        <!--&lt;!&ndash;这条是主键,一定要写&ndash;&gt;-->
        <!--<id column="u_id" property="uId"/>-->
    <!--</resultMap>-->

    <select id="findAll" resultMap="findAllResultMap">
        select * from  tab_user
    </select>
</mapper>

动态sql

动态 SQL 是 MyBatis 的强大特性之一,根据不同的条件动态的凭借sql语句,下面一起来探讨一下

• 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.wcy.mapper.OrderMapper">

    <!--这里我们用动态sql的方式来写这条sql-->
    <select id="findByOrderNumAndUid" resultType="order">
        select * from tab_order
<!--         这里使用条件去判断来拼接sql语句-->
        <where>
            <if test="orderNum != null">
                order_number =#{orderNum}
            </if>
            <if test="uId != null">
                and user_id = #{uId}
            </if>
        </where>
<!--         有的同学可能习惯下面这种写法,这种写法已建议,因为当数据数据量非常大
        的时候效率会非常慢,1=1 会被迫对每行数据进行扫描以比较此行是否满足过滤条件
        消耗新能-->
        where 1=1
        <if test="orderNum != null">
            and order_number =#{orderNum}
        </if>
        <if test="uId != null">
            and user_id = #{uId}
        </if>
    </select>


    <!--trim 顾名思义 就是对sql的后缀处理 这里有几个点先了解下
       prefix : 表示在trim标签内sql语句加上前缀xxx
       suffix ：表示在trim标签内sql语句加上后缀xxx
       suffixOverrides ：表示去除最后一个后缀xxx
       下面就是前面加上set ,并去掉最后一个 , -->
    <update id="update" parameterType="order">
        update tab_order
        <trim prefix="set" suffixOverrides=",">
            <if test="note != null">
                note=#{note},
            </if>
        </trim>
        where id= #{id}
    </update>
</mapper>

更多的动态sql可以参考动态sql,这里面有很多用法

多表查询

我们先看下这个关系,改订单对应一个用户的,该订单对应多个商品

• 需求: 查询某个订单和改订单对应的用户信息

<?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.wcy.mapper.OrderMapper">


    <!--这是第一种方式-->
    <!--查询订单号对应的订单和用户信息-->
    <!--autoMapping="true" : 驼峰命名模式下自动映射-->
    <resultMap id="OrderAndUserResultMap" type="order" autoMapping="true">
        <id column="id" property="id"/>

        <!--这是一种方式-->
        <association property="user" javaType="user" autoMapping="true">
        <id column="uId" property="u_id"/>
        </association>

    </resultMap>
    <select id="findOrderAndUserById" resultMap="OrderAndUserResultMap">
        select t.*,u.*  from tab_order t ,tb_user u
        where t.USER_ID = u.u_id
        and t.id = #{id}
    </select>

<!--################################################################################################-->
    <!--这是第二种方式-->
    <!--查询订单号对应的订单和用户信息-->
    <resultMap id="OrderAndUserResultMap" type="order" autoMapping="true">
        <id column="id" property="id"/>
        <!--这是另一种关联方式-->
        <!--直接掉用UserMapper.getById(Long uId) 这个方法,入参是order表中的user_id字段的值-->
        <association property="user" select="com.wcy.mapper.UserMapper.getById" column="user_id"/>
    </resultMap>

    <select id="findOrderAndUserById" resultMap="OrderAndUserResultMap">
        select t.*  from tab_order t where t.id = #{id}
    </select>


</mapper>

• 需求:查询某个用户所有的订单及订单下的商品信息

User对象

@Data
@AllArgsConstructor
@NoArgsConstructor
//@Alias("user")
public class User {

    private Long uId;
    private String uName;
    private String uAddress;
    private Date uBirthday;
    private Integer uSex;
    /**
    * 用户下对应多个订单
    */
    private List<Order> orders;  
}

UserMapper.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接口-->
<mapper namespace="com.wcy.mapper.UserMapper">
    <!--用户购买的商品信息-->

    <!--collection : 表示集合属性  ofType,对应集合中的元素
        association : 单个对象属性 javaType,对应实体类-->
    <resultMap id="UserAndItemsResultMap" type="user" autoMapping="true">
        <id column="u_id" property="uId"/>
        <!--配置用户创建订单信息,一个用户多个订单-->
        <collection property="orders" ofType="order">
            <id column="id" property="id"/>

            <!--配置订单明细-->
            <collection property="orderDetailList" ofType="orderDetail">
                <id column="id" property="id"/>

                <!--配置商品信息-->
                <association property="items" javaType="items">
                    <id column="id" property="id"/>
                </association>
            </collection>
        </collection>
    </resultMap>

    <select id="findUserAllOrders" resultMap="UserAndItemsResultMap">
        select tab_user.*,tab_order.*,tab_order_detail.*,tab_items.*
        from
            tab_user,tab_order,tab_order_detail,tab_items
        where
            tab_user.u_id=tab_order.user_id
        and tab_order_detail.order_id=tab_order.id
        and tab_order_detail.items_id=tab_items.id
        and tab_user.u_id=#{id}
    </select>
</mapper>

个人觉得Mybatis使用起来是非常方便快捷的,咱们这里探讨的是XML配置方式开发,其实还可以通过注解的方式来开发, 个人还是习惯XML配置的方式.
还有一些多数据源,缓存等配置这里没有讲,文中链接的文档里面可能更详细,可以参考

最后,大家如果有什么好的建议或意见可以评论下,可以一起探讨,谢谢大家~~~