2 Star 1 Fork 0

杏花惊蛰寒 / codereview

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-1.0

codereview

介绍

重构,改善既有代码的设计(java实现)

Chapter.2 重构的原则

2.1 何谓重构

重构就是将复杂冗长的代码,修改成更容易理解,更容易维护的代码,每一个小功能的重构,不会影响程序的运行。

2.2 两顶帽子

“两顶帽子”是指添加新功能和重构。在开发过程中,两顶帽子是可以随时切换的,重构并不是只能在功能开发完成之后进行, 在开发过程中,可能觉得调整代码结构,新功能可能更好的实现。

2.3 何为重构

重构是一个工具,它可以用于以下几个目的

  1. 重构改进软件的设计

    通过重构,我们能够更好的理解架构的整体设计,更加清晰的表达出设计的意图,良好的设计能狗更好的修改和维护。

  2. 重构使软件更容易理解

    重构使结构理想,能够让机器和其他读者更好的阅读代码。

  3. 重构帮助找到bug

    结构清晰,能够更好的进行调试,知道每一步的所作所为,bug自然就找出来了

  4. 重构提高编程速度

    重构提高编程速度并不是说在开发的过程和结束,而是指,在有新功能或者bug修改的时候,我们能清楚的知道代码的功能,使之添加和修改时只需花费少量的时间。

2.4 何时重构
三次法则:事不过三,三则重构 
  1. 预备性重构:让添加新功能更容易
  2. 帮助理解的重构:使代码更易懂
  3. 捡垃圾式重构
  4. 有计划的重构和见机行事的重构
  5. 长期重构
  6. 复审代码时重构
  7. 何时不应该重构

    不需要理解代码工作原理时,我们可以不重构 如果重写时间比重构时间短,我们不重构

2.5 重构的挑战
  1. 延缓新功能开发
  2. 代码所有权
  3. 分支
  4. 测试
  5. 遗留代码
  6. 数据库
2.6 重构、架构和YAGNI
2.7 重构与软件开发过程
2.8 重构与性能
2.9 重构起源何处
2.10 自动化重构
2.11 延展阅读

Chapter.3 代码的坏味道

3.1 神秘命名(Mysterious Name)

好的名字(函数、模块、变量和类名)能够清晰的表明自己的功能和用法

3.2 重复代码(Duplicated Code)

相同的代码结构在多个地方出现,那么可以设法将它们合而为一。但是重复的代码也要留意其间细微的差异。最单纯的重复代码就是 “同一个类的两个函数含有相同的表达式”。这时可以采用提炼函数提炼出重复的代码。如果重复的代码只是相似,可以尝试移动语句 重组代码顺序。如果重复的代码段位于同一个超类的不同子类中,可以使用函数上移来避免两个子类之间互相调用。

3.3 过长函数(Long Function)

小函数能够带来更好的阐述力、更易于分享、更多的选择,让小函数易于理解的关键还是在于良好的命名。 如果一段代码需要用注释来说明的时候,我们就可以将其说明的代码提取为一个函数。 当你尝试用提炼函数的时候,如果函数中有大量的参数和临时变量,我们可以运用查询取代临时变量来消除这些临时元素。 引用参数对象保持对象完整则可以将过长的参数列表变得简洁一些,如果这么做了,还是有太多的临时变量和参数,我们就可以使用命令取代函数 条件表达式和循环也是提炼的信号,我们可以使用分解条件表达式处理条件表达式。对于庞大的switch语句,其中的每个分支都应该通过提炼函数 变成独立的函数调用。如果多个switch语句基于同一个条件进行分支选择,我们可以使用多态取代条件表达式。 针对循环,我们可以将循环和循环内的代码提炼到一个独立的函数中,提炼出的循环很难命名,可能是因为其中做了几件不同的事。我们可以使用拆分循环将其拆分为独立的任务

3.4 过长参数列表(Long Parameter List)
3.5 全局数据(Gloable Data)
3.6 可变数据(Mutable Data)
3.7 发散式修改(Divergent Change)
3.8 霰弹式修改(Shotgun Surgery)
3.9 依恋情结(Feature Envy)
3.10 数据泥团(Data Clumps)
3.11 基本类型偏执(Primitive Obsession)
3.12 重复的switch(Repeated Switches)
3.13 循环语句(Loops)
3.14 冗赘的元素(Lazy Element)
3.15 夸夸其谈通用性(Speculative Generality)
3.16 临时字段(Temporary Field)
3.17 过长的消息链(Message Chains)
3.18 中间人(Middle Man)
3.19 内幕交易(Insider Trading)
3.20 过大的类(Large Class)
3.21 异曲同工的类(Alternative Classes with Different Interfaces)
3.22 纯数据类(Data Class)
3.23 被拒绝的遗赠(Refused Bequest)
3.24 注释(Comments)

Chapter.4 构筑测试体系

4.1 自测试代码的价值
4.2 待测试的示例代码
4.3 第一个测试
4.4 再添加一个测试
4.5 修改测试夹具
4.6 探测边界条件
4.7 测试远不止如此
木兰宽松许可证, 第1版 木兰宽松许可证, 第1版 2019年8月 http://license.coscl.org.cn/MulanPSL 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第1版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的一方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括仅因您或他人修改“贡献”或其他结合而将必然会侵犯到的专利权利要求。如您或您的“关联实体”直接或间接地(包括通过代理、专利被许可人或受让人),就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 条款结束。 如何将木兰宽松许可证,第1版,应用到您的软件 如果您希望将木兰宽松许可证,第1版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details. Mulan Permissive Software License,Version 1 Mulan Permissive Software License,Version 1 (Mulan PSL v1) August 2019 http://license.coscl.org.cn/MulanPSL Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v1 (this License) with following terms and conditions: 0. Definition Software means the program and related documents which are comprised of those Contribution and licensed under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, or are controlled by, or are under common control with a party to this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. Contribution means the copyrightable work licensed by a particular Contributor under this License. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed, excluding of any patent claims solely be infringed by your or others’ modification or other combinations. If you or your Affiliates directly or indirectly (including through an agent, patent licensee or assignee), institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability The Software and Contribution in it are provided without warranties of any kind, either express or implied. In no event shall any Contributor or copyright holder be liable to you for any damages, including, but not limited to any direct, or indirect, special or consequential damages arising from your use or inability to use the Software or the Contribution in it, no matter how it’s caused or based on which legal theory, even if advised of the possibility of such damages. End of the Terms and Conditions How to apply the Mulan Permissive Software License,Version 1 (Mulan PSL v1) to your software To apply the Mulan PSL v1 to your work, for easy identification by recipients, you are suggested to complete following three steps: i. Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii. Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii. Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details.

简介

重构,改善既有代码的设计(java实现) 展开 收起
Java
MulanPSL-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/xrw84/codereview.git
git@gitee.com:xrw84/codereview.git
xrw84
codereview
codereview
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891