Method Object理解与应用

背景

这段时间在重构自己写过的烂代码（尴尬）。本着单一原则想把堆成一堆的代码按照功能拆分成一个个小方法，按照顺序整齐摆放，清晰好看易读有条理。但是遇到了问题，这堆代码涉及到了较多的变量，而且不同部分代码的变量都是另一部分代码需要的参数，所以没有办法单纯的抽出成一个个小方法。

举个例子

比如这一堆代码是一个更新活动的逻辑，其中包含活动的时间转换，活动信息校验，活动额外信息的获取，活动信息拼装以及更新等操作。（当然，实际情况比这个复杂，这里只是作为一个简单的例子来看，而且这个例子单纯是为了解释Method Object，也许有其他更好的重构方式）

/**
 * 前面的一堆代码
 * ……
 */

// 1.入参时间转换
long startTime = getStartTime(actParam.getStartTime());
long endTime = getEndTime(actParam.getEndTime());

// 2.活动信息查询以及校验
ActBean actBean = getActBean(actParam.getActId());
checkRepeatAct(actBean,startTime,endTime);

// 3.获取活动额外信息
ExtraActInfo extraActInfo = getExtraActInfo(actBean);
checkExtraActInfo(extraActInfo);

// 4.活动信息拼装以及更新操作
ActBean updateActBean = getUpdateActBean(startTime, endTime, actBean, extraActInfo);
actService.updateActBean(updateActBean);

/**
 * 后面的一堆代码
 * ……
 *
 */

需求

我需要将这堆代码中的1、2、3部分代码放到一个叫checkActInfo的大方法里，统一做校验以及信息的修正。之后里面的每一部分的校验都封装成一个小方法，只做这部分信息的校验以及转换。比如把第1部分改成checkTime等。但是问题就出现了，1、2、3部分变成一个大方法后，在第4部分需要的入参，没办法通过checkInfo全部返回。而在checkActInfo方法里，如果第1部分变成了一个checkTime方法，那么第2部分中需要的startTime和endTime也没办法通过checkTime全部返回。这样就没办法直接extract method了。

Method Object

于是大佬在我旁边指了一下，说：用Method Object啊，你去看看《重构改善既有代码的设计》这本书。

何为Method Object

以函数对象取代函数（Replace Method with Method Object）
你有一个大型函数，其中对局部变量的使用使你无法采用 Extract Method （提炼函数）。
将这个函数放进一个单独对象中，如此一来局部变量就成了对象内的字段。然后你可以在同一个对象中将这个大型函数分解为多个小型函数。

我的理解就是，以函数对象取代函数实质上是转变一下思维，将一个method(方法)抽象成一个object（对象），而之前方法用到的局部变量都变成了对象中的变量。这样的话，就可以把堆在一起的代码分成几个小方法，而且也不用考虑把每个小方法里处理过的参数返回到主方法里，再传递给其他方法了。因为之前对每个参数的处理，都是对重构后方法对象里的变量做了处理。这样就可以肆无忌惮的分拆这个大方法了。

分拆！

书上说

我们来看看书中介绍的操作流程

1. 建立一个新类，根据待处理函数的用途，为这个类命名。
2. 在新类中建立一个final字段，用以保存原来大型函数所在的对象。我们将这个字段称为“源对象”。同时，针对原函数的每个临时变量和每个参数，在新类中建立一个对应的字段保存之。
3. 在新类中建立一个构造函数，接收源对象及原函数的所有参数。
4. 在新类中建立一个compute()函数。
5. 将原函数的代码复制到compute()函数中。如果需要调用源对象的任何函数，请通过源对象字段调用。
6. 编译。
7. 将旧函数的函数本体替换为这样一条语句“创建上述新类的一个新对象，而后调用其中的compute()函数”。

我们应该怎么做

我建议直接用idea自带的功能，选中需要重构的代码，右键→Refactor→Extract→Method Object。在弹出来的对话框里填写要生成的类的名称checkActInfo。新生成的checkActInfo类如下：

private class CheckActInfo {
    private ActParam actParam;
    private long startTime;
    private long endTime;
    private ActBean actBean;
    private ExtraActInfo extraActInfo;

    public CheckActInfo(ActParam actParam) {
        this.actParam = actParam;
    }

    public long getStartTime() {
        return startTime;
    }

    public long getEndTime() {
        return endTime;
    }

    public ActBean getActBean() {
        return actBean;
    }

    public ExtraActInfo getExtraActInfo() {
        return extraActInfo;
    }

    public CheckActInfo invoke() {
        // 1.入参时间转换
        startTime = getStartTime(actParam.getStartTime());
        endTime = getEndTime(actParam.getEndTime());

        // 2.活动信息查询以及校验
        actBean = getActBean(actParam.getActId());
        checkRepeatAct(actBean,startTime,endTime);

        // 3.获取活动额外信息
        extraActInfo = getExtraActInfo(actBean);
        checkExtraActInfo(extraActInfo);
        return this;
    }
}

CheckActInfo类中的私有变量包含了我们源代码块中的变量参数。构造方法通过接收入参actParam实例化CheckActInfo对象，同时调用CheckActInfo中的invoke方法，会执行之前的那些代码块，并返回一个新的CheckActInfo对象。我们只需要从这个CheckActInfo对象中获取到需要的变量，拼装出一个updateActBean对象就可以按照原有的逻辑更新对象了。这样的话，我们就成功的完成了Replace Method with Method Object。

进一步完善

当然，只是Replace Method with Method这样还不够，我们的目标是把大方法分拆，不过分拆就容易多了。只要肆无忌惮的按照原有的思路把三部分分拆成三个小方法，就ok了。不过这里有个问题，因为之前的方法是有序的，所以我们可以写一个excuteAll的方法，把之前的方法都串起来执行，无需在外面的主方法里依次调用了。改进如下：

private class CheckActInfo {
    private ActParam actParam;
    private long startTime;
    private long endTime;
    private ActBean actBean;
    private ExtraActInfo extraActInfo;

    public CheckActInfo(ActParam actParam) {
        this.actParam = actParam;
    }

    public long getStartTime() {
        return startTime;
    }

    public long getEndTime() {
        return endTime;
    }

    public ActBean getActBean() {
        return actBean;
    }

    public ExtraActInfo getExtraActInfo() {
        return extraActInfo;
    }
    public CheckActInfo transferTime() {
        // 1.入参时间转换
        startTime = getStartTime(actParam.getStartTime());
        endTime = getEndTime(actParam.getEndTime());
        return this;
    }
    public CheckActInfo checkRepeatAct() {
        // 2.活动信息查询以及校验
        actBean = getActBean(actParam.getActId());
        checkRepeatAct(actBean, startTime, endTime);
        return this;
    }

    public CheckActInfo checkAndGetExtraActInfo() {
        // 3.获取活动额外信息
        extraActInfo = getExtraActInfo(actBean);
        checkExtraActInfo(extraActInfo);
        return this;
    }
    public CheckActInfo executeAll(){
        this.transferTime().checkRepeatAct().checkAndGetExtraActInfo();
        return this;
    }
}

之前的主方法调用：

/**
 * 前面的一堆代码
 * ……
 */

CheckActInfo checkActInfo = new CheckActInfo(actParam).executeAll();
// 活动信息拼装以及更新操作
ActBean updateActBean = getUpdateActBean(checkActInfo.getStartTime(), checkActInfo.getEndTime(), 
        checkActInfo.getActBean(), checkActInfo.getExtraActInfo());
actService.updateActBean(updateActBean);
/**
 * 后面的一堆代码
 * ……
 */

完成！