ShardingSphere-UI-京东云开发者社区

ShardingSphere-UI 是 ShardingSphere 的一个简单而有用的web管理控制台。它用于帮助用户更简单的使用 ShardingSphere 的相关功能，目前提供注册中心管理、动态配置管理、数据库编排等功能。

项目结构上采取了前后端分离的方式，前端使用 Vue 框架，后端采用 Spring Boot 框架。使用标准的 Maven 方式进行打包，部署，同时也可以采用前后端分离的方式本地运行，方便开发调试。

## 二进制运行

1. `git clone https://github.com/apache/shardingsphere-ui.git`；
1. 运行 `mvn clean install -Prelease`；
1. 获取安装包 `/shardingsphere-ui/shardingsphere-ui-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-ui-bin.tar.gz`；
1. 解压缩后运行`bin/start.sh`；
1. 访问`http://localhost:8088/`。

## 源码调试模式

ShardingSphere-UI 采用前后端分离的方式。

### 后端

1. 后端程序执行入口为 `org.apache.shardingsphere.ui.Bootstrap`；
1. 访问 `http://localhost:8088/`。

### 前端

1. 进入 `shardingsphere-ui-frontend/` 目录；
1. 执行 `npm install`；
1. 执行 `npm run dev`；
1. 访问 `http://localhost:8080/`。

## 配置

ShardingSphere-UI 的配置文件为 `conf/application.properties`, 它由两部分组成。

1. 程序监听端口；
1. 登录身份验证信息。

```properties
server.port=8088

user.admin.username=admin
user.admin.password=admin
```

## 注意事项

1. 若使用 maven 构建后，再进行本地运行前端项目时，可能因为 node 版本不一致导致运行失败，可以清空 `node_modules/` 目录后重新运行。
错误日志如下：

```
ERROR  Failed to compile with 17 errors
error  in ./src/views/orchestration/module/instance.vue?vue&type=style&index=0&id=9e59b740&lang=scss&scoped=true&
Module build failed (from ./node_modules/sass-loader/dist/cjs.js):
Error: Missing binding /shardingsphere/shardingsphere-ui/shardingsphere-ui-frontend/node_modules/node-sass/vendor/darwin-x64-57/binding.node
Node Sass could not find a binding for your current environment: OS X 64-bit with Node.js 8.x
Found bindings for the following environments:
  - OS X 64-bit with Node.js 6.x
This usually happens because your environment has changed since running `npm install`.
Run `npm rebuild node-sass` to download the binding for your current environment.
```
## 注册中心配置

首先需要添加并激活注册中心。可以添加多个注册中心，但只能有一个处于激活状态，后面的运行状态功能都是针对当前已激活的注册中心进行操作。
目前提供 Zookeeper 和 etcd 的支持，后续会添加第三方注册中心的支持。

+ 点击 + 按钮可以添加新注册中心。

+ 通过配置扩展配置中心来使用其它配置中心管理配置。

+ 支持编辑、激活和删除注册中心操作。
## 规则配置

+ 添加激活注册中心后，可以获取当前注册中心中所有数据源的相关配置，包括数据分片，读写分离、Properties 配置等。

+ 可以通过 YAML 格式对相关配置信息进行修改。

+ 点击 + 按钮可以添加新的数据源和分片规则。

## 运行状态

+ 添加激活注册中心后，可以查看当前注册中心所有运行实例信息。

+ 可以通过操作按钮对运行实例进行熔断与恢复操作。

+ 可以查看所有从库信息，并进行从库禁用与恢复操作。