MyBatis入门（一）

MybBtis学习笔记

MyBatis官方文档

测试代码

1. 简介

MyBatis 是一款优秀的持久层框架
MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作
Dao层、Service层、Controller层
为什么需要MyBatis

传统的JDBC代码太复杂了，简化，框架，自动化
sql和代码的分离，提高了可维护性。
提供映射标签，支持对象与数据库的orm字段关系映射
提供对象关系映射标签，支持对象关系组建维护
提供xml标签，支持编写动态sql

2. 第一个Mybatis程序

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

2.1 搭建环境

创建一个普通的maven项目
删除src目录（就可以把此工程当做父工程了，然后创建子工程）
导入maven依赖(mybatis, mysql-connector-java, junit)

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.11</version>
    </dependency>
</dependencies>

创建一个子Module

2.2 编写mybatis的核心配置文件

src/main/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核心配置文件-->
<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://localhost:3306/mybatis?userSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

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

编写mybatis工具类

//sqlSessionFactory --> sqlSession
public class MybatisUtils {

    static SqlSessionFactory sqlSessionFactory = null;

    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();
    }
}

2.3 编写代码测试

实体类
Dao接口

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

接口实现类（由原来的UserDaoImpl转变为一个Mapper配置文件: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">

<!--namespace=绑定一个指定的Dao/Mapper接口-->
<mapper namespace="com.qi.dao.UserDao">
    <select id="getUserList" resultType="com.qi.pojo.Users">
        select * from users
    </select>
</mapper>

测试

常见错误

org.apache.ibatis.binding.BindingException: Type interface com.kuang.dao.UserDao is not known to the MapperRegistry.

解决方法：核心配置文件中注册mappers，每一个mapper.xml都需要注册

注意点

在build中配置resources，来防止我们资源导出失败的问题

<!--在build中配置resources，来防止我们资源导出失败的问题-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

测试代码

@Test
public void test() {
    //1.获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //2.执行SQL
    // 方式一：getMapper
    UserDao userDao = sqlSession.getMapper(UserDao.class);
    List<Users> userList = userDao.getUserList();
    for (Users user : userList) {
        System.out.println(user);
    }

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

2.4 步骤总结

导入包
配置数据库
建造工具类

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

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

3. CURD

3.1 增删改查

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

UserMapper.xml中写sql语句

namespace中的包名要和接口一致
id：就是对应的namespace（接口）的方法名
resultType：sql语句的返回值！
parameterType：参数类型！

步骤

编写接口
编写对应的mapper中的对应语句
测试

UserMapper中接口

public interface UserMapper {
    //查询所有成员
    List<Users> getUserList();
    //根据ID查询
    Users getUserById(int id);
    //插入用户
    int addUser(Users user);
    //修改用户
    int updateUser(Users user);
    //删除用户
    int deleteUser(int id);
}

UserMapper.xml中编写sql语句

<!--namespace=绑定一个指定的Dao/Mapper接口-->
<mapper namespace="com.qi.dao.UserMapper">
    <!--查询所有成员-->
    <select id="getUserList" resultType="com.qi.pojo.Users">
        select * from mybatis.users
    </select>
    <!--根据ID查询-->
    <select id="getUserById" parameterType="int" resultType="com.qi.pojo.Users">
        select * from mybatis.users where id = #{id}
    </select>
    <!--插入用户-->
    <insert id="addUser" parameterType="com.qi.pojo.Users" >
        insert into mybatis.users (id, name ,pwd) values (#{id},#{name},#{pwd});
    </insert>
    <!--修改用户-->
    <update id="updateUser" parameterType="com.qi.pojo.Users">
        update mybatis.users set name=#{name}, pwd=#{pwd} where id =#{id};
    </update>
    <!--删除用户-->
    <delete id="deleteUser" parameterType="int">
        delete from mybatis.users where id=#{id};
    </delete>
</mapper>

测试所写接口

public class UserDaoTest {

    @Test
    public void test_getUserList() {
        //1.获取SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //2.执行SQL
        // 方式一：getMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<Users> userList = userMapper.getUserList();
        for (Users user : userList) {
            System.out.println(user);
        }
        //3.关闭sqlSession
        sqlSession.close();
    }

    @Test
    public void test_getUserById() {
        //1.获取SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //2.执行SQL
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Users user = userMapper.getUserById(1);
        System.out.println(user);
        //3.关闭sqlSession
        sqlSession.close();
    }

    @Test
    public void test_addUser() {
        //1.获取SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //2.执行SQL
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int res = userMapper.addUser(new Users(5, "猴子", "555555"));
        if (res > 0) {
            System.out.println("插入成功");
        }
        //3.提交事务
        sqlSession.commit();
        //4.关闭sqlSession
        sqlSession.close();
    }

    @Test
    public void test_updateUser(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int res = userMapper.updateUser(new Users(4,"hou","123123"));
        if (res > 0) {
            System.out.println("修改成功");
        }
        //提交事务
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void test_deleteUser(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int res = userMapper.deleteUser(5);
        if (res > 0) {
            System.out.println("删除成功");
        }
        //提交事务
        sqlSession.commit();
        sqlSession.close();
    }
}

3.2 万能Map

假设，我们的实体类，或者数据库中的表，字段或者参数过多，我们应该考虑使用Map,传递map的key

UserMapper接口

//用万能Map插入用户
public void addUser2(Map<String,Object> map);

UserMapper.xml

<!--对象中的属性可以直接取出来 传递map的key-->
<insert id="addUser2" parameterType="map">
    insert into mybatis.users (id,name,pwd) values (#{userid},#{username},#{userpassword})
</insert>

测试

@Test
public void test3(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    HashMap<String, Object> map = new HashMap<String, Object>();
    map.put("userid",5);
    map.put("username","fjksd");
    map.put("userpassword",6546789);
    mapper.addUser2(map);
    //提交事务
    sqlSession.commit();
    //关闭资源
    sqlSession.close();
}

总结

Map传递参数，直接在sql中取出key即可！【parameter=“map”】
对象传递参数，直接在sql中取出对象的属性即可！【parameter=“Object”】
只有一个基本类型参数的情况下，可以直接在sql中取到
多个参数用Map , 或者注解！

3.3 模糊查询

Java代码执行的时候，传递通配符% %

List<User> userList = mapper.getUserLike("%李%");

在sql拼接中使用通配符

select * from user where name like "%"#{value}"%"

4. 配置解析优化

4.1 核心配置文件(mybatis-config.xml)

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

4.2 环境配置（environments）

MyBatis 可以配置成适应多种环境
不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。
Mybatis 默认的事务管理器是JDBC，连接池：POOLED

4.3 属性 properties

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

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

编写一个配置文件 db.properties

driver = com.mysql.jdbc.Driver
url = "jdbc:mysql://111.230.212.103:3306/mybatis?userSSL=true&userUnicode=true&characterEncoding=UTF-8"
username = root 
password = 123456

在核心配置文件中引入

mybatis-config.xml (同时有的话，优先走外面properties)

<configuration>

    <!--引入外部配置文件-->
    <!--<properties resource="db.properties"/>-->
    <properties resource="db.properties">
        <property name="username" value="root"></property>
        <property name="password" value="123456"></property>
    </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/qi/dao/UserMapper.xml"/>
    </mappers>
</configuration>

4.4 类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。它仅用于 XML 配置.
意在降低冗余的全限定类名书写。

类型别名可为 Java 类型设置一个缩写名字。

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

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

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

在实体类，比较少的时候使用第一种，实体类多使用第二种。第一种可以自定义，第二则不行，但是若有注解，则别名为其注解值。

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

4.5 设置 Settings

4.6 其他配置

typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins 插件
- mybatis-generator-core
- mybatis-plus
- 通用mapper

4.7 映射器 mappers

方式一：【推荐使用】

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

方式二：使用class文件绑定注册

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

方式三：使用包扫描进行注入

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

方式二方式三注意点

接口和他的Mapper配置文件必须同名
接口和他的Mapper配置文件必须在同一个包下

4.8 生命周期和作用域

作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

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

5. 解决属性名和字段名不一致的问题

数据库中的字段和测试实体类字段不一致：[pwd ? password]

解决方法一：起别名

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

结果集映射 resultMap

<!--结果集映射-->
    <resultMap id="UserMap" type="User">
        <!--colunm 数据库中的字段，property实体中的属性-->
        <!--<result column="id" property="id"></result>-->
        <!--<result column="name" property="name"></result>-->
        <result column="pwd" property="password"></result>
    </resultMap>

    <select id="getUserById" resultMap="UserMap" parameterType="int">
        select * from mybatis.user where id = #{id}
    </select>

resultMap 元素是 MyBatis 中最重要最强大的元素。
ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。

6. 日志

6.1 日志工厂

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

曾经：sout，debug

现在：日志工厂
logImpl,具体使用哪一个，在设置中设定

SLF4J
LOG4J [掌握]
LOG4J2
JDK_LOGGING
COMMONS_LOGGING
STDOUT_LOGGING [掌握] [标准日志输出]
NO_LOGGING

6.2 Log4j(常用)

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件；
我们也可以控制每一条日志的输出格式；
通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程；
最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

先导入log4j的包

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

新建log4j.properties文件

### set log levels ###
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/qi.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.sql.PreparedStatement=DEBUG

配置实现

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

Log4j使用(生成log/qi.log)

public class UserMapperTest {

    static Logger logger = Logger.getLogger(UserMapperTest.class);

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

7. 分页

7.1 Limit 分页

接口

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

UserMapper.xml

<!-- 分页-->
<select id="getUserByLimit" parameterType="map" resultType="User" resultMap="UserMap">
    select * from mybatis.users limit #{startIndex}, #{pageSize}
</select>

test

@Test
public void getByLimit(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    Map<String, Integer> map = new HashMap<String, Integer>();
    map.put("startIndex", 1);
    map.put("pageSize", 2);
    List<User> userList = mapper.getUserByLimit(map);

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

    sqlSession.close();
}

7.2 RowBounds分页(了解，基本不用)

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

7.3 分页插件（了解）

pageHelper

8. 使用注解开发（解耦）

8.1 面向接口开发

面向对象是指，我们考虑问题时，以对象为单位，考虑它的属性和方法；
面向过程是指，我们考虑问题时，以一个具体的流程（事务过程）为单位，考虑它的实现；
接口设计与非接口设计是针对复用技术而言的，与面向对象（过程）不是一个问题，更多的体现就是对系统整体的架构；

8.2 使用注解开发

删除 UserMapper.xml
UserMapper,注解在接口上实现

@Select("select * from user")
List<User> getUsers();

在核心配置文件中绑定接口

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

测试
本质：反射机制

底层：动态代理！

8.3 MyBatis详细执行流程

8.4 注解CRUD

public interface UserMapper {

    @Select("select * from user")
    List<User> getUsers();

    //方法存在多个参数，所有的参数必须加@Param
    @Select("select * from user where id = #{id}")
    User getUserById(@Param("id") int id);

    @Insert("insert into user (id, name, pwd) values" +
            "(#{id},#{name},#{password})")
    int addUser(User user);

    @Update("update user set name=#{name}, pwd=#{password} " +
            "where id=#{id}")
    int updateUser(User user);

    @Delete("delete from user where id=#{id}")
    int deleteUser(@Param("id") int id);
}

可以在MybatisUtiles中设置自动提交事务

public static SqlSession getSqlSession(){
    return sqlSessionFactory.openSession(true);
}

关于@Param( )注解

基本类型的参数或者String类型，需要加上
引用类型不需要加
如果只有一个基本类型的话，可以忽略，但是建议大家都加上
我们在SQL中引用的就是我们这里的@Param()中设定的属性名

9. Lombok

在IDEA中安装Lombok插件
在项目中导入lombok的jar包

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
    <scope>provided</scope>
</dependency>

在程序上加注解

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private int id;
    private String name;
    private String password;
}

注解说明：常用--> @Data: 无参构造，get，set，toString，hashCode

@Getter and @Setter
@FieldNameConstants
@ToString
@EqualsAndHashCode
@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor
@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog, @Flogger, @CustomLog
@Data
@Builder
@SuperBuilder
@Singular
@Delegate
@Value
@Accessors
@Wither
@With
@SneakyThrows

posted @ 2021-07-10 23:49 qi_chao 阅读(51) 评论(0) 编辑收藏举报

刷新页面返回顶部

qi_chao

往事随风，一往无前