Mybatis(一)

1.1.1 什么是框架

框架（ Framework ）是整个或部分系统的可重用设计，表现为一组抽象构件及构件实例间交互的

方法 ; 另一种定义认为，框架是可被应用开发者定制的应用骨架。前者是从应用方面而后者是从目的

方面给出的定义。

简而言之，框架其实就是某种应用的半成品，就是一组组件，供你选用完成你自己的系统。简

单说就是使用别人搭好的舞台，你来做表演。而且，框架一般是成熟的，不断升级的软件。

1.1.2 框架要解决的问题

框架要解决的最重要的一个问题是技术整合的问题，在 J2EE 的 框架中，有着各种各样的技术，

不同的软件企业需要从 J2EE 中选择不同的技术，这就使得软件企业最终的应用依赖于这些技术，技

术自身的复杂性和技术的风险性将会直接对应用造成冲击。而应用是软件企业的核心，是竞争力的

关键所在，因此应该将应用自身的设计和具体的实现技术解耦。这样，软件企业的研发将集中在应

用的设计上，而不是具体的技术实现，技术实现是应用的底层支撑，它不应该直接对应用产生影响。

框架一般处在低层应用平台（如 J2EE ）和高层业务逻辑之间的中间层。

1.1.3 软件开发的分层重要性

框架的重要性在于它实现了部分功能，并且能够很好的将低层应用平台和高层业务逻辑进行了缓和。

为了实现软件工程中的“高内聚、低耦合”。把问题划分开来各个解决，易于控制，易于延展，易于

分配资源。我们常见的 MVC 软件设计思想就是很好的分层思想。

通过分层更好的实现了各个部分的职责，在每一层将再细化出不同的框架，分别解决各层关注的问

题。

1.1.4 分层开发下的常见框架

常见的 JavaEE 开发框架：

1 、解决数据的持久化问题的框架

 

 作为持久层的框架，还有一个封装程度更高的框架就是 Hibernate，但这个框架因为各种原因目

前在国内的流行程度下降太多，现在公司开发也越来越少使用。目前使用 Spring Data 来实现数据持

久化也是一种趋势。

2 、解决 WEB 层问题的 MVC 框架

3、解决技术整合问题的框架

1.1.5 MyBatis 框架概述 

mybatis 是一个优秀的基于 java 的持久层框架，它内部封装了 jdbc ，使开发者只需要关注 sql 语句本身，而

不需要花费精力去处理加载驱动、创建连接、创建 statement 等繁杂的过程。

mybatis 通过 xml 或注解的方式将要执行的各种 statement 配置起来，并通过 java 对象和 statement 中 sql

的动态参数进行映射生成最终执行的 sql 语句，最后由 mybatis 框架执行 sql 并将结果映射为 java 对象并返回。

采用 ORM 思想解决了实体和数据库映射的问题，对 jdbc 进行了封装，屏蔽了 jdbc api 底层访问细节，使我

们不用与 jdbc api 打交道，就可以完成对数据库的持久化操作。

为了我们能够更好掌握框架运行的内部过程，并且有更好的体验，下面我们将从自定义 Mybatis 框架开始来学

习框架。此时我们将会体验框架从无到有的过程体验，也能够很好的综合前面阶段所学的基础。

1.2 JDBC 编程的分析

1.2.1 jdbc 程序的回顾

public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
//加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
//通过驱动管理类获取数据库链接
connection = DriverManager
.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8","ro
ot", "root");
//定义 sql 语句 ?表示占位符
String sql = "select * from user where username = ?";
//获取预处理 statement
preparedStatement = connection.prepareStatement(sql);
//设置参数，第一个参数为 sql 语句中参数的序号（从 1 开始），第二个参数为设置的
参数值
preparedStatement.setString(1, "王五");
//向数据库发出 sql 执行查询，查询出结果集
resultSet = preparedStatement.executeQuery();
//遍历查询结果集
while(resultSet.next()){
 System.out.println(resultSet.getString("id")+"
 "+resultSet.getString("username"));
}
} catch (Exception e) {
e.printStackTrace();
}finally{
//释放资源
if(resultSet!=null){
try {
resultSet.close();
} catch (SQLException e) {
e.printStackTrace();
} }
if(preparedStatement!=null){
try {
preparedStatement.close();
} catch (SQLException e) {
e.printStackTrace();
} }
if(connection!=null){
try {
connection.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} }} }

1.2.2 jdbc 问题分析

1 、 数据库链接创建、释放频繁造成系统资源浪费从而影响系统性能，如果使用数据库链接池可解

决此问题。

2 、 Sql 语句在代码中硬编码，造成代码不易维护，实际应用 sql 变化的可能较大， sql 变动需要改变 java 代码。

3 、 使用 preparedStatement 向占有位符号传参数存在硬编码，因为 sql 语句的 where 条件不一定，

可能多也可能少，修改 sql 还要修改代码，系统不易维护。

4 、 对结果集解析存在硬编码（查询列名）， sql 变化导致解析代码变化，系统不易维护，如果能将数

据库记录封装成 pojo 对象解析比较方便。

1.2.3 Jdbc 问题解决方案

通过上面的分析我们已找到了相对应的解决方案，下面我们将通过自己定义一个框架的方式来解决

jdbc 编程中所存在的问题。

第2章 自定义 Mybatis 框架

2.1 自定义 Mybatis 框架的前期准备

本章我们将使用前面所学的基础知识来构建一个属于自己的持久层框架，将会涉及到的一些知识点：

工厂模式（ Factory 工厂模式）、构造者模式（ Builder 模式）、代理模式，反射，自定义注解，注解的

反射， xml 解析，数据库元数据，元数据的反射等。

2.1.1 创建 Maven 工程并引入相关坐标

2.1.1.1 开发环境的准备及统一

1. 检查 JDK 环境

2. 检查 Tomcat 环境

3. 检查 maven 环境

2.1.1.2 创建 Maven 工程

1. 第一步 , 新建一个 maven project ，并且使用传统的 java 方式。

第二步：引入相关的 maven 坐标

<dependencies>
    <!-- 日志坐标 --> 
    <dependency> 
        <groupId>log4j</groupId> 
        <artifactId>log4j</artifactId> 
        <version>1.2.12</version>
    </dependency>
    <!-- 解析 xml 的 dom4j --> 
    <dependency> 
        <groupId>dom4j</groupId> 
        <artifactId>dom4j</artifactId> 
        <version>1.6.1</version>
    </dependency>
    <!-- mysql 驱动 --> 
    <dependency> 
        <groupId>mysql</groupId> 
        <artifactId>mysql-connector-java</artifactId> 
        <version>5.1.6</version>
    </dependency>
    <!-- dom4j 的依赖包 jaxen -->
    <dependency> 
        <groupId>jaxen</groupId>
        <artifactId>jaxen</artifactId>
        <version>1.1.6</version>
    </dependency> 
    <dependency> 
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
    </dependency>
</dependencies>

第三步：在工程中将开发所需的工具类引入到项目中

所引入的类说明如下：

XMLConfigBuilder 类，用于实现 XML 文件解析的，解析工具目前采用的是 Dom4j 结合 xpath 实现。

Executor 类，用于实现 SQL 语句的执行，主要是调用 JDBC 来实现 SQL 语句的执行。

2.1.2 创建 SqlMapConfig.xml 配置文件

为了更好将数据库连接信息抽取出来，我们原来在 C3P0 连接池中也已经将数据库连接信息抽取出

来，我们现在也一样将数据库的连接信息抽取出来，放到一个 xml （ SqlMapConfig.xml ）文件中，后

面再去对此配置文件进行 xml 解析，这样就可以将配置文件中的信息读取出来，以便在 jdbc 代码中

直接使用这些数据库连接信息。

SqlMapConfig.xml 配置文件如下：

<?xml version="1.0" encoding="UTF-8" ?> 
<configuration> 
 <environments default="development"> 
 <environment id="development"> 
 <transactionManager type="JDBC" /> 
 <dataSource type="POOLED"> 
 <property name="driver" value="com.mysql.jdbc.Driver" ></property> 
 <property name="url"
value="jdbc:mysql://localhost:3306/mybatisdb?characterEncoding=utf8" ></property> 
 <property name="username" value="root"></property>
 <property name="password" value="root"></property>
 </dataSource> 
 </environment> 
 </environments>
</configuration>

2.1.3 加入用于保存 SQL 语句的类

通过前面 jdbc 存在问题的分析，我们已经知道了要将 SQL 语句放入配置文件中，这样将来修改 SQL

语句会比较方便，但放在配置文件中的 SQL 语句还需要读取出来，这样我们就可以定义一个 Mapper

类，用于将配置文件中的 SQL 语句保存起来，具体如下：

public class Mapper {
    private String querySql;//sql 语句

    private String resultType;//全限定类名

    public String getQuerySql() {
        return querySql; 
    }
    public void setQuerySql(String querySql) {
        this.querySql = querySql;
     }
    public String getResultType() {
        return resultType; 
    }
    public void setResultType(String resultType) {
        this.resultType = resultType; 
    }
}

2.1.4 加入 Configuration 配置类

Configuration 配置类主要用于保存 SqlMapConfig.xml 文件中读取的 xml 结点的信息，以及映射的 SQL

语句的集合。该类的代码如下：

/**
* 核心配置类
* 1.数据库信息
* 2.sql 的 map 集合
*/
public class Configuration {
    private String username; //用户名
    private String password;//密码
    private String url;//地址
    private String driver;//驱动
    //map 集合 Map<唯一标识，Mapper> 用于保存映射文件中的 sql 标识及 sql 语句
    private Map<String,Mapper> mappers;
    public String getUsername() {
        return username;
     }
    public void setUsername(String username) {
        this.username = username; 
    }
    public String getPassword() {
        return password; 
    }
    public void setPassword(String password) {
        this.password = password; 
    }
    public String getUrl() {
        return url; 
    }
    public void setUrl(String url) {
        this.url = url;
     }
    public String getDriver() {
        return driver; 
    }
    public void setDriver(String driver) {
        this.driver = driver;
     }
    public Map<String, Mapper> getMappers() {
        return mappers; 
    }
    public void setMappers(Map<String, Mapper> mappers) {
        this.mappers = mappers; 
    } 
}

 2.1.5 创建数据表及 User 实体类

User 表：

User 实体类：

public class User implements Serializable {
    private int id;
    private String username;// 用户姓名
    private String sex;// 性别
    private Date birthday;// 生日
    private String address;// 地址
     //省略 getter 与 setter
    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
        + ", birthday=" + birthday + ", address=" + address + "]";

    } 
}

 2.1.6 创建自定义@Select 注解

2.1.7 使用@Select 注解开发 UserDao 接口 

创建 UserDao 代理接口

public interface UserDao {
    @Select(value="select * from user")
    public List<User> getAllUserByMybatis() throws Exception;
    //ognl 表达式
    /**
    * sql 
    * --- #{username}
    * username
    * getUsername
    * --- #{sex}
    * 
    * insert into user (username,sex) values (user.get,#{sex})
    * @param user
    * @throws Exception
    */
    // @Insert(value="insert into user (username,sex) values (#{username},#{sex})")
    // public void insert(User user) throws Exception;
}

2.2 基于注解方式定义 Mybatis 框架

2.2.1 使用工厂模式开发

工厂模式的回顾

工厂模式的原理如下图：

 2.2.1.1 第一步：自定义 SqlSession 接口

public interface SqlSession {
public <E> List<E> selectList(String mapperId) throws Exception;
/**
* 创建动态代理对象
* clazz ： 接口的字节码
*/
public <E> E getMapper(Class clazz) throws Exception;
}

这就相当于按工厂模式的图中，创建了一个用于生产产品的接口。其中 getMapper() 方法可以用于模

拟按 mybatis 的代理方式来生成，而 selectList() 方法可以模拟按 mybatis 的传统方式来生成。我们先

只来关注传统方式来实现。

2.2.1.2 第二步：定义 DefaultSqlSession 实现类

DefaultSqlSession 类主要用于生成 mapper 代理对象，以及执行 SQL 语句的方法。

编写 DefaultSqlSession.java 实现类：