java110
2020-07-03 3bec053fc1f3f1de35a330cecab2acb0aa0f65ac
docs/document/README.md
@@ -1,197 +1,70 @@
### 变更历史
版本|变更内容|变更时间|变更人员
:-: | :-: | :-: | :-:
v0.01|初稿|2018-07-24|wuxw
## 介绍
HC小区物业管理系统是由java110团队于2017年4月份发起的前后端分离、分布式架构开源项目,目前我们的代码开源在github 和gitee上,
开源项目由HC小区管理系统后端,HC小区管理系统前端,HC小区管理系统业主手机版和HC小区管理系统物业手机版
## 源码下载
[https://gitee.com/java110](https://gitee.com/java110)
## 在线体验
地址:[https://hc.demo.winqi.cn/](https://hc.demo.winqi.cn/)
物业 账号/密码:wuxw/admin
代理商 账号/密码:dails/admin
运维团队 账号/密码:admin/admin
开发团队 账号/密码:dev/(由于开发者权限较大,删除数据会影响稳定性,查看具体功能,可以单独部署在u_user 表中修改)
## 系统要求
### 开发工具
java1.8 + idea/eclipse + mysql + redis
### 硬件要求
测试环境基本要求:4个CPU 、16G内存和80G硬盘
### 软件要求
需要自行安装 mysql5.6、zookeeper、Redis和kafka
需要启动 service-eureka、service-api、service-order、service-community、
service-store、service-user、service-front、service-fee、service-common和service-job
### 本页内容
## 项目结构说明
1. [中心服务sql](#中心服务sql)
2. [用户服务sql](#用户服务sql)
3. [商品服务sql](#商品服务sql)
4. [商户服务sql](#商户服务sql)
5. [评论服务sql](#评论服务sql)
6. [日志相关sql](#日志相关sql)
7. [配置说明](#配置说明)
8. [二次开发](#二次开发)
     java110-bean      #存放实体bean Vo对象(前台返回对象) Dto对象(数据传输对象) Po对象(数据库持久层对象)
     java110-config    #存放系统配置类,公共配置文件如logback.xml 日志配置文件
     java110-core      #存放系统核心类,各个微服务接口类,上下文对象,工厂类和事件相关类
     java110-db        #存放整套系统的SQL文件mapper
     java110-generator #代码生成器
     java110-service   #存放服务基础信息,基本存放基类和自研动态SQL解析引擎
     java110-util      #存放工具类,如时间工具类,日志工具类 常量类 异常处理类
     service-api       #统一接口封装服务,对外提供统一场景化接口能力
     service-comment   #评论信息存放服务
     service-common    #配置公共存放服务,包括图片上传ftp, 工作流,设备信息
     service-community #小区资产信息 存放服务 楼栋 单元 房屋 巡检 通知 停车位 报修 访客等功能
     service-eureka    #微服务管理服务
     service-fee       #费用处理微服务 费用项功能 缴费 退费功能
     service-front     #统一对外接入服务,主要处理 登录验证 权限验证,对接微信 ,app 等
     service-job       #系统定时任务服务 人脸同步设备 员工同步考勤机和费用定时出账
     service-log       #系统日志记录服务
     service-order     #系统服务调度服务,主要保证事务一致性,和业务轨迹记录
     service-report    #报表服务
     service-rule      #业务规则服务
     service-sequence  #序列生成服务,采用 google 雪花算法
     service-store     #商户服务,系统中 物业 代理商 开发者 运营团队 都属于商户
     service-user      #用户服务,用户信息 业主信息 家庭成员
### 简介
  微小区服务文档由java110团队编写,主要包括:安装教程,接口协议,配置说明和二次开发等
## 联系我们
### 安装文档
HC小区管理系统交流群 827669685
  包括中间件部署,服务打包,数据配置,服务部署
    [安装部署](install)
### 维护sql
  ##### 中心服务sql
  1. 订单相关sql:
  ```
    -- 订单表
    select a.* from c_orders a ;
    -- 订单属性表
    select a.* from c_orders_attrs a;
    -- 业务表
    select a.* from c_business a;
    -- 业务属性表
    select a.* from c_business_attrs a;
    -- 订单类型表
    select a.* from c_order_type a;
    -- 业务类型表
    select a.* from c_business_type a;
  ```
  2. 服务配置相关sql:
  ```
  -- 外部应用表
  select a.* from c_app a ;
  -- 服务提供表
  select a.* from c_service a;
  -- 外部应用 和 服务关联表
  select a.* from c_route a;
  -- 查询类 服务实现表
  select a.* from c_service_sql a;
  ```
  3. 公共配置sql:
  ```
    -- 数据映射表
    select a.* from c_mapping a;
    -- 规格表
    select a.* from spec a;
    -- 状态表
    select a.* from c_status a;
  ```
  ##### 用户服务sql
  ```
    -- 用户Business表
    select a.* from business_user a;
    -- 用户Business 属性表
    select a.* from business_user_attr a;
    -- 用户Business物流地址
    select a.* from business_user_address a;
    -- 用户Business标签
    select a.* from business_user_tag a;
    -- 用户Business证件 表
    select a.* from business_user_credentials a;
    -- 用户表
    select a.* from u_user a;
    -- 用户属性表
    select a.* from u_user_attr a;
    -- 用户物流地址
    select a.* from u_user_address a;
    -- 用户标签
    select a.* from u_user_tag a;
    -- 用户证件表
    select a.* from u_user_credentials a;
    -- 用户等级
    select a.* from user_level a;
    -- 用户位置
    select a.* from u_location a;
    -- 用户tag字典表
    select a.* from tag a;
    -- 用户标签字典表
    select a.* from credentials a;
  ```
  #####  商品服务sql
  ```
    -- 商品 Business 表
    select a.* from business_shop a;
    -- 商品属性 Business 表
    select a.* from business_shop_attr a;
    -- 商品目录 Business 表
    select a.* from business_shop_catalog a;
    -- 商店照片 Business表
    select a.* from business_shop_photo a ;
    -- 商品属性 离散值 Business表
    select a.* from business_shop_attr_param a;
    -- 商品优惠 Business表
    select a.* from business_shop_preferential a ;
    -- 商品描述 Business表
    select a.* from business_shop_desc a ;
    -- 商品表
    select a.* from s_shop a;
    -- 商品属性表
    select a.* from s_shop_attr a;
    -- 商品属性 离散值表,例如 手机颜色 黑 白 红
    select a.* from s_shop_attr_param a;
    -- 商品优惠表
    select a.* from s_shop_preferential a;
    -- 商品描述
    select a.* from s_shop_desc a;
    -- 商品照片
    select a.* from s_shop_photo a;
    -- 商品目录
    select a.* from s_shop_catalog a ;
    -- 商品购买记录
    select a.* from s_buy_shop a ;
    -- 商品购买属性
    select a.* from s_buy_shop_attr a;
  ```
  ##### 商户服务sql
  ```
    -- 商户 Business 表
    select a.* from business_store a;
    -- 商户 属性 Business 表
    select a.* from business_store_attr a;
    -- 商户照片 Business表
    select a.* from business_store_photo a ;
    -- 商户证件 Business表
    select a.* from business_store_cerdentials a ;
    -- 商户表
    select a.* from s_store a ;
    -- 商户属性表
    select a.* from s_store_attr a ;
    -- 商户照片表
    select a.* from s_store_photo a ;
    -- 商户证件表
    select a.* from s_store_cerdentials a ;
    -- 商户种类
    select a.* from store_type a ;
  ```
  ##### 评论服务sql
  ```
    -- 评论表
    select  a.* from c_comment a;
    -- 评论子表
    select a.* from c_sub_comment a;
    -- 评论属性表
    select a.* from c_sub_comment_attr a ;
    -- 评论照片表
    select  a.* from c_sub_comment_photo a;
    -- 评论分数表
    select a.* from c_comment_score a ;
  ```
  ##### 日志相关sql
  ```
  -- 交互日志记录表
  SELECT * FROM l_transaction_log a ;
  -- 交互日志报文记录表
  SELECT * FROM l_transaction_log_message a ;
  ```
### 配置说明
   主要说明 中心服务配置
       [配置说明](center_config)
### 二次开发
  包括新建服务,新增配置,测试方法
      [二次开发](develop)
作者:928255095