Skip to content

Commit

Permalink
translate examples README.md document to chinese (#4923)
Browse files Browse the repository at this point in the history
* Create README_ZH.md

translate examples README.md document to chinese

* Update README_ZH.md

accept the reviewer's suggestion
  • Loading branch information
meAsky committed Mar 25, 2020
1 parent 5f24d7b commit 72ec3e9
Showing 1 changed file with 120 additions and 0 deletions.
120 changes: 120 additions & 0 deletions examples/README_ZH.md
@@ -0,0 +1,120 @@
# ShardingSphere示例

1.x的示例,请参阅 `https://github.com/apache/incubator-shardingsphere/tree/${tag}/sharding-jdbc-example`

2.x或3.x或4.x的示例,请参见 `https://github.com/apache/incubator-shardingsphere-example/tree/${tag}`

**需要注意**

- *请不要使用`dev`分支来运行您的示例,`dev`分支的示例尚未发布。*

- *手动模式初始脚本位于 `https://github.com/apache/incubator-shardingsphere-example/blob/dev/src/resources/manual_schema.sql`,请在首次运行示例之前执行它。*

- *请确保MySQL上的主从数据同步正确运行。否则,此示例查询从库数据将是空。*

## 如果要使用`dev`分支,请在开始该example之前

请确保已安装了来自[shardingsphere](https://github.com/apache/incubator-shardingsphere)[shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl)的某些依赖项,因为某些示例依赖于此。如果您是shardingsphere的新手,您可以准备如下依赖:

1.下载并安装[shardingsphere](https://github.com/apache/incubator-shardingsphere)

```bash
## 下载shardingsphere代码
git clone https://github.com/apache/incubator-shardingsphere.git

## 检出一个指定版本,比如是 4.0.0-RC1
cd incubator-shardingsphere && git checkout 4.0.0-RC1

## 安装依赖
mvn clean install -Prelease
```

2.下载并安装[shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl)

```bash
## 下载shardingsphere-SPI-implement的代码
git clone https://github.com/OpenSharding/shardingsphere-spi-impl.git

## 检出一个指定版本,比如是 4.0.0-RC1
cd shardingsphere-spi-impl && git checkout 4.0.0-RC1

## 安装依赖
mvn clean install
```

## shardingsphere-example模块设计

### 项目结构

```
shardingsphere-example
├── example-core
│   ├── config-utility
│   ├── example-api
│   ├── example-raw-jdbc
│   ├── example-spring-jpa
│   └── example-spring-mybatis
├── sharding-jdbc-example
│   ├── sharding-example
│   │   ├── sharding-raw-jdbc-example
│   │   ├── sharding-spring-boot-jpa-example
│   │   ├── sharding-spring-boot-mybatis-example
│   │   ├── sharding-spring-namespace-jpa-example
│   │   └── sharding-spring-namespace-mybatis-example
│   ├── orchestration-example
│   │   ├── orchestration-raw-jdbc-example
│   │   ├── orchestration-spring-boot-example
│   │   └── orchestration-spring-namespace-example
│   ├── transaction-example
│   │   ├── transaction-2pc-xa-example
│   │   └──transaction-base-seata-example
│   ├── other-feature-example
│   │   ├── hint-example
│   │   └── encrypt-example
├── sharding-proxy-example
│   └── sharding-proxy-boot-mybatis-example
└── src/resources
  └── manual_schema.sql
```

### 分片数据的最佳实践

* 分片数据库
* 分片表
* 分片数据库和表
* 主从
* 分片和主从

您可以从[sharding-example](./sharding-jdbc-example/sharding-example)中获取更多详细信息

### 分片与编排的最佳实践

* 使用本地配置文件和zookeeper/etcd配置分片
* 使用注册中心(zookeeper/etcd)的配置进行分片

您可以从业务[orchestration-example](./sharding-jdbc-example/orchestration-example)中获取更多细节

### 分片+分布式事务的最佳实践

* 2pc-xa事务
* base-seata事务

您可以从[transaction-example](./sharding-jdbc-example/transaction-example)中获取更多详细信息

### 提示路由的最佳实践

您可以从[hint-example](./sharding-jdbc-example/other-feature-example/hint-example)中获取更多细节

### 数据加密的最佳实践

您可以从[encrypt-example](./sharding-jdbc-example/other-feature-example/encrypt-example)中获取更多详细信息

### APM集成的最佳实践

我们将在最近添加APM集成示例。

### 分片代理的最佳实践

我们希望最近添加一个docker基础示例。

### [如何使用docker配置sharding-jdbc和sharding-proxy](./docker/docker-compose.md) (可选)

0 comments on commit 72ec3e9

Please sign in to comment.