玩转Mybatis高级特性：让你的数据操作更上一层楼

[toc]
Mybatis高级特性能够帮助我们更加灵活地操作数据库，包括动态SQL、缓存机制、插件机制、自定义类型转换等。学习这些特性可以让我们更好地利用Mybatis，提高数据操作的效率和质量。

未来的道路由自己抉择，事业的高度由自己决定。

动态SQL

动态SQL中，Mybatis提供了多种标签来帮助我们构建动态的SQL语句，其中包括：

• <if>：用于条件判断，可以动态添加WHERE语句的查询条件。
• <where>：动态生成WHERE语句，可以过滤掉不需要的条件。
• <set>：动态生成UPDATE语句，可以更新需要修改的字段。
• <choose>：类似于Java中的switch语句，可以根据不同的条件生成不同的SQL语句。
• <foreach>：用于循环遍历集合，可以将集合中的元素作为SQL语句的参数进行批量操作。

示例：

<update id="updateByPrimaryKeySelective" parameterType="com.youlai.mybatis.domain.SysUser">
        update sys_user
        <set>
                <if test="username != null">
                    username = #{username,jdbcType=VARCHAR},
                </if>
                <if test="nickname != null">
                    nickname = #{nickname,jdbcType=VARCHAR},
                </if>
                <if test="gender != null">
                    gender = #{gender,jdbcType=TINYINT},
                </if>
                <if test="password != null">
                    password = #{password,jdbcType=VARCHAR},
                </if>
                <if test="deptId != null">
                    dept_id = #{deptId,jdbcType=INTEGER},
                </if>
                <if test="avatar != null">
                    avatar = #{avatar,jdbcType=VARCHAR},
                </if>
                <if test="mobile != null">
                    mobile = #{mobile,jdbcType=VARCHAR},
                </if>
                <if test="status != null">
                    status = #{status,jdbcType=TINYINT},
                </if>
                <if test="email != null">
                    email = #{email,jdbcType=VARCHAR},
                </if>
                <if test="deleted != null">
                    deleted = #{deleted,jdbcType=TINYINT},
                </if>
                <if test="createTime != null">
                    create_time = #{createTime,jdbcType=TIMESTAMP},
                </if>
                <if test="updateTime != null">
                    update_time = #{updateTime,jdbcType=TIMESTAMP},
                </if>
        </set>
        where   id = #{id,jdbcType=INTEGER} 
    </update>

动态SQL的优化技巧：

1. 尽量使用<where>标签生成WHERE语句，可以避免出现多余的AND或OR关键字。
2. 使用<foreach>标签批量操作时，尽量使用batch模式，而不是简单的循环逐一执行。
3. 对于常用的动态SQL语句，可以使用Mybatis提供的缓存机制进行优化。
4. 尽量避免在动态SQL中使用select *语句，而是明确指定需要查询的字段。
5. 在动态SQL中尽量使用预编译语句，可以提高SQL语句的执行效率。

让自己不断进步，让职业越来越优秀。

缓存机制

• 一级缓存和二级缓存的区别
• 一级缓存是Mybatis默认开启的缓存，它是在同一个SqlSession内部共享的缓存，它可以通过查询语句的唯一标识符（id）和查询参数作为key进行缓存，可以有效地避免重复查询。一级缓存的生命周期与SqlSession相同，当SqlSession关闭时，它的缓存也会被清空。
• 二级缓存是Mybatis的全局缓存，它可以被多个SqlSession共享，适用于需要跨SqlSession共享数据的场景。它的存储方式是将数据放在一个HashMap中，key是查询语句的唯一标识符和查询参数的组合，value是查询到的结果。二级缓存的生命周期与整个应用程序相同，它可以在应用程序的多个SqlSession之间共享查询结果，但也由于这个原因，它的数据一旦被修改，就需要手动刷新缓存，否则会导致数据的不一致。
• 缓存的配置和使用方式

配置方式：

mybatis:
  configuration:
    cache-enabled: true   #开启二级缓存(默认开启)
    local-cache-scope: statement #关闭一级缓存(默认开启)
#   local-cache-scope: session   #开启一级缓存(默认开启)

使用方式:

<mapper namespace="com.youlai.mybatis.mapper.SysUserMapper">
    <cache type="com.youlai.mybatis.service.MyCustomCache"/
</mapper>

自定义缓存实现,这里采用本地存储，分布式建议用redis

@Component
@Slf4j
public class MyCustomCache implements Cache, Serializable {

    private String id;
    private Map<Object, Object> cache = new ConcurrentHashMap<>();

    public MyCustomCache() {
    }

    public MyCustomCache(String id) {
        this.id = id;
    }

    @Override
    public String getId() {
        log.info("获取缓存标识:{}",id);
        return id;
    }

    @Override
    public void putObject(Object key, Object value) {
        log.info("添加缓存key:{},value:{}",key,value);
        cache.put(key, value);
    }

    @Override
    public Object getObject(Object key) {
        log.info("获取缓存key:{}",key);
        return cache.get(key);
    }

    @Override
    public Object removeObject(Object key) {
        log.info("删除缓存key:{}",key);
        return cache.remove(key);
    }

    @Override
    public void clear() {
        log.info("清空缓存");
        cache.clear();
    }

    @Override
    public int getSize() {
        log.info("获取缓存数量:{}",cache.size());
        return cache.size();
    }

    @Override
    public ReadWriteLock getReadWriteLock() {
        log.info("拿锁");
        ReentrantReadWriteLock readWriteLock = new ReentrantReadWriteLock(true);
        return readWriteLock;
    }

    private void writeObject(ObjectOutputStream out) throws IOException {
        out.writeObject(cache);
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        cache = (Map<Object, Object>) in.readObject();
    }

}

做自己喜欢的事情，成为自己想成为的人。

插件机制

Mybatis插件可以在执行过程中拦截指定的方法，对其进行增强或者修改,原理是使用JDK动态代理机制，对Mybatis的接口进行代理，从而实现对SQL执行过程的拦截和修改，可以实现一些比较复杂的功能，例如：

• 对SQL语句进行拦截和修改，实现动态SQL的功能。
• 统计SQL执行的时间，方便对性能进行优化。
• 实现通用的分页查询功能。
• 对查询结果进行加密或解密。

自定义插件的步骤：

1. 实现Interceptor接口，重写intercept方法。
2. 在intercept方法中编写拦截逻辑，对需要拦截的方法进行增强或修改。
3. 在plugin方法中，将拦截器实例化，并返回代理对象。
4. 在Mybatis配置中添加插件。

以下是一个统计SQL执行时间示例：

@Intercepts({
        @Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class})
})
@Slf4j
public class MybatisPlugin implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // TODO: 拦截逻辑
        log.info("进入拦截器");
        long startTime = System.currentTimeMillis();
        Object result = invocation.proceed();
        long endTime = System.currentTimeMillis();
        long sqlTime = endTime - startTime;
        StatementHandler statementHandler = (StatementHandler)invocation.getTarget();
        String sql = statementHandler.getBoundSql().getSql();
        ParameterHandler parameterHandler = statementHandler.getParameterHandler();
        log.info("执行sql:{},参数:{},花费了{}毫秒",sql,parameterHandler.getParameterObject().toString(),sqlTime);
        return result;
    }

    @Override
    public Object plugin(Object target) {
        log.info("生成代理对象");
        return Interceptor.super.plugin(target);
    }

    @Override
    public void setProperties(Properties properties) {
        log.info("设置插件属性");
        Interceptor.super.setProperties(properties);
    }
}

添加插件

@Component
public class MySqlSessionFactoryBeanCustomizer implements SqlSessionFactoryBeanCustomizer{
    @Override
    public void customize(SqlSessionFactoryBean factoryBean) {
        //注册插件
        factoryBean.setPlugins(new MybatisPlugin());
    }

}

保持热情与好奇心，不断追求进步和创新。

自定义类型转换

Mybatis中的类型转换指的是Java类型和数据库类型之间的转换。在Mybatis中，我们可以使用TypeHandler来实现自定义的类型转换。

自定义TypeHandler的步骤如下：

1. 创建一个类，实现org.apache.ibatis.type.TypeHandler接口。
2. 在类上使用@MappedJdbcTypes注解指定要转换的JDBC类型。
3. 在类上使用@MappedTypes注解指定要转换的Java类型。
4. 重写TypeHandler接口中的方法，实现自定义的类型转换逻辑。

示例：

@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(String.class)
@Slf4j
public class MyStringTypeHandler implements TypeHandler<String> {

    @Override
    public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        log.info("将Java类型的参数转换为JDBC类型的参数，并设置到PreparedStatement中");
        ps.setString(i, parameter);
    }

    @Override
    public String getResult(ResultSet rs, String columnName) throws SQLException {
        log.info("通过列名{}获取数据，将JDBC类型中的结果转换为java类型",columnName);
        return rs.getString(columnName);
    }

    @Override
    public String getResult(ResultSet rs, int columnIndex) throws SQLException {
        log.info("通过索引获取数据，将JDBC类型中的结果转换为java类型");
        return rs.getString(columnIndex);
    }

    @Override
    public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
        log.info("通过索引获取数据，将JDBC类型中的结果转换为java类型");
        return cs.getString(columnIndex);
    }
}

注册

@Component
public class MySqlSessionFactoryBeanCustomizer implements ConfigurationCustomizer {

    @Override
    public void customize(Configuration configuration) {
        configuration.getTypeHandlerRegistry().register(String.class,new MyStringTypeHandler());
    }
}

以上示例中，我们自定义了一个将Java String类型转换为JDBC VARCHAR类型的TypeHandler。

完整代码:https://gitee.com/youlaiorg/youlai-learning.git

总结

本文介绍了Mybatis的高级特性，包括动态SQL的优化技巧、缓存机制、插件机制和自定义类型转换。动态SQL的优化技巧包括使用<where>标签生成WHERE语句、使用<foreach>标签批量操作时尽量使用batch模式等。缓存机制包括一级缓存和二级缓存，可以通过配置文件进行开启或关闭。插件机制可以在Mybatis的执行过程中拦截指定的方法，对其进行增强或者修改。自定义类型转换可以将Java类型和数据库类型之间进行转换。

不断学习和成长，实现自我价值和职业发展的双赢。

本文由mdnice多平台发布