重构代码之引入参数对象

小半 • 2024年11月14日下午9:24 • 前端开发 • 阅读 97

重构长方法时，“引入参数对象”是一种有效的策略，适用于当一个方法的参数列表过长，影响可读性和维护性时。通过将多个相关的参数组合成一个对象，我们可以简化方法签名、提高代码的内聚性和灵活性。

一、引入参数对象的动机

1. 提高可读性：长参数列表会使得方法签名复杂，调用者难以理解每个参数的作用。将相关的参数封装为对象后，调用变得简洁明了。
2. 减少重复代码：如果同一组参数在多个方法中重复使用，将它们抽取成对象可以减少代码重复。
3. 增强扩展性：当需要增加新参数时，如果已经引入了参数对象，只需要修改对象，而无需修改所有使用此方法的地方。
4. 提升内聚性：把相关的数据放在一个对象中，可以让对象本身承担更多责任，从而提高代码的内聚性。

二、适用场景

• 参数列表过长：方法的参数列表超过三个及以上时就可以考虑引入参数对象。
• 参数之间有明显的关系：例如，多个参数都与一个概念密切相关，比如地址的 street、city、zipcode，可以将其封装成 Address 对象。
• 多处使用相同的参数组：如果多处代码都使用同样的参数组，通过引入参数对象可以减少重复代码。

三、实施步骤

1. 创建对象：首先，为相关参数创建一个对象类（如果已有合适的类，可以直接使用），例如：

public class Address
{
    public string Street { get; set; }
    public string City { get; set; }
    public string ZipCode { get; set; }
}

2. 替换参数：修改原方法，将这些参数替换为对象。例如：

// 重构前
public void SendMail(string street, string city, string zipCode, string content)
{
    // 邮件发送逻辑
}

// 重构后
public void SendMail(Address address, string content)
{
    // 邮件发送逻辑
}

3. 调整调用：同时，调整调用此方法的地方，使用新的参数对象。例如：

var address = new Address { Street = "123 Main St", City = "Springfield", ZipCode = "12345" };
SendMail(address, "Hello World");

四、优化后的好处

• 方法签名更加简洁：改造后的方法参数减少，更加清晰。
• 逻辑更加模块化：地址相关的逻辑可以封装到 Address 类中，方法本身更加专注于业务逻辑。
• 代码扩展性增强：如果以后需要增加 Country 字段，只需在 Address 类中添加，而不需要修改所有使用 SendMail 方法的地方。