Oceanus 数据库中间件使用教程

1. 项目介绍

Oceanus 是由 58 同城开发的数据库中间件，旨在解决不同业务场景下的数据库存储需求。尽管业务各异，但技术难点相似，Oceanus 致力于提供一个功能简单、可依赖、易于上手、易于扩展、易于集成的解决方案。Oceanus 支持各种类型的需求，甚至是平台化系统，拥抱开源，提供各类插件机制集成其他开源项目。新手可以在几分钟内上手编程，分库分表逻辑不再与业务紧密耦合，扩容有标准模式，减少意外错误的发生。

2. 项目快速启动

2.1 环境准备

• Java 8 或更高版本
• Maven 3.x
• Git

2.2 克隆项目

首先，克隆 Oceanus 项目到本地：

git clone https://github.com/58code/Oceanus.git
cd Oceanus

2.3 构建项目

使用 Maven 构建项目：

mvn clean install

2.4 配置文件

在 src/main/resources 目录下创建 oceanus.properties 文件，配置数据库连接信息：

datanode.name=mydb
datanode.url=jdbc:mysql://localhost:3306/mydatabase
datanode.username=root
datanode.password=root

2.5 启动示例

编写一个简单的 Java 类来测试 Oceanus：

import com.wuba.oceanus.core.Oceanus;

public class OceanusDemo {
    public static void main(String[] args) {
        Oceanus oceanus = Oceanus.getInstance();
        oceanus.init("src/main/resources/oceanus.properties");

        // 执行 SQL 查询
        String sql = "SELECT * FROM user";
        oceanus.executeQuery(sql);
    }
}

2.6 运行示例

编译并运行 OceanusDemo 类：

javac -cp target/oceanus-all-1.0-SNAPSHOT.jar OceanusDemo.java
java -cp target/oceanus-all-1.0-SNAPSHOT.jar:. OceanusDemo

3. 应用案例和最佳实践

3.1 分库分表

Oceanus 支持分库分表功能，通过配置文件定义 table 标签，可以实现 SQL 的路由和重写。例如：

table.name=user
table.shardingKey=id
table.shardingCount=4

3.2 监控与报警

Oceanus 内置了监控埋点功能，可以通过自定义 tracker 实现类来监控系统性能。例如：

public class MyTracker implements Tracker {
    @Override
    public void track(String event, long duration) {
        if (duration > 1000) {
            System.out.println("Event " + event + " took too long: " + duration + "ms");
        }
    }
}

4. 典型生态项目

4.1 MyBatis 集成

Oceanus 可以很好地集成到 MyBatis 中，只需引用 Oceanus 插件，编写配置文件，并改写 DataSource 实现即可。

4.2 Hibernate 集成

同样，Oceanus 也可以集成到 Hibernate 中，通过改写 ConnectionProvider 实现来实现分库分表等功能。

4.3 其他开源项目

Oceanus 的设计原则之一是“接地气，拥抱开源”，因此可以与其他开源项目如 Spring、Dubbo 等无缝集成，提供更强大的功能和更好的扩展性。

---

通过以上步骤，您可以快速上手 Oceanus 数据库中间件，并根据实际需求进行扩展和优化。