Java学习笔记10-1——MyBatis

Bug一号质检员

已于 2022-03-02 18:49:39 修改

阅读量590

点赞数

文章标签： java 学习 intellij-idea

于 2022-02-23 17:10:51 首次发布

本文链接：https://blog.csdn.net/weixin_44238066/article/details/122955466

版权

简介

MyBatis 是一款优秀的持久层框架。

它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

持久化
数据持久化

持久化就是将程序的数据在持久状态和瞬时状态转化的过程
内存：断电即失

为什么要持久化？

有一些对象，不能让他丢掉
内存太贵

持久层
Dao层、Service层、Controller层
完成持久化工作的代码块层界限十分明显

为什么需要MyBatis

帮助程序员将数据存入到数据库中
方便
传统的JDBC代码太复杂了，简化，框架，自动化
不用MyBatis也可以，技术没有高低之分

优点：

简单易学
灵活
sql和代码的分离，提高了可维护性
提供映射标签，支持对象与数据库的orm字段关系映射
提供对象关系映射标签，支持对象关系组建维护
提供xml标签，支持编写动态sql

第一个Mybatis程序

建议参阅官方文档（可能需要梯子），以辅助理解以下的笔记：https://mybatis.org/mybatis-3/zh/getting-started.html

思路：搭建环境 --> 导入MyBatis --> 编写代码 --> 测试

搭建环境

新建项目
创建一个普通的maven项目
删除src目录（就可以把此工程当做父工程了，然后创建子工程）
导入maven依赖

    <dependencies>

        <!--连接mysql数据库依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.6</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/junit/junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
            <scope>test</scope>
        </dependency>

    </dependencies>

导入Mybatis，编写配置文件

编写mybatis的核心配置文件（mybatis-config.xml）

注意！！此文件不能写中文注释，不然极有可能报错，初步判断应该是IDEA编码问题（可百度：idea怎么设置默认编码）properties文件对应的编码设置成UTF-8不再报错，这样就可以在这里写中文注释。
（后来发现：原来是xml第一行写错了，原来是<?xml version="1.0" encoding="UTF-8" ?>，UTF8多了一个横杠，正确应该是<?xml version="1.0" encoding="UTF8" ?>，这样即使不设置IDEA也能写中文注释）

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--configuration核心配置文件-->
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?userSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
<!--每一个Mapper.xml文件都要在核心配置文件中注册-->
    <mappers>
        <mapper resource="com/cheng/dao/UserMapper.xml"></mapper>
    </mappers>
    
</configuration>

编写mybatis工具类

//sqlSessionFactory --> sqlSession
public class MybatisUtils {

    static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            //使用Mybatis第一步 ：获取sqlSessionFactory对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例.
    // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

编写代码

创建实体类（注意无参有参构造不要忘记创建）
Dao接口

public interface UserDao {
    public List<User> getUserList();
}

接口实现类（由原来的UserDaoImpl转变为一个Mapper.xml配置文件）
UserMapper.xml（要放在resource文件夹下，不然后续会报错）

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--namespace=绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.cheng.dao.UserDao">
<!--    select代表查询的SQL语句，id的内容代表重写DAO接口里面的方法-->
    <select id="getUserList" resultType="com.cheng.pojo.User">
        select * from USER
    </select>
</mapper>

测试

junit测试

public class UserDaoTest {
    @Test
    public void test(){
        // 第一步：获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();


        UserDao userDao = sqlSession.getMapper(UserDao.class);
        List<User> userList = userDao.getUserList();

        for (User user : userList) {
            System.out.println(user);
        }

        // 关闭sqlSession
        sqlSession.close();
    }
}

可能会遇到的问题：

配置文件没有注册
绑定接口错误
方法名不对
返回类型不对
Maven导出资源问题
空指针问题之数据库版本和驱动不匹配
（驱动版本8.0后为com.mysql.cj.jdbc.Driver ；8.0之前为com.mysql.jdbc.Driver）

了解一下官方文档的建议

SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

实现增删改查

namespace
namespace中的包名要和接口一致

select、insert、update、delete

id：就是对应的namespace的方法名
resultType：sql语句执行后的返回值的类型
parameterType：传入的参数的类型

编写接口

public interface UserMapper {
    // 查询全部用户
    List<User> getUserList();

    // 根据id查询用户
    User getUserById(int id);

    // 插入用户
    int addUser(User user);

    // 修改用户
    int UpdateUser(User user);

    // 删除用户
    int deleteUser(int id);

}

编写对应的mapper中的sql语句

<!--namespace=绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.cheng.dao.UserMapper">
<!--    select代表查询的SQL语句，id的内容代表重写Mapper接口里面的方法-->
    <select id="getUserList" resultType="com.cheng.pojo.User">
        select * from USER
    </select>

    <select id="getUserById" resultType="com.cheng.pojo.User" parameterType="int">
        select * from user where id=#{id}
    </select>

    <insert id="addUser" parameterType="com.cheng.pojo.User" >
        insert into user(id,name,pwd) values (#{id},#{name},#{pwd})
    </insert>

    <update id="UpdateUser" parameterType="com.cheng.pojo.User">
        update user set name=#{name},pwd=#{pwd}  where id=#{id} ;
    </update>

    <delete id="deleteUser" >
        delete from user where id=#{id}
    </delete>
</mapper>

测试

public class UserMapperTest {
    @Test
    public void getUserListTest(){
        // 第一步：获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        // 方式一：getMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.getUserList();

        for (User user : userList) {
            System.out.println(user);
        }

        // 关闭sqlSession
        sqlSession.close();
    }

    @Test
    public void getUserByIdTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User userById = userMapper.getUserById(2);
        System.out.println(userById);

        sqlSession.close();
    }

    @Test
    public void addUserTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int num = userMapper.addUser(new User(7, "阿斯顿", "123"));
        if (num>0){
            System.out.println(num+" "+"success！");
        }

        sqlSession.commit();
        sqlSession.close();
    }



    @Test
    public void updateUserTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int num = userMapper.updateUser(new User(1,"自行车1","123123"));
        if (num>0){
            System.out.println(num+" "+"success！");
        }

        sqlSession.commit();
        sqlSession.close();
    }


    @Test
    public void deleteUserTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int num = userMapper.deleteUser(7);
        if (num>0){
            System.out.println(num+" "+"success！");
        }

        sqlSession.commit();
        sqlSession.close();
    }
}

注意点：增删改需要提交事务

使用map进行CRUD

假如我们的实体类属性过多，用map，传递map的key（以后会有更好的方法）

接口：

    int addUser2(Map<String, Object> map);

mapper.xml：

    <!--这个键（即#{}里面的名称）可以自定义，因为这是map的key-->
    <insert id="addUser2" parameterType="map">
        insert into user (id, name, pwd) values (#{usrId}, #{usrName}, #{pwd});
    </insert>

测试：

    @Test
    public void addUser2(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("usrId",8);
        map.put("usrName","张三");
        map.put("pwd","12345");
        mapper.addUser2(map);

        sqlSession.commit();
        sqlSession.close();
    }

模糊查询

传递通配符%两种方法

1.select * from user where name like #{value}

2.select * from user where name like “%”#{value}"%"

接口：

    List<User> getUserLike(String value);

mapper.xml：

    <select id="getUserLike" resultType="com.cheng.pojo.User">
        select * from user where name like #{value}
    </select>

测试：

    @Test
    public void getUserLikeTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> list = mapper.getUserLike("%李%");

        for(User user : list){
            System.out.println(user);
        }

        sqlSession.close();
    }
}

配置解析(mybatis-config.xml)

核心配置文件mybatis-config.xml

configuration（配置）
properties（属性）
settings（设置）
typeAliases（类型别名）
typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins（插件）
environments（环境配置）
environment（环境变量）
transactionManager（事务管理器）
dataSource（数据源）
databaseIdProvider（数据库厂商标识）
mappers（映射器）

环境配置（environments）

MyBatis 可以配置成适应多种环境

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。

Mybatis 默认的事务管理器是JDBC，连接池：POOLED

属性

我们可以通过properties属性来引用配置文件

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。（db.properties）

在核心配置文件中引入db.properties：
(mybatis-config.xml 同时设置了属性的话，优先走外面的properties设置的属性)

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--configuration核心配置文件-->
<configuration>
    <!--引用外部配置文件-->
    <properties resource="db.properties">
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
    </properties>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                 <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="com/cheng/dao/UserMapper.xml"></mapper>
    </mappers>

</configuration>

类型别名（typeAliases）

方法一：直接在mybatis-config.xml给实体类起别名

<typeAliases>    
	<typeAlias type="com.cheng.pojo.User" alias="User"></typeAlias> 
</typeAliases>

此时mapper.xml的parameterType应使用别名User

方法二：扫描实体类的包，默认别名就为这个类的类名首字母小写

<typeAliases>
    <package name="com.cheng.pojo"></package>
</typeAliases>

此时别名默认变为了user。
如果有注解，则别名为其注解。

@Alias("hello")
public class User {
}

此时User类的别名是hello

设置

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true \| false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置 fetchType属性来覆盖该项的开关状态。	true \| false	false
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J \| LOG4J \| LOG4J2 \| JDK_LOGGING \| COMMONS_LOGGING \| STDOUT_LOGGING \| NO_LOGGING	未设置

映射器

方式一: [推荐使用]

<mappers>
    <mapper resource="com/cheng/dao/UserMapper.xml"/>
</mappers>

方式二：
接口和它的Mapper必须同名
接口和他的Mapper必须在同一包下

<mappers>
    <mapper class="com.cheng.dao.UserMapper" />
</mappers>

方式三：
接口和它的Mapper必须同名
接口和他的Mapper必须在同一包下

<mappers>
    <package name="com.cheng.dao" />
</mappers>

生命周期和作用域

作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。
在这里插入图片描述
SqlSessionFactoryBuilder:

一旦创建了 SqlSessionFactory，就不再需要它了。
局部变量

SqlSessionFactory：

就是数据库连接池。
一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。多次重建 SqlSessionFactory被视为一种代码“坏习惯”。
因此 SqlSessionFactory 的最佳作用域是应用作用域。
最简单的就是使用单例模式或者静态单例模式。

SqlSession：

每个线程都应该有它自己的 SqlSession 实例。
连接到连接池的请求.
SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
用完之后赶紧关闭，否则资源被占用。

在这里插入图片描述

属性名和字段名不一致的问题（结果集映射）

数据库中的字段和实体类的属性名字不一致，类型处理器无法识别。
在这里插入图片描述

无法识别，因此没有展示出pwd的值：

原因是类型处理器无法一一匹配，找不到pwd

// select * from user where id = #{id}
// 类型处理器
// 相当于select id,name,pwd from user where id = #{id}

解决方法：

起别名（操作sql，不建议）

<select id="getUserById" resultType="com.cheng.pojo.User">
    select id,name,pwd as password from USER where id = #{id}
</select>

结果集映射

<mapper namespace="com.cheng.Dao.UserMapper">

<resultMap id="userMap" type="user">
<!--   名字一样的可以不改 -->
<!--column数据库中的字段，property实体类中的属性-->
<!--    <id column="id" property="id" ></id>-->
<!--    <result column="name" property="name"></result>-->
    <result column="pwd" property="password"></result>
</resultMap>

    <select id="getUserById" resultMap="userMap">
        select * from user where id=#{id}
    </select>
</mapper>

resultMap 元素是 MyBatis 中最重要最强大的元素。
ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。
ResultMap 的优秀之处——你完全可以不用显式地配置它们。

日志

日志工厂

如果一个数据库操作出现了异常，我们需要排错。日志就是最好的助手。

曾经：sout，debug

现在：日志工厂

logImpl

SLF4J
LOG4J [掌握]
LOG4J2
JDK_LOGGING
COMMONS_LOGGING
STDOUT_LOGGING [掌握]（Mybatis自带的）
NO_LOGGING（不使用日志）

具体使用哪一个，在设置中设定

mybatis-config.xml中设置使用STDOUT_LOGGING（因为是自带的，可直接拿来用）

<settings>
    <setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>

Log4j

先导包

    <!-- https://mvnrepository.com/artifact/log4j/log4j -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>

配置settings为log4j实现

<settings>
    <setting name="logImpl" value="LOG4J"/>
</settings>

log4j.properties文件

#将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/demo.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sq1.PreparedStatement=DEBUG

测试

public class Log4jTest {
        static Logger logger = Logger.getLogger(Log4jTest.class);

        @Test
        public void test1() {
            SqlSession sqlSession = MybatisUtils.getSqlSession();
            try {
                UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
                logger.info("============================测试");
                User userById = userMapper.getUserById(2);
                logger.info("++++++++++" + userById + "++++++++++++++");
                logger.info("============================");

                System.out.println(userById);

                //提交事务,默认有。可不写
                sqlSession.commit();
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                sqlSession.close(); //关闭
            }
        }

        @Test
        public void test_log4j() {
            logger.info("info:进入了testlog4j");
            logger.debug("debug:进入了testlog4j");
            logger.error("error:进入了testlog4j");
        }
}

Log4j简单使用

在要使用Log4j的类中，导入包 import org.apache.log4j.Logger;

日志对象，参数为当前类的class对象

Logger logger = Logger.getLogger(UserDaoTest.class);

日志级别

info
debug
error

分页

为什么分页？
减少数据的处理量

使用MyBatis实现分页，核心SQL

接口

//分页
List<User> getUserByLimit(Map<String,Integer> map);

Mapper.xml

<!--分页查询-->
<select id="getUserByLimit" parameterType="map" resultType="com.cheng.pojo.User">
	select * from user limit #{startIndex},#{pageSize}
</select>

测试

@Test
public void getUserByLimit(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    HashMap<String, Integer> map = new HashMap<String, Integer>();
    map.put("startIndex",1);
    map.put("pageSize",2);
    List<User> list = mapper.getUserByLimit(map);
    for (User user : list) {
        System.out.println(user);
    }
}

RowBounds分页(了解即可)

接口

//分页2
List<User> getUserByRowBounds();

mapper.xml

    <!--分页查询2-->
    <select id="getUserByRowBounds" resultType="com.cheng.pojo.User">
        select * from user 
    </select>

测试

public void getUserByRowBounds(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //RowBounds实现
    RowBounds rowBounds = new RowBounds(1, 3);
    //通过Java代码层面实现分页
    List<User> userList = sqlSession.selectList("com.cheng.dao.UserMapper.getUserByRowBounds", null, rowBounds);
    for (User user : userList) {
        System.out.println(user);
    }
    sqlSession.close();
}