Bootstrap

Spring Boot 中使用 ShardingSphere-Proxy

Spring Boot 中使用 ShardingSphere-Proxy,与使用 ShardingSphere-JDBC 有所不同。ShardingSphere-Proxy 作为独立的代理层,处理数据库分库分表、路由和负载均衡等功能,而应用程序通过 JDBC 连接到代理服务,而不是直接连接数据库。因此,集成 ShardingSphere-Proxy 的方式主要包括配置 Spring Boot 连接到 ShardingSphere-Proxy。

下面是如何在 Spring Boot 中配置和使用 ShardingSphere-Proxy 的详细步骤。

1. ShardingSphere-Proxy 部署

首先,确保你已经部署了 ShardingSphere-Proxy。ShardingSphere-Proxy 是一个独立的代理服务,它可以通过下载官方的 ShardingSphere-Proxy 二进制包来进行部署,或者通过 Docker 容器部署。

部署 ShardingSphere-Proxy

  1. 下载 ShardingSphere-Proxy

  2. 配置 ShardingSphere-Proxy

    • 配置文件一般位于 conf 文件夹中的 server.yaml 文件,主要配置数据源、分片策略等。
    • 下面是一个基本的 server.yaml 配置示例:
    server:
      port: 3307  # 代理服务监听的端口,Spring Boot 连接此端口
    
    datasource:
      names: ds0, ds1
      ds0:
        url: jdbc:mysql://localhost:3306/db0
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
      ds1:
        url: jdbc:mysql://localhost:3306/db1
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
    
    sharding:
      tables:
        user:
          actualDataNodes: ds${0..1}.user${0..1}
          tableStrategy:
            inline:
              shardingColumn: user_id
              algorithmExpression: user${user_id % 2}
      defaultDatabaseStrategy:
        inline:
          shardingColumn: user_id
          algorithmExpression: ds${user_id % 2}
      defaultTableStrategy:
        inline:
          shardingColumn: user_id
          algorithmExpression: user${user_id % 2}
    
    • 数据源配置ds0ds1 是两个数据库实例,分别指向不同的 MySQL 数据库。
    • 分片配置user 表通过 user_id 字段进行分片,表和数据库都会根据 user_id 进行分片。
  3. 启动 ShardingSphere-Proxy

    • 通过命令行启动代理服务:

      bin/start.sh
      
    • ShardingSphere-Proxy 会在配置的端口上启动,例如 3307。

2. Spring Boot 配置

ShardingSphere-Proxy 已经作为一个独立服务运行,因此在 Spring Boot 中,应用程序通过 JDBC 连接到 ShardingSphere-Proxy,而不是直接连接到数据库。

2.1 添加依赖

首先,在 pom.xml 中添加 ShardingSphere-Proxy 所需的 JDBC 驱动和 Spring Boot 相关依赖。

<dependencies>
    <!-- Spring Boot Starter DataSource -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <!-- MySQL JDBC Driver -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <!-- HikariCP connection pool (optional) -->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
    </dependency>
</dependencies>

2.2 配置 application.yml

application.yml 中配置 Spring Boot 连接到 ShardingSphere-Proxy。

spring:
  datasource:
    url: jdbc:mysql://localhost:3307  # ShardingSphere-Proxy 代理服务的地址和端口
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
    hikari:
      maximum-pool-size: 10
   

在配置中:

  • 数据源配置:指向 ShardingSphere-Proxy 服务的 JDBC URL(例如:jdbc:mysql://localhost:3307)。
  • ShardingSphere 配置:在 Spring Boot 中配置与 ShardingSphere 相关的分片规则。

2.3 配置 DataSource 连接池(可选)

可以使用 HikariCP 或任何其他连接池来配置数据源。Spring Boot 会自动为你配置连接池。

spring:
  datasource:
    hikari:
      maximum-pool-size: 10
      minimum-idle: 5

2.4 配置实体和仓库

定义实体类和 Spring Data JPA 仓库接口与通常的方式相同。以 User 表为例,创建实体类和仓库接口:

@Entity
public class User {
    @Id
    private Long userId;
    private String userName;

    // getters and setters
}
public interface UserRepository extends JpaRepository<User, Long> {
    User findByUserId(Long userId);
}

2.5 在控制器中使用数据

然后,你可以在控制器中像使用普通的 Spring Data JPA 一样使用分库分表后的数据:

@RestController
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping("/user/{userId}")
    public User getUser(@PathVariable Long userId) {
        return userRepository.findByUserId(userId);
    }
}

3. ShardingSphere-Proxy 访问与调试

一旦你启动了 Spring Boot 应用,并且 ShardingSphere-Proxy 正在运行,你的应用就可以通过代理与多个数据库进行交互。你可以通过访问 Spring Boot 提供的 API 来执行查询操作,而 ShardingSphere-Proxy 会根据配置的分库分表策略自动进行路由和分片。

3.1 查看 Proxy 日志

你可以在 ShardingSphere-Proxy 的控制台或日志文件中查看 SQL 请求和路由信息,确保数据通过代理服务正确分片。

4. 事务管理

ShardingSphere-Proxy 支持分布式事务管理,你可以像平常一样在 Spring Boot 中使用 Spring 的事务管理,ShardingSphere 会确保跨多个数据库的事务一致性。

@Transactional
public void createUser(User user) {
    userRepository.save(user);
}

ShardingSphere-Proxy 会在后台处理多数据源之间的事务提交和回滚。

总结

  • ShardingSphere-Proxy 是一个独立的数据库代理层,它在 Spring Boot 中通过 JDBC 连接到 ShardingSphere-Proxy 服务,而不是直接连接数据库。
  • 配置 ShardingSphere-Proxy 的关键在于设置 application.yml 中的数据库连接地址为代理服务的地址(如 jdbc:mysql://localhost:3307)。
  • ShardingSphere-Proxy 适用于需要集中管理和跨多个应用共享数据库服务的场景,尤其是在微服务架构中。

这种方式的好处是:你可以集中管理多个数据库实例,并且通过统一的代理服务来处理分片、路由和事务等复杂逻辑,而无需每个应用都嵌入分库分表逻辑。

 

 

悦读

道可道,非常道;名可名,非常名。 无名,天地之始,有名,万物之母。 故常无欲,以观其妙,常有欲,以观其徼。 此两者,同出而异名,同谓之玄,玄之又玄,众妙之门。

;