Skip to content

T
together
提交 6bb43e7f 作者: 潘亚楠
操作

更新 README.md

上级 f5d3c021
流水线 #57195 已失败 于阶段
in 1 分 57 秒
正在显示 包含 239 行增加 和 70 行删除
README.md
......@@ -450,75 +450,17 @@ singleton.getInstance("$_requestFactory");
1. [简介](#简介)
2. [功能](#功能)
+ [zookeeper](#zookeeper)
+ [rpc](#rpc)
3. [安装](#安装)
## 简介
> todo
## 功能
### zookeeper
#### 介绍
> ClientSync.ts/ TransactionSync.ts 是对zookeeperAPI的封装,将回调函数封装为Promise
> index.ts 基于业务需要对Zookeeper的封装, 如下
```
export interface ConnectOptions {
sessionTimeout: number;
spinDelay: number;
retries: number;
}
export class Zookeeper {
static client: Client;
/**
* @information 删除一个服务
* @param {String} 服务名
* @param {Number} 服务端口号
* @return {Boolean} 删除成功为true
*/
static remove(name: string, port?: number): Promise<boolean>;
/**
* @information 创建zookeeper连接
* @param url zookeeper 服务地址
* @param options 连接选项
*/
static conect(url: string, options?: ConnectOptions): Promise<boolean>;
/**
* @information 注册服务接口
* @param name 服务名称
* @param port 服务端口
* @param pmode 服务类型 (default 永久节点)
* @param cmode 服务的子节点类型(default 临时节点)
* @param acls 权限
* @param data 节点数据
*/
static registe(name: string, port: number, pmode?: number, cmode?: number, acls?: ACL[], data?: Buffer): Promise<string | boolean>;
/**
* @information 获取某个服务的ip和端口
* @param node 节点名
* @return {Promise}
*/
static discover(name: string): Promise<{
children: string[];
stats: Stat;
}>;
/**
* @information 关闭zookeeper连接
*/
static close(): Promise<boolean>;
}
```
#### 使用
### 简介
> node服务公共模块提取
> todo
### 功能
### rpc
#### rpc
#### 介绍
##### 介绍
> 契约文件编译
1. 通过编译cli对thrift文件编译
......@@ -606,7 +548,7 @@ export class RPCClient {
end(): void;
}
```
#### 使用
##### 使用
1. 编译
+ 编写编译配置文件
......@@ -693,15 +635,123 @@ startServer()
```
## 安装
> todo
### 安装
+ npm config set registry http://39.106.145.141:9000/repository/node-public/
+ npm i qjsl_node
## 前端脚手架
> todo
### 简介
> 通过cli创建前端项目模板
### 安装
+ npm config set registry http://39.106.145.141:9000/repository/node-public/
+ npm i qj-cli -g
### 使用
> 打开终端,输入 qj-cli -h 查看帮助; qj-cli ls 查看支持的项目模板; qj-cli create vue2 hello-vue 创建项目hello-vue
## elementui表单设计器
> todo
### 1. 项目背景
针对新版电子合同,在线考试,意见反馈等试卷类项目开发的npm包
### 2. 文档
- [rice所有文档集合](https://docs.qq.com/sheet/DUWhNSHhCTlhsUUVN?tab=BB08J3&c=F7A0A0)
### 3. 项目结构
```
├─build·························webpack构建目录
├─config························webpack配置目录
├─examples······················网站相关
├─packages······················需要向外抛出的组件
├─src···························开发目录
│ ├─assets·····················静态资源
│ │ ├─font····················字体图标
│ │ ├─images··················图片文件
│ │ └─js······················配置文件
│ ├─components·················组件
│ ├─mixins·····················混入文件
│ ├─style······················样式相关
│ ├─utils······················工具类
│ ├─views······················路由页
│ ├─index.js···················组件注册
│ ├─npm.js·····················打包工具
│ └─scan_file.js···············组件扫描工具
├─static························静态资源文件
├─types·························ts类型声明
│ .babelrc
│ .editorconfig
│ .gitignore
│ .postcssrc.js
│ index.html····················根页面
│ package.json··················包信息
│ README.md·····················项目介绍文件
```
### 4. 开发说明
#### npm 安装
首先替换下载源
```shell
npm config set registry http://39.106.145.141:9000/repository/node-host/
```
下载依赖
```shell
npm install FormMakingRice -S
```
在 main.js 中写入如下内容
```shell
import FormMakingRice from "FormMakingRice";
Vue.use(FormMakingRice)
```
#### cdn 引入
##### 地址
> 200服务器
```shell
// 0.0.3 为表单编辑器的版本号, 应该替换为使用的正确版本号
<script src="https://192.168.10.200:7008/libs@0.0.3/index.js"></script>
```
> 测试环境
```shell
// 0.0.3 为表单编辑器的版本号, 应该替换为使用的正确版本号
<script src="https://dformmakingrice.allhome.com.cn/libs@0.0.3/index.js"></script>
```
> 正式环境
```shell
// 0.0.3 为表单编辑器的版本号, 应该替换为使用的正确版本号
<script src="https://formmakingrice.allhome.com.cn/libs@0.0.3/index.js"></script>
```
##### 项目引入
webpack.base.config.js externals配置项中添加如下：
```shell
formMakingRice': 'FormMakingRice
```
main.js 引入：
```shell
import formMakingRice from "formMakingRice";
Vue.use(formMakingRice);
```
## cubeui表单设计器
......@@ -715,11 +765,130 @@ startServer()
## 房源验真
> todo
> #### 按照坐落获取权证信息
```
[POST] /houseVerify
[Request] Body
{
"region": "行政区名称",
"estateName": "小区名称",
"buildingNumber": "楼号",
"unitNumber": "单元号",
"floor": "楼层",
"doorNumber": "户号"
}
[Response] Body
[success]
{
"cityCode": "行政区代码",
"propertyNumber": "产权证编号",
"propertyPersonCertificatesNumber": "产权人身份证号",
"propertyPerson": "产权人姓名",
"isShare": "产权类型是否为共有"
}
[error]
null
```
> #### 按照人员获取权证信息
```
[POST] /ownerVerify
[Request] Body
{
"name": "姓名",
"idNumber": "身份证号"
}
[Response] Body
[success]
[
{
"cityCode": "行政区代码",
"propertyNumber": "产权证编号",
"propertyPersonCertificatesNumber": "产权人身份证号",
"propertyPerson": "产权人姓名",
"isShare": "产权类型是否为共有"
}
]
[error]
null
```
> #### 使用产权证编号查询产权共有类型(共有、独有)
```
[GET] /PUB/qjHousing/coparcenary/:id
[Request] Params
{
"id": "产权证编号"
}
[Response] Body
[success]
{
"result": true,
"statusCode": 1000,
"message": "成功"
}
[error]
{
"result": null,
"statusCode": 1004,
"message": "未查到"
}
```
## 短信服务
> todo
### 简介
基础短信服务:
参数1 projectName: 项目名称(非必须，字符串类型)
参数2 smsModel: 阿里短信参数Model + Rsa 加密后的base64格式字符串
加密前参数格式参考: [阿里云短信服务API文档](https://help.aliyun.com/document_detail/57458.html)
| 模板名称 | 模板CODE |模板内容 |
| ------ | --------------| --------- |
|退款通知 |SMS_151579322 |尊敬的客户，千家地产已经向您尾号${var1}的账户退款${var2} 元，请查收！|
|动态密码 |SMS_151765124 |尊敬的用户您好，您的动态密码为：${var1}，请尽快完成操作。请妥善保管，不要把动态密码泄露给其他人！|
|登陆安全码|SMS_151770093 |尊敬的用户您好，您的登陆安全码为：${var1}，请尽快完成操作。请妥善保管，不要把验证码泄露给其他人!|
|简历注册码 |SMS_151549232 |尊敬的用户您好，您的注册验证码为：${var1}，请尽快完成操作。请妥善保管，不要把验证码泄露给其他人！|
|操作验证码|SMS_151549224|您的操作验证码是：${var1}。请不要把验证码泄露给其他人。|
|登录验证码|SMS_151549230|您的登录验证码是：${var1}。请不要把验证码泄露给其他人|
### 使用
```
//发送短信(立即发送)
[POST] /Bas/SMS/sendSMS
[Request] Body
{
"projectName": "BAS_SMSGateway_node",
"smsModel": "dDmoLXRdvz5aGAKNIcqphtdJsPser7uaE0ZtP2XIzOF05IgcixcDMRdffla7fVbsnlZ6e0ibLutFrQzZ493bLoEghvxIgEO+t2+zNrgoSlvROM9DRXweaRhRRSPM+VH3QWD8ocEQL+M2KwB72HvxEWt3QRbLGAaQ2XsYqIOl4OYPpjUpQD4g9Ay5qcpM+WByn2LDcDL22k/PL+Wy9IjVV6BtfP0EjAlJtaRELCkUL5i30FAtPhn1032snNqAkDw3/fF5eJd5W4RHu+GWi8ACOxKnOfFJ3FV67F5Bgrj4yohba3c0rzF3ve1r2IUnx4ihhV1DgZ1teExTx7iAEvgF1w=="
}
[Response] Body
[success]
{
"statusCode": "200",
"message": "短信发送成功"
}
短信加入信箱(按信件顺序排队发送)
[POST] /Bas/SMS/collectSMS
[Request] Body
{
"projectName": "BAS_SMSGateway_node",
"smsModel": "dDmoLXRdvz5aGAKNIcqphtdJsPser7uaE0ZtP2XIzOF05IgcixcDMRdffla7fVbsnlZ6e0ibLutFrQzZ493bLoEghvxIgEO+t2+zNrgoSlvROM9DRXweaRhRRSPM+VH3QWD8ocEQL+M2KwB72HvxEWt3QRbLGAaQ2XsYqIOl4OYPpjUpQD4g9Ay5qcpM+WByn2LDcDL22k/PL+Wy9IjVV6BtfP0EjAlJtaRELCkUL5i30FAtPhn1032snNqAkDw3/fF5eJd5W4RHu+GWi8ACOxKnOfFJ3FV67F5Bgrj4yohba3c0rzF3ve1r2IUnx4ihhV1DgZ1teExTx7iAEvgF1w=="
}
[Response] Body
[success]
{
"statusCode": "200",
"message": "短信发送成功"
}
```
## 平台日志
### 用户操作日志对接文档
......
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论