【MyBatis深入剖析】应用分析与最佳实践（下）

2020-04-26 16:04:09来源：博客园阅读 ()

【MyBatis深入剖析】应用分析与最佳实践（下）

MyBatis编程式开发

MyBatis编程式开发步骤

MyBatis和MySQL Jar包依赖
全局配置文件mybatis-config.xml
映射器Mapper.xml
Mapper接口

编程式开发伪代码

    @Test
    public void show() {
        SqlSession session = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            session = sqlSessionFactory.openSession();
            Student student = session.selectOne("com.fly.crud.mapper.StudentMapper.selectDataById", 1);
            log.info("student jsonStr is {}", JSON.toJSONString(student));
        } catch (Exception e) {
            log.error("MyBatis 编程式开发异常.", e);
        } finally {
            if (Objects.nonNull(session)) {
                session.close();
            }
        }
    }

MyBatis编程式开发核心对象

SqlSessionFactoryBuilder
SqlSessionFactory
SqlSession
Mapper

MyBatis编程式开发核心对象的生命周期

对象	生命周期
SqlSessionFactoryBuilder	方法局部（method）
SqlSessionFactory（Singleton）	应用级别（application）
SqlSession	请求和操作
Mapper	方法局部

MyBatis核心配置

标签	作用
configuration	MyBatis根标签
properties	mybatis全局属性
settings	mybatis设置
typeAliases	mybatis类型别名
typeHadlers	mybatis类型处理器
objectFactory	mybatis对象工程
plugins	mybatis插件
environments	mybatis环境变量
databaseIdProvider	mybatis数据库厂商标识
mappers	mybatis映射器

settings 默认源码解读

private void settingsElement(Properties props) {
    // 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射；PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集（无论是否嵌套）
    configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
    /**
     * 指定发现自动映射目标未知列（或未知属性类型）的行为。
     *  NONE: 不做任何反应
     *  WARNING: 输出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN）
     *  FAILING: 映射失败 (抛出 SqlSessionException)
     */
    configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
    // 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存
    configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
    // 指定 Mybatis 创建可延迟加载对象所用到的代理工具。
    configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
    // 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。
    configuration.setLazyLoadingEnabled(booleanValueOf(props.getProperty("lazyLoadingEnabled"), false));
    // 开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。
    configuration.setAggressiveLazyLoading(booleanValueOf(props.getProperty("aggressiveLazyLoading"), false));
    // 是否允许单个语句返回多结果集（需要数据库驱动支持）
    configuration.setMultipleResultSetsEnabled(booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true));
    // 使用列标签代替列名。实际表现依赖于数据库驱动，具体可参考数据库驱动的相关文档，或通过对比测试来观察
    configuration.setUseColumnLabel(booleanValueOf(props.getProperty("useColumnLabel"), true));
    // 允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）
    configuration.setUseGeneratedKeys(booleanValueOf(props.getProperty("useGeneratedKeys"), false));
    // 配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。
    configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));
    // 设置超时时间，它决定数据库驱动等待数据库响应的秒数。
    configuration.setDefaultStatementTimeout(integerValueOf(props.getProperty("defaultStatementTimeout"), null));
    // 为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。
    configuration.setDefaultFetchSize(integerValueOf(props.getProperty("defaultFetchSize"), null));
    // 指定语句默认的滚动策略。（新增于 3.5.2）
    configuration.setDefaultResultSetType(resolveResultSetType(props.getProperty("defaultResultSetType")));
    // 是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。
    configuration.setMapUnderscoreToCamelCase(booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false));
    // 是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。
    configuration.setSafeRowBoundsEnabled(booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false));
    /** MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。
     * 默认值为 SESSION，会缓存一个会话中执行的所有查询。
     * 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。
     */
    configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));
    // 当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。
    configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER")));
    // 指定对象的哪些方法触发一次延迟加载
    configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));
    // 是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。
    configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));
    // 指定动态 SQL 生成使用的默认脚本语言。
    configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));
    // 指定 Enum 使用的默认 TypeHandler 。（新增于 3.4.5）
    configuration.setDefaultEnumTypeHandler(resolveClass(props.getProperty("defaultEnumTypeHandler")));
    // 指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。
    configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));
    // 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1）
    configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));
    // 当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）
    configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));
    // 指定 MyBatis 增加到日志名称的前缀。
    configuration.setLogPrefix(props.getProperty("logPrefix"));
    /**
     * 指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。
     * 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3）
     */
    configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory")));
  }

MyBatis 最佳实践

批量插入伪代码

        SqlSession sqlSession = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            sqlSession = sqlSessionFactory.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
            List<Student> studentList = new ArrayList<>(16);
            for (int i = 0; i < 5; i++) {
                int hashCodeV = UUID.randomUUID().toString().hashCode();
                hashCodeV = hashCodeV>0?hashCodeV:-hashCodeV;
                Student student = new Student("滕飞"+i,String.valueOf(hashCodeV));
                studentList.add(student);
            }
            mapper.insertDataBatch(studentList);
            sqlSession.commit();
        } catch (IOException e) {
            log.error("StudentMapper insertDataBatch fail.", e);
        } finally {
            if (Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }

批量查询伪代码

        SqlSession sqlSession = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            sqlSession = sqlSessionFactory.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
            List<Integer> ids = Arrays.asList(1,12,13,14,15);
            List<Student> students = mapper.selectDataByIdBatch(ids);
            log.info("students jsonStr is {}",JSON.toJSONString(students));
        } catch (IOException e) {
            log.error("StudentMapper insertDataBatch fail.", e);
        } finally {
            if (Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }

延迟加载伪代码

        SqlSession sqlSession = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            sqlSession = sqlSessionFactory.openSession();
            StaffMapper mapper = sqlSession.getMapper(StaffMapper.class);
            StaffAndDepartment staffAndDepartment = mapper.findStaffWithDepartmentQuery(1);
            System.out.println("-----------:"+staffAndDepartment.getClass());
            // 如果开启了延迟加载，会在使用的时候才发出SQL
            // equals,clone,hashCode,toString也会触发延迟加载
            // System.out.println("-----------调用toString方法:"+blog);
//            System.out.println("-----------getAuthor:"+staffAndDepartment.toString());
            // 如果 aggressiveLazyLoading = true ，也会触发加载，否则不会
            System.out.println("-----------getName:"+staffAndDepartment.getName());
        } catch (IOException e) {
            log.error("系统异常.", e);
        } finally {
            if (Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }

翻页

逻辑翻页和物理翻页区别
- 逻辑分页-假分页：将数据全部加载到内存，根据rowBound里面的偏移量，和条数，将偏移量之前的都去掉，只去从偏移量开始后指定数量的那一部分；
- 物理分页- 真分页：将分页信息硬编码到sql语句中，到库里直接查询需要的那部分数据

逻辑翻页伪代码

        SqlSession sqlSession = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            sqlSession = sqlSessionFactory.openSession();
            StaffMapper mapper = sqlSession.getMapper(StaffMapper.class);
            int start = 0; // offset
            int pageSize = 5; // limit
            RowBounds rowBounds = new RowBounds(start, pageSize);
            List<Staff> staffs = mapper.findStaffAll(rowBounds);
            log.info("staffs jsonStr is {}", JSON.toJSONString(staffs));
        } catch (IOException e) {
            log.error("系统异常.", e);
        } finally {
            if (Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }

物理翻页伪代码

/**
* mapper 配置
**/
@Select("select name from staff limit #{start},#{end}")
    List<Staff> findStaffPhysical(@Param("start") int start, @Param("end") int end);

SqlSession sqlSession = null;
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            sqlSession = sqlSessionFactory.openSession();
            StaffMapper mapper = sqlSession.getMapper(StaffMapper.class);
            List<Staff> staffs = mapper.findStaffPhysical(0, 5);
            log.info("staffs jsonStr is {}", JSON.toJSONString(staffs));
        } catch (IOException e) {
            log.error("系统异常.", e);
        } finally {
            if (Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }