{"id":19993296,"url":"https://github.com/QNJR-GROUP/sharding-method","last_synced_at":"2025-05-04T12:31:10.679Z","repository":{"id":54566660,"uuid":"98815720","full_name":"QNJR-GROUP/sharding-method","owner":"QNJR-GROUP","description":"分表分库的新思路——服务层Sharding框架，全SQL、全数据库兼容，ACID特性与原生数据库一致，能实现RR级别读写分离，无SQL解析性能更高","archived":false,"fork":false,"pushed_at":"2017-08-28T16:01:57.000Z","size":58,"stargazers_count":202,"open_issues_count":4,"forks_count":63,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-04-08T01:42:09.317Z","etag":null,"topics":["db2","mariadb","mysql","oracle","sharding","sharding-jdbc","sqlserver"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QNJR-GROUP.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-30T18:05:09.000Z","updated_at":"2024-10-27T02:41:02.000Z","dependencies_parsed_at":"2022-08-13T20:00:32.386Z","dependency_job_id":null,"html_url":"https://github.com/QNJR-GROUP/sharding-method","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNJR-GROUP%2Fsharding-method","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNJR-GROUP%2Fsharding-method/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNJR-GROUP%2Fsharding-method/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNJR-GROUP%2Fsharding-method/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QNJR-GROUP","download_url":"https://codeload.github.com/QNJR-GROUP/sharding-method/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252334293,"owners_count":21731375,"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":["db2","mariadb","mysql","oracle","sharding","sharding-jdbc","sqlserver"],"created_at":"2024-11-13T04:52:34.484Z","updated_at":"2025-05-04T12:31:05.672Z","avatar_url":"https://github.com/QNJR-GROUP.png","language":"Java","funding_links":[],"categories":["Java","数据库中间件"],"sub_categories":[],"readme":"# 核心特性\n全数据库全SQL兼容、完美RR级别读写分离、与原生一致的ACID特性、轻量简单易扩展\n\n# 另外一个轮子的意义\n很多人会质疑 市面上较为流行的Sharding中间件/应用层Sharing框架已经有很多，他们都已经发展了很久了，功能也很强大，为什么要一个再重复制造这么个轮子呢？\n\n之所以这里有一个新的轮子并不是因为我懒得无事，而是我对目前基于传统RDB上Sharding框架的设计的理念不太赞同，虽然他们或许都很圆，跑的很快，但是使用不当的话，容易翻车。我期望的轮子是既能跑的快，但也能跑的稳。\n\n\n我们目前国内主流的Sharding框架都是基于SQL来完成，其主要流程：\n1. 是解析上层传入的SQL\n2. 结合对应的分表分库配置，对传入的SQL进行改写并分发到对应的单机数据库上\n3. 获得各个单机数据库的返回结果后，根据原SQL归并结果，返回用户期待的结果\n\n这种实现希望提供一个屏蔽底层Sharding逻辑的解决方案，对上层应用来说，只有一个RDB,这样应用可以透明访问多个数据库。\n\n然而，这仅仅只是一个美丽的目标。因种种原因，这些层次的Sharding方案都无法提供跟原生数据库一样的功能：\n* ACID里的A无法保证\n* ACID里的C可能被打破\n* ACID里的I与原生不一致\n* 由于SQL解析复杂，性能等考虑，很多数据库SQL不支持\n\n正因为存在这些差异，本质上，上层应用必须明确的知道经过此类Sharding方案后得到的查询结果、事务结果与原生的有啥不一致才能写出正确可靠的程序。\n\n**因此，基于SQL的Sharding方案对应用层并不透明。**\n\n如果要基于SQL层的框架写出正确可靠的代码的话，我们需要遵循一些范式：\n* 所有事务（包括读、写）都不能跨库\n* 跨分片的查询提供的隔离级别与原生不一致\n* 某些聚合查询的性能消耗很大，要慎用\n* ......\n\n这些范式对于实际上就是使用Sharding数据库框架时，不透明的表现。而这些表现都是隐式的隐藏于SQL中，难以REVIEW。\n\n而且这些范式对于很多人来说不一定能够充分理解执行的含义，以至于忽略了。\n\n由上面最重要的一点“所有事务（包括读、写）都不能跨库”决定，**一个合理设计的代码里绝大多数的业务代码中数据库访问都不会跨分区，核心业务代码都在同一分区内进行。**\n因此，我们大多数情况下，需要的只是一个协助我们便捷选择对应分片的一个框架。\n\n因此我的想法很简单，提供一个方便透明选择分片、并辅以自动生成ID的框架。对于需要访问多个分片的少数业务，框架提供手段，便捷地获取所有分片数据库的数据，并由用户自行归并得出所需结果（简单的归并框架可以自动进行）。\n\n# 基本使用方法\n\n先简略展示以下框架的基本用法（以下代码在UT案例中，但为突出重点，有所裁剪）\n\nService层\n\n\t@Service\n\t@ShardingContext(dataSourceSet=\"orderSet\",shardingKeyEls=\"[user].userId\",shardingStrategy=\"@modUserId\",generateIdStrategy=\"@snowflaker\",generateIdEls=\"[user].userId\")\n\tpublic class UserServceImpl {\n\t\t\n\t\t@Autowired\n\t\tprivate UserDaoImpl userDao;\n\t\t\n\t\t@Transactional\n\t\t@SelectDataSource\n\t\tpublic void updateUser(User user){\n\t\t\tuserDao.updateUser(user);\n\t\t}\n\t\t\n\t\t@Transactional\n\t\t@SelectDataSource\n\t\t@GenerateId\n\t\tpublic void saveUser(User user){\n\t\t\tuserDao.saveUser(user);\n\t\t}\n\t\t\n\t\t@Transactional(readOnly=true)\n\t\t@SelectDataSource(keyNameEls=\"[userId]\")\n\t\tpublic User findUser(int userId){\n\t\t\treturn userDao.findUser(userId);\n\t\t}\n\t\t\n\t\tpublic List\u003cUser\u003e findAllUsers(){\n\t\t\treturn userDao.findAllUsers();\n\t\t}\n\t\t\n    \tpublic double calcUserAvgAge(){\n    \t\tList\u003cUser\u003e allUsers = userDao.findAllUsers();\n    \t\treturn allUsers.stream().mapToInt(u-\u003eu.getAge()).average().getAsDouble();\n    \t}\n\t}\n\n@ShardingContext表示当前的Service的Sharding上下文，就是说，如果有 选择数据源、Map到各数据库Reduce出结果、生成ID等操作时，如果某些参数没有指定，都从这个ShardingContext里面的配置取\n\n@SelectDataSource表示为该方法内执行的SQL根据Sharding策略选择一个Sharding数据源，在方法结束返回前，不能更改Sharding数据源\n\n@GenerateId表示生成ID，并将其赋值到参数的指定位置\n\n@GenerateId对应的逻辑会先执行，然后到@SelectDataSource然后到@Transaction\n\n@Transactional(readOnly=true)标签指定了事务时只读的，因此框架会根据readOnly标志自动选择读库（如果有的话）\n\n从方法calcUserAvgAge可以看到在JDK8的LAMBADA表达式及Stream功能下，JAVA分析处理集合数据变得极为简单，这会大大减少我们自行加工Sharding分片数据的复杂度。\n\n接下来看DAO层\n\n\t@Component\n\tpublic class UserDaoImpl {\n\t\t\n\t\t@Autowired\n\t\tprivate JdbcTemplate jdbcTemplate;\n\t\t\n\t\tpublic void updateUser(User user){\n\t\t\tint update = jdbcTemplate.update(\"UPDATE `user` SET `name`=? WHERE `user_id`=?;\",user.getName(),user.getUserId());\n\t\t\tAssert.isTrue(update == 1,\"it should be updated!\");\n\t\t}\n\t\t\n\t\tpublic User findUser(int userId){\n\t\t\treturn jdbcTemplate.queryForObject(\"SELECT * FROM user WHERE user_id = ?\", new Object[]{userId}, rowMapper);\n\t\t}\n\t\t\n\t\t@Transactional\n\t\t@MapReduce\n\t\tpublic List\u003cUser\u003e findAllUsers(){\n\t\t\treturn jdbcTemplate.query(\"SELECT * FROM user\", rowMapper);\n\t\t}\n\t\t\n\t\t@Transactional(readOnly=true)\n\t\t@MapReduce\n\t\tpublic void findAllUsers(ReduceResultHolder resultHolder){\n\t\t    List\u003cUser\u003e shardingUsers = jdbcTemplate.query(\"SELECT * FROM user\", rowMapper);\n\t\t    resultHolder.setShardingResult(shardingUsers);\n\t\t}\n\t}\n\n@MapReduce表示该方法将会在每个数据分片都执行一遍，然后进行数据聚合后返回。\n对于聚合前后返回的数据类型一致的方法，调用时可以直接从返回值取得聚合结果。\n对于聚合前后返回的数据类型不一致的方法，需要传入一个对象ReduceResultHolder,调用完成后，通过该对象获得聚合结果\n\n默认情况下，框架会提供一个通用Reduce策略，如果是数字则累加返回，如果是Collection及其子类则合并后返回，如果是MAP则也是合并后返回。\n如果该策略不适合，那么用户可自行设计指定Reduce策略。\n\n@Transaction表示每一个Sharding执行的SQL都处于一个事务中，并不是表示整个聚合操作是一个整体的事务。所以，MapReduce最好不要进行更新操作（考虑框架层次限制MapReduce只允许ReadOnly事务）。\n\n@MapReduce执行的操作会在@Transaction之前。\n\n\n# 优点缺点对比\n以上是框架的主要使用形式，我们可以从这种实现中发现服务层的Sharding有以下好处\n* 全数据库、全SQL兼容\n    * SQL层Sharding无法做到\n* 能完美实现读写分离\n    * 基于SQL层实现的Sharding引入读写分离后，在上层Service感知的事务里，存在混乱的隔离级别的问题，其最多实现RC级别读写分离(若不在Service层介入相关辅助代码的话)，而Service层Sharding在Service开始前就能确定该事务是读事务，整个读事务都在一个读库中完成，隔离级别与数据库一致\n* 无额外维护DBProxy可用性的负担\n* 相对于复杂的SQL解析，实现简单，相信花个一天就能看完所有代码，整个框架了如指掌\n* 无SQL解析成本，性能更高\n* 隔离级别及事务原子性等特征与使用的数据库一致，无额外学习负担，易于写出正确的程序\n    * 框架限制了所有事务都在单库进行\n    * 基于Sql的Sharding即使在非读写分离情况下，因其需要归并多个数据库的结果，其提供的隔离级别也是混乱的，但这个区别并没有显式的提示到程序员。\n\n\n当然也存在缺点\n\n劣势：\n* 跨库查询需要自行进行结果聚合\n    * 是劣势也是优势\n    * 劣势：需要完成额外的聚合代码\n    * 优势：但其能能更好的调优,使用JDK8的Stream及Lambada表达式，能像写SQL一样简单的完成相关集合处理\n* 跨库事务需要自行保证\n    * 是劣势也是优势\n    * 劣势：需要额外自行实现跨库事务\n    * 优势：目前所有的Sharding框架实现的跨库事务都有缺陷或者说限制，如Sharding-JDBC,Mycat等提供的跨库事务都并非严格意义的ACID，A可能被打破，I也与原生定义的不一样，程序员不熟悉时就很容易写出不可靠的代码。因此自行控制分布式事务，采用显式的事务控制或许是更好的选择。可参考使用本人写的另外一个框架EasyTransaction\n* 无法实现单库分表\n\t* 其实，单库分表并不是必须的，这可以用数据原生的表分区来实现，性能一样，使用更便捷\n\n# 具体使用方法\n更具体使用案例请参考 测试Package：org.easydevelop.business里的案例","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQNJR-GROUP%2Fsharding-method","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FQNJR-GROUP%2Fsharding-method","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQNJR-GROUP%2Fsharding-method/lists"}