【Mybatis从入门到实战教程】第三章 Mybatis 核心配置文件详解

MyBatis的全局配置文件mybatis-config.xml，配置内容如下：

• properties（属性）

• settings（全局配置参数）

• typeAliases（类型别名）

• typeHandlers（类型处理器）

• objectFactory（对象工厂）

• plugins（插件）

• environments（环境集合属性对象）

  • environment（环境子属性对象）

    • transactionManager（事务管理）

    • dataSource（数据源）

• mappers（映射器）

    将数据库连接参数单独配置在db.properties中，只需要在mybatis-config.xml中加载db.properties的属性值。在mybatis-config.xml中就不需要对数据库连接参数硬编码。

# Oracle相关配置
jdbc.oracle.driver=oracle.jdbc.driver.OracleDriver
jdbc.oracle.url=jdbc:oracle:thin:@localhost:1521:orcl
jdbc.oracle.username=scott
jdbc.oracle.password=tiger

# Mysql相关配置
jdbc.mysql.driver=com.mysql.jdbc.Driver
jdbc.mysql.url=jdbc:mysql://localhost:3306/ssm?characterEncoding=utf8&useSSL=false
jdbc.mysql.username=root
jdbc.mysql.password=root

使用 标签加载属性文件：

• resource: 从classpath下读取资源文件

  • classpath为maven项目中的src/main/resources目录 + src/main/java目录，编译之后的目录为target/classes；

• url: 从当前系统环境的文件系统中读取资源

  • windows: d:/conf/test.properties

  • linux: /home/tom/conf/test.properties

在环境中使用：

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

1. 在properties标签体内定义的属性首先被读取；

2. 然后会读取properties标签中resource或url加载的属性，它会覆盖已读取的同名属性；

3. 最后读取parameterType传递的属性，它会覆盖已读取的同名属性；

建议：

1. 不要在properties标签体内添加任何属性值，只将属性值定义在properties文件中；

2. 在properties文件中定义属性名要有一定的特殊性，如：XXXXX.XXXXX.XXXX；

    MyBatis框架在运行时可以调整一些运行参数，比如：开启二级缓存、开启延迟加载。

可配置参数如下：

开启下划线与驼峰命名的转换：

    在mapper.xml中，定义很多的statement。statement需要parameterType指定输入参数的类型、需要resultType指定输出结果的映射类型。如果在指定类型时输入类型全路径，不方便进行开发，可以针对parameterType或resultType指定的类型定义一些别名，在mapper.xml中通过别名定义，方便开发。

单个定义别名：

    单个类型的别名配置：typeAlias。
        type：类型，java中类的全限定名；
        alias：别名；

批量定义别名：

    批量类型别名的配置：package。
        name：需要配置别名的类所在的包；
        设置包名之后，此包下所有的类都拥有类型别名，其别名为：该类的类名，首字母大小均可。

注解定义别名：

    在实体类上可以使用 @Alias("name") 注解来标识该类的别名。

@Alias("depart")
public class Dept {
    //...
}

注意：配置和注解仅能使用一种方式，当注解存在时，则其别名为其注解值。

实体类：

public class Dept {

    private Integer deptno;
    private String dname;
    private String loc;

    public Integer getDeptno() {
        return deptno;
    }

    public void setDeptno(Integer deptno) {
        this.deptno = deptno;
    }

    public String getDname() {
        return dname;
    }

    public void setDname(String dname) {
        this.dname = dname;
    }

    public String getLoc() {
        return loc;
    }

    public void setLoc(String loc) {
        this.loc = loc;
    }

    @Override
    public String toString() {
        return "Dept{" +
            "deptno=" + deptno +
            ", dname='" + dname + ''' +
            ", loc='" + loc + ''' +
            '}';
    }
}

接口：

package com.newcapec.mapper;

import com.newcapec.entity.Dept;

import java.util.List;

public interface DeptMapper {

    List select();

    Dept selectById(Integer deptno);

    List selectByDname(String dname);
}

mapper文件：

    
        select deptno,dname,loc from dept
    

    
        select deptno,dname,loc from dept where deptno=#{deptno}
    

    
        select deptno,dname,loc from dept where dname=#{dname}
    
 
测试：
 
package com.newcapec;

import com.newcapec.entity.Dept;
import com.newcapec.mapper.DeptMapper;
import com.newcapec.util.MybatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;


public class TypeAliasTest {

    @Test
    public void testSelect() {
        SqlSession sqlSession = MybatisUtil.getSession();
        DeptMapper deptMapper = sqlSession.getMapper(DeptMapper.class);
        List list = deptMapper.select();
        for (Dept dept : list) {
            System.out.println(dept);
        }
        sqlSession.close();
    }

    @Test
    public void testSelectById() {
        SqlSession sqlSession = MybatisUtil.getSession();
        DeptMapper deptMapper = sqlSession.getMapper(DeptMapper.class);
        Dept dept = deptMapper.selectById(10);
        System.out.println(dept);
        sqlSession.close();
    }

    @Test
    public void testSelectByDname() {
        SqlSession sqlSession = MybatisUtil.getSession();
        DeptMapper deptMapper = sqlSession.getMapper(DeptMapper.class);
        List list = deptMapper.selectByDname("ACCOUNTING");
        System.out.println(list);
        sqlSession.close();
    }
}
 
3.4 typeHandlers类型处理器 
    MyBatis中通过typeHandlers完成jdbc类型和Java类型的转换，MyBatis自带的类型处理器基本上满足日常需求，不需要单独定义。
 
MyBatis支持类型处理器：
 
类型处理器
Java类型
JDBC类型
BooleanTypeHandler
Boolean，boolean
任何兼容的布尔值
ByteTypeHandler
Byte，byte
任何兼容的数字或字节类型
ShortTypeHandler
Short，short
任何兼容的数字或短整型
IntegerTypeHandler
Integer，int
任何兼容的数字和整型
LongTypeHandler
Long，long
任何兼容的数字或长整型
FloatTypeHandler
Float，float
任何兼容的数字或单精度浮点型
DoubleTypeHandler
Double，double
任何兼容的数字或双精度浮点型
BigDecimalTypeHandler
BigDecimal
任何兼容的数字或十进制小数类型
StringTypeHandler
String
CHAR和VARCHAR类型
ClobTypeHandler
String
CLOB和LONGVARCHAR类型
NStringTypeHandler
String
NVARCHAR和NCHAR类型
NClobTypeHandler
String
NCLOB类型
ByteArrayTypeHandler
byte[]
任何兼容的字节流类型
BlobTypeHandler
byte[]
BLOB和LONGVARBINARY类型
DateTypeHandler
java.util.Date
TIMESTAMP类型
DateOnlyTypeHandler
java.util.Date
DATE类型
TimeOnlyTypeHandler
java.util.Date
TIME类型
SqlTimestampTypeHandler
java.sql.Timestamp
TIMESTAMP类型
SqlDateTypeHandler
java.sql.Date
DATE类型
SqlTimeTypeHandler
java.sql.Time
TIME类型
ObjectTypeHandler
任意
其他或未指定类型
EnumTypeHandler
Enumeration类型
VARCHAR-任何兼容的字符串类型，作为代码存储（而不是索引）
3.5 mappers映射器 
    mappers：映射器，加载mapper文件。
 
3.5.1 单个加载映射文件 
    单个映射文件的加载：mapper。
 
 
resource: 从classpath下加载mapper文件
 

    
    
    
 
 
class: 配置dao接口的全限定名，通过Java中的dao接口的名称加载mapper.xml文件
 

    
    
    
 
要求：
 
 
必须使用mapper代理的开发方式；
 
 
mapper.xml文件的名称必须与dao接口的名称保持一致；
 
 
mapper.xml文件必须与dao接口放在同一个目录下；
 
注意：同一个目录是指编译之后的目录，并非开发时的目录。
 
 
3.5.2 批量加载映射文件 
    批量映射文件的加载：package。
 
 
name：dao接口与mapper文件存放的共同的目录名称
 
此种配置使mapper扫描指定包，并在此包下获取所有的接口以及与接口名称相同mapper文件，并加载；
 

    
    
 
要求：与mapper接口加载单个映射文件(class方式)一致。
 
3.5.3 应用 
实体类：
 
public class Emp {

    private Integer empno;
    private String ename;
    private String job;
    private Integer mgr;
    private Date hiredate;
    private Double sal;
    private Double comm;
    private Integer deptno;
    private String gender;

    public Integer getEmpno() {
        return empno;
    }

    public void setEmpno(Integer empno) {
        this.empno = empno;
    }

    public String getEname() {
        return ename;
    }

    public void setEname(String ename) {
        this.ename = ename;
    }

    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }

    public Integer getMgr() {
        return mgr;
    }

    public void setMgr(Integer mgr) {
        this.mgr = mgr;
    }

    public Date getHiredate() {
        return hiredate;
    }

    public void setHiredate(Date hiredate) {
        this.hiredate = hiredate;
    }

    public Double getSal() {
        return sal;
    }

    public void setSal(Double sal) {
        this.sal = sal;
    }

    public Double getComm() {
        return comm;
    }

    public void setComm(Double comm) {
        this.comm = comm;
    }

    public Integer getDeptno() {
        return deptno;
    }

    public void setDeptno(Integer deptno) {
        this.deptno = deptno;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Emp{" +
                "empno=" + empno +
                ", ename='" + ename + ''' +
                ", job='" + job + ''' +
                ", mgr=" + mgr +
                ", hiredate=" + hiredate +
                ", sal=" + sal +
                ", comm=" + comm +
                ", deptno=" + deptno +
                ", gender='" + gender + ''' +
                '}';
    }
}
 
接口：
 
public interface EmpMapper {

    List select();
}
 
mapper文件：
 




    
        select empno,ename,job,mgr,hiredate,sal,comm,deptno from emp
    

测试：

public class MappersTest {
    @Test
    public void testSelectEmp() {
        SqlSession sqlSession = MybatisUtil.getSession();
        EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class);
        List list = empMapper.select();
        for (Emp emp : list) {
            System.out.println(emp);
        }
        sqlSession.close();
    }
}

Mybatis配置文件中各标签的位置顺序如下：

	properties?,
    settings?, 
    typeAliases?, 
    typeHandlers?, 
    objectFactory?, 
    objectWrapperFactory?, 
    reflectorFactory?, 
    plugins?, 
    environments?, 
    databaseIdProvider?, 
    mappers?
        
    具体可以参考 http://mybatis.org/dtd/mybatis-3-config.dtd 文件。