SpringBoot 整合 oceanbase，实现 oracle 无缝切换到 oceanbase

前言

  随着去“IOE”化的潮流，近些年来，许多与国家相关的项目不约而同地往”国产化“方向靠拢，不可避免地，一些项目可能需要进行数据库迁移。

  Oceanbase 作为蚂蚁集团完全自主研发的国产原生分布式数据库，在 TPC-C 核 TPC-H 的测试上有过刷新世界纪录的辉煌成就，已连续 9 年稳定支撑双 11，在阿里集团中多个领域如淘宝、花呗、芝麻信用等投入使用，它具有云原生、强一致性、高度兼容 mysql 和 oracle 等特性，非常适合一些需要往国产化数据库迁移的项目。

  本文以 Springboot+Mybatis-plus 为技术栈，通过实战讲解 oracle 迁移到 oceanbase 流程，希望能够帮助到有需要的朋友。

Springboot 整合 Oceanbase

  前提：Oceanbase 数据库高度兼容 Oracle 数据库，可以通过 Oracle 租户的方式近乎无成本地进行数据库迁移。

一、引入依赖

  因为 Oceanbase 的数据库驱动包还没有上传到 maven 的中央仓库 mvnrepository 中，因此需要跟 Oceanbase 官方获取，获取方式如下：

• 方式一、到Oceanbase官方网站，然后联系官方人员获取

• 方式二、直接下载博主上传到百度云的依赖包(推荐)：Oceanbase依赖包下载
  

  在项目中引入依赖，可以通过本地引入的方式或者将获取到的 jar 包上传到公司私服上，然后使用坐标引用，本文案例是通过本地引入的方式进行：

<dependency>            <groupId>com.alipay.oceanbase</groupId>            <artifactId>oceanbase-client</artifactId>            <version>2.2.7.2</version>            <scope>system</scope>            <systemPath>${basedir}/src/main/resources/lib/oceanbase-client-2.2.7.2.jar</systemPath></dependency>

二、添加数据库连接配置

  配置信息如下：

    url: jdbc:oceanbase://ip:端口/scheme名    username: 用户名@租户名#集群名 或者 集群名:租户名:用户名    password: 密码    driver-class-name: com.alipay.oceanbase.jdbc.Driver

  参数详解，oceanbase 的 username 组成相比于其他数据库连接较特别，支持两种写法即：用户名 @租户名 #集群名 或者 集群名:租户名:用户名。如果想用使用 obclient 命令行的方式连接 oceanbase，可以参考：使用obclient连接oceabase数据库

三、处理异常 Mybatis-plus 框架异常

  完成上面两个步骤后，正常情况下就可以跟使用其他数据库一样使用 Mybatis 等持久层框架对数据库进行增删改查等操作，但是，如果在项目中使用到了 Mybatis-Plus 框架，则还需要额外进行处理以下问题。

  场景复现: 项目在迁移之前，使用的是 Mybatis-Plus 框架中的 API 操作 Oracle 数据完成分页功能查询，切换到 Oceanbase 的 oracle 租户后，执行原来的功能会出现语法问题，提示信息因为使用了 oceanbase 的 oracle 租户不支持的 limit 语法。

  问题排查：

  经过跟踪 Mybatis-plus 源码发现，其在获取数据库方言时是根据配置文件中连接数据库 url 中的协议进行匹配的，这样导致即使使用了 oceanbase 的 oracle 组合，在设置方言时也会匹配成 oceanbase 方言，而不是 oracle 的方言，从而出现的语法问题。

  解决方案：

  Mybatis-plus 的分页依赖于 PaginationInnerInterceptor 插件，可以继承该类重写数据库的查找方言方法，使得在数据库连接 url 为 oceanbase 协议时返回的的方言为 oracle，这样就可以支持项目由 oracle 数据库无缝切换到 oceanbase 的 oracle 租户(mysql 租户时同理)，重写代码如下：

@Slf4j@Configuration(value = "PaginationInnerInterceptor")public class PaginationInnerInterceptorConfig extends PaginationInnerInterceptor {
    /**     * 数据库类型     */    private DbType dbType;    /**     * 方言实现类     */    private IDialect dialect;
    /**     * 重写获取分页方言类的逻辑，使得oceanbase的oracle租户时能够走oracle方言     * @return 分页方言类     */    @Override    protected IDialect findIDialect(Executor executor) {        String jdbcUrl = null;        try {            Connection conn = executor.getTransaction().getConnection();            jdbcUrl = conn.getMetaData().getURL();            // 项目使用的是oceanbase的oracle租户,方言要使用oracle的，否则会有语法问题            if (jdbcUrl.contains(":oceanbase:") || jdbcUrl.contains(":oracle:")) {                IDialect tempDialect = DialectFactory.getDialect(DbType.ORACLE);                return tempDialect;            }            if (dialect != null) {                return dialect;            }            if (dbType != null) {                dialect = DialectFactory.getDialect(dbType);                return dialect;            }            return DialectFactory.getDialect(JdbcUtils.getDbType(executor));        } catch (Exception e) {            return DialectFactory.getDialect(DbType.OTHER);        }
    }
} 

数据库方言

  从上面的例子看到，在切换到 oceanbase 时，因为数据库方言的问题导致原有的项目无法无缝切换，那数据库方言到底是什么？为什么需要它呢？

  方言： 通俗的理解，方言就是具有有些地方特色的语言，它通常只能被某些地区的人能识别，不同地方可以存在不同的方言，就像广东有粤语，广西有壮语、勉语一样。

  数据库中的方言，则可以理解成遵循 SQL 统一规范前提下不同的拓展实现，如 MySQL、Oracle 等，在不同的实现中，可能存在相同或者不同的语法，如分页语法：mysql 是使用 Limit，oracle 则使用 rownum

设置方言的必要性

  对于 ORM 框架(mybatis、jpa)而言，在上层都是统一封装，无差别调用，比如分页功能，无论底层是使用哪一种类型的数据库，在 ORM 框架中都是调用某个特定的 API 接口，但是在实际的底层中，要根据使用了哪些数据库来调用不同的 DBAPI，因此需要在 ORM 中指定使用哪种方言。

  比如上文提到的 Mybatis-plus 框架，则是通过数据库连接的 url 中的关键字进行设置数据库的方言。

  同时，数据库方言可以用来实现对查询的优化，实现分页语句以及 count 语句的自动生成，方言会生成适合于该特定数据库的效率较高的 SQL 语法。

数据库驱动与方言

  数据库驱动程序： 是实现用于连接数据库的协议（ODBC，JDBC）的程序。它是一个将通用接口连接到特定供应商实现的适配器，就像打印机驱动程序一样。

  方言： 数据库方言是平台无关软件（JPA，Hibernate 等）的配置设置，允许此类软件将其通用 SQL 语句转换为供应商特定的 DDL,DML。

  区别： 也就是说，“数据库驱动程序”是具有单一具体含义的公认行业术语，而“数据库方言”未被类似地识别，因此指代不同上下文中的不同概念。

写在最后

  随着世界格局动荡，为了避免关键时刻被“卡脖子”，发展自主可控的国产软件势在必行，数据库作为其中核心的一环，想要搭建健康的生态，需要更多有志之士参与。

  Oceanbase 作为完全自主研发的国产化分布式数据库，对于想要往国产化迁移的项目以及想要实现完全国产化的公司，确实是一个能够进行参考的选项。