Mybatis快速入门(XML,注解方式)

梦里梦外; 2022-05-14 16:26 265阅读 0赞

# 简介 #

## 什么是Mybatis ##

>  *  Mybatis是一个优秀的基于java的持久层框架，它内部封装了JDBC，使开发者只需要关注SQL语句本身，而不需要花费精力去处理加载驱动、创建连接、创建Statement等繁杂的过程
>  *  Mybatis通过XML或注解的方式将要执行的各种Statement配置起来，并通过Java对象和statement中SQL的动态参数进行映射生成最终执行的SQL语句，最后由Mybatis框架执行sql并将结果映射为java对象并返回
>  *  采用ORM思想解决了实体和数据库映射的问题，对JDBC 进行了封装，屏蔽了JDBC API底层访问细节，使我们不用与JDBC API打交道，就可以完成对数据库的持久化操作

## Mybatis的特点 ##

> 1.  简单易学：很小且简单。最简单安装只要两个jar文件+配置几个sql映射文件
> 2.  灵活：Mybatis不会对应用程序或者数据库的现有设计强加任何影响。SQL写在XML里，便于统一管理和优化。通过SQL基本上可以实现我们不使用数据访问框架可以实现的所有功能，或许更多
> 3.  解除SQL与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试
> 4.  提供映射标签，支持对象与数据库的ORM字段关系映射
> 5.  提供对象关系映射标签，支持对象关系组建维护
> 6.  提供XML标签，支持编写动态SQL

## Mybatis的环境搭建 ##

前期准备 数据库表 mybatisdb.sql

DROP TABLE IF EXISTS `user`;
    
    CREATE TABLE `user` (
      `id` int(11) NOT NULL auto_increment,
      `username` varchar(32) NOT NULL COMMENT '用户名称',
      `birthday` datetime default NULL COMMENT '生日',
      `sex` char(1) default NULL COMMENT '性别',
      `address` varchar(256) default NULL COMMENT '地址',
      PRIMARY KEY  (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    insert  into `user`(`id`,`username`,`birthday`,`sex`,`address`) values (41,'老王','2018-02-27 17:47:08','男','北京'),(42,'小二王','2018-03-02 15:09:37','女','北京金燕龙'),(43,'小二王','2018-03-04 11:34:34','女','北京金燕龙'),(45,'传智播客','2018-03-04 12:04:06','男','北京金燕龙'),(46,'老王','2018-03-07 17:37:26','男','北京'),(48,'小马宝莉','2018-03-08 11:44:00','女','北京修正');
    
    
    DROP TABLE IF EXISTS `account`;
    
    CREATE TABLE `account` (
      `ID` int(11) NOT NULL COMMENT '编号',
      `UID` int(11) default NULL COMMENT '用户编号',
      `MONEY` double default NULL COMMENT '金额',
      PRIMARY KEY  (`ID`),
      KEY `FK_Reference_8` (`UID`),
      CONSTRAINT `FK_Reference_8` FOREIGN KEY (`UID`) REFERENCES `user` (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    insert  into `account`(`ID`,`UID`,`MONEY`) values (1,41,1000),(2,45,1000),(3,41,2000);
    
    DROP TABLE IF EXISTS `role`;
    
    CREATE TABLE `role` (
      `ID` int(11) NOT NULL COMMENT '编号',
      `ROLE_NAME` varchar(30) default NULL COMMENT '角色名称',
      `ROLE_DESC` varchar(60) default NULL COMMENT '角色描述',
      PRIMARY KEY  (`ID`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    
    insert  into `role`(`ID`,`ROLE_NAME`,`ROLE_DESC`) values (1,'院长','管理整个学院'),(2,'总裁','管理整个公司'),(3,'校长','管理整个学校');
    
    
    DROP TABLE IF EXISTS `user_role`;
    
    CREATE TABLE `user_role` (
      `UID` int(11) NOT NULL COMMENT '用户编号',
      `RID` int(11) NOT NULL COMMENT '角色编号',
      PRIMARY KEY  (`UID`,`RID`),
      KEY `FK_Reference_10` (`RID`),
      CONSTRAINT `FK_Reference_10` FOREIGN KEY (`RID`) REFERENCES `role` (`ID`),
      CONSTRAINT `FK_Reference_9` FOREIGN KEY (`UID`) REFERENCES `user` (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    insert  into `user_role`(`UID`,`RID`) values (41,1),(45,1),(41,2);

使用Maven构建项目

**基于XML的Mybatis的使用**

1.  创建Maven工程 ,工程信息如下

groupId	   com.luokexi	
    artifactId	  Two_Mybatis_Run	
    version	 1.0-SNAPSHOT

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>com.luokexi</groupId>
        <artifactId>Two_Mybatis_Run</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <dependencies>
    
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.4.5</version>
            </dependency>
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.6</version>
            </dependency>
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.12</version>
            </dependency>
        </dependencies>
        
    </project>

1.  在 src/main/resources 目录下 导入 log4j.properties 文件 实现日志功能

# Set root category priority to INFO and its only appender to CONSOLE.
    #log4j.rootCategory=INFO, CONSOLE            debug   info   warn error fatal
    log4j.rootCategory=debug, CONSOLE, LOGFILE
    
    # Set the enterprise logger category to FATAL and its only appender to CONSOLE.
    log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
    
    # CONSOLE is set to be a ConsoleAppender using a PatternLayout.
    log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
    log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
    log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
    
    # LOGFILE is set to be a File appender using a PatternLayout.
    log4j.appender.LOGFILE=org.apache.log4j.FileAppender
    log4j.appender.LOGFILE.File=d:\axis.log
    log4j.appender.LOGFILE.Append=true
    log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
    log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

1.  在 src/main/java 下新建 com.luokexi.domain.User 类 实现Serializable接口 实体类User中的属性与数据库表中的字段保持一致

package com.luokexi.domain;
    
    import java.io.Serializable;
    import java.util.Date;
    
    /**
     * @Author: Luokexi
     * @Date: 2018/10/28 20:46
     * 明确需求,整理思路,步步实现,规范编写,测试功能,总结经验.
     */
    public class User implements Serializable {
    
        /** id       编号
         *  username 姓名
         *  address  住址
         *  sex      性别
         *  birthday 生日
         */
        private Integer id;
        private String username;
        private String address;
        private String sex;
        private Date   birthday;
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public String getAddress() {
            return address;
        }
    
        public void setAddress(String address) {
            this.address = address;
        }
    
        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;
        }
    
        @Override
        public String toString() {
            return "User{" +
                    "id=" + id +
                    ", username='" + username + '\'' +
                    ", address='" + address + '\'' +
                    ", sex='" + sex + '\'' +
                    ", birthday=" + birthday +
                    '}';
        }
    }

1.  在 src/main/resources 目录下 创建核心配置文件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>
        
        <environments default="mysql">
            
            <environment id="mysql">
                
                <transactionManager type="JDBC"></transactionManager>
                
                <dataSource type="POOLED">
                    <property name="driver" value="com.mysql.jdbc.Driver"></property>
                    <property name="url" value="jdbc:mysql://localhost:3306/test"></property>
                    <property name="username" value="MySQL用户名"></property>
                    <property name="password" value="MySQL密码"></property>
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
            <mapper resource="com/luokexi/dao/IUserDao.xml"></mapper>
        </mappers>
    </configuration>

1.  在 src/main/java 目录下创建 com.luokexi.dao.IUserDao 接口

package com.luokexi.dao;
    
    import com.luokexi.domain.User;
    import java.util.List;
    
    /**
     * @Author: Luokexi
     * @Date: 2018/10/28 21:06
     * 明确需求,整理思路,步步实现,规范编写,测试功能,总结经验.
     * 用户持久层接口
     */
    public interface IUserDao {
    
        /**
         * 查询所有用户
         * @return 返回所有用户信息
         */
        List<User> findAll();
    }

1.  在 src/main/resources 目录下 创建与实体类相同路径的映射文件IUserDao.xml (这里的命名规范可以是Mapper结尾),此时创建的是directory ,需要一级一级的创建 ,项目结构如下图所示  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MjQxMDAz_size_27_color_FFFFFF_t_70]

<?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.luokexi.dao.IUserDao">
    
    
        <select id="findAll" resultType="com.luokexi.domain.User">
            SELECT * FROM user;
        </select>
    </mapper>

1.  在 src/test/java 目录下 新建Junit 测试类

package com.luokexi;
    
    import com.luokexi.dao.IUserDao;
    import com.luokexi.domain.User;
    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;
    
    /**
     * @Author: Luokexi
     * @Date: 2018/10/28 21:23
     * 明确需求,整理思路,步步实现,规范编写,测试功能,总结经验.
     */
    public class MybatisTest {
    
    
        /**
         * 测试查询文件
         */
        @Test
        public void testFindAll() throws IOException {
    
    //        读取配置文件
            InputStream inputStream = MybatisTest.class.getClassLoader().getResourceAsStream("SqlMapConfig.xml");
    //        获取SqlSessionFactory对象
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);
    //        使用工厂生产SqlSession对象 
            SqlSession sqlSession = factory.openSession();
    //        使用SqlSession创建Dao接口的代理对象
            IUserDao userDao = sqlSession.getMapper(IUserDao.class);
    //        执行查询所有方法
            List<User> userList = userDao.findAll();
            for (User user : userList) {
                System.out.println(user);
            }
    //       释放资源
            sqlSession.close();
            inputStream.close();
    
        }
    }

基于注解的Mybatis的使用

1.  删除映射配置文件 IUserDao.xml
2.  在 src/main/java/com/luokexi/dao/IUserDao 即持久层接口的方法上面使用注解 @Select

package com.luokexi.dao;
    
    import com.luokexi.domain.User;
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    
    /**
     * @Author: Luokexi
     * @Date: 2018/10/28 22:06
     * 明确需求,整理思路,步步实现,规范编写,测试功能,总结经验.
     * 用户持久层接口
     */
    public interface IUserDao {
    
        /**
         * 查询所有用户
         * @return 返回所有用户信息
         */
        @Select("select * from user")
        List<User> findAll();
    }

1.  修改核心配置文件SqlMapConfig.xml mapper 指定class属性为被注解的dao的全限定类名

<?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="mysql">
            
            <environment id="mysql">
                
                <transactionManager type="JDBC"></transactionManager>
                
                <dataSource type="POOLED">
                    <property name="driver" value="com.mysql.jdbc.Driver"></property>
                    <property name="url" value="jdbc:mysql://localhost:3306/test"></property>
                    <property name="username" value="root"></property>
                    <property name="password" value="root"></property>
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
            
            <mapper class="com.luokexi.dao.IUserDao"></mapper>
        </mappers>
    </configuration>

1.  此时再次运行 Junit测试类 MybatisTest.java  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MjQxMDAz_size_27_color_FFFFFF_t_70 1]

## 小结 ##

> 通过快速入门示例，我们发现使用mybatis是非常容易的一件事情，因为只需要编写Dao接口并且按照Mybatis要求编写两个配置文件，就可以实现功能（我们使用注解之后，将变得更为简单，只需要编写一个Mybatis配置文件就够了。）  
> 但是，这里面包含了许多细节，比如为什么会有工厂对象（SqlSessionFactory）,为什么有了工厂之后还要有构建者对象（SqlSessionFactoryBuilder），为什么IUserDao.xml在创建时有位置和文件名的要求等等。  
> 接下来我们会实现自定义一个Mybatis,应该会更好的了解Mybatis的内部到底怎么执行的.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MjQxMDAz_size_27_color_FFFFFF_t_70]: /images/20220503/b6695941ab7a40398720aecfcfe0bcd3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MjQxMDAz_size_27_color_FFFFFF_t_70 1]: /images/20220503/ff211f3dfd5442f2b08598c13824695b.png