佳文分享:Refactor and reason for ReArchitecture

本文深入探讨了重构(ReArchitecture)背后的原理及其重要性。通过引用Martin Fowler和Jaroslav Tulach的观点,解释了为何重构是必要的,如何通过经常性的重构来预防架构退化或代码衰败。文章提供了重构的时机建议,并强调了重构的目标在于维持代码设计的清晰性和可维护性,而非仅仅为了更新功能。

经历过大 规模架构重构( ReArchitecture )的同学都知道: ReArchitecture 是一个极其痛苦的过程,要想将原有的 working 的代码,彻底地用新的架构,新的技术 重新写一遍,其工作量是令人望而生畏的。最复杂的莫过于业务逻辑的梳理,如果你有精力将原有的代码从头读一遍,那是最 lucky 的事,但大多数情况下,别人写的代码 需要你自己重新写一遍,大多数人没有精力或不愿意去通读代码,而主要依赖于需求文档,结合旧代码,写出新的代码。但需求文档的更新永远赶不上代码的更新速 度,你得期盼原先写这个代码的同学有很好的习惯,将变更的需求反映在文档中,而且代码中有很好的注释。基本上这种情况很少见。

而且 ReArchitecture 的时间也相对较长,我经历过的 ReArchitecture 基本上都超过 30 个人月。而且多数需要 ReArchitecture 的系统都是重要的业务系统, ReArchitecture 意味着重构期间,业务逻辑不能有或基 本不能有太大的变化。这也是众多业务方不愿支持 ReArchitecture 的主要原因(因为从业务功能上基本是 无效果的)。多数 ReArchitecture 能够执行都是因为不改实在不行了,或 者是某项重要的业务功能不改无法实现,或是因为在现有的架构下实现业务功能的周期越来越长。

讲了这么 多 ReArchitecture 的缺点,但我们应该探究为什么要进行 ReArchitecture ?其本质的原因是什么?带着这个疑 惑,最近拜读了一些大师的文章,其中有 2 位的观点,对 ReArchitecture 的原因做了较清楚的说明。其中一位是 著名的 Martin Fowler ,在其《 Refactoring – Improving the Design of Existing Code 》书中对为何要做 refactor 做了如下的解释 (P55)

没有 refactor ,程序的设计就会 decay( 注:这个词不翻译,因为后面有一个类 似的词,翻了可能会引起歧义 ) 。当人们修改代码时, ( 修改代码以实现短期的业务目标或在没 有完全理解已有设计的情况下修改代码 ) 代码的结构就遭到了破坏。理解代码的 设计会变得非常困难。 Refactoring 有些像整理代码。即将那些不在合适位 置的代码移除。代码结构的破坏会有 cumulative effect 。当代码的设计越难理解,就越难保留 这种设计,其 decay 的速度就会越快,经常性的 refactor 可以帮助代码保持其设计

看到这一 段(最好大家看看原文,会比我的翻译更原汁原味),觉得 Martin Fowler 讲的太精彩了,非常到位。同样的话 题, Netbeans 的首席架构师, Jaroslav Tulach 在其《 Practical API Design – Confessions of a Java Framework Architect 》一书也有更精准的描述 (P100)

架构的 degradation (这个词比 decay 更妙一些,我个人认为比 decay 更准确),即代码的各个部分开始和其 他不相关的部分互相 talking ,是不可避免的。一定会发生,除非主 动地预防

原文很 少,引用如下:

The degradation of architecture , where each part of the code base starts talking to each other unrelated part, is inevitable. It has to happen, unless explicitly prevented

Jaroslav Tulach ,认为解决之道是 module programming 。这个超出我要讨论的范围了,不展开 了。个人非常欣赏 Jaroslav Tulach 的这句话,也一直向周围的同事推荐这 句话。觉得精炼到了可以和文言文媲美的程度。而且讲出了解决之道:主动地预防 。这句话已经成为我考虑问题和设计方案时的一个重要原则了。

理解了 ReArchitecture 的原因之后,解决之道就变得比较容易 了,经常性地做一些 refactor 可以预防架构的 degradation 或代码的 decay 。关于怎么做 refactor ,在 Martin Fowler 的书中有全面的描述,这里我主要列出 refactor 的契机:

  • 增加功能时, refactor
  • Fix bug 时, refactor
  • 进行 code review 时, refactor

最后,列 出 Martin Fowler 对于 refactor 的定义:

  • Refactoring (noun) : a change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behavior.
  • Refactor (verb) : to restructure software by applying a series of refactorings without changing its observable behavior.

最后,说 明一下,我对于 ReArchitecture 并不完全反对,合适的时机和情况下, 还是需要 ReArchitecture 的,但只要秉持上述的原则和实践,可 以极大的避免无原则和无目的的 ReArchitecture

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网络结构设计、损失函数构建及物理边界条件的嵌入方法,同时可借鉴其他案例提升综合仿真能力。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值