干货！高效编码之谋篇布局-CSDN博客

本文链接：https://blog.csdn.net/y4x5M0nivSrJaY3X92c/article/details/109233651

作者 | SUNNY

企鹅杏仁架构师

高效编码不是高速编码，而是在相同或更短的时间内交付质量更高、更易维护的代码。

首先简单介绍一下，高效编码的三个步骤：

编码的步骤

1、设计组件和接口：设计组件和组件之间交互的接口。

2、编写骨架代码：编写组件和接口的胶水代码，将组件搭建和组装起来。

3、编写实现代码：编写实现接口功能的具体代码。

闲话少叙，接下来，让我们通过一个案例来演示从设计到编码全过程。

案例

案例：对网关的路由表进行分组。

背景：由于历史原因公司上海部和成都部分别建设了一个网关系统，现在需要将两地的网关合二为一，由于网关非常重要，必须要保证迁移过程的安全可靠，同时还要满足日常需求（高速上换轮胎），我们决定使用分组分批迁移的方案。由于上海网关没有路由分组功能，实施起来人工成本太高，所以需要实现对路由表进行分组的功能。

要求：

（1）不修改路由数据模型（不增加分组字段）。

（2）控制时间，必须快速的完成开发和测试（小于 8 小时）。

1 、设计组件和接口

设计组件和组件之间交互的接口，如下图：

组件说明：

（1）RouteView 路由视图组件：渲染路由表页面。

（2）RouteController 路由控制器组件：查询路由表数据，通过视图组件渲染路由表。

（3）RouteCache 路由缓存组件：从缓存中高效读取路由表。

（4）RedisService 缓存服务组件：提供 Redis 通用缓存读写服务。

（5）hashOperations 哈希表操作器组件：提供 Redis 哈希表读写服务。

注：a）网关管理面板使用 MVC + Thymeleaf 实现。b）网关路由表使用 Redis 做为“持久层”。

组件之间的依赖关系：

（1）控制器主线：RouteController 依赖视图 RouteView 和路由数据缓存组件 RouteCache。

（2）视图支线：Routeview 依赖路由数据 routes。

（3）数据支线：RouteCache 依赖 RedisService，RedisService 依赖 hashOperations。

注：如果依赖关系特别复杂，可以借助思维导图来梳理。

组件与组件之间交互的接口：

通过梳理组件之间的依赖和交互关系，我们能快速准确的定义组件之间交互的接口：

（1）RouteController # routes(group)：路由控制器 # 分组展示路由表。

（2）RouteCache # getRoutes(group) ：路由缓存 # 获取指定分组的路由表。

（3）RedisService # scanHash(prefix) ：缓存服务 # 获取哈希表键中有指定前缀的子哈希表。

（4）hashOperations # scan(...) ：哈希表操作器 # 扫描哈希表。

组件接口设计基本原则：

（1）在对的层次上做对的抽象：

组件	层次	功能
RouteController	MVC 中的控制器	协调 Model 数据与 View 视图的交互，控制哪些数据在哪个视图上进行展示
RoutesView	MVC 中的视图	实现数据展示
RoutesVO	MVC 中的模型	定义在视图中展示的数据模型
RouteCache	数据访问层	从缓存中高效读取路由表（业务相关）
RedisService	缓存服务层	提供 Redis 通用缓存读写接口（与具体业务解耦）
hashOperations	哈希表操作器	提供 Redis 哈希表读写接口

（2）每个接口只做一件事：

接口	组件	职责
routes (group)	RouteController	查询并展示某分组的路由表
getRoutes (group)	RouteCache	从缓存中查询某分组的路由表
scanHash (prefix)	RedisService	扫描 Redis 哈希表键中有指定前缀的子哈希表
scan (...)	hashOperations	扫描 Redis 哈希表（通用方法）

2、编写骨架代码

通过第 1 步的组件和接口设计，我们能快速的编写各个组件的骨架代码：

（1）RouteController # routes (group)：查询并展示某分组的路由表

public Mono<String> routes (final Model model,
                            @QueryParam("group") String group) {
  // TODO: 1.1 按分组获取路由表：routeCache.getRouteMap(group): Map<routeId, routeDefinition>
  // TODO: 1.2 将路由缓存模型转换为路由视图模型：routeVoTransfer.from(RouteDefinition): RouteVO
  // TODO: 1.3 构造路由表视图模型：buildRoutesVo(routeVoList): RoutesVO
  // TODO: 1.4 渲染视图
}

（2）RouteCache # getRoutes (group)：从缓存中查询某分组的路由表

public Map<String, RouteDefinition> getRoutes (String group) {
  // TODO: 2.1 扫描有带有分组前缀的缓存字典：redisService.scanHash(KEY, group)
  // TODO: 2.2 反序列化缓存路由表：routeDefinitionTransfer.from(RouteJson): RouteDefinition
}

（3）RedisService # scanHash：扫描 Redis 哈希表键中有指定前缀的子哈希表

public Map<String, Object> scanHash (String key, String prefix, long limit) {
  // TODO: 3.1 构造 scanOptions
  // TODO: 3.2 扫描哈希表：hashOperations.scan(key, scanOptions)
}