为什么干净的代码很重要

为什么干净的代码很重要

在各种咨询项目中,我最近注意到同样的事情不断重复:集群代码。我这么说是什么意思?好吧,让我这样说。当你编码时,你应该考虑干净的代码。是的,我知道,又有一个人在谈论干净的代码。你为什么要听我的?从 12 岁起,我就对计算机及其工作原理感兴趣。当我 15 岁时,我开始观看 Pluralsight,这是一堆关于如何进行 MVVM、MVC、架构等的视频。我看了很多视频,但我还不知道如何编程。我跟着做了,但我记得很多事情都不明白。

在过去的几年里,我一直在多家公司担任架构师和高级软件开发人员。我的背景是计算机工程和 IT 学徒。正如你们所知,我试图与你们分享我所知道的东西,以帮助人们,同时也像 LinkedIn 上的所有人一样获得曝光。是的,他们并不像你想象的那么热爱写作;这纯粹是一种商业模式。但这并不重要,对吧?所以就这样了。希望有一天您会购买我的一款产品。 ;)

现在,让我告诉你我最近在不同项目中看到的情况。我认为干净的代码并不总是被应用的原因并不一定是因为人们不具备相关知识。这通常与严格的期限和来自不同项目的压力有关。如果您是像我一样的软件工程师或项目经理,您就会知道项目的成功需要一定的限制和时间压力。

为了交付给客户,即使在内部工作,您也会面临截止日期和不同的利益相关者。公司通常采用订阅模式运营,客户定期期待新功能。这带来了很多挑战。开发人员和项目规划人员需要保持项目向前发展,而不要陷入架构债务的陷阱,因为他们没有足够的时间来正确思考解决方案。

一旦出现这个问题,就很难回去解决它。根据我的经验,人们不会经常回去重构他们的项目——至少我认识的人不会。如果您有不同,请告诉我。你可以做很多事情来重构,这很有帮助,但问题是它没有优先考虑。如果代码可以工作并且客户满意,那么重构就不是首要任务。但让我们想想未来两三年。一旦代码变得越来越集群会发生什么?

你最终可能会雇佣很多开发人员将单体架构改造成微服务架构,这会花费很多钱。这就是为什么你应该考虑干净的代码——不仅仅是当你开始一个项目时,不仅仅是当你醒来时,而是一直如此。因为如果你不应用它,最终它会回来咬你。

清洁代码的实用策略

一致的代码审查
定期代码审查可确保遵守编码标准并及早发现潜在问题。

自动化测试
实施自动化测试,包括单元测试、集成测试和端到端测试,有助于在问题投入生产之前发现问题。

定期重构
在项目计划中留出专门用于重构的时间,以防止技术债务累积并保持代码库的可维护性。

采用坚实的原则
SOLID 原则(单一职责、开闭、里氏替换、接口隔离和依赖反转)提供了一个用于编写干净且可维护的代码的框架。

清晰的文档
编写清晰简洁的文档可以帮助新开发人员更快地理解代码库并减少引入错误的可能性。

结对编程
结对编程允许两个开发人员一起处理相同的代码,尽早发现错误并在团队成员之间共享知识。

干净代码的长期好处

降低维护成本
干净的代码更容易维护,减少修复错误和实现新功能所花费的时间和金钱。

增强可读性和可理解性
干净的代码库更容易阅读和理解,这对于新开发人员的入职和项目的长期可持续性至关重要。

提高性能
结构良好的代码可以避免不必要的复杂性并优化资源使用,从而带来更好的性能。

更大的可扩展性
干净的代码可以更轻松地扩展应用程序,简化添加新功能和适应不断变化的需求的过程。

提高开发者满意度
使用干净的代码可以减少开发人员的挫败感并提高工作满意度,从而提高生产力并降低流动率。

乱码示例

应用程序= $应用程序;  }  公共函数addSkill(应用程序$app,请求$request)  {    $userInput['id'] = $request->request->get('id', null);    $userInput['id'] = preg_replace("/[^0-9,.]/", "", $userInput['id']);    $app['checkpoint']->minimumRole(1);    $user = $app['session']->get('user', []);    $userId = $user['个人资料']['easyJobAddressId'];    if ($userInput['id'] === null) {      返回 $app->json(['ok' => true]);    }    $app['dbs']['appMySql']->insert('技能', [      'skillId' => $userInput['id'],      '用户ID' => $用户ID,      '排名' => 0    ]);    返回 $app->json(['ok' => true]);  }}

重构代码

降重鸟 降重鸟

要想效果好,就用降重鸟。AI改写智能降低AIGC率和重复率。

降重鸟 113 查看详情 降重鸟

重构后的代码通过分解职责、使用依赖注入并遵循 SOLID 原则,遵循干净代码原则。

依赖注入和构造函数

公共函数 __construct(    UserRoleService $userRoleService, RequestStack $requestStack,    用户存储库 $用户存储库,    EasyJobServiceInterface $easyJobService,    技能存储库 $skillsRepository,    应用程序数据服务$appDataService){    $this->userRoleService = $userRoleService;    $this->requestStack = $requestStack;    $this->userRepository = $userRepository;    $this->easyJobService = $easyJobService;    $this->skillsRepository = $skillsRepository;    $this->appDataService = $appDataService;}

通过注入依赖关系,我们确保每个类都有单一的职责,并且可以轻松测试和维护。

添加技能的单一职责

#[路线('/profile/experience/add', name: 'profile_experience_add', 方法: ['POST'])]公共函数addExperience(请求$请求):JsonResponse{    $this->denyAccessUnlessGranted('ROLE_USER');    $skillId = $request->request->get('id');    if (!is_numeric($skillId)) {        return $this->json(['status' => 'error', 'message' => '技能 ID 无效']);    }    $userId = $this->getUser()->getId();    $result = $this->appDataService->addSkillToUser($userId, (int) $skillId);    返回 $this->json(['status' => 'ok', 'added' => $result]);}

这里,我们使用专门的方法来处理技能的添加。它确保验证并遵循干净、简洁的结构。

关注点分离

公共函数index():响应{    $user = $this->getUser();    $userId = $user->getId();    $allSkills = [90, 10, 11, 12, 13, 20, 21, 22, 23, 30, 31];    $skills = array_fill_keys($allSkills, 0);    $userSkills = $this->appDataService->getSkillsByUserId($userId);    foreach ($userSkills 作为 $skill) {        $skillId = $skill->getSkillId();        if (array_key_exists($skillId, $skills)) {            $技能[$skillId] = 1;        }    }}

注意我们如何使用appDataService来解耦系统。
通过分离关注点,我们使每个方法专注于单个任务,使代码更易于阅读和维护。

结论

总之,始终考虑干净的代码。现在看起来可能并不紧急,但忽视它可能会导致严重的问题。优先考虑干净的代码将在未来节省时间、金钱和麻烦。定期重构并遵守编码标准是维护健康代码库的关键。请记住,您今天为编写干净代码所付出的努力从长远来看将会得到回报,使您的项目更具可扩展性、可维护性并且工作起来更加愉快。

以上就是为什么干净的代码很重要的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/529229.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
6月进口游戏版号曝光,无畏契约在列!
上一篇 2025年11月9日 09:41:17
如何使用 JavaScript 检查对象是否为空?
下一篇 2025年11月9日 09:41:24

相关推荐

  • 开源免费PHP工具 PHP开发效率提升利器

    推荐开源免费PHP开发工具以提升效率:VS Code、Sublime Text轻量高效,PhpStorm专业强大;调试用Xdebug、Kint、Ray;依赖管理选Composer;代码质量工具包括PHPStan、Psalm、PHP_CodeSniffer;数据库管理可用%ignore_a_1%MyA…

    2026年5月10日
    000
  • MySQL数据库不支持中文的解决办法

    接上一篇文章,在解决了mysql+flask环境配置问题之后,往数据库存中文字符串会报1366错误,提示不正确的字符。继而发现默认的mysql采用了latin1字符集,这种编码是不支持中文的。 如果想支持中文的话,需要设置一下mysql字符集。 众所周知utf-8是可以的,gbk也没问题,为了可扩展…

    用户投稿 2026年5月10日
    000
  • PHP多维数组到复杂XML结构的SOAP序列化实践

    本文旨在解决php多维数组向复杂soap xml结构序列化时遇到的“无法序列化结果”问题。通过深入理解soap xml的结构要求,包括命名空间和类型属性,文章将指导您如何构建符合特定xml schema的php关联数组。我们将利用`spatie/array-to-xml`库,详细演示其安装与使用方法…

    2026年5月10日
    100
  • CodeIgniter在IIS环境下实现URL重写与index.php移除指南

    本教程详细指导如何在IIS服务器上部署的CodeIgniter应用中,移除URL中不必要的index.php。核心解决方案涉及修改CodeIgniter的config.php文件,将$config[‘index_page’]设置为空,并辅以正确的IIS web.config重…

    2026年5月10日
    100
  • Go语言连接外部MySQL数据库:DSN配置与常见错误解析

    本文详细阐述了go语言使用`go-sql-driver/mysql`驱动连接外部mysql数据库的正确方法。重点介绍了数据源名称(dsn)的规范格式,特别是主机地址部分的配置,以避免常见的“getaddrinfow: the specified class was not found.”等网络解析错…

    2026年5月10日
    000
  • PHP代码注入检测日志分析_PHP代码注入日志检测方法详解

    答案:日志分析是发现PHP代码注入的关键手段,主要通过Web服务器访问日志、PHP错误日志、PHP-FPM日志及应用自定义日志等多源数据,结合grep、ELK、WAF等工具识别含eval()、system()、Base64编码、目录遍历等特征的异常请求,并建立基线、设置检测规则与自动化告警,配合事件…

    2026年5月10日
    000
  • Go语言与Microsoft SharePoint集成指南

    Go语言可以有效集成Microsoft SharePoint,主要通过两种途径:一是利用SharePoint提供的RESTful API进行数据交互,Go的标准HTTP客户端库即可轻松实现;二是通过SharePoint应用模型开发自托管应用,这种模型支持使用包括Go在内的任何语言编写后端逻辑。 1.…

    2026年5月10日
    000
  • Python继承中父类属性的初始化与访问策略

    本文深入探讨python面向对象编程中,子类如何正确初始化和访问父类属性。重点分析`super().__init__()`的工作原理,解释在继承链中参数传递的重要性,并提供通过子类构造函数传递参数的解决方案。此外,针对子类需要与特定父类实例交互的场景,文章还介绍了组合(composition)模式的…

    2026年5月10日
    000
  • 如何用Golang构建无状态微服务 分享Session管理最佳实践

    如何用Golang构建无状态微服务 分享Session管理最佳实践如何用Golang构建无状态微服务 分享Session管理最佳实践如何用Golang构建无状态微服务 分享Session管理最佳实践如何用Golang构建无状态微服务 分享Session管理最佳实践

    构建无状态微服务时,session管理可通过jwt、redis和统一认证中心实现。①使用jwt作为token,客户端存储,服务端无状态;②结合redis记录session元数据,支持主动失效;③设立统一认证中心,中间件校验token;④确保https传输安全并设计token刷新机制。 用 Golan…

    2026年5月10日 用户投稿
    000
  • 后缀php怎么打开_php文件打开方式与运行环境搭建指南

    要打开PHP文件需根据用途选择方式:查看代码可用文本编辑器或IDE,运行则需服务器环境。推荐新手使用XAMPP、WAMP等集成环境,将文件放入htdocs目录后访问localhost;开发者可利用PHP内置服务器,命令行执行php -S localhost:8000运行;高级用户可手动配置Apach…

    2026年5月10日
    000
  • PHP动态网页数据库备份恢复_PHP动态网页MySQL数据库备份教程

    答案:PHP动态网页的MySQL数据库备份与恢复需通过定期导出SQL文件并安全存储来保障数据安全,核心方法包括使用mysqldump命令行工具实现高效灵活的自动化备份,利用phpMyAdmin图形化工具进行手动导出导入以降低操作门槛,以及通过PHP脚本调用系统命令将备份过程集成到应用中;恢复时可采用…

    2026年5月10日
    000
  • php登录怎么实现_php用户登录系统完整实现

    <blockquote>PHP用户登录系统的核心是安全验证与会话管理。首先创建POST提交的登录表单,避免敏感信息暴露;后端通过session_start()启动会话,使用trim()和htmlspecialchars()清理输入,防止XSS攻击;利用PDO预处理语句查询数据库,防止SQ…

    用户投稿 2026年5月10日
    000
  • C#如何处理异常?C# try-catch-finally最佳实践与常见错误规避

    正确使用 try-catch-finally 应捕获具体异常、用 finally 或 using 释放资源、避免空 catch 和裸抛异常,确保异常日志记录并保留堆栈跟踪,提升代码健壮性与可维护性。 在C#中,异常处理是保障程序稳定运行的重要机制。正确使用 try-catch-finally 结构不…

    2026年5月10日
    000
  • 远程MySQL数据库连接指南:从本地PHP应用访问GCP实例数据库

    本文详细指导如何在本地php应用中连接到google cloud platform (gcp) 虚拟机实例上的远程mysql数据库。教程涵盖了数据库连接参数的配置、使用php pdo建立连接的方法、gcp环境下的网络配置要点,以及常见的安全和故障排除建议,旨在帮助开发者顺利实现跨环境的数据库通信。 …

    2026年5月10日
    000
  • PHP处理大型文本文件转JSON:内存溢出诊断与优化实践

    本文深入探讨了PHP在将大型文本文件转换为结构化JSON时可能遇到的内存溢出问题。文章详细指导读者如何通过phpinfo()诊断并正确配置PHP的memory_limit,包括检查php.ini和.htaccess的潜在冲突,并提供了逐步增加内存限制的建议。同时,文章也分析了特定数据格式下内存消耗的…

    2026年5月10日
    100
  • Go语言中通过字符串动态创建类型实例的实践指南

    本文探讨了在Go语言中如何通过字符串动态创建类型实例。由于Go的静态类型特性和编译优化,直接实现此功能具有挑战性。文章详细介绍了两种主要方法:一是利用reflect包手动维护类型注册表并通过反射创建实例,并提供了示例代码和注意事项;二是推荐使用工厂模式或函数映射等更符合Go惯用法的替代方案,以提高代…

    2026年5月10日
    000
  • Nginx 子目录应用URI重写与参数传递教程

    本教程详细阐述了如何在Nginx中为PHP应用实现子目录URI重写,特别是如何从请求URI中剥离子目录路径并将其余部分作为参数传递给主入口文件。通过try_files和rewrite指令的组合,本教程提供了一种高效且准确的解决方案,以替代Apache .htaccess的RewriteRule功能,…

    2026年5月10日
    000
  • JavaScript中如何确保IoT安全?

    在javascript中确保iot安全可以通过以下步骤实现:1) 使用https协议进行安全通信;2) 实施oauth 2.0或jwt进行身份验证和授权;3) 避免使用不安全的javascript功能并验证输入;4) 使用异步编程优化性能;5) 定期更新和修补软件。 在JavaScript中确保Io…

    2026年5月10日
    000
  • 在R Markdown中运行JavaScript并导入库的正确姿势

    本文旨在解决在R Markdown文档中运行JavaScript代码并成功导入外部库(如MSAL)时遇到的常见问题。通过详细的代码示例和步骤说明,帮助读者掌握在R Markdown环境中集成JavaScript库的正确方法,实现更强大的交互式数据分析和可视化功能。 在R Markdown文档中集成J…

    2026年5月10日
    100
  • 在PHP中实现MySQL数据插入时避免重复记录的策略

    本文将探讨在php应用中向mysql数据库插入数据时,如何有效避免重复记录的产生。针对当主键或唯一索引字段值已存在的情况,我们将介绍使用`insert ignore`语句的策略,以确保数据完整性并防止不必要的重复插入,从而简化数据管理逻辑。 引言:数据完整性与重复记录问题 在数据库管理中,数据完整性…

    2026年5月10日
    000

发表回复

登录后才能评论
关注微信