使用示例

首先创建 mybatis-config.xml 配置文件，这是 MyBatis 中的基础配置文件，其中配置了数据库的 URL 地址、数据库用户名密码、别名信息、映射配置文件的位置以及一些全局配置信息。具体格式如下：

<?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>
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://x.x.x.x:3306/user"/>
        <property name="username" value="xxx"/>
        <property name="password" value="xxx"/>
    </properties>
    <!-- 全局配置信息 -->
    <settings>
        <setting name="cacheEnabled" value="true"/>
    </settings>
    <!-- 别名配置信息,在mapper文件中可直接使用UserInfo这个别名代替org.xl.mybatis.UserInfo这个类 -->
    <typeAliases>
        <typeAlias type="org.xl.mybatis.UserInfo" alias="UserInfo"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <!-- 配置事务管理器的类型 -->
            <transactionManager type="JDBC"/>
            <!-- 配置数据源的类型, 以及数据库连接的相关信息 -->
            <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>
        <mapper resource="mybatis/mapper/UserInfoMapper.xml"/>
    </mappers>
</configuration>

了解了 mybatis-config.xml 配置文件的大致结构后，我们来看一下 UserInfoMapper.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="org.xl.mybatis.UserInfoMapper">
    <!-- 定义映射规则,这里直接使用别名代替完整类路径 -->
    <resultMap id="UserInfoResultMap" type="UserInfo">
        <id column="id" property="id" />
        <result column="name" property="name" />
        <result column="age" property="age"/>
        <result column="address" property="address"/>
        <result column="creat_time" property="creatTime"/>
    </resultMap>
    <!-- 定义SQL语句 -->
    <select id="getAll" resultMap="UserInfoResultMap">
        SELECT * FROM user_info;
    </select>
</mapper>

最后我们来看一下 Java 程序中如何加载上述配置文件以及如何使用 MyBatis 的 API。

public class MyBatisMain {
    public static void main(String[] args) throws IOException {
        String resourceLocation = "mybatis/config/mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resourceLocation);
        SqlSessionFactory sqlSessionFactory =
                new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            List<UserInfo> list = sqlSession.selectList("org.xl.mybatis.UserInfoMapper.getAll");
            System.out.println(list);
        } finally {
            sqlSession.close();
        }
    }
}

与 Spring 集成

与 Spring 集成后，无需再通过 SqlSession 来执行 SQL 语句，而是直接以 Bean 的形式注入相应的 Mapper 接口类然后执行方法即可。

@Configuration
@MapperScan(basePackages = {"com.example.mybatis.dao"}, sqlSessionFactoryRef = "sqlSessionFactory")
public class MyBatisConfig {

    @Autowired
    private DataSource dataSource;

    @Bean(name = "sqlSessionFactory")
    @ConditionalOnMissingBean(SqlSessionFactory.class)
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        // 配置数据源
        sessionFactory.setDataSource(dataSource);
        // 用于加载mybatis配置文件
        sessionFactory.setConfigLocation(new PathMatchingResourcePatternResolver()
                .getResource("classpath:mybatis-config.xml"));
        // 配置包中类的别名，配置后在XML映射文件中使用时可以省略包名部分，直接用类名
        sessionFactory.setTypeAliasesPackage("com.example.mybatis.domain");
        // 配置XML映射文件的路径
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
                .getResources("classpath:mapper/*mapper.xml"));
        // mybatis全局配置
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        // 关闭全局二级缓存
        configuration.setCacheEnabled(false);
        // 下划线自动转驼峰映射实体类
        configuration.setMapUnderscoreToCamelCase(true);
        sessionFactory.setConfiguration(configuration);
        return sessionFactory.getObject();
    }
}

其中，@MapperScan 注解用于扫描 Mapper 文件对应的接口，属性含义如下：

• basePackage：用于配置基本的包路径。每个映射器将会在指定的包路径中递归地被搜索到。
• annotationClass：用于过滤被扫描的接口，如果设置了该属性，那么 MyBatis 的接口只有包含该注解才会被扫描进去。
• sqlSessionFactoryRef：指定在 Spring 上下文中有多个 SqlSessionTemplate 的情况下使用。通常只有在有多个数据源时才需要这样做。

MyBatis 映射语句基础

MyBatis 的强大之处在于它的映射语句，这也是它的魔力所在。同时 MyBatis 3.0 支持使用接口来调用方法，通过使用 Java 的动态代理可以直接通过接口来调用相应的方法，不需要提供接口的实现类。另外，当有多个参数时可通过 ＠Param 注解设置参数的名字省去了手动构造 Map 参数的过程，尤其在 Spring 中使用的时候，可以配置为自动扫描所有的接口类，直接将接口注入需要用到的地方。

1. XML 方式

1.1 select

接口定义如下：

public interface AppInfoDao {
    AppInfo queryById(@Param("id") Long id);
}

相应 Mapper 定义如下：

<mapper namespace="com.example.mybatis.dao.AppInfoDao">
    <resultMap id="appInfoMap" type="com.example.mybatis.domain.AppInfo">
        <id property="id" column="id"/>
        <result property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="buName" column="bu_name"/>
        <result property="empEmail" column="emp_email"/>
        <result property="prodFullPath" column="prod_full_path"/>
    </resultMap>
    <select id="queryById" resultMap="appInfoMap">
        select * from app_info where id = #{id}
    </select>
</mapper>

• ：映射查询语句使用的标签。 ：用于配置 Java 对象的属性和查询结果列的对应关系。可以通过在 resultMap 中配置 property 属性和 column 属性的映射，或者在 SQL 中设置别名这两种方式实现将查询列映射到对象属性的目的。 #{id}：MyBatis 中使用预编译参数的一种方式，通过 @Param 获取传入的参数。MyBatis 会把 ＠Param 注解修饰的参数封装成 requestMap 中的 key ，因此写 SQL 时就可通过配置的注解值来使用参数。注意 ${} 和 #{} 的区别。${} 会直接赋值，#{} 会采用占位符的方式，可以有效避免 SQL 注入。 接口中定义的返回值类型必须和 XML 中配置的 resultType （或 resultMap 中的 type ）类型一致，否则就会因为类型不一致而抛出异常。如果使用 resultType 来设置返回结果的类型，需要在 SQL 中为所有列名和属性名不一致的列设置别名，通过设置别名使最终的查询结果列和 resultType 指定对象的属性名保持一致，实现自动映射。 当返回值最多只有 1 个结果的时候，可以将接口返回值定义为 T，而不是 List。但是如果超过就会抛出TooManyResultsException 异常。 此外，MyBatis 还提供了一个全局属性 mapUnderscoreToCamelCase 用来进行自动映射，通过配置这个属性为 true 可以自动将以下划线方式命名的数据库列映射到 Java 对象的驼峰式命名属性中。该属性默认为 false，我们可以手动添加该配置。 @Configuration @MapperScan(basePackages = { "com.example.mybatis.dao" }, sqlSessionFactoryRef = "sqlSessionFactory") public class MyBatisConfig { @Autowired private DataSource dataSource; @Bean(name = "sqlSessionFactory") @ConditionalOnMissingBean(SqlSessionFactory.class) public SqlSessionFactory sqlSessionFactory() throws Exception { SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean(); sessionFactory.setDataSource(dataSource); sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*mapper.xml")); // 添加配置信息 org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration(); configuration.setMapUnderscoreToCamelCase(true); sessionFactory.setConfiguration(configuration); return sessionFactory.getObject(); } } 1.2 insertint add(AppInfo appInfo); 相应 Mapper 定义如下： <mapper namespace="com.example.mybatis.dao.AppInfoDao"> <insert id="add"> insert into app_info (gmt_create, gmt_modified, name, emp_email, bu_name, prod_full_path) values (now(), now(), #{name}, #{empEmail}, #{buName}, #{prodFullPath}) </insert> </mapper> 标签包含的一些属性： flushCache：默认值为 true，任何时候只要语句被调用，都会清空一级缓存和二级缓存。timeout：设置在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。useGeneratedKeys ：默认值为 false。如果设置为 true，MyBatis 会使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键。keyProperty：MyBatis 通过 getGeneratedKeys 获取主键值后将要赋值的属性名。databaseId：如果配置了databaseidProvider，MyBatis 会优先加载匹配当前 databaseId 的语句。 如何获取自增主键的值？ 1）使用 useGeneratedKeys + keyProperty <mapper namespace="com.example.mybatis.dao.AppInfoDao"> <insert id="add" useGeneratedKeys="true" keyProperty="id"> insert into app_info (gmt_create, gmt_modified, name, emp_email, bu_name, prod_full_path) values (now(), now(), #{name}, #{empEmail}, #{buName}, #{prodFullPath}) </insert> </mapper> 这样，当 insert 语句执行完后，会将新增的主键赋给 id，然后我们从入参对象里直接获取即可。 2）使用 selectKey 获取主键上面这种回写主键的方法只适用于支持主键自增的数据库。有些数据库不提供主键自增的功能，而是使用序列得到一个值，然后将这个值赋给 id，再将数据插入数据库。对于这种情况，可以使用 标签获取主键值，这种方式不仅适用于不提供主键自增功能的数据库，也适用于提供主键自增功能的数据库。 <mapper namespace="com.example.mybatis.dao.AppInfoDao"> <insert id="add"> insert into app_info (gmt_create, gmt_modified, name, emp_email, bu_name, prod_full_path) values (now(), now(), #{name}, #{empEmail}, #{buName}, #{prodFullPath}) <selectKey keyColumn="id" resultType="long" keyProperty="id" order="AFTER"> select last_insert_id() </selectKey> </insert> </mapper> 标签的 keyColumn、keyProperty 和 useGeneratedKeys 的用法含义相同，resultType 用于设置返回值类型。order 属性的设置和使用的数据库有关。 元素中的内容就是一个独立的 SQL 语句，比如 MySQL 中的 select last_insert_id() 用于获取数据库中最后插入的数据的 ID 值。 此外，为了防止类型错误，对于一些特殊的数据类型，建议指定具体的 jdbcType 值。比如：数据库区分 date、time、datetime 类型，但是 Java 中一般都使用 java.util.Date 类型。因此为了保证数据类型的正确，需要手动指定日期类型，date、time、datetime 对应的 jdbcType 分别为DATE、TIME 和 TIMESTAMP 1.3 updateint updateById(AppInfo appInfo); 相应 Mapper 定义如下： <mapper namespace="com.example.mybatis.dao.AppInfoDao"> <update id="updateById"> update app_info set name=#{name}, owner=#{owner}, emp_email=#{empEmail} where id=#{id} </update> </mapper> 1.4 deletepublic interface AppInfoDao { int deleteById(Long id); } 相应 Mapper 定义如下： <mapper namespace="com.example.mybatis.dao.AppInfoDao"> <delete id="deleteById"> delete from app_info where id=#{id} </delete> </mapper> 2. 注解方式MyBatis 注解方式就是将 SQL 语句直接写在接口上。使用方式就是在接口方法基础上添加需要的注解，并写上相应的 SQL 语句。＠Select、@Insert、＠Update 和 ＠Delete 这 4 个基本注解的参数可以是字符串数组类型，也可以是字符串类型。 当需要用到特殊符号时，需要对特殊字符进行转义。OGNL特殊字符的转义列表为：OGNL。 2.1 @Insert 返回自增主键@Insert({"insert into app_info " + "(gmt_create, gmt_modified, name, emp_email, bu_name, prod_full_path) " + "values " + "((now(), now(), #{name}, #{empEmail}, #{buName}, #{prodFullPath}))"}) @Options(useGeneratedKeys = true, keyProperty = "id") int insert(AppInfo list); 2.2 @Provider 注解除了上面 4 种注解可以使用简单的 SQL 外，MyBatis 还提供了 4 种 Provider 注解，分别是 @SelectProvider、＠InsertProvider、＠UpdateProvider 和 ＠DeleteProvider。它们同样可以实现查询、插入、更新、删除操作。 public interface AppMapper { @SelectProvider(type = AppProvider.class, method = "selectById") AppInfo queryById(@Param("id") Long id); } public class AppProvider { public String selectById(final Long id) { return new SQL(){{ SELECT("*"); FROM("app_info"); WHERE("id=#{id}"); }}.toString(); } } Provider 的注解中提供了两个必填属性 type 和 method 。type 配置的是一个包含 method 属性指定方法的类，这个类必须有空的构造方法，这个方法的值就是要执行的 SQL 语句，并且 method 属性指定的方法的返回值必须是 String 类型。 拼接 SQL 语句有两种写法，SQL 较长或需要拼接时推荐使用 new SQL()，或者直接返回 sql 字符串。 MyBatis 动态 SQL 1. if<if> 标签通常用于 WHERE 语句中，通过判断参数值来决定是否使用某个查询条件，它也经常用于 UPDATE 语句中判断是否更新某一个字段，还可以在 INSERT 语句中用来判断是否插入某个字段的值。 1）XML 示例： <select id="queryByName" resultType="com.example.mybatis.domain.AppInfo"> select * from app_info where 1=1 <if test="buName != null and buName != ''"> and bu_name like concat('%', #{buName}, '%') </if> </select> 2）注解示例： @Select({"<script>", "select * from app_info where 1=1 " + "<if test='buName != null'> and bu_name like concat('%', #{buName}, '%') </if>", "</script>"}) List<AppInfo> queryByName(@Param("buName") String buName); if 标签有一个必填的属性 test，test 的属性值是一个符合 OGNL 要求的判断表达式，支持 and、or 的判断符。在注解上使用动态 SQL 的标签时，需要添加