手把手教你如何实现代码扩展点设计
lipiwang 2024-10-31 15:24 17 浏览 0 评论
引言
在我们写业务代码的时候,无可避免肯定会涉及到业务逻辑分支,从而写if-else类似的语句。如果当前逻辑只有一个if-else,则不会过度影响代码可读性,但是当if 代码块的逻辑膨胀、else代码块的逻辑膨胀,那么整体代码的可读性就非常差,因为随着逻辑膨胀,if-else 代码块还会继续出现更多的if-else。
正常情况下,初学者一般都会封装方法,即把if代码块的逻辑封装到另外一个方法里面,这样子看起来恢复了之前的样子,只有一个if-else。但是,这样其实并没有解决根本问题:代码可读性差。 因为在阅读代码的时候,还是会进入封装的方法内,然后方法内会有更多的if-else等着你。随着逻辑分支的增多,人的脑力一般是无法同时记住之前的逻辑,所以整体代码的可读性还是很差。
那遇到这类问题,我们该如何解决呢?
思路
根本原因是我们脑力无法去深入梳理逻辑,归纳逻辑,总是看后面忘了前面,那么如果我们把多个层级的逻辑梳理出来,归纳成单层级逻辑,那么整体的代码可读性就容易理解了。原来的多层级逻辑实例如下图:
类似这种,就是多层级逻辑结构,如果只是封装方法,那么作为代码阅读者就会陷入各种if else 内部的方法跳转中,而无法从整体去理解业务。
那么基于这种常见的多层级逻辑,我们应该拆分为单层级逻辑,如下图:
这样子,我们在代码处理上,就可以拆分为1个业务逻辑处理接口、4个业务逻辑处理实现类,1个工厂类或者上下文类。 然后在主逻辑代码块上通过工厂类获取封业务逻辑处理接口实例,然后调用处理方法。从而实现业务的封装和抽象,即把这块相关逻辑抽象为一个接口,不同的实现。下次如果再增加一个逻辑,则只要新增一个实现类,在工厂方法新增一个类型标识即可,主逻辑代码不变。
实现方案一
这里以路边的地磁停车位为例,具体的线下业务是在停车场会安装一个地磁硬件,当有车进来的时候会上报一个车辆驶入事件,车出去的时候会上报一个车辆驶出事件,除了这2事件,当车位被占用或者空闲的时候,会上报2个心跳:持续占用和持续空闲
结合上面的业务,不同事件会有不同的处理方式,这里我们会创建一个状态处理接口,该接口有2个方法,一个返回状态枚举、一个处理方法,如下:
public interface StateHandler {
DeviceStatusEnum state();
void handle(String deviceNo, String code);
}
然后,我们再创建一个工厂类或者叫上下文处理类,通过Spring的构造器注入所有实现StateHandler接口的实现类,然后放入当前实例的缓存map中,另外还提供一个根据枚举返回处理器的方法,具体如下:
@Component
public class StateContext {
public Map<DeviceStatusEnum, StateHandler> stateMap = new HashMap<>();
public StateContext(List<StateHandler> stateHandlerList){
stateHandlerList.forEach(handler -> {
stateMap.put(handler.state(), handler);
});
}
public StateHandler getHandler(DeviceStatusEnum state){
return stateMap.get(state);
}
}
接下来就是具体状态的处理实现类,这里只放车辆驶出的处理类,如下:
@Component
public class OutStateHandler implements StateHandler{
@Override
public DeviceStatusEnum state() {
return DeviceStatusEnum.OUT;
}
@Override
public void handle(String deviceNo, String code) {
// TODO
}
}
这样子,在主逻辑代码只要根据状态类型,从工厂类获取处理器类,然后执行方法即可,如下:
DeviceStatusEnum state = DeviceStatusEnum.get(status.getStatus());
StateHandler handler = stateContext.getHandler(state);
handler.handle(request.getSN(), request.getBerthCode());
这样子即可消除对应的if-else
问题
通过上述的方案一,我们实现了消除基本的if-else,但是我们再深入思考下,方案一会有什么问题? 很明显,这是针对具体业务的一个实现方式,该实现方式需要1个上下文类、1个接口、对应的N个实现类,那么当我们的业务代码有多个不同业务的if-else,每个业务都需要创建2+N个类,造成了类膨胀。
所以,针对该问题,我们还需要对上述的实现方式进行抽象,让它更实用 。
实现方案二(最终解决方案)
通过对方案一实现的思考,我们可以对以下几个点进行优化
?针对接口类,我们可以抽象不同业务的接口,该接口只有一个方法,用于返回具体某个业务的枚举类?针对枚举类,不同业务会有不同的枚举类,而枚举类的抽象就是他们的父类:Enum?针对上下文类,原来的map缓存key是具体某个枚举类,value是不同的实现类;而这里为了实现多个业务扩展点,我们key可以设计为枚举类的父类Enum,value为不同实现类的列表
具体的代码如下:
1.创建一个抽象接口,用于返回具体某个业务的枚举类
public interface IExtensionHandler<Y extends Enum>{
Y extension();
}
这里的泛型Y就是具体某个业务的枚举类
2.创建一个上下文类的接口,并实现其默认实现
public interface IExtensionHandlerFactory {
/**
* 添加扩展处理器
* @param extensionHandler 处理器
* @param <Y> 扩展点
*/
<Y extends Enum<Y>>void addExtensionHandler(IExtensionHandler<Y> extensionHandler);
/**
* 获取扩展点处理器
* @param extension 扩展点
* @param type 处理器类型
* @param <T> 扩展处理器
* @param <Y> 扩展点
*/
<T extends IExtensionHandler<Y>,Y extends Enum<Y>> T getExtensionHandler(Y extension, Class<T> type);
}
上下文类的默认实现
@Slf4j
public class DefaultExtensionHandlerFactoryImpl implements IExtensionHandlerFactory, ApplicationContextAware {
private final Map<Enum, List<IExtensionHandler>> serviceListCache = new ConcurrentHashMap<>();
private final Map<ExtensionCacheKey, IExtensionHandler> serviceCache = new ConcurrentHashMap<>();
@Override
public <Y extends Enum<Y>> void addExtensionHandler(IExtensionHandler<Y> extensionHandler) {
Assert.notNull(extensionHandler.extension(), "add extension handler failed, bean class " + extensionHandler.getClass().getName() + " extension is null");
serviceListCache.putIfAbsent(extensionHandler.extension(), new LinkedList<>());
serviceListCache.get(extensionHandler.extension()).add(extensionHandler);
}
@Override
public <T extends IExtensionHandler<Y>, Y extends Enum<Y>> T getExtensionHandler(Y extension, Class<T> type) {
ExtensionCacheKey<Y> cacheKey = new ExtensionCacheKey(extension, type);
IExtensionHandler result = this.serviceCache.get(cacheKey);
if (result == null) {
List<IExtensionHandler> extensionHandlers = serviceListCache.getOrDefault(extension, Collections.synchronizedList(Collections.emptyList()));
for (IExtensionHandler extensionHandler : extensionHandlers) {
if (type.isAssignableFrom(extensionHandler.getClass())) {
result = extensionHandler;
serviceCache.put(cacheKey, result);
break;
}
}
if (result == null) {
log.warn("No IExtensionHandler found by CacheKey : " + cacheKey + " !");
}
}
return (T) result;
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
Map<String,IExtensionHandler> handlerMap = applicationContext.getBeansOfType(IExtensionHandler.class);
log.info("疯狂加载扩展ing ...");
long start = System.currentTimeMillis();
handlerMap.forEach((k, v) -> {
//排除组合类自己
if (!this.getClass().isAssignableFrom(v.getClass())) {
addExtensionHandler(v);
}
});
long end = System.currentTimeMillis();
log.info("加载扩展点结束,耗时: {}, 扩展点个数: {}", end - start, handlerMap.size());
}
}
在默认的上下文实现类中,我们还多了一个Map,该Map是为了提高扩展点的查找而设计的,如果只是使用serviceListCache,那么每次根据某个业务的枚举类会返回对应的扩展处理器列表,需要再循环一次才能找到对应的处理器,这里是设计了一个缓存Key: ExtensionCacheKey, 代码实现如下
@Data
@AllArgsConstructor
@ToString
@EqualsAndHashCode
public class ExtensionCacheKey<T extends Enum> {
private T extension;
private Class<? extends IExtensionHandler<T>> extensionHandlerClass;
}
一个业务枚举类,可能会有不同类型的扩展处理接口,serviceListCache的value值为什么设计成List和为什么需要设计一个ExtensionCacheKey的原因所在。
最后
这个扩展点设计虽然简单,但是在我实践的项目中有大量的使用,也推荐大家理解并使用,对于复杂业务的处理非常有帮助。
另外扩展点设计还有另外一种方式,基于注解的方式,具体实现可以搜下 COLA 4.0
获取完整源码地址:https://gitee.com/anyin/shiro-to-token
相关推荐
- 前端入门——css 网格轨道详细介绍
-
上篇前端入门——cssGrid网格基础知识整体大概介绍了cssgrid的基本概念及使用方法,本文将介绍创建网格容器时会发生什么?以及在网格容器上使用行、列属性如何定位元素。在本文中,将介绍:...
- Islands Architecture(孤岛架构)在携程新版首页的实践
-
一、项目背景2022,携程PC版首页终于迎来了首次改版,完成了用户体验与技术栈的全面升级。作为与用户连接的重要入口,旧版PC首页已经陪伴携程走过了22年,承担着重要使命的同时,也遇到了很多问题:维护/...
- HTML中script标签中的那些属性
-
HTML中的<script>标签详解在HTML中,<script>标签用于包含或引用JavaScript代码,是前端开发中不可或缺的一部分。通过合理使用<scrip...
- CSS 中各种居中你真的玩明白了么
-
页面布局中最常见的需求就是元素或者文字居中了,但是根据场景的不同,居中也有简单到复杂各种不同的实现方式,本篇就带大家一起了解下,各种场景下,该如何使用CSS实现居中前言页面布局中最常见的需求就是元...
- CSS样式更改——列表、表格和轮廓
-
上篇文章主要介绍了CSS样式更改篇中的字体设置Font&边框Border设置,这篇文章分享列表、表格和轮廓,一起来看看吧。1.列表List1).列表的类型<ulstyle='list-...
- 一文吃透 CSS Flex 布局
-
原文链接:一文吃透CSSFlex布局教学游戏这里有两个小游戏,可用来练习flex布局。塔防游戏送小青蛙回家Flexbox概述Flexbox布局也叫Flex布局,弹性盒子布局。它决定了...
- css实现多行文本的展开收起
-
背景在我们写需求时可能会遇到类似于这样的多行文本展开与收起的场景:那么,如何通过纯css实现这样的效果呢?实现的难点(1)位于多行文本右下角的展开收起按钮。(2)展开和收起两种状态的切换。(3)文本...
- css 垂直居中的几种实现方式
-
前言设计是带有主观色彩的,同样网页设计中的css一样让人摸不头脑。网上列举的实现方式一大把,或许在这里你都看到过,但既然来到这里我希望这篇能让你看有所收获,毕竟这也是前端面试的基础。实现方式备注:...
- WordPress固定链接设置
-
WordPress设置里的最后一项就是固定链接设置,固定链接设置是决定WordPress文章及静态页面URL的重要步骤,从站点的SEO角度来讲也是。固定链接设置决定网站URL,当页面数少的时候,可以一...
- 面试发愁!吃透 20 道 CSS 核心题,大厂 Offer 轻松拿
-
前端小伙伴们,是不是一想到面试里的CSS布局题就发愁?写代码时布局总是对不齐,面试官追问兼容性就卡壳,想跳槽却总被“多列等高”“响应式布局”这些问题难住——别担心!从今天起,咱们每天拆解一...
- 3种CSS清除浮动的方法
-
今天这篇文章给大家介绍3种CSS清除浮动的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。首先,这里就不讲为什么我们要清楚浮动,反正不清除浮动事多多。下面我就讲3种常用清除浮动的...
- 2025 年 CSS 终于要支持强大的自定义函数了?
-
大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!1.什么是CSS自定义属性CSS自...
- css3属性(transform)的一个css3动画小应用
-
闲言碎语不多讲,咱们说说css3的transform属性:先上效果:效果说明:当鼠标移到a标签的时候,从右上角滑出二维码。实现方法:HTML代码如下:需要说明的一点是,a链接的跳转需要用javasc...
- CSS基础知识(七)CSS背景
-
一、CSS背景属性1.背景颜色(background-color)属性值:transparent(透明的)或color(颜色)2.背景图片(background-image)属性值:none(没有)...
- CSS 水平居中方式二
-
<divid="parent"><!--定义子级元素--><divid="child">居中布局</div>...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- maven镜像 (69)
- undefined reference to (60)
- zip格式 (63)
- oracle over (62)
- date_format函数用法 (67)
- 在线代理服务器 (60)
- shell 字符串比较 (74)
- x509证书 (61)
- localhost (65)
- java.awt.headless (66)
- syn_sent (64)
- settings.xml (59)
- 弹出窗口 (56)
- applicationcontextaware (72)
- my.cnf (73)
- httpsession (62)
- pkcs7 (62)
- session cookie (63)
- java 生成uuid (58)
- could not initialize class (58)
- beanpropertyrowmapper (58)
- word空格下划线不显示 (73)
- jar文件 (60)
- jsp内置对象 (58)
- makefile编写规则 (58)