Chapter 6 通用情况的模块应该更深

本文探讨了在软件设计中,模块设计的通用性与针对性之间的平衡。通过对比两种不同的设计思路,阐述了面向通用性设计的优势,包括更好的信息隐藏、易于理解和扩展,以及对未来需求的适应性。文章以文本编辑器为例,展示了如何通过设计更加通用的接口,实现更简洁、易懂且灵活的代码。

通用情况的模块应该更深

通常我们在设计一个模块的时候都会遇到一个问题,是把它设计的更加通用呢,还是只是解决眼前的问题。
模块设计得更加通用的话会有以下性质:

  • 能够解决更多的问题
  • 因为很难预料系统以后的需求,因此模块中可能会包含很多从未被用到的功能

在设计类时设计得稍微通用些

模块功能的设计按照当前的需求来进行,但是模块中接口的设计应该设计的通用些,接口的设计不应当和当前的需求耦合

例子:设计一个文本编辑器

目的是设计一个文本编辑器界面,可以打开文件,允许用户修改文本,并且允许在多个窗口中打开同一个文件的视图
首先会设计一个代表文本的类Text,它具有以下几个接口:

void backspace(Cursor cursor);
void delete(Cursor cursor);
void deleteSelection(Selection selection);

其中Cursor代表光标,Selection代表文本范围
然后接着会实现用户接口,这就导致了一个问题,如果这么设计Text类的话,会导致该类中出现很多很浅的接口,每个接口只会在一个用户接口中被用到,比如删除操作,只会在一个地方被用到。开发用户接口的人需要了解大量的Text提供的接口。每添加一个新的用户接口,都需要在Text类中添加相应的接口。所以开发用户接口的人需要同时开发Text接口。

一个更加通用的设计

Text的设计应该更加贴近文本操作的特征,而不应该反映上层的操作,对于修改操作来说,只需要下面两个通用接口:

void insert(Position position, String newText);
void delete(Position start, Position end);

另外使用了Position,而不是反映特定用户的Cursor,另外提供一个改变位置的接口

Position changePosition(Position position, int numChars);

这样删除操作就可以使用如下的代码实现:

text.delete(cursor, text.changePosition(cursor, 1));

虽然这样面向通用性的api的代码相较于面向专用的api的代码更长,但是新代码相较于老的代码更加容易理解;另外在面向未来的新功能时,面向通用性设计的api会用得上,比如现在需要实现一个全局替换功能,如果使用通用性的api,需要的仅是一个搜索文本下一次出现地方的接口

Position findNext(Position start, String string);

通用性设计能够更好地实现信息隐藏

比如在上面这个例子中,如果使用通用性设计,Text类就不需要了解用户接口,比如如何处理退格键,如何处理退格键的逻辑现在在用户接口中

一些在设计中自问的问题

应该设计多少接口来满足现有的需求

如果能够减少接口的数量,但是不减少功能,那么由很大可能是因为设计了更加通用的方法
比如上面的例子,如果是面向专用性的设计,三种删除方式分别需要三个方法,而通用的api只需要一种

看一个方法在多少个地方被用到

如果一个方法只会在一个地方被调用,可能意味着该方法过于专用化

当前的api对于当前的需求来说是否易于使用

这个问题可以用来判断接口的通用性是否过大。比如如果将删除操作和添加操作都设计为只能删除一个字符,这样的接口虽然也很简单并且具有通用性,但是不利于使用,用户接口需要调用循环来执行多次删除或者添加

AI 代码审查Review工具 是一个旨在自动化代码审查流程的工具。它通过集成版本控制系统(如 GitHub 和 GitLab)的 Webhook,利用大型语言模型(LLM)对代码变进行分析,并将审查意见反馈到相应的 Pull Request 或 Merge Request 中。此外,它还支持将审查结果通知到企业微信等通讯工具。 一个基于 LLM 的自动化代码审查助手。通过 GitHub/GitLab Webhook 监听 PR/MR 变,调用 AI 分析代码,并将审查意见自动评论到 PR/MR,同时支持多种通知渠道。 主要功能 多平台支持: 集成 GitHub 和 GitLab Webhook,监听 Pull Request / Merge Request 事件。 智能审查模式: 详细审查 (/github_webhook, /gitlab_webhook): AI 对每个变文件进行分析,旨在找出具体问题。审查意见会以结构化的形式(例如,定位到特定代码行、问题分类、严重程度、分析和建议)逐条评论到 PR/MR。AI 模型会输出 JSON 格式的分析结果,系统再将其转换为多条独立的评论。 通用审查 (/github_webhook_general, /gitlab_webhook_general): AI 对每个变文件进行整体性分析,并为每个文件生成一个 Markdown 格式的总结性评论。 自动化流程: 自动将 AI 审查意见(详细模式下为多条,通用模式下为每个文件一条)发布到 PR/MR。 在所有文件审查完毕后,自动在 PR/MR 中发布一条总结性评论。 即便 AI 未发现任何值得报告的问题,也会发布相应的友好提示和总结评论。 异步处理审查任务,快速响应 Webhook。 通过 Redis 防止对同一 Commit 的重复审查。 灵活配置: 通过环境变量设置基
【直流微电网】径向直流微电网的状态空间建模与线性化:一种耦合DC-DC变换器状态空间平均模型的方法 (Matlab代码实现)内容概要:本文介绍了径向直流微电网的状态空间建模与线性化方法,重点提出了一种基于耦合DC-DC变换器的状态空间平均模型的建模策略。该方法通过数学建模手段对直流微电网系统进行精确的状态空间描述,并对其进行线性化处理,以便于系统稳定性分析与控制器设计。文中结合Matlab代码实现,展示了建模与仿真过程,有助于研究人员理解和复现相关技术,推动直流微电网系统的动态性能研究与工程应用。; 适合人群:具备电力电子、电力系统或自动化等相关背景,熟悉Matlab/Simulink仿真工具,从事新能源、微电网或智能电网研究的研究生、科研人员及工程技术人员。; 使用场景及目标:①掌握直流微电网的动态建模方法;②学习DC-DC变换器在耦合条件下的状态空间平均建模技巧;③实现系统的线性化分析并支持后续控制器设计(如电压稳定控制、功率分配等);④为科研论文撰写、项目仿真验证提供技术支持与代码参考。; 阅读建议:建议读者结合Matlab代码逐步实践建模流程,重点关注状态变量选取、平均化处理和线性化推导过程,同时可扩展应用于复杂的直流微电网拓扑结构中,提升系统分析与设计能力。
内容概要:本文介绍了基于物PINN驱动的三维声波波动方程求解(Matlab代码实现)理信息神经网络(PINN)求解三维声波波动方程的Matlab代码实现方法,展示了如何利用PINN技术在无需大量标注数据的情况下,结合物理定律约束进行偏微分方程的数值求解。该方法将神经网络与物理方程深度融合,适用于复杂波动问题的建模与仿真,并提供了完整的Matlab实现方案,便于科研人员理解和复现。此外,文档还列举了多个相关科研方向和技术服务内容,涵盖智能优化算法、机器学习、信号处理、电力系统等多个领域,突出其在科研仿真中的广泛应用价值。; 适合人群:具备一定数学建模基础和Matlab编程能力的研究生、科研人员及工程技术人员,尤其适合从事计算物理、声学仿真、偏微分方程数值解等相关领域的研究人员; 使用场景及目标:①学习并掌握PINN在求解三维声波波动方程中的应用原理与实现方式;②拓展至其他物理系统的建模与仿真,如电磁场、热传导、流体力学等问题;③为科研项目提供可复用的代码框架和技术支持参考; 阅读建议:建议读者结合文中提供的网盘资源下载完整代码,按照目录顺序逐步学习,重点关注PINN网络结构设计、损失函数构建及物理边界条件的嵌入方法,同时可借鉴其他案例提升综合仿真能力。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值