mybatis源码解析 与自定义数据库插件

1.源码环境

1.1引入依赖

<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis</artifactId>
			<version>3.5.2</version>
</dependency>
<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>8.0.16</version>
			<scope>runtime</scope>
</dependency>

1.2项目目录

1.3mapper类与实体类

public interface UserMapper {
    /**
     * 通过id获取user
     * @param id
     * @return
     */
    User selectById(Integer id);
}

@Data
public class User {

    private Integer id;

    private String userName;

    private Integer age;

    private Integer gender;

}

1.4UserMapper.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="com.gz.mybatis.source.mapper.UserMapper">

    <select id="selectById" resultType="com.gz.mybatis.source.pojo.User">
    select * from user
    where id =#{id}
    </select>
</mapper>

1.5mybatis-config.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>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://192.168.10.10:3306/luhua?characterEncoding=utf-8&amp;useUnicode=true&amp;zeroDateTimeBehavior=convertToNull&amp;serverTimezone=Asia/Shanghai"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="mapper/UserMapper.xml"/>
    </mappers>
</configuration>

2.源码逻辑图

• 创建sqlsession工厂

使用建造者模式，创建sqlsession功能
解析xml文件，封装再configuration
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

• 创建sqlsession

通过SqlSessionFactory获取sqlsession
SqlSession sqlSession = sqlSessionFactory.openSession();

• 获取mapper代理

动态代理获取mpper代理接口
UserMapper mapper = sqlSession.getMapper(UserMapper.class);

• 执行数据库操作

User user= mapper.selectById(1);

3 执行数据库操作整个链路

1.执行mpper动态代理invoke方法
2.通过RoutingStatementHandler创建statementHandler
3.RoutingStatementHandler根据不同路由选择不同statementHanlder
4.创建ParameterHandler 进行动态代理加载插件 对参数处理
5.创建ResultSetHandler 进行动态代理加载插件 对结果处理
6.创建StatementHandler进行动态代理加载插件 对数据库执行处理
这个就是数据库插件原理

4.自定义mybatis插件

• 自定义拦截器

@Intercepts({
        @Signature(
                type = Executor.class,
                method = "query",
                args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})
@Slf4j
public class MyBatisPlugin2 implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 方法的参数
        Object[] args = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) args[0];

        // 不存在注解时，直接执行
        if (!hasAnnotation(mappedStatement.getId())){
            invocation.proceed();
        }

        SqlSource rowSqlSource = mappedStatement.getSqlSource();
        System.out.println(String.format("修改前的SQL = %s", rowSqlSource.getBoundSql(null).getSql()));
        // 获得 private final SqlSource sqlSource; 对象
        Field staticsqlSourceField = rowSqlSource.getClass().getDeclaredField("sqlSource");
        staticsqlSourceField.setAccessible(true);
        Object staticsqlSourceObject = staticsqlSourceField.get(rowSqlSource);
        // 修改 sqlSource 的 sql 字段值
        Field sqlField = staticsqlSourceObject.getClass().getDeclaredField("sql");
        sqlField.setAccessible(true);
        String sqlFieldValue = (String)sqlField.get(staticsqlSourceObject);
        sqlField.set(staticsqlSourceObject, sqlFieldValue +" limit 1");
        System.out.println(String.format("修改后的SQL = %s", rowSqlSource.getBoundSql(null).getSql()));

        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {

    }

    /**
     * 判断是否有此注解
     * @param classPath
     * @return
     * @throws ClassNotFoundException
     */
    private boolean hasAnnotation(String classPath) throws ClassNotFoundException {
        if(StringUtils.isBlank(classPath)){
            return false;
        }
        //先判断类上面是否加上了注解
        String mapperClass = classPath.substring(0, classPath.lastIndexOf("."));
        Class<?> classType = Class.forName(mapperClass);
        if(classType.isAnnotationPresent(DbPluginAnnotation.class)){
            return true;
        }
        //如果类上面没有加上注解，判断方法上是否加上了注解
        String methodName = classPath.substring(classPath.lastIndexOf(".") + 1);
        Method method1 = Arrays.stream(classType.getMethods()).filter(method -> method.equals(methodName)).findFirst().orElse(null);
        if(method1 == null){
            return false;
        }
        return method1.isAnnotationPresent(DbPluginAnnotation.class);
    }
}

• 注解

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DbPluginAnnotation {
}