Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
apache
Shardingsphere
提交
afa34fa9
Shardingsphere
项目概览
apache
/
Shardingsphere
通知
56
Star
3
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
Shardingsphere
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
afa34fa9
编写于
4月 14, 2017
作者:
H
haocao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
For #197: refactor 00-overview documents.
上级
41b5814a
变更
4
隐藏空白更改
内联
并排
Showing
4 changed file
with
48 addition
and
39 deletion
+48
-39
sharding-jdbc-doc/content/00-overview/contribution.md
sharding-jdbc-doc/content/00-overview/contribution.md
+42
-33
sharding-jdbc-doc/content/00-overview/index.md
sharding-jdbc-doc/content/00-overview/index.md
+1
-1
sharding-jdbc-doc/content/00-overview/intro.md
sharding-jdbc-doc/content/00-overview/intro.md
+3
-3
sharding-jdbc-doc/content/00-overview/release-notes.md
sharding-jdbc-doc/content/00-overview/release-notes.md
+2
-2
未找到文件。
sharding-jdbc-doc/content/00-overview/contribution.md
浏览文件 @
afa34fa9
# 如何成为贡献者?
+++
toc = true
date = "2017-04-12T16:06:17+08:00"
title = "贡献代码"
weight = 3
prev = "/00-overview/release-note"
next = "/01-start/index"
+++
您可以报告bug,提交一个新的功能增强建议或者直接对以上内容提交改进补丁。
...
...
@@ -60,7 +68,7 @@
### 提交一个功能增强建议之前
-
请先检查
[
详细功能列表
](
http://dangdangdotcom.github.io/sharding-jdbc/pos
t/features/
)
。
-
请先检查
[
详细功能列表
](
/01-star
t/features/
)
。
-
请确定这不是一个重复的功能增强建议。
查看
[
Issue Page
](
https://github.com/dangdangdotcom/sharding-jdbc/issues
)
列表,搜索您要提交的功能增强建议是否已经被提交过。
...
...
@@ -93,36 +101,7 @@
## 贡献补丁(patch)
本文档帮助贡献者搭建开发环境并贡献代码,示例和文档。
### 编译代码
Sharding-JDBC的代码编译需要
[
Maven
](
http://maven.apache.org/
)
,请保证IDE中正确配置了它。
代码用到的所有依赖完全都可以从公网下载,请根据自身的网络情况选择合理的镜像。
代码使用了
[
Lombok
](
https://projectlombok.org/download.html
)
来生成类属性的访问方法,构造器等。
故请以上从链接内容来获取适合您的IDE的解决方法。
### 文档生成
文档使用博客生成引擎
[
HUGO
](
https://gohugo.io/
)
,请根据文档安装环境。
文档全部在sharding-jdbc/sharding-jdbc-doc/content/post目录中。
### 贡献方法
请按照下面的步骤贡献代码,示例和文档。
-
所有的问题与新功能请使用
[
Issue Page
](
https://github.com/dangdangdotcom/sharding-jdbc/issues
)
进行管理。
-
任何人想要开发任何功能,请先回复该功能所关联的Issue,表明您当前正在这个Issue上工作。
并在回复的时候为自己设置一个deadline,并添加的回复内容中。
-
在核心贡献者找到一个导师(shepherd),导师会在设计与功能实现上给予即时的反馈。
如果您没有熟悉的架构师,请向__sharding_jdbc@groups.163.com__发送邮件。
-
您应该新建一个分支来开始您的工作,分支的名字为功能名称/issueId。
例如,您想完成一个SQL解析(parser)功能中 __Issue 111__,那么您的branch名字应为 __parser/111__。
功能名称与导师讨论后确定。
-
完成后,发送一个pull request到dangdangdotcom/sharding-jdbc,
接着导师做CodeReview,然后他会与您讨论一些细节(包括设计,实现,性能等)。当团队中所有人员对本次修改满意后,导师会将提交合并到master分支。
-
最后,恭喜您已经成为了Sharding-JDBC的官方贡献者!
本章节向贡献者介绍开发规范、环境、示例和文档。
### 开发理念
...
...
@@ -172,4 +151,34 @@ Sharding-JDBC的代码编译需要[Maven](http://maven.apache.org/),请保证I
-
多数据断言, 应使用assertThat。
-
精确断言, 尽量不使用not, containsString断言。
-
调用业务方法的变量, 应命名为actualXXX, 期望值应命名为expectedXXX。
-
只有junit assertXXX, hamcrest, mocktio相关可以使用static import。
\ No newline at end of file
-
只有junit assertXXX, hamcrest, mocktio相关可以使用static import。
### 编译代码
Sharding-JDBC的代码编译需要
[
Maven
](
http://maven.apache.org/
)
,请保证IDE中正确配置了它。
代码用到的所有依赖完全都可以从公网下载,请根据自身的网络情况选择合理的镜像。
代码使用了
[
Lombok
](
https://projectlombok.org/download.html
)
来生成类属性的访问方法,构造器等。
故请以上从链接内容来获取适合您的IDE的解决方法。
### 文档生成
文档使用博客生成引擎
[
HUGO
](
https://gohugo.io/
)
,请根据文档安装环境。
文档全部在sharding-jdbc/sharding-jdbc-doc/public目录中。
### 贡献方法
请按照规范贡献代码,示例和文档。
-
所有的问题与新功能请使用
[
Issue Page
](
https://github.com/dangdangdotcom/sharding-jdbc/issues
)
进行管理。
-
任何人想要开发任何功能,请先回复该功能所关联的Issue,表明您当前正在这个Issue上工作。
并在回复的时候为自己设置一个deadline,并添加的回复内容中。
-
在核心贡献者找到一个导师(shepherd),导师会在设计与功能实现上给予即时的反馈。
如果您没有熟悉的架构师,请向__sharding_jdbc@groups.163.com__发送邮件。
-
您应该新建一个分支来开始您的工作,分支的名字为功能名称/issueId。
例如,您想完成一个SQL解析(parser)功能中 __Issue 111__,那么您的branch名字应为 __parser/111__。
功能名称与导师讨论后确定。
-
完成后,发送一个pull request到dangdangdotcom/sharding-jdbc,
接着导师做CodeReview,然后他会与您讨论一些细节(包括设计,实现,性能等)。当团队中所有人员对本次修改满意后,导师会将提交合并到master分支。
-
最后,恭喜您已经成为了Sharding-JDBC的官方贡献者!
\ No newline at end of file
sharding-jdbc-doc/content/00-overview/index.md
浏览文件 @
afa34fa9
...
...
@@ -16,7 +16,7 @@ Sharding-JDBC是当当应用框架ddframe中,关系型数据库模块dd-rdb中
Sharding-JDBC定位为轻量级java框架,使用客户端直连数据库,以jar包形式提供服务,未使用中间层,无需额外部署,无其他依赖,DBA也无需改变原有的运维方式,可理解为增强版的JDBC驱动,旧代码迁移成本几乎为零。
[
![Maven Status
](
https://maven-badges.herokuapp.com/maven-central/com.dangdang/sharding-jdbc/badge.svg
)
](https://maven-badges.herokuapp.com/maven-central/com.dangdang/sharding-jdbc)
[
![Build Status
](
https://secure.travis-ci.org/dangdangdotcom/sharding-jdbc.
pn
g?branch=master
)
](https://travis-ci.org/dangdangdotcom/sharding-jdbc)
[
![Build Status
](
https://secure.travis-ci.org/dangdangdotcom/sharding-jdbc.
sv
g?branch=master
)
](https://travis-ci.org/dangdangdotcom/sharding-jdbc)
[
![Coverage Status
](
https://coveralls.io/repos/dangdangdotcom/sharding-jdbc/badge.svg?branch=master&service=github
)
](https://coveralls.io/github/dangdangdotcom/sharding-jdbc?branch=master)
[
![GitHub release
](
https://img.shields.io/github/release/dangdangdotcom/sharding-jdbc.svg
)
](https://github.com/dangdangdotcom/sharding-jdbc/releases)
[
![Hex.pm
](
http://dangdangdotcom.github.io/elastic-job/img/license.svg
)
](http://www.apache.org/licenses/LICENSE-2.0.html)
...
...
sharding-jdbc-doc/content/00-overview/intro.md
浏览文件 @
afa34fa9
...
...
@@ -47,9 +47,9 @@ Sharding-JDBC配置多样:
# 整体架构图
![
整体架构图
](
http://dangdangdotcom.github.io/sharding-jdbc
/img/architecture.png
)
![
整体架构图
](
/img/architecture.png
)
![
柔性事务-最大努力送达型
](
http://dangdangdotcom.github.io/sharding-jdbc
/img/architecture-soft-transaction-bed.png
)
![
柔性事务-最大努力送达型
](
/img/architecture-soft-transaction-bed.png
)
# 快速入门
...
...
@@ -76,7 +76,7 @@ ShardingRule shardingRule = ShardingRule.builder()
.
build
();
```
规则配置包括数据源配置、表规则配置、分库策略和分表策略组成。这只是最简单的配置方式,实际使用可更加灵活,如:多分片键,分片策略直接和
tableRule
绑定等。
规则配置包括数据源配置、表规则配置、分库策略和分表策略组成。这只是最简单的配置方式,实际使用可更加灵活,如:多分片键,分片策略直接和
表规则配置
绑定等。
## 使用原生JDBC接口
通过ShardingDataSourceFactory工厂和规则配置对象获取ShardingDataSource,ShardingDataSource实现自JDBC的标准接口DataSource。然后可通过DataSource选择使用原生JDBC开发,或者使用JPA, MyBatis等ORM工具。
...
...
sharding-jdbc-doc/content/00-overview/release-notes.md
浏览文件 @
afa34fa9
...
...
@@ -4,7 +4,7 @@ date = "2016-12-06T22:38:50+08:00"
title = "Release Note"
weight = 2
prev = "/00-overview/intro"
next = "/0
1-start/index
"
next = "/0
0-overview/contribution
"
+++
...
...
@@ -48,7 +48,7 @@ next = "/01-start/index"
1.
[
ISSUE #162
](
https://github.com/dangdangdotcom/sharding-jdbc/issues/162
)
分布式主键算法实现
1.
[
ISSUE #163
](
https://github.com/dangdangdotcom/sharding-jdbc/issues/163
)
获取自增序列jdbc接口实现
1.
[
ISSUE #171
](
https://github.com/dangdangdotcom/sharding-jdbc/issues/171
)
sharding-jdbc-core配合自动生成序列改造
1.
[
ISSUE #172
](
https://github.com/dangdangdotcom/sharding-jdbc/issues/172
)
Y
aml
与Spring的配置方式增加对于自增序列的支持
1.
[
ISSUE #172
](
https://github.com/dangdangdotcom/sharding-jdbc/issues/172
)
Y
AML
与Spring的配置方式增加对于自增序列的支持
### 缺陷修正
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录