MyBatis应用实例

Flora.~

已于 2023-12-28 09:58:54 修改

阅读量94

点赞数

分类专栏：数据库学习笔记文章标签： mybatis java 开发语言

于 2022-08-02 14:40:32 首次发布

本文链接：https://blog.csdn.net/weixin_40497710/article/details/126059010

版权

学习笔记同时被 2 个专栏收录

10 篇文章 0 订阅

订阅专栏

数据库

4 篇文章 0 订阅

订阅专栏

1、pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId> </groupId>
    <artifactId> </artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--从此处往下复制-->
    <packaging>jar</packaging>

    <dependencies>
        <!--mybatis核心-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
<!--        junit测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
<!--        mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.29</version>
        </dependency>
<!--        log4j日志-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>


</project>

2、mybatis-config

<?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?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)".-->
    <properties resource="jdbc.properties"/>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <typeAliases>
        <package name="修改com.flora.mybatis.pojo"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <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>

        <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="mysql"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>

        <package name="修改com.flora.mybatis.mapper"/>
    </mappers>
</configuration>

3、mybatis-mapper

<?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.flora.mybatis.mapper.UserMapper">
    
</mapper>

4、utils-SqlSessionUtil

package com.flora.mybatis.utils;

import com.flora.mybatis.mapper.UserMapper;
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 java.io.IOException;
import java.io.InputStream;

/**
 * @Author 
 * @Date 
 */
public class SqlSessionUtil {
    public static SqlSession getSqlSession(){
        SqlSession sqlSession=null;
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
            SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
            sqlSession = sqlSessionFactory.openSession(true);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return sqlSession;
    }
}

5、jdbc.properties

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC
jdbc.username=root
jdbc.password=mysql

6、log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!-- 日志输出到控制台 -->
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name = "Encoding" value = "UTF-8" />
        <!-- 日志输出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!--
        1. 指定logger的设置，additivity是否遵循缺省的继承机制
        2. 当additivity="false"时，root中的配置就失灵了，不遵循缺省的继承机制
        3. 代码中使用Logger.getLogger("logTest")获得此输出器，且不会使用根输出器
    -->
    <logger name="java.sql" >
        <level value ="debug"/>
    </logger>
    <logger name="org.apache.ibatis">
        <level value="info"/>
    </logger>


    <!-- 根logger的设置，若代码中未找到指定的logger，则会根据继承机制，使用根logger-->
    <root>
        <level value="'debug"/>
        <appender-ref ref="STDOUT"/>
    </root>

</log4j:configuration>

7、mybatis获取参数值的方式

${} 字符串拼接，需要加引号
#{} 占位符赋值，解析后自动加单引号

8、mapper接口的参数注解@Param

mybatis会将这些参数作为key放到map中，进行存储。
默认以param1, param2作为key进行存储

/**
     * 根据参数查询用户
     * @param username
     * @param password
     * @return
     */
    User checkLoginByParam(@Param("username") String username, @Param("password") String password);

9、@MapKey(“key”)

将map集合放到一个大的map集合中，将查询的某个字段的值作为键

/**
     * 查询所有用户作为map输出
     * @return
     */
    @MapKey("id")
    Map<String, Object> getAllUserToMap();

10、表字段对应类属性的方式

方式一：取别名

        select emp_id empId, emp_name empName,age, gender, dept_id deptId from t_emp where emp_id = #{empId}

方式二：在mybatis-config.xml中添加设置

	<settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>

方式三：在Mapper.xml中使用resultMap作为返回值
id作为唯一标识

	<resultMap id="empResultMap" type="Emp">
        <id column="emp_id" property="empId"></id>
        <result column="emp_name" property="empName"></result>
        <result column="age" property="age"></result>
        <result column="gender" property="gender"></result>
        <result column="dept" property="dept"></result>
    </resultMap>
    <select id="getEmpByEmpId" resultMap="empResultMap">
        select * from t_emp where emp_id = #{empId}
    </select>

11、多对一表联查

方式一：

	<resultMap id="empAndDeptResultMap" type="Emp">
        <id column="emp_id" property="empId"></id>
        <result column="emp_name" property="empName"></result>
        <result column="age" property="age"></result>
        <result column="gender" property="gender"></result>
        <result column="dept_id" property="dept.deptId"></result>
        <result column="dept_name" property="dept.deptName"></result>
    </resultMap>
    <select id="getEmpAndDeptByEmpId" resultMap="empAndDeptResultMap">
        select * from t_emp left join  t_dept on t_emp.dept_id = t_dept.dept_id where t_emp.emp_id = #{empId}
    </select>

方式二：
association标签：处理实体类型的属性

	<resultMap id="empAndDeptResultMap2" type="Emp">
        <id column="emp_id" property="empId"></id>
        <result column="emp_name" property="empName"></result>
        <result column="age" property="age"></result>
        <result column="gender" property="gender"></result>
        <association property="dept" javaType="Dept">
            <id column="dept_id" property="deptId"></id>
            <result column="dept_name" property="deptName"></result>
        </association>
    </resultMap>
    <select id="getEmpAndDeptByEmpId" resultMap="empAndDeptResultMap2">
        select * from t_emp left join  t_dept on t_emp.dept_id = t_dept.dept_id where t_emp.emp_id = #{empId}
    </select>

12、一对多表联查

	<resultMap id="DeptAndEmpByDeptIdResult" type="Dept">
        <id column="dept_id" property="deptId"></id>
        <result column="dept_name" property="deptName"></result>
        <collection property="emps" ofType="Emp">
            <id column="emp_id" property="empId"></id>
            <result column="emp_name" property="empName"></result>
            <result column="age" property="age"></result>
            <result column="gender" property="gender"></result>
        </collection>
    </resultMap>
    <select id="getDeptAndEmpByDeptId" resultMap="DeptAndEmpByDeptIdResult">
        select * from t_dept left join t_emp on t_dept.dept_id = t_emp.dept_id where t_dept.dept_id =#{deptId}
    </select>

13、分步查询

DeptMapper.java接口

	/**
     * 分步查询根据部门ID查询部门信息以及部门中所有员工信息的第一步
     * @param deptId
     * @return
     */
    Dept getDeptAndEmpByStepOne(@Param("deptId") Integer deptId);

DeptMapper.xml

	<resultMap id="DeptAndEmpByStepOneResult" type="Dept">
        <id column="dept_id" property="deptId"></id>
        <result column="dept_name" property="deptName"></result>
        <collection property="emps" select="com.flora.mybatis.mapper.EmpMapper.getDeptAndEmpByStepTwo" column="dept_id"></collection>
    </resultMap>
    <select id="getDeptAndEmpByStepOne" resultMap="DeptAndEmpByStepOneResult">
        select * from t_dept where dept_id = #{deptId}
    </select>

EmpMapper.java接口

	/**
     * 分步查询根据部门的ID查询部门及部门中员工信息的第二步
     * @param deptId
     * @return
     */
    List<Emp> getDeptAndEmpByStepTwo(@Param("deptId") Integer deptId);

EmpMapper.xml

	<select id="getDeptAndEmpByStepTwo" resultType="Emp">
        select * from t_emp where dept_id = #{deptId}
    </select>

14、条件查询

方式一：if标签

	<select id="getEmpByCondition" resultType="Emp">
        select * from t_emp where 1=1
        <if test="empName !='' and empName != null">
            and emp_name = #{empName}
        </if>
        <if test="age !='' and age != null">
            and age = #{age}
        </if>
        <if test="gender !='' and gender != null">
            and gender = #{gender}
        </if>

    </select>

方式二：where标签
作用：
自动加where语句
自动去除多余的and
没有匹配条件时不生成where条件

	<select id="getEmpByCondition" resultType="Emp">
        select * from t_emp
        <where>
            <if test="empName !='' and empName != null">
                emp_name = #{empName}
            </if>
            <if test="age !='' and age != null">
                and age = #{age}
            </if>
            <if test="gender !='' and gender != null">
                and gender = #{gender}
            </if>
        </where>

    </select>

15、批量插入

	<insert id="insertBenchEmp">
        insert into t_emp values
        <foreach collection="emps" item="emp" separator=",">
            (null, #{emp.empName}, #{emp.age}, #{emp.gender}, null)
        </foreach>
    </insert>

	/**
     * 批量添加员工
     * @param emps
     */
    void insertBenchEmp(@Param("emps") List<Emp> emps);

16、批量删除

	@Test
    public void testDeleteBenchEmp(){
        SqlSession sqlSession = SqlSessionUtil.getSqlSession();
        DynamicSQLMapper mapper = sqlSession.getMapper(DynamicSQLMapper.class);
        Integer[] empIds = new Integer[]{5,6};
        mapper.deleteBenchEmp(empIds);
    }

	<delete id="deleteBenchEmp">
        delete from t_emp where
        <foreach collection="empIds" item="empId" separator="or">
            emp_id = #{empId}
        </foreach>
    </delete>

在这里插入图片描述

17、sql标签

用include标签引入定义的sql片段

	<sql id="itemSql">
        null, #{emp.empName}, #{emp.age}, #{emp.gender}, null
    </sql>
    <insert id="insertBenchEmp">
        insert into t_emp values
        <foreach collection="emps" item="emp" separator=",">
            (<include refid="itemSql"></include>)
        </foreach>
    </insert>

18、一级缓存

SqlSession级别的，查询同一个数据，sql只执行一次
任何中间的增删改查操作都会自动清除缓存
手动清除一级缓存：sqlSession.clearCache();

理解：一级缓存只是相对于同一个SqlSession而言。所以在参数和SQL完全一样的情况下，我们使用同一个SqlSession对象调用一个Mapper方法，往往只执行一次SQL，因为使用SelSession第一次查询后，MyBatis会将其放在缓存中，以后再查询的时候，如果没有声明需要刷新，并且缓存没有超时的情况下，SqlSession都会取出当前缓存的数据，而不会再次发送SQL到数据库。

如果sqlSession去执行commit操作（执行插入、更新、删除），清空SqlSession中的一级缓存，这样做的目的为了让缓存中存储的是最新的信息，避免脏读。

正式开发，是将mybatis和spring进行整合开发，事务控制在service中。

一个service方法中包括很多mapper方法调用。一级缓存生效。Service方法结束，sqlSession就关闭。

如果是执行两次service调用查询相同的用户信息，不走一级缓存，因为Service方法结束，sqlSession就关闭，一级缓存就清空。

	@Test
    public void testGetEmpById(){
        SqlSession sqlSession = SqlSessionUtil.getSqlSession();
        CaCheMapper mapper = sqlSession.getMapper(CaCheMapper.class);
        Emp empById1 = mapper.getEmpById(7);
        System.out.println(empById1);
        Emp empById2 = mapper.getEmpById(7);
        System.out.println(empById2);
    }

19、二级缓存

SqlSessionFactory级别的
通过同一个SqlSessionFactory所获取的SqlSession所查询的数据会被缓存
开启的条件：
在核心配置文件中，设置全局配置属性cacheEnabled=“true”
在映射文件中设置标签
二级缓存必须在SqlSession关闭或提交之后有效
查询的数据所转换的实体类类型必须实现序列化的接口

查询数据：先查二级缓存，再查一级缓存，再查数据库

理解：多个sqlSession可以共享一个UserMapper的二级缓存区域。

UserMapper有一个二级缓存区域（按namespace分，如果namespace相同则使用同一个相同的二级缓存区），其它mapper也有自己的二级缓存区域（按namespace分）。

mybaits的二级缓存是mapper范围级别，除了在Config.xml设置二级缓存的总开关，还要在具体的mapper.xml中开启二级缓存。

应用场景：

对于访问多的查询请求且用户对查询结果实时性要求不高，此时可采用mybatis二级缓存技术降低数据库访问量，提高访问速度，业务场景比如：耗时较高的统计分析sql、电话账单查询sql等。

实现方法如下：通过设置刷新间隔时间，由mybatis每隔一段时间自动清空缓存，根据数据变化频率设置缓存刷新间隔flushInterval，比如设置为30分钟、60分钟、24小时等，根据需求而定。

20、逆向工程

在这里插入图片描述
pom.xml文件添加

	<build>
        <plugins>
            <!-- MyBatis 逆向工程插件 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>
                    <verbose>true</verbose>
                    <overwrite>false</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.29</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

generatorConfig.xml

<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <context id="DB2Table" targetRuntime="MyBatis3">
        <!--数据库连接信息-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"
                        userId="root"
                        password="mysql" />
        
        <!--javaModelGenerator : 节点用于配置实体类生成器-->
        <!--targetPackage：生成实体类存放的包名 targetProject：指定目标项目路径，可以使用绝对路径或者相对路径-->
        <javaModelGenerator targetPackage="com.flora.mybatis.pojo" targetProject="src/main/java">
            <!--enableSubPackages 是否在targetPackage基础上生成子包。默认为false。当为true时，会将表所在 schema 名作为子包名-->
            <property name="enableSubPackages" value="true" />
            <!--在setter方法中是否对传入字符串进行 trim 操作-->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        
        <!--sqlMapGenerator : 节点用于配置 XML 生成器-->
        <sqlMapGenerator targetPackage="com.flora.mybatis.mapper"  targetProject="src/main/resources">
            <!--enableSubPackages ： 是否在targetPackage基础上生成子包。默认为false。当为true时，会将表所在 schema 名作为子包名-->
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
        
        <!-- javaClientGenerator：最多配置一个，用于生成mapper接口
            MyBatis3：ANNOTATEDMAPPER、MIXEDMAPPER、XMLMAPPER
            MyBtais3Simple：ANNOTATEDMAPPER、XMLMAPPER
        -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.flora.mybatis.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        
        <!--表的配置-->
        <table tableName="t_emp" domainObjectName = "Emp"></table>
        <table tableName="t_Dept" domainObjectName = "Dept"></table>
    </context>
</generatorConfiguration>

21、分页插件

pom.xml

<!--        pageHelper插件-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>4.2.1</version>
        </dependency>

mybatis-config.xml

	<plugins>
        <plugin interceptor="com.github.pagehelper.PageHelper"></plugin>
    </plugins>

注意版本对应关系
添加链接描述

测试类：

public class PageTest {
    @Test
    public void testPage(){
        SqlSession sqlSession = SqlSessionUtil.getSqlSession();
        EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
//        查询前开启分页查询功能
        PageHelper.startPage(1,4);
        List<Emp> emps = mapper.selectByExample(null);
        for (Emp emp:emps
             ) {
            System.out.println(emp);
        }
        //        查询后获取分页的数据信息，navigatePages=3
        PageInfo<Emp> pageInfo = new PageInfo<Emp>(emps, 3);

    }
}