Java框架之MyBatis框架（一）

2019-08-16 11:56:14来源：博客园阅读 ()

Java框架之MyBatis框架（一）

一、框架介绍：

　　MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。

　　Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、CallableStatement---java中调存储过程）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

二、对比下，JDBC存在的问题：

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

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

3、使用preparedStatement向占位符号传参数存在硬编码，因为sql语句的where条件不一定，可能多也可能少，修改sql还要修改代码，系统不易维护。

4、对结果集解析存在硬编码（查询列名），sql变化导致解析代码变化，系统不易维护，如果能将数据库记录封装成pojo对象解析比较方便。

三、架构：

1、 mybatis配置

SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。------一个表对应一个XML！！

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、加入mybatis核心包、依赖包、数据驱动包:

2、创建：

创建资源文件夹（source Folder是个资源文件夹：资源文件夹被引用是不需要加文件名，是默认的根目录的！）config，加入log4j.properties和SqlMapConfig.xml配置文件

log4j.properties：

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

# 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：(已进行最后的配置修改）

<?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是属性-这个地址(source file类型的）是资源文件夹，不需要写src ,-->
    <properties resource="db.properties"></properties>
    
    
    <!-- 配置别名 不区分大小写-->
     <typeAliases>
        <!--<typeAlias alias="user" type="com.oracle.pojo.User"/>-->
        <!-- 将pojo里的所有类配置别名 -->
        <package name="com.oracle.pojo"/>
    </typeAliases> 
    
    
    <!--environments 环境集合属性对象：单独使用此框架的时候使用， 和spring整合后 environments配置将废除 -->
    <environments default="development">
　　            <!-- environment环境子属性对象 -->
        <environment id="development">
            <!-- transactionManager:事务管理-使用jdbc事务管理 -->
            <transactionManager type="JDBC" />
            <!-- dataSource:数据源-数据库连接池 -->
            <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映射器 必须掌握-->
    <mappers>
             <!-- <mapper resource="com/oracle/mapper/UserMapper.xml"/>  原来的写法 
            <mapper class="com.oracle.mapper.UserMapper"/>   使用mapper接口类路径。。。下面是注册指定包下的所有mapper接口 -->
        <package name="com.oracle.mapper"/>
    </mappers>
</configuration>

创建pojo类：

package com.oracle.pojo;

public class Orders {
    private Integer id;
    private Integer userId;
    private String number;
    private String createtime;
    private String note;
    private User user;//一对一的话直接私有个类，一对多就得List<User>
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public Integer getUserId() {
        return userId;
    }
    public void setUserId(Integer userId) {
        this.userId = userId;
    }
    public String getNumber() {
        return number;
    }
    public void setNumber(String number) {
        this.number = number;
    }
    public String getCreatetime() {
        return createtime;
    }
    public void setCreatetime(String createtime) {
        this.createtime = createtime;
    }
    public String getNote() {
        return note;
    }
    public void setNote(String note) {
        this.note = note;
    }
    public User getUser() {
        return user;
    }
    public void setUser(User user) {
        this.user = user;
    }
    @Override
    public String toString() {
        return "Orders [id=" + id + ", userId=" + userId + ", number=" + number + ", createtime=" + createtime
                + ", note=" + note + ", user=" + user + "]";
    }
    
    
    
}

在config下的sqlmap目录下创建sql映射文件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">
<!--  必须掌握-->
<!-- namespace：命名空间，用于隔离sql -->
<mapper namespace="com.oracle.mapper.OrdersMapper">
    <resultMap type="orders" id="getOrders">
        <!-- <id property="id" column="id"/> -->
        <result property="userId" column="user_id"/>
    </resultMap>
<!--查询所有订单信息  -->

<select id="getAllOrders" resultMap="getOrders">
    select * from orders
</select>
    <!--查询所有的订单信息以及其关联的用户信息  -->
        <!-- 因为两个表是一对一！为使用resultMap，所以在orders下添加私有的User类对应的user属性，因为无法将数据映射到user里面
        所以开始下面的手动映射 -->
    <resultMap type="orders" id="orderUserResultMap">
    <id property="id" column="id" />
    <result property="userId" column="user_id" />
    <result property="number" column="number" />
    <result property="createtime" column="createtime" />
    <result property="note" column="note" />

    <!-- association ：配置一对一属性 -->
    <!-- property:order里面的User属性名 -->
    <!-- javaType:属性类型 -->
    <association property="user" javaType="user">
        <!-- id:声明主键，表示user_id是关联查询对象的唯一标识-->
        <id property="id" column="user_id" />
        <result property="username" column="username" />
        <result property="address" column="address" />
    </association>

</resultMap>

<!-- 一对一关联，查询订单，订单内部包含用户属性 -->
<select id="getOrdersUser" resultMap="orderUserResultMap">
    SELECT
    o.id,
    o.user_id userId,
    o.number,
    o.createtime,
    o.note,
    u.username,
    u.address
    FROM
    `orders` o
    LEFT JOIN `user` u ON o.user_id = u.id
</select>
</mapper>

mybatis框架需要加载Mapper.xml映射文件，将users.xml添加在SqlMapConfig.xml：（上图已添加）

测试下：

    // 查询所有的订单及用户信息
    public static void method02() throws IOException {
        // 1. 创建SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 2. 加载SqlMapConfig.xml配置文件
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 3. 创建SqlSessionFactory对象
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 5.执行sql
        OrdersMapper ordersMapper = sqlSession.getMapper(OrdersMapper.class);// 获得一个(动态代理）UserMapper接口的实现类对象
        List<Orders> list = ordersMapper.getOrdersUser();
        System.out.println(list);
        // 6.释放资源
        sqlSession.close();
    }

五、小结：

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

　　${}表示拼接sql串（拼串就能引起注入），通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换， ${}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，${}括号中只能是value。

　　parameterType：指定输入参数类型，mybatis通过ognl从输入对象中获取参数值拼接在sql中。

　　resultType：指定输出结果类型，mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。如果有多条数据，则分别进行映射，并把对象放到容器List中（写泛型）

六、Mybatis解决jdbc编程的问题：

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

解决：在SqlMapConfig.xml中配置数据连接池，使用连接池管理数据库链接。

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

解决：将Sql语句配置在XXXXmapper.xml文件中与java代码分离。

3、向sql语句传参数麻烦，因为sql语句的where条件不一定，可能多也可能少，占位符需要和参数一一对应。

解决：Mybatis自动将java对象映射至sql语句，通过statement中的parameterType定义输入参数的类型。

4、对结果集解析麻烦，sql变化导致解析代码变化，且解析前需要遍历，如果能将数据库记录封装成pojo对象解析比较方便。

解决：Mybatis自动将sql执行结果映射至java对象，通过statement中的resultType定义输出结果的类型。

七、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需要具有很强的经验和能力才行。

　　总之，按照用户的需求在有限的资源环境下只要能做出维护性、扩展性良好的软件架构都是好架构，所以框架只有适合才是最好。

八、Dao开发方法：　　　　　　

　　　　　　　　原始Dao开发方法和Mapper动态代理开发方法。

（一）、sqlsession:

1、SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。

SqlSession通过SqlSessionFactory创建。

SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。

2、SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory创建的。所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。

3、SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。

4、SqlSession是一个面向用户的接口，sqlSession中定义了数据库操作方法。

每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。

（二）、原始Dao开发方法需要程序员编写Dao接口和Dao实现类。

原始Dao开发中存在以下问题：

1、 Dao方法体存在重复代码：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法

2、调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码，不便于开发维护。

（三）、Mapper:动态代理！！！

　　Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象（一个接口的实现类对象），代理对象的方法体同上边Dao接口实现类方法。

　　Mapper接口开发需要遵循以下规范：

1、 Mapper.xml文件中的namespace与mapper接口的类路径相同。

2、 Mapper接口方法名和Mapper.xml中定义的每个statement的id相同

3、 Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同

4、 Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

package com.oracle.mapper;

import java.util.List;

import com.oracle.pojo.Query;
import com.oracle.pojo.QueryVo;
import com.oracle.pojo.User;

public interface UserMapper {
//    Mapper接口开发需要遵循以下规范：
    //1、    Mapper.xml文件中的namespace与mapper接口的类路径相同。
    //2、    Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 
    //3、    Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
    //4、    Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
    //一个新的--创建一个xml文件和接口！xml里面配置接口的地址（包+类）<mapper namespace="com.oracle.mapper.UserMapper">
    //    根据id查询User
    public  User getUserById(Integer id);
    //根据用户名模糊查询用户列表
    public List<User> getUserByUserName(String username);
    //新增用户
    public void addUser(User user);
    //删除用户
    public void deleteUser(Integer id);
    //修改用户
    public void updateUser(User user);
    //根据QueryVo的模糊查询用户列表
    public List<User> getUsernameByQueryVo(QueryVo vo);
    //查询总记录数
    public Integer getCount();
    //根据姓名和性别查明用户
    public List<User> getUserBySexAndUserName(User user);
    //根据多个id查询用户
    public List<User> getUserByQuery(Query query);
    //查询所有用户信息及订单信息
    public List<User> getUserOrders();
}

1、定义mapper映射文件UserMapper.xml,将UserMapper.xml放在config下mapper目录下；

2、创建UserMapper接口；

3、修改SqlMapConfig.xml文件加载UserMapper.xml；

注： namespace

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

九、SqlMapConfig.xml配置文件：

（一）、SqlMapConfig.xml中配置的内容和顺序如下：

properties（属性）

settings（全局配置参数）

typeAliases（类型别名）

typeHandlers（类型处理器）

objectFactory（对象工厂）

plugins（插件）

environments（环境集合属性对象）

environment（环境子属性对象）

transactionManager（事务管理）

dataSource（数据源）

mappers（映射器）

（二）、SqlMapConfig.xml可以引用java属性文件中的配置信息如下：

在config下定义db.properties（属性）file文件：键值对形式，都必须是String类型！

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

MyBatis 将按照下面的顺序来加载属性：

1、在 properties 元素体内定义的属性首先被读取。

2、然后会读取properties 元素中resource或 url 加载的属性，它会覆盖已读取的同名属性。

（三）、typeAliases（类型别名）---也可以起别名

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
map	Map