1. 代码 & 板书仓库📚
链接:后续更新
2. 概念🔍
在 Java 开发中,脚手架 (Scaffolding) 是一种通过自动化工具生成项目基础结构和样板代码的技术。它类似于建筑工地中的 "脚手架"🏗️,为开发者快速搭建项目框架,避免重复劳动。
2.1 作用
- 提高开发效率:通过自动生成基础代码,减少手动创建文件和编写重复代码的时间。
- 统一项目结构:遵循最佳实践,生成标准化的项目结构,便于团队协作和项目维护。
- 减少错误:自动生成的代码经过验证,减少了人为错误。
- 快速原型开发:可以快速搭建起一个可运行的项目原型,便于演示和早期测试。
- 集成场景最佳实践:通常集成了日志、配置、测试框架等,帮助开发者遵循行业标准。
2.2 封装
"脚手架封装 " 通常指的是在项目启动阶段,通过定制化工具或模板为团队搭建一套标准化的项目基础框架。
2.2.1 封装目标:
- 统一技术栈:固化团队技术选型 (如 Spring Cloud Alibaba + MyBatis-Plus + Redis)。
- 标准化规范:目录结构、代码风格 (Checkstyle)、日志格式 (Logback)、异常处理等。
- 沉淀最佳实践:集成通用模块 (用户认证、日志追踪、监控上报)。
- 提升效率:一键生成 CRUD 代码、自动集成中间件配置。
2.2.2 封装内容:
- 基础项目结构封装:标准化目录树
- 依赖管理封装:锁定所有第三方依赖版本 (避免冲突)
- 通用代码模块封装:封装团队通用组件,异常处理
- 自动化生成工具封装:定制代码生成器
- 基础设施集成:监控,日志,安全,文档
在 C++ 方面很多大厂都会封装一套自己的库和组件,虽然名字不叫脚手架,但是本质上都是工程化的最佳实践👏,我们这里也是基于脚手架的功能和思想,将一些现有的场景解决方案打包封装到一起,生成一个项目的常见功能库,应用于不同的项目中,避免重复造轮子🛞,帮助开发者减少代码重复,从而加快开发进程提高工作效率。
3. 封装📦
本次 C++ 脚手架的封装,我们计划了比较常用的第三方库,以及典型中间件 SDK 进行封装打包,其功能涵盖了配置解析、网络通信、序列化、测试框架、日志输出、音视频处理、数据存储管理等多个方面,具体如下:
3.1 基础功能库
| 名称 | 说明 |
|---|---|
| gflags | 程序参数配置解析库 |
| spdlog | 日志输出库 |
| gtest | 单元测试框架 |
| jsoncpp | json 格式序列化库 |
| protobuf | protobuf 格式序列化库 |
| ffmpeg | 音视频处理库 |
| httplib | HTTP 服务器搭建库 |
| websocketpp | Websocket 服务器搭建库 |
| brpc | rpc 客户端 & 服务器库 |
3.2 中间件及客户端 SDK
| 名称 | 说明 | 客户端 SDK |
|---|---|---|
| aliyun-sms | 阿里云短信服务 | alibabacloud |
| etcd | 键值对存储中间件 | etcd-api-v3 |
| rabbitmq | 消息队列中间件 | amqp-cpp |
| fastdfs | 文件分布式存储中间件 | fastdfs-api |
| mysql | 关系型数据库中间件 | orm 框架 odb |
| redis | 键值对存储中间件 | redis++ |
| elasticsearch | 搜索引擎中间件 | elasticlient |
