{"id":15024521,"url":"https://github.com/ifyun/rw-separate-spring-boot-starter","last_synced_at":"2025-08-14T05:12:23.285Z","repository":{"id":57743318,"uuid":"208377367","full_name":"ifyun/rw-separate-spring-boot-starter","owner":"ifyun","description":"Spring Boot 多主从数据源读写分离","archived":false,"fork":false,"pushed_at":"2021-04-28T05:44:26.000Z","size":30,"stargazers_count":8,"open_issues_count":0,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T02:11:48.894Z","etag":null,"topics":["multi-datasource","read-write-separation","spring-boot"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ifyun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-14T02:22:26.000Z","updated_at":"2021-07-09T07:11:03.000Z","dependencies_parsed_at":"2022-08-26T01:33:05.270Z","dependency_job_id":null,"html_url":"https://github.com/ifyun/rw-separate-spring-boot-starter","commit_stats":null,"previous_names":["ifyun/rw-separate-spring-boot-starter","imcloudfloating/rw-separate-spring-boot-starter"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ifyun%2Frw-separate-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ifyun%2Frw-separate-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ifyun%2Frw-separate-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ifyun%2Frw-separate-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ifyun","download_url":"https://codeload.github.com/ifyun/rw-separate-spring-boot-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530085,"owners_count":21119585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["multi-datasource","read-write-separation","spring-boot"],"created_at":"2024-09-24T20:00:28.960Z","updated_at":"2025-04-12T06:33:04.957Z","avatar_url":"https://github.com/ifyun.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Boot 主从读写分离\n\n![GitHub last commit](https://img.shields.io/github/last-commit/imcloudfloating/rw-separate-spring-boot-starter?style=flat-square)\n![GitHub license](https://img.shields.io/github/license/imcloudfloating/rw-separate-spring-boot-starter?style=flat-square)\n[![JitPack](https://img.shields.io/jitpack/v/github/imcloudfloating/rw-separate-spring-boot-starter?style=flat-square)](https://jitpack.io/#imcloudfloating/rw-separate-spring-boot-starter)\n\nrw-separate-spring-boot-starter 是一个可以实现任意多个主从数据源读写分离的工具，\n使用 Hikari 连接池（暂不支持其他连接池，后期可能会添加支持）。\n\n\u003e 本工具库只是替换了 Spring Boot 数据源，你可以随意选择 ORM 框架，JPA，MyBatis 都可以使用。\n\n## 使用\n\nStep 1. 添加 jitpack 到 pom.xml：\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003ejitpack.io\u003c/id\u003e\n        \u003curl\u003ehttps://www.jitpack.io\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\nStep 2. 添加依赖：\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.imcloudfloating\u003c/groupId\u003e\n    \u003cartifactId\u003erw-separate-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n首先需要排除默认的 `DataSourceAutoConfiguration` ：\n\n```java\n@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})\npublic class FooApplication {\n\n    public static void main(String[] args) {\n        SpringApplication.run(FooApplication.class, args);\n    }\n}\n```\n\n\u003e 不排除默认的 `DataSource` 会报冲突错误。\n\n### application.yml 配置\n\n示例：\n\n```yaml\nspring:\n  separated-datasource:\n    # 主库数据源\n    masters:\n      - dataSourceName: master_1\n        hikari:\n          driverClassName: com.mysql.cj.jdbc.Driver\n          url: jdbc:mysql://10.0.0.100:3306/test\n          username: root\n          password: root\n\n    # 从库数据源\n    slaves:\n      - dataSourceName: slave_1\n        hikari:\n          driverClassName: com.mysql.cj.jdbc.Driver\n          url: jdbc:mysql://10.0.0.101:3306/test\n          username: reader\n          password: reader\n    \n      - dataSourceName: slave_2\n        hikari:\n          driverClassName: com.mysql.cj.jdbc.Driver\n          url: jdbc:mysql://10.0.0.102:3306/test\n          username: reader\n          password: reader\n```\n\n- 以上配置文件中的 `hikari` 部分，可以参考 `HikariConfig` 类中的 setter 方法来填写（首字母小写）\n- `dataSourceName` 为数据源的名称，请避免名称重复（如果不需要显式地指定数据源，可以不设置）\n- 当设置多个数据源时，默认使用轮询的方式来切换数据源\n- 可以只设置 `master` ，使用名称切换，当作多数据源使用，使用 `@Write(\"datasource\")` 切换即可\n\n### 使用注解实现读写分离\n\n```java\n@Service\npublic class FooService {\n\n    @Resource\n    FooMapper fooMapper;\n    \n    /**\n     * 使用读库\n     */\n    @Read\n    public List\u003cItem\u003e getFoo() {\n        return fooMapper.getAll();\n    }\n\n    /**\n     * 使用写库\n     */\n    @Write\n    public int addFoo(Foo foo) {\n        return fooMapper.add(foo);\n    }\n}\n```\n\n可以使用参数显式地指定数据源（需要在 `application.yml` 中指定 `dataSourceName`）:\n\n```java\n@Service\npublic class FooService {\n\n    /**\n     * 显式地指定数据源为 master_1\n     */\n    @Write(\"master_1\")\n    public int addFoo(Foo foo) {\n        return fooMapper.add(foo);\n    }\n\n}\n```\n\n显式地指定数据源时，`@Write` 只能指定 masters 中的数据源，`@Read` 只能指定 slaves 中的数据源。\n\n\u003e 可以在 DAO 层使用，但是无法支持事务。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fifyun%2Frw-separate-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fifyun%2Frw-separate-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fifyun%2Frw-separate-spring-boot-starter/lists"}