Mybatis入门基本操作

Mybatis官网

https://mybatis.net.cn/

Mybatis环境准备及关系梳理

mybatis涉及到的配置文件

  1. pom.xml 存放mybatis的坐标
  2. mybatis-config.xml 用于存放mybatis的配置（推荐）
  3. pojo类，对应的表
  4. Mapper java接口，用于直接从sqlsession中获取Mapper代理对象
  5. Mapper的xml配置，用于写sql（和java接口放在同一目录下，其实就是放在resources目录下）

mybatis如何把这些串联起来

  1. mybatis配置文件中，配置environment，用于访问db
  2. mybatis配置mappers，用于扫描mapper的xml文件（采用mapper代理的方式）
  3. Mapper的xml（sql映射文件）和mppaer java接口要放在同一目录下
  4. Mapper的xml中的namespace配置成Mapper java接口的全限定名，且java接口的方法名与xml中的id一致且参数类型、返回值也一致
  5. 这样，mybatis就能将java接口和sql映射文件及其中的内容都一一对应起来
  6. java接口返回的是pojo类，那么mybatis就能自动进行对象创建和填充

pom.xml

<!--mybatis 依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.5</version>
        </dependency>

        <!--mysql 驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>

        <!--junit 单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>


        <!-- 添加slf4j日志api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.20</version>
        </dependency>
        <!-- 添加logback-classic依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- 添加logback-core依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>

快速入门

  1. 创建表添加数据
  2. 导入maven坐标
  3. 编写Mybatis配置文件
  4. 定义pojo类
  5. 编写mapper接口
  6. 编写SQL映射文件
  7. 编码运行
    1. 编写测试类
    2. 加载核心配置文件获取SqlSessionFactory对象
    3. 获取SqlSession对象，执行Sql语句
    4. 释放资源

Mybatis配置文件 resources/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>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--数据库连接信息-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///test?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <!-- 配置了要扫描的sql映射文件 -->
        <package name="com.cc.qin.mapper"/>
    </mappers>
</configuration>

POJO类：位置 com.cc.qin.pojo.Fruit

package com.cc.qin.pojo;

public class Fruit {
    private int id;
    private String fname;
    private String price;
    private int fcount;
    private String remark;
    // getter setter
}

Mapper 接口：位置com.cc.qin.mapper.FruitMapper

package com.cc.qin.mapper;

import com.cc.qin.pojo.Fruit;

import java.util.List;

public interface FruitMapper {
    List<Fruit> selectAll();
}

Sql映射文件：位置 resources/com/cc/qin/mapper/FruitMapper.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">
<!-- 命名空间与FruitMapper的接口一样 -->
<mapper namespace="com.cc.qin.mapper.FruitMapper">
    <!--statement, id与FruitMapper中的接口相同-->
    <!--resultType, 如果没有配置Alias，那么需要写pojo的全类名-->
    <select id="selectAll" resultType="com.cc.qin.pojo.Fruit">
        select * from fruit;
    </select>
</mapper>

测试类运行代码：

package com.cc.qin.test;

import com.cc.qin.mapper.FruitMapper;
import com.cc.qin.pojo.Fruit;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class FruitTest {

    @Test
    public void test_selectAll() 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接口的代理对象
        FruitMapper fruitMapper = sqlSession.getMapper(FruitMapper.class);
        //4. 执行方法
        List<Fruit> fruits = fruitMapper.selectAll();
        System.out.println(fruits);
        //5. 释放资源
        sqlSession.close();
    }
}

文件示意图

一些用法记录

使用@param指定参数名称

在mapper的java接口中，使用@param注解，指定传参名称，这样在sql映射文件中就可以直接使用#{name} 占位符来使用变量，否则默认参数名称是arg0 或param1

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

mybatis mapper接口参数封装：

MyBatis 参数封装：
  * 单个参数：
      1. POJO类型：直接使用，属性名 和 参数占位符名称 一致
      2. Map集合：直接使用，键名 和 参数占位符名称 一致
      3. Collection：封装为Map集合，可以使用@Param注解，替换Map集合中默认的arg键名
          map.put("arg0",collection集合);
          map.put("collection",collection集合);
      4. List：封装为Map集合，可以使用@Param注解，替换Map集合中默认的arg键名
          map.put("arg0",list集合);
          map.put("collection",list集合);
          map.put("list",list集合);
      5. Array：封装为Map集合，可以使用@Param注解，替换Map集合中默认的arg键名
          map.put("arg0",数组);
          map.put("array",数组);
      6. 其他类型：直接使用
  * 多个参数：封装为Map集合,可以使用@Param注解，替换Map集合中默认的arg键名
      map.put("arg0",参数值1)
      map.put("param1",参数值1)
      map.put("param2",参数值2)
      map.put("agr1",参数值2)
      ---------------@Param("username")
      map.put("username",参数值1)
      map.put("param1",参数值1)
      map.put("param2",参数值2)
      map.put("agr1",参数值2)

sql映射文件占位符

* 参数占位符：
    1. #{}:会将其替换为 ?，为了防止SQL注入
    2. ${}：拼sql。会存在SQL注入问题
    3. 使用时机：
        * 参数传递的时候：#{}
        * 表名或者列名不固定的情况下：${} 会存在SQL注入问题

 * 参数类型：parameterType：可以省略
 * 特殊字符处理：
    1. 转义字符：
    2. CDATA区:

开启主键返回

<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>

resultmap（可以不写所有的字段）

<!--
        数据库表的字段名称  和  实体类的属性名称 不一样，则不能自动封装数据
            * 起别名：对不一样的列名起别名，让别名和实体类的属性名一样
                * 缺点：每次查询都要定义一次别名
                    * sql片段
                        * 缺点：不灵活
            * resultMap：
                1. 定义<resultMap>标签
                2. 在<select>标签中，使用resultMap属性替换 resultType属性

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

其他：logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- CONSOLE ：表示当前的日志信息是可以输出到控制台的。-->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%level]  %cyan([%thread]) %boldGreen(%logger{15}) - %msg %n</pattern>
        </encoder>
    </appender>
    <logger name="com.cc.qin" level="DEBUG" additivity="false">
        <appender-ref ref="Console"/>
    </logger>
    <!--
      level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
     ， 默认debug
      <root>可以包含零个或多个<appender-ref>元素，标识这个输出位置将会被本日志级别控制。
      -->
    <root level="DEBUG">
        <appender-ref ref="Console"/>
    </root>
</configuration>
posted @ 2022-03-24 00:23  蟹与西梅  阅读(74)  评论(0)    收藏  举报