add features-status.md to track features develop status

2 years ago · 057c464563
parent 72136a2266
commit 057c464563
2 changed files with 200 additions and 34 deletions
--- a/README.md
+++ b/README.md
@ -314,40 +314,43 @@ release/paopao-ce --no-default-features --features sqlite3,localoss,loggerfile,r
 ```

 目前支持的功能集合:
-* 数据库: MySQL/Sqlite3/PostgreSQL   
-  `Gorm` + `MySQL`/`Sqlite3`/`PostgreSQL` 使用[gorm](https://github.com/go-gorm/gorm)作为数据库的ORM，默认使用 `Grom` + `MySQL`组合(目前状态：稳定，默认，推荐使用)；    
-  `Sqlx` + `MySQL`/`PostgreSQL` 使用[sqlx](https://github.com/jmoiron/sqlx)作为数据库的ORM(目前状态：WIP)；      
-* 对象存储: AliOSS/COS/HuaweiOBS/MinIO/LocalOSS      
-  `AliOSS` 阿里云对象存储服务；    
-  `COS` 腾讯云对象存储服务；  
-  `HuaweiOBS` 华为云对象存储服务；  
-  `MinIO` [MinIO](https://github.com/minio/minio)对象存储服务；  
-  `S3` AWS S3兼容的对象存储服务；    
-  `LocalOSS` 提供使用本地目录文件作为对象存储的功能，仅用于开发调试环境；  
-* 缓存: Redis/SimpleCacheIndex/BigCacheIndex     
-  `SimpleCacheIndex` 提供简单的 广场推文列表 的缓存功能；   
-  `BigCacheIndex` 使用[BigCache](https://github.com/allegro/bigcache)缓存 广场推文列表，缓存每个用户每一页，简单做到千人千面(推荐使用)；  
-* 搜索: Zinc/Meili   
-  `Zinc` 基于[Zinc](https://github.com/zinclabs/zinc)搜索引擎提供推文搜索服务(目前状态: 稳定，推荐使用)；  
-  `Meili` 基于[Meilisearch](https://github.com/meilisearch/meilisearch)搜索引擎提供推文搜索服务(目前状态: 稳定，推荐使用);  
-* 日志: LoggerFile/LoggerZinc/LoggerMeili  
-  `LoggerFile` 使用文件写日志(目前状态: 稳定);   
-  `LoggerZinc` 使用[Zinc](https://github.com/zinclabs/zinc)写日志(目前状态: 稳定，推荐使用);    
-  `LoggerMeili` 使用[Meilisearch](https://github.com/meilisearch/meilisearch)写日志(目前状态: 内测阶段);  
-* 用户关系模式: Friendship/Followship    
-  `Friendship` 弱关系好友模式，类似微信朋友圈(目前状态: 开发阶段);    
-  `Followship` 关注者模式，类似Twitter的Follow模式(目前状态: WIP);    
-* 支付: Alipay   
-  `Alipay`  开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能；   
-* 短信验证码: SmsJuhe(需要开启sms)    
-  `Sms` 开启短信验证码功能，用于手机绑定验证手机是否注册者的；功能如果没有开启，手机绑定时任意短信验证码都可以绑定手机；
-* 开发文档: Docs:OpenAPI     
-  `Docs:OpenAPI` 开启openapi文档功能，提供web api文档说明(visit http://127.0.0.1:8008/docs/openapi)；        
-* 其他: PhoneBind/OSS:Retention/OSS:TempDir     
-  `PhoneBind` 手机绑定功能；     
-  `OSS:Retention` 基于对象存储系统的对象过期自动删除特性实现 先创建临时对象再持久化的功能(目前状态: 内测阶段)；  
-  `OSS:TempDir` 基于对象存储系统的对象拷贝/移动特性实现 先创建临时对象再持久化的功能(目前状态: 内测阶段)；     
-
+| 功能项 | 类别 | 状态 | 备注 |
+| ----- | ----- | ----- | ----- |
+|`OldWeb` | 子服务 | 稳定(默认) | 开启旧的Web服务 |
+|`Web` | 子服务 | WIP | 开启Web服务|
+|`Admin` | 子服务 | WIP | 开启Admin后台运维服务|
+|`SpaceX` | 子服务 | WIP | 开启SpaceX服务|
+|`Bot` | 子服务 | WIP | 开启Bot服务|
+|`NativeOBS` | 子服务 | WIP | 开启NativeOBS服务|
+|`Deprecated:Web` | 子服务 | 稳定 | Deprecated(关闭) OldWeb服务|
+|`Gorm` + `MySQL`/`Sqlite3`/`PostgreSQL` | 数据库 | 稳定(默认) | 使用[gorm](https://github.com/go-gorm/gorm)作为数据库的ORM，默认使用 `Grom` + `MySQL`组合|
+|`Sqlx` + `MySQL`/`Sqlite3`/`PostgreSQL`| 数据库 | WIP | 使用[sqlx](https://github.com/jmoiron/sqlx)作为数据库的ORM|
+|`AliOSS` | 对象存储 | 稳定(推荐) |阿里云对象存储服务|
+|`COS` | 对象存储 | 内测 |腾讯云对象存储服务|
+|`HuaweiOBS` | 对象存储 | 内测 |华为云对象存储服务|
+|`MinIO` | 对象存储 | 稳定 |[MinIO](https://github.com/minio/minio)对象存储服务|
+|`S3` | 对象存储 | 内测 |AWS S3兼容的对象存储服务|
+|`LocalOSS` | 对象存储 | 内测 |提供使用本地目录文件作为对象存储的功能，仅用于开发调试环境|
+|`OSS:Retention` | 对象存储 | 内测 |基于对象存储系统的对象过期自动删除特性实现 先创建临时对象再持久化的功能|
+|`OSS:TempDir` | 对象存储 | 内测 |基于对象存储系统的对象拷贝/移动特性实现 先创建临时对象再持久化的功能|
+|`Redis` | 缓存 | 稳定 | Redis缓存功能 |
+|`SimpleCacheIndex` | 缓存 | 稳定 | 提供简单的 广场推文列表 的缓存功能 |
+|`BigCacheIndex` | 缓存 | 稳定(推荐) | 使用[BigCache](https://github.com/allegro/bigcache)缓存 广场推文列表，缓存每个用户每一页，简单做到千人千面 |
+|`Zinc` | 搜索 | 稳定(推荐) | 基于[Zinc](https://github.com/zinclabs/zinc)搜索引擎提供推文搜索服务 |
+|`Meili` | 搜索 | 稳定(推荐) | 基于[Meilisearch](https://github.com/meilisearch/meilisearch)搜索引擎提供推文搜索服务 |
+|`Bleve` | 搜索 | WIP | 基于[Bleve](https://github.com/blevesearch/bleve)搜索引擎提供推文搜索服务 |
+|`LoggerFile` | 日志 | 稳定 | 使用文件写日志 |
+|`LoggerZinc` | 日志 | 稳定(推荐) | 使用[Zinc](https://github.com/zinclabs/zinc)写日志 |
+|`LoggerMeili` | 日志 | 内测 | 使用[Meilisearch](https://github.com/meilisearch/meilisearch)写日志 |
+|`Friendship` | 用户关系模式 | 内测(默认) | 弱关系好友模式，类似微信朋友圈 |
+|`Followship` | 用户关系模式 | WIP | 关注者模式，类似Twitter的Follow模式 |
+|`Alipay` | 支付 | 稳定 | 开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能 |
+|`Sms` | 短信验证码 | 稳定 | 开启短信验证码功能，用于手机绑定验证手机是否注册者的；功能如果没有开启，手机绑定时任意短信验证码都可以绑定手机 |
+|`Docs:OpenAPI` | 开发文档 | 稳定 | 开启openapi文档功能，提供web api文档说明(visit http://127.0.0.1:8008/docs/openapi) |
+|`PhoneBind` | 其他 | 稳定 | 手机绑定功能 |   
+
+功能项状态详情参考 [features-status](features-status.md).
+     
 ### 搭建依赖环境
 #### [Zinc](https://github.com/zinclabs/zinc) 搜索引擎:
 * Zinc运行
--- a/features-status.md
+++ b/features-status.md
@ -0,0 +1,163 @@
+## Features Status
+功能项状态说明。
+
+## 目前支持的功能集合
+#### 子服务
+* `OldWeb` 开启旧的Web服务(目前状态: 默认)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+    * [x] 接口定义
+    * [x] 业务逻辑实现
+* `Web` 开启Web服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现
+* `Admin` 开启Admin后台运维服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现
+* `SpaceX` 开启SpaceX服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现
+* `Bot` 开启Bot服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现
+* `NativeOBS` 开启NativeOBS服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [ ] 服务初始化逻辑
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现
+* `Deprecated:OldWeb` Deprecated(关闭)旧的Web服务(目前状态: WIP)
+    * [ ] 提按文档
+    * [x] 服务初始化逻辑
+
+#### 数据库:
+* `Gorm` + `MySQL`/`Sqlite3`/`PostgreSQL`
+使用[gorm](https://github.com/go-gorm/gorm)作为数据库的ORM，默认使用 `Grom` + `MySQL`组合(目前状态：稳定，默认，推荐使用)； 
+    * [ ] 提按文档
+    * [x] 接口定义
+    * [x] 业务逻辑实现  
+* `Sqlx` + `MySQL`/`PostgreSQL`
+使用[sqlx](https://github.com/jmoiron/sqlx)作为数据库的ORM(目前状态：WIP)；
+    * [ ] 提按文档
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现  
+    
+#### 对象存储: 
+* `AliOSS` 阿里云对象存储服务；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现    
+* `COS` 腾讯云对象存储服务；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+* `HuaweiOBS` 华为云对象存储服务；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+* `MinIO` [MinIO](https://github.com/minio/minio)对象存储服务；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+* `S3` AWS S3兼容的对象存储服务；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现     
+* `LocalOSS` 提供使用本地目录文件作为对象存储的功能，仅用于开发调试环境；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+* `OSS:Retention` 基于对象存储系统的对象过期自动删除特性实现 先创建临时对象再持久化的功能(目前状态: 内测阶段)；  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+* `OSS:TempDir` 基于对象存储系统的对象拷贝/移动特性实现 先创建临时对象再持久化的功能(目前状态: 内测阶段)；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+
+#### 缓存:
+* `Redis` Redis缓存
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+* `SimpleCacheIndex` 提供简单的 广场推文列表 的缓存功能能； 
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+* `BigCacheIndex` 使用[BigCache](https://github.com/allegro/bigcache)缓存 广场推文列表，缓存每个用户每一页，简单做到千人千面(推荐使用)；  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+
+#### 搜索:
+* `Zinc` 基于[Zinc](https://github.com/zinclabs/zinc)搜索引擎提供推文搜索服务(目前状态: 稳定，推荐使用)；  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+* `Meili` 基于[Meilisearch](https://github.com/meilisearch/meilisearch)搜索引擎提供推文搜索服务(目前状态: 稳定，推荐使用); 
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现  
+* `Bleve` 基于[Bleve](https://github.com/blevesearch/bleve)搜索引擎提供推文搜索服务(目前状态: WIP); 
+    * [ ] 提按文档  
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现  
+#### 日志:
+* `LoggerFile` 使用文件写日志(目前状态: 稳定); 
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+* `LoggerZinc` 使用[Zinc](https://github.com/zinclabs/zinc)写日志(目前状态: 稳定，推荐使用);   
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现  
+* `LoggerMeili` 使用[Meilisearch](https://github.com/meilisearch/meilisearch)写日志(目前状态: 内测阶段);  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+
+#### 用户关系模式:    
+* `Friendship` 弱关系好友模式，类似微信朋友圈(目前状态: 开发阶段); 
+    * [x] 提按文档
+    * [x] 接口定义
+    * [x] 业务逻辑实现     
+* `Followship` 关注者模式，类似Twitter的Follow模式(目前状态: WIP);  
+    * [ ] 提按文档
+    * [ ] 接口定义
+    * [ ] 业务逻辑实现   
+
+### 支付:  
+* `Alipay`  开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能； 
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现   
+
+### 短信验证码: 
+* SmsJuhe(需要开启sms)  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+* `Sms` 开启短信验证码功能，用于手机绑定验证手机是否注册者的；功能如果没有开启，手机绑定时任意短信验证码都可以绑定手机；
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现 
+
+### 开发文档:  
+* `Docs:OpenAPI` 开启openapi文档功能，提供web api文档说明(visit http://127.0.0.1:8008/docs/openapi)；  
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现      
+ 
+### 其他:    
+* `PhoneBind` 手机绑定功能； 
+    * [ ] 提按文档  
+    * [x] 接口定义
+    * [x] 业务逻辑实现