# zero-one-smart-community

**Repository Path**: zhe-shi-shen-me-gui/zero-one-smart-community

## Basic Information

- **Project Name**: zero-one-smart-community
- **Description**: 零一智慧社区，是一个小区物业管理系统
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: v1.0.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 14
- **Created**: 2023-05-25
- **Last Updated**: 2023-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# `zero-one-smart-community`

物业管理相关概念参考：

- https://zh.wikipedia.org/zh-my/%E7%89%A9%E6%A5%AD%E7%AE%A1%E7%90%86
- https://baike.baidu.com/item/%E7%89%A9%E4%B8%9A%E7%AE%A1%E7%90%86/450
- http://www.gov.cn/gongbao/content/2016/content_5139402.htm

## 项目简介

**零壹智慧社区**是一款社区管理系统，目标在于：打造一套数字化智能物业管理系统，帮助物业公司最大程度降本增效；打造智慧社区，提供丰富的社区增值服务，便利于业主，提升住家幸福感；逐步打造IoT智能物联系统，多样化硬件对接，整合硬件设备，打破设备信息孤岛，实现智能互联；提供商家入驻，构建社区商城系统。

功能蓝图涵盖：房产、业主、 线上缴费、线上报修、投诉建议、采购、巡检、停车、门径、道闸、监控、工作流、问卷和公告等等。

## 系统架构图

项目主体骨架基于`Spring Cloud Alibaba`生态体系，使用`MySQL`进行数据持久化管理，采用`Vue3`生态体系与`Element Puls` `UI`框架完成前端制作，同时项目提供`C++`微服务开发解决方案与集成。

![architecture](./documents/00、preview-pic/architecture.jpg)

## 项目结构说明
> `zero-one-smart-community`  
>
> > `.gitignore` -- 忽略提交配置
> >
> > `README.md` -- 项目自述文件
> >
> > `documents` -- 环境搭建、编码规范、项目需求等等文档资源
> >
> > `sc-java` -- `Java`项目主体
> >
> > `sc-cpp` -- `C++`项目主体
> >
> > `sc-frontend` -- 前端项目主体

## 软件架构

### `Java`技术栈

#### 后端核心技术栈

版本匹配参考：

https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E

| 技术                     | 说明                   | 版本          | 备注                                                         |
| ------------------------ | ---------------------- | ------------- | ------------------------------------------------------------ |
| `Spring`                 | 容器                   | 5.2.15        | https://spring.io/                                           |
| `Spring Web MVC`         | `MVC`框架              | 5.2.15        | https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html |
| `Beanvalidation`         | 实体属性校验           | 2.0.2         | https://beanvalidation.org/2.0-jsr380/<br>https://www.baeldung.com/spring-boot-bean-validation |
| `MyBatis`                | `ORM`框架              | 3.5.7         | http://www.mybatis.org/mybatis-3/zh/index.html               |
| `MyBatis Plus`           | `MyBatis`的增强工具    | 3.4.3.4       | https://baomidou.com/                                        |
| `MyBatis Plus Generator` | 代码生成器             | 3.5.1         | https://github.com/baomidou/generator                        |
| `Druid`                  | 数据库连接池           | 1.2.8         | https://github.com/alibaba/druid                             |
| `Lombok`                 | 实体类增加工具         | 1.18.20       | https://github.com/rzwitserloot/lombok                       |
| `Hutool`                 | Java工具类库           | 5.8.3         | https://hutool.cn/docs/#/                                    |
| `Knife4j`                | 接口描述语言           | 2.0.8         | https://gitee.com/xiaoym/knife4j                             |
| `Nimbus JOSE JWT`        | `JSON Web Token`       | 8.21          | https://bitbucket.org/connect2id/nimbus-jose-jwt/wiki/Home   |
| `Spring Boot`            | Spring快速集成脚手架   | 2.3.12        | https://spring.io/projects/spring-boot                       |
| `Spring Cloud`           | 微服务框架             | `Hoxton.SR12` | https://spring.io/projects/spring-cloud                      |
| `Spring Cloud Alibaba`   | 微服务框架             | 2.2.8         | https://github.com/alibaba/spring-cloud-alibaba/wiki         |
| `Spring Cloud Security`  | 认证和授权框架         | 2.2.5         | https://spring.io/projects/spring-cloud-security             |
| `Sentinel`               | 分布式系统的流量防卫兵 | 1.8.4         | https://sentinelguard.io/zh-cn/                              |
| `Seata`                  | 分布式事务解决方案     | 1.5.1         | https://seata.io/zh-cn/                                      |

#### 后端扩展技术栈

版本匹配参考：

https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/#preface.requirements

| 技术                        | 说明                   | 版本   | 备注                                                         |
| --------------------------- | ---------------------- | ------ | ------------------------------------------------------------ |
| `easyexcel`                 | Excel报表              | 3.0.5  | https://github.com/alibaba/easyexcel                         |
| `RocketMQ`                  | 消息队列中间件         | 4.9.3  | https://github.com/alibaba/spring-cloud-alibaba/wiki/RocketMQ |
| `Spring WebSocket`          | 及时通讯服务           | 5.2.15 | https://docs.spring.io/spring-framework/docs/5.3.15/reference/html/web.html#websocket |
| `FastDFS`                   | `dfs`客户端            | 2.0.1  | https://gitee.com/zero-awei/fastdfs-spring-boot-starter      |
| `Elasticsearch`             | 分布式搜索和分析引擎   | 7.6.2  | https://www.elastic.co/guide/en/elasticsearch/reference/7.6/index.html |
| `LogStash`                  | 日志收集工具           | 7.6.2  | https://www.elastic.co/guide/en/logstash/7.6/index.html      |
| `Kibana`                    | 日志可视化查看工具     | 7.6.2  | https://www.elastic.co/guide/en/kibana/7.6/index.html        |
| `logstash-logback-encoder`  | `Logstash`日志收集插件 | 6.6    | https://github.com/logfellow/logstash-logback-encoder/tree/logstash-logback-encoder-6.6 |
| `spring-data-elasticsearch` | spring集成es           | 4.0.9  | https://docs.spring.io/spring-data/elasticsearch/docs/4.0.9.RELEASE/reference/html/#preface |
| `spring-boot-admin`         | 服务管理和监控面板     | 2.3.1  | https://github.com/codecentric/spring-boot-admin             |

### 前端技术栈

#### 核心技术栈

| 技术           | 说明             | 版本                                                         | 备注                                 |
| -------------- | ---------------- | ------------------------------------------------------------ | ------------------------------------ |
| `Vue`          | 前端框架         | `v3.x`                                                       | https://v3.vuejs.org/                |
| `Vue-Router`   | 路由框架         | `v4.x`                                                       | https://next.router.vuejs.org/       |
| `Pinia`        | 全局状态管理框架 | `v2.x`                                                       | https://pinia.vuejs.org/             |
| `Axios`        | HTTP中间件       | [v0.27.2](https://github.com/axios/axios/releases/tag/v0.27.2) | https://github.com/axios/axios       |
| `Element-Plus` | 前端`UI`框架     | latest                                                       | https://element-plus.gitee.io/zh-CN/ |

#### 扩展技术栈

| 技术       | 说明                    | 版本     | 备注                     |
| ---------- | ----------------------- | -------- | ------------------------ |
| `Avue`     | 基于`ElementUI`二次封装 | `v3.1.4` | https://v3.avuejs.com/   |
| `V-Charts` | 基于`Echarts`的图表框架 | latest   | https://v-charts.js.org/ |

### `CPP`技术栈

#### 后端核心技术栈

| 技术              | 说明                         | 版本                                                         | 备注                                                         |
| ----------------- | ---------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `cinatra`         | `Http`框架                   | [d91b912bb6](https://github.com/qicosmos/cinatra/tree/d91b912bb63193eb2592732445ebf14c96e78180) | https://github.com/qicosmos/cinatra                          |
| `nlohmann/json`   | `json`框架                   | [v3.10.5](https://github.com/nlohmann/json/releases/tag/v3.10.5) | https://github.com/nlohmann/json                             |
| `asio`            | 网络和低级I/O编程的跨平台C库 | 1.20.0                                                       | https://think-async.com/Asio/                                |
| `MySQL Connector` | `MySQL`连接驱动库            | 8.0.27                                                       | https://dev.mysql.com/downloads/connector/cpp/<br>https://dev.mysql.com/doc/connector-cpp/1.1/en/connector-cpp-apps.html |
| `JWT`             | `JSON` Web Token             | [v1.4](https://github.com/arun11299/cpp-jwt/tree/v1.4)       | https://opensourcelibs.com/lib/cpp-jwt                       |
| `OpenSSL`         | 开源安全套接层协议           | `1.1.1L`                                                     | https://www.openssl.org/<br>https://www.xolphin.com/support/OpenSSL/OpenSSL_-_Installation_under_Windows |

#### 后端扩展技术栈

| 技术       | 说明              | 版本     | 备注                                          |
| ---------- | ----------------- | -------- | --------------------------------------------- |
| `xlnt`     | excel报表         | 1.5.0    | https://github.com/tfussell/xlnt              |
| `fastdfs`  | 文件存储客户端    | latest   | https://gitee.com/fastdfs100                  |
| `yaml-cpp` | 解析`yaml`数据    | 0.7.0    | https://github.com/jbeder/yaml-cpp            |
| `nacos`    | `nacos`客户端     | `v1.1.0` | https://github.com/nacos-group/nacos-sdk-cpp  |
| `redis++`  | `redis`连接客户端 | 1.3.2    | https://github.com/sewenew/redis-plus-plus    |
| `rocketmq` | `rokcetmq`客户端  | 2.1.0    | https://github.com/apache/rocketmq-client-cpp |

#### 测试前端技术栈

| 技术         | 说明       | 版本  | 备注                            |
| ------------ | ---------- | ----- | ------------------------------- |
| `jQuery`     | Ajax框架   | 3.6.0 | https://jquery.com/             |
| `HTML5`      | 文本页面   | 5     | https://www.w3schools.com/html/ |
| `CSS3`       | 页面样式表 | 3     | https://www.w3schools.com/css/  |
| `JavaScript` | 页面小脚本 | `ES6` | https://www.w3schools.com/js/   |

## 环境要求

### 开发工具

| 工具            | 说明                  | 版本     | 备注                                                         |
| --------------- | --------------------- | -------- | ------------------------------------------------------------ |
| `Navicat`       | 数据库连接工具        | latest   | https://www.navicat.com.cn/                                  |
| `RDM`           | `Redis`可视化管理工具 | latest   | https://github.com/uglide/RedisDesktopManager<br>https://gitee.com/qishibo/AnotherRedisDesktopManager |
| `PowerDesigner` | 数据库设计工具        | 16.6     | http://powerdesigner.de/                                     |
| `Axure`         | 原型设计工具          | 9        | https://www.axure.com/                                       |
| `MindMaster`    | 思维导图设计工具      | latest   | http://www.edrawsoft.cn/mindmaster                           |
| `Visio`         | 流程图绘制工具        | latest   | https://www.microsoft.com/zh-cn/microsoft-365/visio/flowchart-software |
| `Apipost`       | `API`接口调试工具     | latest   | https://www.apipost.cn/                                      |
| `Mock.js`       | `API`接口模拟测试     | latest   | http://mockjs.com/                                           |
| `Git`           | 项目版本管控工具      | latest   | https://git-scm.com/                                         |
| `TAPD`          | 开发过程管控软件      | latest   | https://www.tapd.cn/                                         |
| `IDEA`          | `Java`开发`IDE`       | 2022.1.3 | https://www.jetbrains.com/idea/download                      |
| `Apache Maven`  | Maven 构建工具        | 3.6.3    | https://maven.apache.org/                                    |
| `Docker Maven`  | Maven Docker插件      | 0.40.2   | https://dmp.fabric8.io/<br>https://github.com/fabric8io/docker-maven-plugin |
| `VS`            | `C++`开发`IDE`        | 2019     | https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes |
| `Cmake`         | `C++`跨平台编译       | latest   | https://cmake.org/cmake/help/latest/index.html               |

### 开发环境

| 依赖环境  | 版本       | 备注                      |
| --------- | ---------- | ------------------------- |
| `Windows` | 10+        | 操作系统                  |
| `JDK`     | 1.8.0_191+ | https://www.injdk.cn/     |
| `NodeJS`  | 16.17.0    | https://nodejs.org/zh-cn/ |
| `NPM`     | 8.19.2     | https://www.npmjs.com/    |

### 服务器环境

| 依赖环境    | 版本                                                         | 备注                                                         |
| ----------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `Anolis OS` | `8.6 GA`                                                     | https://openanolis.cn/anolisos                               |
| `Docker`    | latest                                                       | https://www.docker.com/                                      |
| `MySQL`     | 8                                                            | https://www.mysql.com/cn/                                    |
| `Redis`     | 6.2.7                                                        | https://redis.io/                                            |
| `Nacos`     | 2.1.0                                                        | https://nacos.io/zh-cn/docs/quick-start-docker.html          |
| `Sentinel`  | 1.8.4                                                        | https://github.com/alibaba/Sentinel/releases                 |
| `Seata`     | 1.5.1                                                        | https://github.com/seata/seata                               |
| `RocketMQ`  | 4.9.3                                                        | https://rocketmq.apache.org/                                 |
| `Nginx`     | latest                                                       | https://nginx.org/en/                                        |
| `FastDFS`   | [V6.07](https://github.com/happyfish100/fastdfs/releases/tag/V6.07) | https://gitee.com/fastdfs100                                 |
| `ELK`       | 7.6.2                                                        | https://www.elastic.co/guide/en/elastic-stack/7.6/index.html |
| `Jenkins`   | latest                                                       | https://www.jenkins.io/zh/doc/book/installing/               |

## 特别鸣谢

`zero-one-smart-community`的诞生离不开开源软件和社区的支持，感谢以下开源项目及项目维护者：

- spring：https://github.com/spring-projects
- alibaba：https://github.com/alibaba
- mybatis：https://github.com/mybatis/mybatis-3.git
- mp：https://github.com/baomidou
- api：https://gitee.com/xiaoym/knife4j
- `vue`：https://github.com/vuejs
- ui：https://github.com/ElemeFE
- cinatra：https://github.com/qicosmos/cinatra
- 业务参考项目：https://gitee.com/wuxw7/MicroCommunity

同时也感谢其他没有明确写出来的开源组件提供给与维护者。

## 支持一下

如果觉得框架和项目还不错，点个⭐Star，这将是对“01星球”极大的鼓励与支持。

想了解更多关于计算机方向选择、学习建议等相关信息，可以关注[01星球B站主页](https://space.bilibili.com/1653229811?spm_id_from=333.1007.0.0)~