Mybatis入门:环境配置及入门代码实例

发布于 2020-03-25  167 热度


概述

简介

MyBatis本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。
MyBatis是一个优秀的持久层框架,它对jdbc的操作数据库的过程进行封装,使开发者只需要关注 SQL 本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
Mybatis通过xml或注解的方式将要执行的各种statement(statement、preparedStatemnt、CallableStatement)配置起来,并通过java对象和statement中的sql进行映射生成最终执行的sql语句,最后由mybatis框架执行sql并将结果映射成java对象并返回。

架构

Mybatis入门:环境配置及入门代码实例
1、mybatis配置
SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息。
mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。
2、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂
3、由会话工厂创建sqlSession即会话,操作数据库需要通过sqlSession进行。
4、mybatis底层自定义了Executor执行器接口操作数据库,Executor接口有两个实现,一个是基本执行器、一个是缓存执行器。
5、Mapped Statement也是mybatis一个底层封装对象,它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象,sql的id即是Mapped statement的id。
6、Mapped Statement对sql执行输入参数进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中,输入参数映射就是jdbc编程中对preparedStatement设置参数。
7、Mapped Statement对sql执行输出结果进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中,输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

流程

1、使用XML配置文件或Java代码方式生产SqlSessionFactory
2、使用Resources类的getResourceAsStream()方法读取XML配置文件
3、使用SqlSessionFactoryBuilder类的build()方法创建sqlSessionFactory
4、得到sqlSessionFactory类后使用该类的openSession()获取SqlSession
5、得到SqlSession后需要实现映射器的功能,映射器有一个接口和该接口对应的XML映射文件或使用注解组成
6、使用SqlSession的getMapper()方法得到具体的接口类对象
7、通过Mapper接口类对象对数据进行操作
8、操作完毕,SqlSession提交或回滚

环境搭建

下载所需Jar包

mybatis的代码由github.com管理
下载地址:https://github.com/mybatis/mybatis-3/releases
下载后解压可看到几个文件和文件夹:
* mybatis-3.2.7.jar::mybatis核心包
* lib:mybatis依赖包
* mybatis.pdf:mybatis使用手册

创建Java工程

略。

加入Jar包

把mybatis的核心包、依赖包、数据库驱动包Add to build path。

加入配置文件

创建资源文件夹config,加入log4j.properties和SqlMapConfig.xml配置文件。

log4j.properties

这是日志信息配置文件,用于在控制台输出运行日志信息。
在config下创建log4j.properties如下:

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

SqlMapConfig.xml

这是mybatis的全局配置文件。

可配置的内容和顺序如下:

  • properties(属性)
  • settings(全局配置参数)
  • typeAliases(类型别名)
  • typeHandlers(类型处理器)
  • objectFactory(对象工厂)
  • plugins(插件)
  • environments(环境集合属性对象)
    • environment(环境子属性对象)
      • transactionManager(事务管理)
      • dataSource(数据源)
  • mappers(映射器)

可以在config下定义db.properties文件,如下所示:

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root

在config下创建SqlMapConfig.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="db.properties">
        <!-- 在properties内部用property定义属性 -->
        <!-- 如果外部配置文件有该属性,则内部定义属性被外部属性覆盖 -->
        <property name="jdbc.username" value="root123" />
        <property name="jdbc.password" value="root123" />
    </properties>

    <!-- 别名,在mapper配置文件里可以用别名代替完整类名 -->
    <typeAliases>
    <!--
        给com.itheima.mybatis.pojo.User起别名为User
        <typeAlias type="com.itheima.mybatis.pojo.User" alias="User"/>
    -->

        <!-- 给包里的所有类起别名 别名大小写不敏感-->
        <package name="com.itheima.mybatis.pojo"/>
    </typeAliases>

    <!-- 和spring整合后 environments配置将废除    -->
    <environments default="development">
        <environment id="development">
            <!-- 使用jdbc事务管理 -->
            <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>
    </environments>

    <!-- 加载映射文件 -->
    <mappers>

        <!-- 方式1:使用相对于类路径的资源(不推荐) -->
        <mapper resource="sqlmap/User.xml" />

        <!-- 方式2:使用mapper接口类路径 -->
        <!-- 注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。 -->
        <mapper class="cn.itcast.mybatis.mapper.UserMapper"/>

        <!-- 方式3:注册指定包下的所有mapper接口 -->
        <!-- 注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。 -->
        <package name="cn.itcast.mybatis.mapper"/>
    </mappers>
</configuration>

注意: MyBatis 将按照下面的顺序来加载属性:
* 在 properties 元素体内定义的属性首先被读取。
* 然后会读取properties 元素中resource或 url 加载的属性,它会覆盖已读取的同名属性。

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">
<!-- namespace:命名空间,一般为Mapper接口类的完整类名-->
<mapper namespace="com.itheima.mybatis.mapper.UserMapper">
    <!-- id:statement的id 或者叫做sql的id-->
    <!-- parameterType:声明输入参数的类型 -->
    <!-- resultType:声明输出结果的类型,应该填写pojo的全路径或别名 -->
    <!-- #{}:输入参数的占位符,相当于jdbc的? -->
    <!-- ${}:拼接sql字符串 -->
    <!-- 通过ID查询一个用户 -->
    <!-- 通过ID查询一个用户 -->
    <select id="findUserById" parameterType="Integer" resultType="User">
        select * from user where id = #{id}
    </select>
    <select id="findUserByUsername" parameterType="String" resultType="User">
        select * from user where username like "%"#{username}"%"
    </select>


    <select id="findAllUser" resultType="User">
        select * from user
    </select>


    <!-- 添加用户 -->
    <insert id="insertUser" parameterType="User" keyProperty="id" useGeneratedKeys="true">
        insert into user (username,birthday,address,sex) 
        values (#{username},#{birthday},#{address},#{sex})
    </insert>

    <!-- 更新 -->
    <update id="updateUserById" parameterType="User">
        update user 
        set username = #{username},sex = #{sex},birthday = #{birthday},address = #{address}
        where id = #{id}
    </update>

    <!-- 删除 -->
    <delete id="deleteUserById" parameterType="Integer">
        delete from user 
        where id = #{id}
    </delete>

</mapper>

代码实例

假定有一个用户表user,通过Mybatis对该表进行简单操作。

表 user.sql

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) DEFAULT NULL,
  `sex` varchar(255) DEFAULT NULL,
  `birthday` timestamp NULL DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8mb4;

实体类 User.java

package com.itheima.mybatis.pojo;

import java.io.Serializable;
import java.util.Date;

public class User implements Serializable {

    private static final long serialVersionUID = 1L;
    private Integer id;
    private String username;// 用户姓名
    private String sex;// 性别
    private Date birthday;// 生日
    private String address;// 地址

    /* 实体类必须提供一个无参构造方法 */
    public User() {
        super();
    }
    public Integer getId() {
        return id;
    }
    public User(String username, String sex, Date birthday, String address) {
        super();
        this.username = username;
        this.sex = sex;
        this.birthday = birthday;
        this.address = address;
    }
    public User(Integer id, String username, String sex, Date birthday, String address) {
        super();
        this.id = id;
        this.username = username;
        this.sex = sex;
        this.birthday = birthday;
        this.address = address;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + ", birthday=" + birthday + ", address=" + address + "]";
    }
}

Mapper接口类 UserMapper.java

遵循四个原则
1. 接口类方法名 与 映射文件Mapper.xml中的 id 名一致
2. 接口类方法返回值类型 与 Mapper.xml文件中返回值类型一致
3. 接口类方法的入参类型 与 Mapper.xml中入参的类型一致
4. 命名空间要绑定此接口

package com.itheima.mybatis.mapper;

import java.util.List;

import org.apache.ibatis.annotations.Delete;

import com.itheima.mybatis.pojo.User;

public interface UserMapper {
    public User findUserById(Integer id);
    public User findUserByUsername(String username);
    public List<User> findAllUser();
    public Integer insertUser(User user);
    public Integer updateUserById(User user);

    /* 对于简单的SQL语句,也可以通过@注释来执行SQL */
    @Delete("delete from user where id = #{id}")
    public Integer deleteUserById(Integer id);
}

Mapper映射文件

代码在上面SQL映射文件。

封装Utils工具类

由于加载配置文件和创建SqlSessionFactory需消耗大量资源。所以在一个项目中应只存在一个。因此,需要建立一个Mybatis工具类。使得SqlSessionFactory只创建一次。

package com.itheima.mybatis.tool;

import java.io.IOException;
import java.io.InputStream;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class MybatisUtils {
    private static SqlSessionFactory sf;
    static{
        //加载核心配置文件
        String resource = "sqlMapConfig.xml";
        InputStream in = null;
        try {
            in = Resources.getResourceAsStream(resource);
            sf = new SqlSessionFactoryBuilder().build(in);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        //创建SqlSessionFactory
    }
     //获得session => 获得全新session
    public static SqlSession openSession(){
                //3 获得session
                SqlSession session = sf.openSession();

                return session;
    }
}

测试类

package com.itheima.mybatis.junit;

import java.util.Date;
import java.util.List;

import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import com.itheima.mybatis.mapper.UserMapper;
import com.itheima.mybatis.pojo.User;
import com.itheima.mybatis.tool.MybatisUtils;

public class MybatisMapperTest {


    @Test
    public void findUserById() throws Exception {
        SqlSession sqlSession = MybatisUtils.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.findUserById(1);
        System.out.println(user);
    }
    @Test
    public void findAllUser() throws Exception {
        SqlSession sqlSession = MybatisUtils.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.findAllUser();
        for (User user : userList) {
            System.out.println(user);
        }
    }
    @Test
    public void insertUser() throws Exception {
        SqlSession sqlSession = MybatisUtils.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = new User("李四","男",new Date(),"菏泽市");
        Integer result = userMapper.insertUser(user);
        sqlSession.commit();
        System.out.println(String.format("Result:%d,Id:%d", result,user.getId()));
    }
    @Test
    public void updateUserById() throws Exception {
        SqlSession sqlSession = MybatisUtils.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = new User(5,"赵六","女",new Date(),"菏泽市");
        Integer result = userMapper.updateUserById(user);
        sqlSession.commit();
        System.out.println(result);
    }
    @Test
    public void deleteUserById() throws Exception {
        SqlSession sqlSession = MybatisUtils.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Integer result = userMapper.deleteUserById(6);
        sqlSession.commit();
        System.out.println(result);
    }
}

学习笔记,可能存在错误,烦请指正。
创作不易,如需转载,请保留原文链接。
博主有全套学习资料,包括视频、笔记、代码等,如果需要可以免费分享。


我一直在开辟我的天空