Mybatis入门

1. Mybatis的介绍

  • 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官方文档

2. 使用JDBC编码的分析

2.1 准备

  • 根据用户id查询用户信息
  • 创建MySQL数据库
    mybatis.sql
SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for `orders`
-- ----------------------------
DROP TABLE IF EXISTS `orders`;
CREATE TABLE `orders` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_id` int(11) NOT NULL COMMENT '下单用户id',
  `number` varchar(32) NOT NULL COMMENT '订单号',
  `createtime` datetime NOT NULL COMMENT '创建订单时间',
  `note` varchar(100) DEFAULT NULL COMMENT '备注',
  PRIMARY KEY (`id`),
  KEY `FK_orders_1` (`user_id`),
  CONSTRAINT `FK_orders_id` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE NO ACTION ON UPDATE NO ACTION
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of orders
-- ----------------------------
INSERT INTO `orders` VALUES ('3', '1', '1000010', '2015-02-04 13:22:35', null);
INSERT INTO `orders` VALUES ('4', '1', '1000011', '2015-02-03 13:22:41', null);
INSERT INTO `orders` VALUES ('5', '10', '1000012', '2015-02-12 16:13:23', null);

-- ----------------------------
-- Table structure for `user`
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(32) NOT NULL COMMENT '用户名称',
  `birthday` date DEFAULT NULL COMMENT '生日',
  `sex` char(1) DEFAULT NULL COMMENT '性别',
  `address` varchar(256) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=27 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', '王五', null, '2', null);
INSERT INTO `user` VALUES ('10', '张三', '2014-07-10', '1', '北京市');
INSERT INTO `user` VALUES ('16', '张小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('22', '陈小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('24', '张三丰', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('25', '陈小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('26', '王五', null, null, null);

  • 创建工程,导入MySQL驱动的jar包

2.2 JDBC编码的步骤

  1. 加载数据库驱动
  2. 创建并获取数据库链接
  3. 创建jdbc statement对象
  4. 设置sql语句
  5. 设置sql语句中的参数(使用preparedStatement)
  6. 通过statement执行sql并获取结果
  7. 对sql执行结果进行解析处理
  8. 释放资源(resultSet、preparedstatement、connection)

2.3 程序代码

package com.itzhouq.jdbc;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class JDBCTest {

    public static void main(String[] args) {
        //需求:根据id查询用户 select * from user where id = 10
        
        Connection connection = null;
        PreparedStatement stmt = null;
        ResultSet rs = null;
        
        try {
            //1. 加载驱动
            Class.forName("com.mysql.jdbc.Driver");
            //2. 获取连接
            connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis", "root", "2626");
            //3. 获取预处理
            stmt = connection.prepareStatement("select * from user where id = ?");
            //4. 设置参数
            stmt.setInt(1, 10);
            //5. 执行,得到结果集
            rs = stmt.executeQuery();
            //6. 从结果集中获取结果
            while(rs.next()) {
                System.out.println(rs.getInt(1)+"---"+rs.getString(2));//10---张三
            }
            
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            try {
                rs.close();
                stmt.close();
                connection.close();
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
}

  • 上边使用jdbc的原始方法(未经封装)实现了查询数据库表记录的操作。

2.4 JDBC问题

  • 涉及到重复创建链接和释放链接,造成资源浪费,解决方式:使用连接池
  • 出现硬编码,体现在,数据库驱动,url、用户名密码、sql,解决方式:使用配置文件
  • 结果获取不方便,解决方式:把结果放到一个POJO中

3. Mybatis架构

Mybatis架构
  • mybatis配置 SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息。mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。

  • 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂。

  • 由会话工厂创建sqlSession即会话,操作数据库需要通过sqlSession进行。

  • mybatis底层自定义了Executor执行器接口操作数据库,Executor接口有两个实现,一个是基本执行器、一个是缓存执行器。

  • Mapped Statement也是mybatis一个底层封装对象,它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象,sql的id即是Mapped statement的id。

  • Mapped Statement对sql执行输入参数进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中,输入参数映射就是jdbc编程中对preparedStatement设置参数。

  • Mapped Statement对sql执行输出结果进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中,输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

  • 输入映射(传入的参数)
    支持的数据类型:
    基本数据类型:基础类型以及包装类、String
    POJO
    Map
    包装的POJO:一个pojo中有pojo属性

  • 输出映射(产生的结果类型)
    基本数据类型:基础类型以及包装类、String
    POJO
    Map
    List

4. Mybatis入门程序

4.1 mybatis下载

mybaits的代码由github.com管理,地址:https://github.com/mybatis/mybatis-3/releases

mybatis-3.2.7.jar ---- mybatis的核心包
lib ---- mybatis的依赖包
mybatis-3.2.7.pdf ---- mybatis使用手册

4.2 需求

  • 实现以下功能:
    根据用户id查询一个用户信息
    根据用户名称模糊查询用户信息列表
    添加用户
    更新用户
    删除用户

4.3 工程搭建

  • 环境:eclipse+JDK1.8
  • 导入mybatis核心包、依赖包、数据驱动包

4.4 配置日志文件

/mybatis-day01/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

mybatis默认使用log4j作为输出日志信息。

4.5 mybaits核心配置文件

/mybatis-day01/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>
    <!-- 和spring整合后 environments配置将废除-->
    <environments default="development">
        <environment id="development">
        <!-- 使用jdbc事务管理-->
            <transactionManager type="JDBC" />
        <!-- 数据库连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
                <property name="username" value="root" />
                <property name="password" value="2626" />
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper resource="user.xml"/>
    </mappers>
</configuration>

SqlMapConfig.xml是mybatis核心配置文件,上边文件的配置内容为数据源、事务管理。

4.6 pojo类

Pojo类作为mybatis进行sql映射使用,po类通常与数据库表对应,User.java如下:

package com.itzhouq.mybatis.pojo;

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

public class User implements Serializable {
    private int id;
    private String username;// 用户姓名
    private String sex;// 性别
    private Date birthday;// 生日
    private String address;// 地址
    public int getId() {
        return id;
    }
    public void setId(int 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 + "]";
    }
    
}

4.7 sql映射文件

/mybatis-day01/config/user.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">

<mapper namespace="test">
    <!-- statementId -->
    <select id="findUserById" parameterType="int" resultType="com.itzhouq.mybatis.pojo.User" >
        select * from user where id = #{id}
    </select>
    
    <select id="findUserByUsername" parameterType="String" resultType="com.itzhouq.mybatis.pojo.User">
        select * from user where username like '%${value}%'
    </select>
    
    <insert id="insertUser" parameterType="com.itzhouq.mybatis.pojo.User">
        <selectKey resultType="int" keyProperty="id" order="AFTER">
            <!-- 返回当前事务最后产生的id值 -->
            SELECT LAST_INSERT_ID();
        </selectKey>
        insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address});
    </insert>
</mapper>
  • namespace :命名空间,用于隔离sql语句.
  • mybatis框架需要加载映射文件,将Users.xml添加在SqlMapConfig.xml.

5. 根据id查询用户信息

5.1 映射文件

在user.xml中添加:

<select id="findUserById" parameterType="int" resultType="com.itzhouq.mybatis.pojo.User" >
        select * from user where id = #{id}
    </select>
  • parameterType:定义输入到sql中的映射类型,#{id}表示使用preparedstatement设置占位符号并将输入变量id传到sql。resultType:定义结果映射类型。

5.2 测试程序

com.itzhouq.mybatis.test.UserTest

package com.itzhouq.mybatis.test;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

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 org.junit.Test;

import com.itzhouq.mybatis.pojo.User;

public class UserTest {
    
    @Test
    public void testFindUserId() throws IOException {
        //1. 获取sqlSessionFactory对象
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        InputStream inputStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
        //2. 获取sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3. 使用sqlSession的方法
        //p1:statementId   p2:指定的输入映射参数
        User user = sqlSession.selectOne("findUserById", 10);
        System.out.println(user);
        //4. 关闭sqlSession
        sqlSession.close();
    }
}

6. 根据用户用户名查询用户信息

6.1 映射文件

在user.xml中添加:

<select id="findUserByUsername" parameterType="String" resultType="com.itzhouq.mybatis.pojo.User">
        select * from user where username like '%${value}%'
    </select>
  • parameterType:定义输入到sql中的映射类型,{value}表示使用参数将{value}替换,做字符串的拼接。
  • 注意:如果是取简单数量类型的参数,括号中的值必须为value
    resultType:定义结果映射类型。

6.2 测试程序

package com.itzhouq.mybatis.test;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

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 org.junit.Test;

import com.itzhouq.mybatis.pojo.User;

public class UserTest {
    @Test
    public void testFindUserByUsername() throws IOException {
        //1. 获取sqlSessionFactory对象
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        InputStream inputStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
        //2. 获取sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3. 使用sqlSession的方法
        //p1:statementId   p2:指定的输入映射参数
        List<User> list = sqlSession.selectList("findUserByUsername", "张");
        System.out.println(list);
        //4. 关闭sqlSession
        sqlSession.close();
    }
}

7. 总结

7.1 比较#{}和${}

  • #{}表示一个占位符号,通过#{}可以实现preparedStatement向占位符中设置值,自动进行java类型和jdbc类型转换,#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。 如果parameterType传输单个简单类型值,#{}括号中可以是value或其它名称。如果传入的是字符串,预编译时会自动带上单引号。

  • ${}表示拼接sql串,通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换, ${}可以接收简单类型值或pojo属性值,如果parameterType传输单个简单类型值,${}括号中只能是value。如果传入的是基础数据类型 大括号中只能写value 即${value},如果传入的是pojo或者map类型,大括号中只能写属性名或key名${username}

7.2 parameterType和resultType

  • parameterType:指定输入参数类型,mybatis通过ognl从输入对象中获取参数值拼接在sql中。
  • resultType:指定输出结果类型,mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。

7.3 selectOne和selectList

  • selectOne查询一条记录,如果使用selectOne查询多条记录则抛出异常:
    org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 3 at org.apache.ibatis.session.defaults.DefaultSqlSession.selectOne(DefaultSqlSession.java:70)

selectList可以查询一条或多条记录。

8. 添加用户

8.1 映射文件

在SqlMapConfig.xml中添加:

<insert id="insertUser" parameterType="com.itzhouq.mybatis.pojo.User">
        <selectKey resultType="int" keyProperty="id" order="AFTER">
            <!-- 返回当前事务最后产生的id值 -->
            SELECT LAST_INSERT_ID();
        </selectKey>
        insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address});
    </insert>

8.2 测试程序

package com.itzhouq.mybatis.test;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

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 org.junit.Test;

import com.itzhouq.mybatis.pojo.User;

public class UserTest {
    @Test
    public void testInsertUser() throws IOException {
        //1. 获取sqlSessionFactory对象
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        InputStream inputStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
        //2. 获取sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        User user = new User();
        user.setAddress("花果山");
        user.setBirthday(new Date());
        user.setSex("0");
        user.setUsername("美猴王");
        sqlSession.insert("insertUser", user);
        sqlSession.commit();
        System.out.println(user);
        sqlSession.close();
    }
}
  • 添加selectKey实现将主键返回
  • keyProperty:返回的主键存储在pojo中的哪个属性
  • order:selectKey的执行顺序,是相对与insert语句来说,由于mysql的自增原理执行完insert语句之后才将主键生成,所以这里selectKey的执行顺序为after
  • resultType:返回的主键是什么类型
  • LAST_INSERT_ID():是mysql的函数,返回auto_increment自增列新记录id值。

9. Mybatis解决jdbc编程的问题

  • 数据库链接创建、释放频繁造成系统资源浪费从而影响系统性能,如果使用数据库链接池可解决此问题。
    解决:在SqlMapConfig.xml中配置数据链接池,使用连接池管理数据库链接。
  • Sql语句写在代码中造成代码不易维护,实际应用sql变化的可能较大,sql变动需要改变java代码。
    解决:将Sql语句配置在XXXXmapper.xml文件中与java代码分离。
  • 向sql语句传参数麻烦,因为sql语句的where条件不一定,可能多也可能少,占位符需要和参数一一对应。
    解决:Mybatis自动将java对象映射至sql语句,通过statement中的parameterType定义输入参数的类型。
  • 对结果集解析麻烦,sql变化导致解析代码变化,且解析前需要遍历,如果能将数据库记录封装成pojo对象解析比较方便。
    解决:Mybatis自动将sql执行结果映射至java对象,通过statement中的resultType定义输出结果的类型。

10. mybatis与hibernate不同

  • Mybatis和hibernate不同,它不完全是一个ORM框架,因为MyBatis需要程序员自己编写Sql语句,不过mybatis可以通过XML或注解方式灵活配置要运行的sql语句,并将java对象和sql语句映射生成最终执行的sql,最后将sql执行的结果再映射生成java对象。

  • Mybatis学习门槛低,简单易学,程序员直接编写原生态sql,可严格控制sql执行性能,灵活度高,非常适合对关系数据模型要求不高的软件开发,例如互联网软件、企业运营类软件等,因为这类软件需求变化频繁,一但需求变化要求成果输出迅速。但是灵活的前提是mybatis无法做到数据库无关性,如果需要实现支持多种数据库的软件则需要自定义多套sql映射文件,工作量大。

  • Hibernate对象/关系映射能力强,数据库无关性好,对于关系模型要求高的软件(例如需求固定的定制化软件)如果用hibernate开发可以节省很多代码,提高效率。但是Hibernate的学习门槛高,要精通门槛更高,而且怎么设计O/R映射,在性能和对象模型之间如何权衡,以及怎样用好Hibernate需要具有很强的经验和能力才行。
    总之,按照用户的需求在有限的资源环境下只要能做出维护性、扩展性良好的软件架构都是好架构,所以框架只有适合才是最好。

11. mybatis DAO层的开发方式

  • 方式一:传统开发方式(因为还是有硬编码问题,不推荐)
    接口+实现类+映射文件(了解)
    namespace:作用 :sql的隔离
  • 方式二:mapper代理形式(官方推荐)
    接口+映射文件

11.1 传统的dao开发方式

  • 传统的Dao开发方法需要程序员编写Dao接口和Dao实现类。

11.1.1 映射文件

  • /mybatis-day01/config/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">

<mapper namespace="test1">
    <!-- statementId -->
    <select id="findUserById" parameterType="int" resultType="com.itzhouq.mybatis.pojo.User" >
        select * from user where id = #{id}
    </select>
    
    <insert id="insertUser" parameterType="com.itzhouq.mybatis.pojo.User">
        <selectKey resultType="int" keyProperty="id" order="AFTER">
            <!-- 返回当前事务最后产生的id值 -->
            SELECT LAST_INSERT_ID();
        </selectKey>
        insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address});
    </insert>
</mapper>

11.1.2 dao接口

package com.itzhouq.mybatis.dao;

import com.itzhouq.mybatis.pojo.User;

public interface UserDao {
    public User findById(int id);
    
    public void insertUser(User user);
}   

package com.itzhouq.mybatis.dao.impl;


import java.util.Date;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import com.itzhouq.mybatis.dao.UserDao;
import com.itzhouq.mybatis.pojo.User;

public class UserDaoImpl implements UserDao {
    SqlSessionFactory sqlSessionFactory = null;
    
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }
    @Override
    public User findById(int id) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        User user = sqlSession.selectOne("test1.findUserById", id);
        sqlSession.close();
        return user;
    }

    @Override
    public void insertUser(User user) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.insert("test1.insertUser", user);
        sqlSession.commit();
        sqlSession.close();
        
    }

}

11.1.3 dao测试

package com.itzhouq.mybatis.test;

import java.io.IOException;
import java.util.Date;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import com.itzhouq.mybatis.dao.UserDao;
import com.itzhouq.mybatis.dao.impl.UserDaoImpl;
import com.itzhouq.mybatis.pojo.User;

public class UserDaoTest {
    SqlSessionFactory sqlSessionFactory = null;
    @Before
    public void init() throws IOException {
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        sqlSessionFactory = builder.build(Resources.getResourceAsStream("sqlMapConfig.xml"));
    }
    
    @Test
    public void testFindById() {
        UserDao userDao = new UserDaoImpl(sqlSessionFactory);
        User user = userDao.findById(29);
        System.out.println(user);
        //User [id=29, username=美猴王, sex=0, birthday=Mon Apr 08 00:00:00 CST 2019, address=花果山]
    }

    @Test
    public void testInsertUser() {
        UserDao userDao = new UserDaoImpl(sqlSessionFactory);
        User user2 = new User();
        user2.setUsername("刘备");
        user2.setSex("1");
        user2.setAddress("蜀");
        user2.setBirthday(new Date());
        userDao.insertUser(user2);
    }
}

11.1.4 传统dao开发的问题

  • Dao方法体存在重复代码:通过SqlSessionFactory创建SqlSession,调用SqlSession的数据库操作方法
  • 调用sqlSession的数据库操作方法需要指定statement的id,这里存在硬编码,不得于开发维护。

11.2 Mapper动态代理方式

11.2.1 开发规范

  • Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。
    Mapper接口开发需要遵循以下规范:
  1. 接口的全路径要和映射文件的namespace保持一致
  2. 接口的方法名要和映射文件中的statementId保持一致
  3. 接口方法的参数类型、返回数据类型要和映射文件中的parameterType、resultType保持一致
  4. 接口和映射文件的名字最好保持一致 UserMapper.java UserMapper.xml
  5. 接口和映射文件最好放到同一个目录

11.2.2 Mapper.xml(映射文件)

  • 定义mapper映射文件UserMapper.xml(内容同Users.xml),需要修改namespace的值为 UserMapper接口路径。
<?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.itzhouq.mybatis.mapper.UserMapper">
    <!-- statementId -->
    <select id="findById" parameterType="int" resultType="com.itzhouq.mybatis.pojo.User" >
        select * from user where id = #{id}
    </select>
    
    <insert id="insertUser" parameterType="com.itzhouq.mybatis.pojo.User">
        <selectKey resultType="int" keyProperty="id" order="AFTER">
            <!-- 返回当前事务最后产生的id值 -->
            SELECT LAST_INSERT_ID();
        </selectKey>
        insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address});
    </insert>
</mapper>

11.2.3 接口文件

package com.itzhouq.mybatis.mapper;

import com.itzhouq.mybatis.pojo.User;

public interface UserMapper {
    public User findById(int id);
    
    public void insertUser(User user);
}

11.2.4 加载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">
    
    <mapper namespace="com.itzhouq.mybatis.mapper.UserMapper">
        <!-- statementId -->
        <select id="findById" parameterType="int" resultType="com.itzhouq.mybatis.pojo.User" >
            select * from user where id = #{id}
        </select>
        
        <insert id="insertUser" parameterType="com.itzhouq.mybatis.pojo.User">
            <selectKey resultType="int" keyProperty="id" order="AFTER">
                <!-- 返回当前事务最后产生的id值 -->
                SELECT LAST_INSERT_ID();
            </selectKey>
            insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address});
        </insert>
    </mapper>

11.2.5 测试

package com.itzhouq.mybatis.test;

import java.io.IOException;

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 org.junit.Before;
import org.junit.Test;

import com.itzhouq.mybatis.mapper.UserMapper;
import com.itzhouq.mybatis.pojo.User;

public class UserMapperTest {
    SqlSessionFactory sqlSessionFactory = null;
    @Before
    public void init() throws IOException {
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        sqlSessionFactory = builder.build(Resources.getResourceAsStream("sqlMapConfig.xml"));
    }
    
    @Test
    public void testFindById() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.findById(28);
        System.out.println(user);
        sqlSession.close();
    }
}

11.2.6 总结

  • selectOne和selectList
    动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。

  • namespace
    mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。

12. SqlMapConfig.xml配置文件

12. 1配置内容

  • SqlMapConfig.xml中配置的内容和顺序如下:
  • properties(属性)
  • settings(全局配置参数)
  • typeAliases(类型别名)
  • typeHandlers(类型处理器)
  • objectFactory(对象工厂)
  • plugins(插件)
  • environments(环境集合属性对象)
  • environment(环境子属性对象)
  • transactionManager(事务管理)
  • dataSource(数据源)
  • mappers(映射器)

12.2 properties(属性)

SqlMapConfig.xml可以引用java属性文件中的配置信息如下:
在classpath下定义db.properties文件,

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

SqlMapConfig.xml引用如下:

<properties resource="db.properties"/>
    <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>
    </environments>
  • MyBatis 将按照下面的顺序来加载属性:
  • 在 properties 元素体内定义的属性首先被读取。
  • 然后会读取properties 元素中resource或 url 加载的属性,它会覆盖已读取的同名属性。

12. 3 mappers(映射器)

  • Mapper配置的几种方法:
 <mapper resource=" " />

使用相对于类路径的资源,如:

<mapper resource="sqlmap/User.xml" />

<mapper class=" " />
  • 使用mapper接口类路径
<mapper class="cn.itcast.mybatis.mapper.UserMapper"/>

注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。

<package name=""/>

注册指定包下的所有mapper接口如:

<package name="cn.itcast.mybatis.mapper"/>

注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容