分解方法[通俗易懂]

分解方法[通俗易懂]分解方法概述“分解方法”的思想和前面讲到的“提取方法”、“提取方法对象”基本一致。它是将较大个体的方法不断的拆分,让每个“方法”做单一的事情,从而提高每个方法的可读性和可维护性。分解方法可以看做是

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

分解方法

 

概述

“分解方法”的思想和前面讲到的“提取方法”、“提取方法对象”基本一致。
它是将较大个体的方法不断的拆分,让每个“方法”做单一的事情,从而提高每个方法的可读性和可维护性。
分解方法可以看做是“提取方法”的递归版本,它是对方法反复提炼的一种重构策略。

分解方法

下图表示了这个重构策略,第1次提炼和第2次提炼都采用了“提取方法”这个策略。

image

何时分解方法?

“分解方法”最终可以让方法的可读性极大地增强,通常我们可以依据以下几点来辨别方法是否需要分解:

1. 每个方法应该只做一件事情(对事情的理解程度,决定了事情的粒度)

2. 方法应该尽量短小,方法最好不要超过20行(依不同情况,酌情考虑行数) 

3. 方法的缩进层次不宜太多,最好不要超过两级 

4. 方法需要太多的注释才能理解

示例

场景说明

假设在企业制作年度预算的场景中,用户需要按照如下Excel模板填写科目、部门、各月的预算数据,然后将Excel文件导入到“预算系统”。

image

为了表示用户填写的每一行预算数据,开发人员在系统中设计了两个class:BudgetItem(预算项)和BudgetItemDetail(预算项明细)。
上图红色方框标注的表示一个BudgetItem对象,每个蓝色方框则对应一个BudgetItemDetail对象。

image

BudgetItem.cs和BudgetItemDetail.cs
/// <summary> /// 预算项 /// </summary> public class BudgetItem { public string Dept { get; set; } public string Account { get; set; } public IList<BudgetItemDetail> BudgetItemDetails { get; set; } } /// <summary> /// 预算项明细 /// </summary> public class BudgetItemDetail { public string Month { get; set; } public decimal Amount { get; set; } }

重构前

在表示这段逻辑时,我们编写了一个BudgetItemImport类,用于读取Excel并返回IList<BudgetItem>集合

public class BudgetItemImport { private Regex _monthRegex = new Regex(@"\d{4}\\\d{2}"); public IList<BudgetItem> GetBudgetItems(string path) { // 读取Excel获取DataTable DataTable table = ExcelUtil.RenderFromExcel(path); // 获取表示月份的列名 IList<string> monthColumns = new List<string>(); for (var i = 0; i < table.Columns.Count; i++) { var columnName = table.Columns[i].ColumnName; if (_monthRegex.IsMatch(columnName)) { monthColumns.Add(columnName); } } // 遍历DataRow获取BudgetItems IList<BudgetItem> budgetItems = new List<BudgetItem>(); for (var i = 1; i < table.Rows.Count; i++) { // 获取DataRow DataRow dataRow = table.Rows[i]; // 创建BudgetItem对象,并设置部门和科目信息 BudgetItem budgetItem = new BudgetItem { Dept = dataRow[0].ToString(), Account = dataRow[1].ToString() }; // 创建BudgetItemDetail集合 IList<BudgetItemDetail> budgetItemDetails = new List<BudgetItemDetail>(); foreach (var column in monthColumns) { // 创建BudgetItemDetail对象,并设置预算月份和相应金额 BudgetItemDetail detail = new BudgetItemDetail { Month = column, Amount = Convert.ToDecimal(dataRow[column]) }; budgetItemDetails.Add(detail); } budgetItem.BudgetItemDetails = budgetItemDetails; budgetItems.Add(budgetItem); } return budgetItems; } } 

以上这段代码,如果没有这些注释,GetBudgetItems()方法是比较难以读懂的。
接下来,我们采用“分解方法”这个策略来对它重构。

第一次重构

我们粗略分析一下,可以得知GetBudgetItems()方法一共做了3件事情,下图阐述了它的逻辑。

image
秉承着“一个方法只做一件事情”的原则,我们将这3件事情拆分出来,使其变成3个方法。

public class BudgetItemImport { private Regex _monthRegex = new Regex(@"\d{4}\\\d{2}"); public IList<BudgetItem> GetBudgetItems(string path) { // 读取Excel获取DataTable DataTable table = ExcelUtil.RenderFromExcel(path); // 获取表示月份的列名 IList<string> monthColumns = GetMonthColumns(table.Columns); // 读取DataTable获取BudgetItem集合 return GetBudgetItemsFromDataTable(table, monthColumns); } // 获取表示月份的列名 private IList<string> GetMonthColumns(DataColumnCollection collection) { IList<string> monthColumns = new List<string>(); for (var i = 0; i < collection.Count; i++) { var columnName = collection[i].ColumnName; if (_monthRegex.IsMatch(columnName)) { monthColumns.Add(columnName); } } return monthColumns; } // 读取DataTable获取BudgetItem集合 private IList<BudgetItem> GetBudgetItemsFromDataTable(DataTable table, IList<string> monthColumns) { // 遍历DataRow获取BudgetItems IList<BudgetItem> budgetItems = new List<BudgetItem>(); for (var i = 1; i < table.Rows.Count; i++) { DataRow dataRow = table.Rows[i]; // 创建BudgetItem对象,并设置部门和科目信息 BudgetItem budgetItem = new BudgetItem { Dept = dataRow[0].ToString(), Account = dataRow[1].ToString() }; // 创建BudgetItemDetail集合,并设置每个BudgetItemDetail对象的月份和金额 IList<BudgetItemDetail> budgetItemDetails = monthColumns.Select(column => new BudgetItemDetail { Month = column, Amount = Convert.ToDecimal(dataRow[column]) }).ToList(); budgetItem.BudgetItemDetails = budgetItemDetails; budgetItems.Add(budgetItem); } return budgetItems; } } 

第二次重构

虽然GetBudgetItems()拆分成了3个方法,但新追加的GetBudgetItemsFromDataTable()方法还是不具备良好的可读性,这个方法我们仍然需要借助注释才能读懂。
我们再具体分析这个方法内部的逻辑,GetBudgetItemsFromDataTable()这个方法也做了3件事情,见下图:

image

按照这个更加明细的逻辑流程,我们将这3件事情再拆分出来。

public class BudgetItemImport { private Regex _monthRegex = new Regex(@"\d{4}\\\d{2}"); public IList<BudgetItem> GetBudgetItems(string path) { // 读取Excel获取DataTable DataTable table = ExcelUtil.RenderFromExcel(path); // 获取表示月份的列名 IList<string> monthColumns = GetMonthColumns(table.Columns); // 读取DataTable获取BudgetItem集合 return GetBudgetItemsFromDataTable(table, monthColumns); } // 获取表示月份的列名 private IList<string> GetMonthColumns(DataColumnCollection collection) { IList<string> monthColumns = new List<string>(); for (var i = 0; i < collection.Count; i++) { var columnName = collection[i].ColumnName; if (_monthRegex.IsMatch(columnName)) { monthColumns.Add(columnName); } } return monthColumns; } // 读取DataTable获取BudgetItem集合 private IList<BudgetItem> GetBudgetItemsFromDataTable(DataTable table, IList<string> monthColumns) { IList<BudgetItem> budgetItems = new List<BudgetItem>(); foreach (DataRow dataRow in table.Rows) { BudgetItem budgetItem = GetBudgetItemFromDataRow(dataRow, monthColumns); budgetItems.Add(budgetItem); } return budgetItems; } // 创建BudgetItem对象,并设置部门和科目信息 private BudgetItem GetBudgetItemFromDataRow(DataRow dataRow, IList<string> monthColumns) { BudgetItem budgetItem = new BudgetItem { Dept = dataRow[0].ToString(), Account = dataRow[1].ToString(), BudgetItemDetails = GetBudgetItemDetailsFromDataRow(dataRow, monthColumns) }; return budgetItem; } // 创建BudgetItemDetail集合,并设置每个BudgetItemDetail对象的月份和金额 private IList<BudgetItemDetail> GetBudgetItemDetailsFromDataRow(DataRow dataRow, IList<string> monthColumns) { return monthColumns.Select(column => new BudgetItemDetail { Month = column, Amount = Convert.ToDecimal(dataRow[column]), }).ToList(); } } 

经过这次重构后,BudgetItemImport类的可读性已经很好了。每个方法都只做一件事情,每个方法都很短小,都不超过20行,我们甚至不需要为这些方法写注释了。

小结

在经历过两次重构后,我们得到了结构良好的代码。回顾这个示例的重构过程,我们可以用下面一副图来表示。

image

写代码和写别的东西很像。在写文章时,你先想什么就写什么,然后再打磨它。初稿也许丑陋无序,你就雕章琢句,直至达到你心目中的样子。
我们并不能直接写出结构和可读性良好的方法,一开始我们的方法写得复杂且冗长,包含了各种循环、判断、缩进和注释。
然后我们打磨这些代码,通过分解方法逐一解决这些问题。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/166450.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 博弈论学习笔记(六)纳什均衡之约会游戏与古诺模型

    博弈论学习笔记(六)纳什均衡之约会游戏与古诺模型可以将纳什均衡看成一种自我实施的协议,假设每个人都相信大家都会遵守协议,那么大家就都会遵守。纳什均衡是和领导力紧密联系的。在协调博弈中,领导力的作用就是促成人们达到某个特定均衡而不是其他均衡。尤其是某些缺乏领导的混乱状态,在这类博弈中领导力的作用举足轻重。–领导力的用武之地。举个简单的例子,如下表,很显然协调能够起到作用。αβα1,10…

    2022年10月15日
    2
  • Oracle数据库学习的小结-1

    Oracle数据库学习的小结-1Oracle数据库监听配置 一、监听器(LISTENER)  监听器是Oracle基于服务器端的一种网络服务,主要用于监听客户端向数据库服务器端提出的连接请求。既然是基于服务器端的服务,那么它也只存在于数据库服务器端,进行监听器的设置也是在数据库服务器端完成的。 二、本地服务名(Tnsname)  Oracle客户端与服务器端的连接是通过客户端发出连接请求,由服务器

    2022年9月25日
    4
  • 使用Exhibitor管理Zookeeper

    使用Exhibitor管理ZookeeperExhibitor是什么Exhibitor是一个为zookeeper而设计的管理工具,主要是以共享的方式管理zoo.cfg和myid文件,具体介绍参考:https://github.com/soabase/exhibitor/wiki本文中还涉及一个JavaServiceWrapper工具,它可以将java应用注册为Unix的守护进程,官网:https://wrapper.tan…

    2025年8月24日
    2
  • 怎样使用cookie登录自己的账号

    在这之前,不管是做测试还是挖漏洞总会遇到这种问题做测试的时候测试项里面有一个会话标识未更新,这种漏洞说白了就是在退出个人账户的时候没有及时的清除cookie,从而让别人利用你的cookie再次登录你的账户,然后测试的时候客户就让测试如何使用cookie登录在挖漏洞的时候一般xss都需要打cookie然后伪造别人的身份登录,其实也是使用打到的cookie登录在这之前我没深入的理解这块,现…

    2022年4月8日
    80
  • srgb的伽马值_srgb模式和标准模式

    srgb的伽马值_srgb模式和标准模式sRGB标准人眼对亮度的感知不是线性的,其对较暗区域的变化更加敏感参见:ComputerColorisBroken基于人眼该特点,sRGB标准要求图像(各通道为8bits,最多存储256个亮度值)使用编码伽马,把更多地空间用来存储更多暗部区域,来最大化地利用表示亮度的数据位或带宽伽马校正(Gammacorrection)在早期,阴极射线管(CRT)显示器是唯一的电子显示设备,但它的输入电压和显示出来的亮度关系不是线性的,而是一个类似幂律(pow-law)曲线的关系,…

    2022年9月2日
    4
  • vim设置自动添加头部注释

    vim设置自动添加头部注释

    2021年6月4日
    84

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号