使用mybatis框架生成带hint的sql语句，hint不生效

OceanBase 技术问题
#1

【 使用环境 】生产环境
【 OB or 其他组件 】OB
【 使用版本 】4.2.1
【问题描述】清晰明确描述问题
使用mybatis框架生成带hint的sql语句，hint不生效，hint的添加方式是：
select /*+ BEGIN_OUTLINE_DATA LEADING(@"SEL$2" ("u"@"SEL$2" ("ro"@"SEL$2" "test"."r"@"SEL$2"))) USE_HASH(@"2" ("ro"@"SEL$2" "questionnaire"."r"@"SEL$2")) */ * from ...

请问这是什么原因导致的呢？

#3

只有这个hint不生效吗？可以换成一个简单的试下
感觉有两个可能，1、mybatis配置的问题，2、这个hint中的特殊字符被转义

#4

这个可以生效：
explain extended select /*+ BEGIN_OUTLINE_DATA LEADING(@"SEL$C6D21C0F" ("test"."test_user1"@"SEL$1" "test"."test_user2"@"SEL$1")) USE_HASH(@"SEL$C6D21C0F" "test"."test_user2"@"SEL$1") FULL(@"SEL$C6D21C0F" "test"."test_user1"@"SEL$1") FULL(@"SEL$C6D21C0F" "test"."test_user2"@"SEL$1") OUTER_TO_INNER(@"SEL$1") OPTIMIZER_FEATURES_ENABLE('4.3.1.0') END_OUTLINE_DATA*/ * from test_user1 join test_user2 on test_user1.id = test_user2.id
生成环境上的比这个要复杂的多，
怎么确定是不是mybatis配置的问题呢？如果是mybatis配置的问题应该改哪里呢？

#5

mybatis我懂的也不多，抱歉

#6

@论坛小助手

#7

根据您提供的信息和问题描述，我们可以从以下几个方面分析并解决问题：

1. Hint 不生效的原因

根据文档片段中的内容（如文档片段 2 和文档片段 4），OceanBase 数据库的 Hint 主要用于指定优化器的行为，并按照 Hint 执行 SQL 查询。如果 Hint 不生效，可能有以下几种原因：

  • Hint 的语法或格式错误：如果 Hint 的语法不符合 OceanBase 的规范，优化器将忽略该 Hint。
  • 表名或别名冲突：如果 Hint 中指定的表名或别名在当前 Query Block 中不存在，或者存在冲突，Hint 将无效（参考文档片段 1）。
  • SQL 语句被框架修改：某些框架（如 MyBatis）可能会对生成的 SQL 进行额外的处理或包装，导致 Hint 被移除或失效。

在您的场景中，explain extended 可以正常生效，但实际运行时 Hint 不生效，这可能与 MyBatis 的配置或 SQL 生成逻辑有关。

2. 如何确定是否是 MyBatis 配置的问题

为了确认是否是 MyBatis 的问题，可以按照以下步骤排查：

(1) 检查 MyBatis 是否修改了 SQL

MyBatis 在执行 SQL 时，可能会对原始 SQL 进行动态拼接或参数替换。您可以启用 MyBatis 的日志功能，查看最终发送到数据库的 SQL 是否包含正确的 Hint。

  • 启用 MyBatis 日志：
    在 MyBatis 的配置文件中，设置日志级别为 DEBUG 或 TRACE，以便查看生成的 SQL。
    log4j.logger.org.mybatis=DEBUG
log4j.logger.com.example.mapper=DEBUG
    如果最终生成的 SQL 中没有包含 Hint，则说明 MyBatis 在生成 SQL 时可能移除了 Hint。

(2) 检查 MyBatis 的 SQL 拼接逻辑

MyBatis 提供了多种方式生成 SQL，包括 XML 映射文件和注解方式。如果使用的是 XML 映射文件，请确保 Hint 已正确添加到 <select> 标签中。

例如：

<select id="selectWithHint" resultType="YourResultType">
    SELECT /*+ BEGIN_OUTLINE_DATA LEADING(@"SEL$2" ("u"@"SEL$2" ("ro"@"SEL$2" "test"."r"@"SEL$2"))) USE_HASH(@"2" ("ro"@"SEL$2" "questionnaire"."r"@"SEL$2")) */
    * FROM test_user1 JOIN test_user2 ON test_user1.id = test_user2.id
</select>

如果使用的是注解方式，请确保 Hint 已正确添加到 @Select 注解中：

@Select("SELECT /*+ BEGIN_OUTLINE_DATA LEADING(...) USE_HASH(...) */ * FROM test_user1 JOIN test_user2 ON test_user1.id = test_user2.id")
List<YourResultType> selectWithHint();

(3) 检查 MyBatis 插件或拦截器

如果您在项目中使用了 MyBatis 插件或拦截器（如分页插件、性能监控插件等），这些插件可能会对 SQL 进行修改。请检查相关插件的实现逻辑，确保它们不会移除或修改 Hint。

3. 如果是 MyBatis 配置的问题，应该如何修改？

如果确认问题是由于 MyBatis 的配置或插件导致的，可以尝试以下解决方案：

(1) 确保 Hint 不被移除

在 MyBatis 的 SQL 拼接过程中，确保 Hint 不被移除。可以通过以下方式实现：

  • 自定义插件：编写一个 MyBatis 插件，在 SQL 执行前检查并保留 Hint。
  • 禁用插件的 SQL 修改功能：如果某些插件会修改 SQL，请检查其配置选项，禁用不必要的 SQL 修改功能。

(2) 使用动态 SQL

如果 SQL 较为复杂，建议使用 MyBatis 的动态 SQL 功能，确保 Hint 能够正确添加到 SQL 中。例如：

<select id="selectWithHint" resultType="YourResultType">
    <bind name="hint" value="'/*+ BEGIN_OUTLINE_DATA LEADING(...) USE_HASH(...) */'"/>
    ${hint} SELECT * FROM test_user1 JOIN test_user2 ON test_user1.id = test_user2.id
</select>

(3) 升级 MyBatis 版本

如果使用的 MyBatis 版本较旧，可能存在兼容性问题。建议升级到最新版本，并查看其官方文档中关于 SQL 拼接和 Hint 的支持情况。

4. 其他可能的原因

如果排除了 MyBatis 的问题，还可以从以下方面进一步排查：

  • OceanBase 的版本特性：您提到使用的版本是 4.2.1。根据文档片段 6，该版本已经支持无需指定 Hint 自适应串行执行的功能。因此，某些 Hint 可能会被优化器忽略。
  • SQL 语句的复杂度：如果 SQL 语句过于复杂，优化器可能会选择忽略部分 Hint。可以尝试简化 SQL 语句，逐步排查问题。

5. 总结

根据文档库中的信息（参考文档片段 1 至 4），以及您的问题描述，Hint 不生效的原因可能是 MyBatis 的配置或插件导致的。建议按照以下步骤排查：

  1. 启用 MyBatis 日志，查看最终生成的 SQL 是否包含正确的 Hint。
  2. 检查 MyBatis 的 SQL 拼接逻辑，确保 Hint 已正确添加。
  3. 排查 MyBatis 插件或拦截器是否修改了 SQL。
  4. 如果问题仍未解决，可以尝试简化 SQL 语句，逐步排查。

如果仍有疑问，建议联系 OceanBase 的人工答疑团队，获取更专业的技术支持。

检索到的文档如下:

  1. 阅读和管理 OceanBase 数据库 SQL 执行计划
  2. 用户自定义变量
  3. 读写分离
  4. 异常处理的限制