研发手册大纲

技术方案整体概述

• 目前采用MVVM web 架构，原型技术栈主要使用.net 5 + React + EF
• 首先先实现用户常用场景下的一些操作做出技术点例子，如用户注册，登陆，文件上传，下载，看教学视频，能对自己的信息进行管理等，然后在进一步做详细规划

技术点研究

0. 底层技术研究

   • async&await
     • async await 友好的生产者消费者队列实现
   • SIT
     • web api SIT
     • web ui SIT

1. 后端例子

   • 功能相关
     • 日志系统
       • 日志规范，等级，分类
       • 内置日志，自定义日志，第三方日志
     • 认证授权
       • 认证
       • 授权
     • 数据库ORM
       • 数据模型定义，初始化,创建
       • 数据库迁移（Migration）
     • WebAPI
       • 大文件包
         • 上传
         • 下载
       • 其他数据传输(json)
     • 中间件
       • 管道
       • 宿主
     • 服务器路由
     • GRPC
   • 工程相关
     • 编译，打包发布，部署，托管
       • 本地
       • docker
     • K8s
     • 测试
       • 单元测试
       • 半集成测试
       • 测试报告输出
     • 研发手册，根据各级目录生成 (Todo)

2. 前端例子

   • 功能相关
     • 表单
     • 上传
     • 下载
     • 状态管理
     • 用户登陆 TODO
     • 表格控件
     • 界面组件库
     • 路由
     • css 布局，设计实现 TODO
     • 工程化 TODO
     • 过渡和动画 TODO
   • 工程相关
     • 编译部署
     • 单元测试
     • Mock数据
     • E2E测试 TODO
     • 代码规范
     • babel TODO
     • webpack 设置

3. 微服务架构组件

   • K8S
     • K8S 初体验
   • S3
     • S3介绍(C# Interactive Notebook)
   • EFK
     • EFK介绍(Jupyter Notebook)
   • 认证和授权(TODO)
     • JWT 结构介绍
     • Asp.Net Core OAuth2 客户端认证模式实战
   • 分布式追踪
     • Jaeger 分布式追踪体验
     • ZipKin 分布式追踪体验
     • 异构分布式追踪对接演示

WebApp原型（结合所有技术点做出的原型站点）

• Todo

参考资料

• ASP.NET Core Docs

目录结构

.
├── LICENSE
├── Notes
│   └── DataFormat.md
├── PrototypeWebApp
│   └── README.md
├── README.md
├── Resources
│   ├── doc
│   └── video
│       └── react.md
└── TecPoints
    ├── Foundation
    │   ├── AsyncProducerConsumerCollection
    ├── Backend
    │   ├── Authentication
    │   │   ├── Authen
    │   │   ├── Author
    │   │   └── README.md
    │   ├── AutoTest
    │   │   ├── Finally
    │   │   ├── Initial
    │   │   └── README.md
    │   ├── CompileAndPack
    │   │   ├── Finally
    │   │   ├── Initial
    │   │   ├── README.md
    │   │   ├── capture.png
    │   │   ├── kestrel-to-internet.png
    │   │   └── kestrel-to-internet2.png
    │   ├── CustomRouting
    │   │   ├── 01_Initial
    │   │   ├── 02_Finally
    │   │   └── CustomRouting.md
    │   ├── DBMigration
    │   │   ├── Finally1
    │   │   ├── Finally2
    │   │   ├── Initial
    │   │   ├── README.md
    │   │   └── aspnetcore_dbcontext_1.png
    │   ├── DocPro
    │   ├── GRPC
    │   │   ├── Finally
    │   │   ├── Initial
    │   │   ├── README.md
    │   │   ├── capture1.png
    │   │   ├── capture2.png
    │   │   └── gRPC-min.png
    │   ├── Logging
    │   │   ├── Finally
    │   │   ├── Initial
    │   │   └── README.md
    │   ├── Middleware
    │   │   ├── Finally
    │   │   ├── Initial
    │   │   ├── README.md
    │   │   ├── middleware-pipeline.svg
    │   │   ├── mvc-endpoint.svg
    │   │   └── request-delegate-pipeline.png
    │   └── WebApi
    │       ├── Finally
    │       ├── Initial
    │       ├── README.md
    │       ├── architecture.png
    │       ├── network.png
    │       └── network1.png
    └── Frontend
        ├── Form
        │   └── form.md
        ├── form-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── mock-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── nested-router-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── react-hook-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── redux-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── router-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── router-para-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        ├── two-way-binding-demo
        │   ├── README.md
        │   ├── final
        │   └── init
        └── upload-download-demo
            ├── README.md
            ├── final
            └── init

写在最后

关于整体架构，我发现一个非常有趣的项目 https://github.com/damikun/trouble-training

当我们团队考虑做原型和技术公关时，我们并不知道这个的项目存在，如果能早接触到这些图例，对我们理解微服务的格局是非常有意义的。

另外，这个工程更加关注具体的技术点和动手指导，未来可以考虑如何在宏观层面提供原型指导，https://github.com/damikun/trouble-training 值得参考。