Lianxun_Java.git

parent: e546f6e1 | 补丁 | 提交 | ignore whitespace

wuxw

2019-05-09 fe6fb0f54f952e62cda322ae65a1b40f0f927466

修改编码规范加入 建表语句参考

1个文件已删除

1个文件已修改

1 文件已重命名

3个文件已添加

	docs/CodeStandards.md	21 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	docs/_sidebar.md	6 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	docs/api/room/deleteRoom.md	60 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	docs/api/room/updateRoom.md	77 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	docs/start/CodeStandards.md	60 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	docs/start/install.md	补丁 \| 查看 \| 原始文档 \| blame \| 历史

 docs/CodeStandards.md

File was deleted

 docs/_sidebar.md

@@ -2,8 +2,8 @@
* 入门

  * [快速开始](README.md)
  * [安装部署](install.md)
  * [编码规范](CodeStandards.md)
  * [安装部署](start/install.md)
  * [编码规范](start/CodeStandards.md)

* api接口

@@ -27,6 +27,8 @@
  * [修改单元信息](api/unit/updateUnit.md)
  * [删除单元信息](api/unit/deleteUnit.md)
  * [保存房屋信息](api/room/saveRoom.md)
  * [修改房屋信息](api/room/updateRoom.md)
  * [删除房屋信息](api/room/deleteRoom.md)

* 服务端接口协议


 docs/api/room/deleteRoom.md

New file
@@ -0,0 +1,60 @@


**1\. 删除房屋信息**
###### 接口功能
> 用户通过web端或APP删除房屋信息接口

###### URL
> [http://api.java110.com:8008/api/room.deleteRoom](http://api.java110.com:8008/api/room.deleteRoom)

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配                      |
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|

###### 请求参数
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|roomId|1|String|30|房间ID|12312313|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，

成功


###### 举例
> 地址：[http://api.java110.com:8008/api/room.deleteRoom](http://api.java110.com:8008/api/room.deleteRoom)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

{
    "roomId":"12313",
    "communityId":"小区ID",
    "unitId":"填写具体值",
}

返回报文：
成功

```

 docs/api/room/updateRoom.md

New file
@@ -0,0 +1,77 @@


**1\. 修改房屋信息**
###### 接口功能
> 用户通过web端或APP保存单元信息接口

###### URL
> [http://api.java110.com:8008/api/room.updateRoom](http://api.java110.com:8008/api/room.updateRoom)

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数(header部分)
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-:|
|app_id|1|String|30|应用ID|Api服务分配                      |
|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
|sign|1|String|-|签名|请参考签名说明|
|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|

###### 请求参数
|参数名称|约束|类型|长度|描述|取值说明|
| :-: | :-: | :-: | :-: | :-: | :-: |
|roomId|1|String|30|房间ID|12312313|
|unitPrice|1|String|4|房屋单价|-|
|section|1|String|4|房间数|-|
|remark|1|String|200|备注|-|
|userId|1|String|30|用户ID|-|
|communityId|1|String|30|小区ID|-|
|layer|1|String|30|房屋楼层|-|
|builtUpArea|1|String|30|建筑面积| 如 97.98|
|roomNum|1|String|12|房间编号|1123|
|unitId|1|String|30|小区单元ID|-|
|apartment|1|String|4|户型|1010 一室一厅 1020 一室两厅 2010 两室一厅 2020 两室两厅 3020 三室两厅|

###### 返回协议

当http返回状态不为200 时请求处理失败 body内容为失败的原因

当http返回状态为200时请求处理成功，body内容为返回内容，

成功


###### 举例
> 地址：[http://api.java110.com:8008/api/room.updateRoom](http://api.java110.com:8008/api/room.updateRoom)

``` javascript
请求头信息：
Content-Type:application/json
USER_ID:1234
APP_ID:8000418002
TRANSACTION_ID:10029082726
REQ_TIME:20181113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：

{
    "roomId":"12313",
    "communityId":"小区ID",
    "unitPrice":"填写具体值",
    "section":"填写具体值",
    "remark":"填写具体值",
    "layer":"填写具体值",
    "builtUpArea":"填写具体值",
    "roomNum":"填写具体值",
    "unitId":"填写具体值",
    "apartment":"填写具体值"
}

返回报文：
成功

```

 docs/start/CodeStandards.md

New file
@@ -0,0 +1,60 @@
## 变更历史
版本|变更内容|变更时间|变更人员
:-: | :-: | :-: | :-:
v0.01|初稿|2019-04-22|wuxw

## mysql数据库规范
* 建表名称 过程表 为 business + 模块 + 业务意义 如 business_sys_privilege  实例表为：模块+业务意义 如 sys_privilege
* 表和表字段需要写备注
* 每个业务必须包含 business表 和 instance表 如权限表 business_sys_privilege 和 sys_privilege
* 新建业务表必须包含 b_id 和 create_time 如：b_id VARCHAR(30) NOT NULL COMMENT '业务Id',  create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间'
* business表必须包含字段 operate 如： operate VARCHAR(4) NOT NULL COMMENT '数据状态，添加ADD，修改MOD 删除DEL'
* 新建instance表时必须包含字段 status_cd 如：status_cd VARCHAR(2) NOT NULL DEFAULT '0' COMMENT '数据状态，详细参考c_status表，S 保存，0, 在用 1失效'
* 由于框架问题审核状态信息不能和status_cd 合并为一个，故 加入 audit_status_cd varchar(4) NOT NULL DEFAULT '0000' comment '审核状态'

* 建表参考语句：

```
-- 单元信息（business） building 楼宇管理
CREATE TABLE business_building_unit(
  unit_id VARCHAR(30) NOT NULL COMMENT '单元ID',
  b_id VARCHAR(30) NOT NULL COMMENT '业务Id',
  unit_num VARCHAR(12) NOT NULL COMMENT '单元编号',
  floor_id VARCHAR(30) NOT NULL COMMENT '楼ID',
  layer_count int NOT NULL COMMENT '总层数',
  lift varchar(4) NOT NULL COMMENT '是否有电梯 1010有 2020 无',
  user_id VARCHAR(30) NOT NULL COMMENT '用户ID',
  remark VARCHAR(200) NOT NULL COMMENT '备注',
  create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  operate VARCHAR(4) NOT NULL COMMENT '数据状态，添加ADD，修改MOD 删除DEL'
);


CREATE INDEX idx_business_unit_id ON business_building_unit(unit_id);
CREATE INDEX idx_business_unit_b_id ON business_building_unit(b_id);

-- 单元信息（instance）
CREATE TABLE building_unit(
  unit_id VARCHAR(30) NOT NULL COMMENT '单元ID',
  b_id VARCHAR(30) NOT NULL COMMENT '业务Id',
  unit_num VARCHAR(12) NOT NULL COMMENT '单元编号',
  floor_id VARCHAR(30) NOT NULL COMMENT '楼ID',
  layer_count int NOT NULL COMMENT '总层数',
  lift varchar(4) NOT NULL COMMENT '是否有电梯 1010有 2020 无',
  user_id VARCHAR(30) NOT NULL COMMENT '用户ID',
  remark VARCHAR(200) NOT NULL COMMENT '备注',
  create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  status_cd VARCHAR(2) NOT NULL DEFAULT '0' COMMENT '数据状态，详细参考c_status表，S 保存，0, 在用 1失效',
  UNIQUE KEY (unit_id)
);
CREATE INDEX idx_unit_b_id ON building_unit(b_id);
CREATE UNIQUE INDEX idx_unit_id ON building_unit(unit_id);

```


## java代码规范


## 前段代码规范


 docs/start/install.md

			@@ -2,8 +2,8 @@
			* 入门

			* [快速开始](README.md)
			* [安装部署](install.md)
			* [编码规范](CodeStandards.md)
			* [安装部署](start/install.md)
			* [编码规范](start/CodeStandards.md)

			* api接口

			@@ -27,6 +27,8 @@
			* [修改单元信息](api/unit/updateUnit.md)
			* [删除单元信息](api/unit/deleteUnit.md)
			* [保存房屋信息](api/room/saveRoom.md)
			* [修改房屋信息](api/room/updateRoom.md)
			* [删除房屋信息](api/room/deleteRoom.md)

			* 服务端接口协议

New file
			@@ -0,0 +1,60 @@


			1\. 删除房屋信息
			###### 接口功能
			> 用户通过web端或APP删除房屋信息接口

			###### URL
			> [http://api.java110.com:8008/api/room.deleteRoom](http://api.java110.com:8008/api/room.deleteRoom)

			###### 支持格式
			> JSON

			###### HTTP请求方式
			> GET

			###### 请求参数(header部分)
			\|参数名称\|约束\|类型\|长度\|描述\|取值说明\|
			\| :-: \| :-: \| :-: \| :-: \| :-: \| :-:\|
			\|app_id\|1\|String\|30\|应用ID\|Api服务分配 \|
			\|transaction_id\|1\|String\|30\|请求流水号\|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 \|
			\|sign\|1\|String\|-\|签名\|请参考签名说明\|
			\|req_time\|1\|String\|-\|请求时间\|YYYYMMDDhhmmss\|

			###### 请求参数
			\|参数名称\|约束\|类型\|长度\|描述\|取值说明\|
			\| :-: \| :-: \| :-: \| :-: \| :-: \| :-: \|
			\|roomId\|1\|String\|30\|房间ID\|12312313\|

			###### 返回协议

			当http返回状态不为200 时请求处理失败 body内容为失败的原因

			当http返回状态为200时请求处理成功，body内容为返回内容，

			成功


			###### 举例
			> 地址：[http://api.java110.com:8008/api/room.deleteRoom](http://api.java110.com:8008/api/room.deleteRoom)

			``` javascript
			请求头信息：
			Content-Type:application/json
			USER_ID:1234
			APP_ID:8000418002
			TRANSACTION_ID:10029082726
			REQ_TIME:20181113225612
			SIGN:aabdncdhdbd878sbdudn898
			请求报文：

			{
			"roomId":"12313",
			"communityId":"小区ID",
			"unitId":"填写具体值",
			}

			返回报文：
			成功

			```

New file
			@@ -0,0 +1,77 @@


			1\. 修改房屋信息
			###### 接口功能
			> 用户通过web端或APP保存单元信息接口

			###### URL
			> [http://api.java110.com:8008/api/room.updateRoom](http://api.java110.com:8008/api/room.updateRoom)

			###### 支持格式
			> JSON

			###### HTTP请求方式
			> GET

			###### 请求参数(header部分)
			\|参数名称\|约束\|类型\|长度\|描述\|取值说明\|
			\| :-: \| :-: \| :-: \| :-: \| :-: \| :-:\|
			\|app_id\|1\|String\|30\|应用ID\|Api服务分配 \|
			\|transaction_id\|1\|String\|30\|请求流水号\|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 \|
			\|sign\|1\|String\|-\|签名\|请参考签名说明\|
			\|req_time\|1\|String\|-\|请求时间\|YYYYMMDDhhmmss\|

			###### 请求参数
			\|参数名称\|约束\|类型\|长度\|描述\|取值说明\|
			\| :-: \| :-: \| :-: \| :-: \| :-: \| :-: \|
			\|roomId\|1\|String\|30\|房间ID\|12312313\|
			\|unitPrice\|1\|String\|4\|房屋单价\|-\|
			\|section\|1\|String\|4\|房间数\|-\|
			\|remark\|1\|String\|200\|备注\|-\|
			\|userId\|1\|String\|30\|用户ID\|-\|
			\|communityId\|1\|String\|30\|小区ID\|-\|
			\|layer\|1\|String\|30\|房屋楼层\|-\|
			\|builtUpArea\|1\|String\|30\|建筑面积\| 如 97.98\|
			\|roomNum\|1\|String\|12\|房间编号\|1123\|
			\|unitId\|1\|String\|30\|小区单元ID\|-\|
			\|apartment\|1\|String\|4\|户型\|1010 一室一厅 1020 一室两厅 2010 两室一厅 2020 两室两厅 3020 三室两厅\|

			###### 返回协议

			当http返回状态不为200 时请求处理失败 body内容为失败的原因

			当http返回状态为200时请求处理成功，body内容为返回内容，

			成功


			###### 举例
			> 地址：[http://api.java110.com:8008/api/room.updateRoom](http://api.java110.com:8008/api/room.updateRoom)

			``` javascript
			请求头信息：
			Content-Type:application/json
			USER_ID:1234
			APP_ID:8000418002
			TRANSACTION_ID:10029082726
			REQ_TIME:20181113225612
			SIGN:aabdncdhdbd878sbdudn898
			请求报文：

			{
			"roomId":"12313",
			"communityId":"小区ID",
			"unitPrice":"填写具体值",
			"section":"填写具体值",
			"remark":"填写具体值",
			"layer":"填写具体值",
			"builtUpArea":"填写具体值",
			"roomNum":"填写具体值",
			"unitId":"填写具体值",
			"apartment":"填写具体值"
			}

			返回报文：
			成功

			```

New file
			@@ -0,0 +1,60 @@
			## 变更历史
			版本\|变更内容\|变更时间\|变更人员
			:-: \| :-: \| :-: \| :-:
			v0.01\|初稿\|2019-04-22\|wuxw

			## mysql数据库规范
			* 建表名称过程表为 business + 模块 + 业务意义如 business_sys_privilege 实例表为：模块+业务意义如 sys_privilege
			* 表和表字段需要写备注
			* 每个业务必须包含 business表和 instance表如权限表 business_sys_privilege 和 sys_privilege
			* 新建业务表必须包含 b_id 和 create_time 如：b_id VARCHAR(30) NOT NULL COMMENT '业务Id', create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间'
			* business表必须包含字段 operate 如： operate VARCHAR(4) NOT NULL COMMENT '数据状态，添加ADD，修改MOD 删除DEL'
			* 新建instance表时必须包含字段 status_cd 如：status_cd VARCHAR(2) NOT NULL DEFAULT '0' COMMENT '数据状态，详细参考c_status表，S 保存，0, 在用 1失效'
			* 由于框架问题审核状态信息不能和status_cd 合并为一个，故加入 audit_status_cd varchar(4) NOT NULL DEFAULT '0000' comment '审核状态'

			* 建表参考语句：

			```
			-- 单元信息（business） building 楼宇管理
			CREATE TABLE business_building_unit(
			unit_id VARCHAR(30) NOT NULL COMMENT '单元ID',
			b_id VARCHAR(30) NOT NULL COMMENT '业务Id',
			unit_num VARCHAR(12) NOT NULL COMMENT '单元编号',
			floor_id VARCHAR(30) NOT NULL COMMENT '楼ID',
			layer_count int NOT NULL COMMENT '总层数',
			lift varchar(4) NOT NULL COMMENT '是否有电梯 1010有 2020 无',
			user_id VARCHAR(30) NOT NULL COMMENT '用户ID',
			remark VARCHAR(200) NOT NULL COMMENT '备注',
			create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
			operate VARCHAR(4) NOT NULL COMMENT '数据状态，添加ADD，修改MOD 删除DEL'
			);


			CREATE INDEX idx_business_unit_id ON business_building_unit(unit_id);
			CREATE INDEX idx_business_unit_b_id ON business_building_unit(b_id);

			-- 单元信息（instance）
			CREATE TABLE building_unit(
			unit_id VARCHAR(30) NOT NULL COMMENT '单元ID',
			b_id VARCHAR(30) NOT NULL COMMENT '业务Id',
			unit_num VARCHAR(12) NOT NULL COMMENT '单元编号',
			floor_id VARCHAR(30) NOT NULL COMMENT '楼ID',
			layer_count int NOT NULL COMMENT '总层数',
			lift varchar(4) NOT NULL COMMENT '是否有电梯 1010有 2020 无',
			user_id VARCHAR(30) NOT NULL COMMENT '用户ID',
			remark VARCHAR(200) NOT NULL COMMENT '备注',
			create_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
			status_cd VARCHAR(2) NOT NULL DEFAULT '0' COMMENT '数据状态，详细参考c_status表，S 保存，0, 在用 1失效',
			UNIQUE KEY (unit_id)
			);
			CREATE INDEX idx_unit_b_id ON building_unit(b_id);
			CREATE UNIQUE INDEX idx_unit_id ON building_unit(unit_id);

			```


			## java代码规范


			## 前段代码规范