java - 何时创建辅助方法和单独的文件

Question

背景:我有一个很大的(几百行)类，它管理一个基于一些原始类型数据结构的概念

long[] slist;  //list of unique patterns (related to polyominoes)
int[][][] sref;//patterns at each place [location][depth][<list of indices in slist>]

问题:填充和更新这些数据的两种方法会很长，有一些 5-20 行任务，一些是共享的，另一些是独特的。我可能想为每个子任务制作一个辅助方法。

update(...){
    //do A
    //do B
    //do C
    //...
}
build(){
    //do D
    //do B
    //do E
    //...
}

问题是如果一个文件中有太多不相关的辅助方法，可读性不会提高。

this question 的答案让我到达那里的大部分时间。我可以在同一个包中、在它们自己的类中声明结构，并访问原始成员字段或调用相关方法。但我仍然想知道这里公认的智慧，因为这个组织并不容易想到。

您是否会将 update() 和 build() 函数放在它们自己的文件中？如果是这样，他们的共同任务应该在哪里声明？

Answer 1

我强烈推荐阅读 Refactoring ( Amazon link ) 作者:马丁·福勒 (Martin Fowler)；它应该在每个程序员的库中，并且会帮助你处理这样的情况。我会在帖子中提到它。

如果一个类的代码太多，那么通常是时候拆分这个类了。这可能需要创建具有类的成员变量(委托(delegate)功能)，或者可能意味着动态创建对象 (replace method with method object)。具有共同点的事物是应用继承或 state/strategy pattern 的好例子.

简答

是的，您甚至可以将这些函数放在它们自己的文件中。但是，我宁愿让他们上课。可能是 Updater 和 Builder 对象。您可以继承自 BuilderCommon 和 UpdaterCommon 类。这些新对象会耦合到旧对象上，但没关系。您可以考虑将这些新的类集放在它们自己的包中。分层组织将有助于提高公共(public)代码的可读性和重用性。尝试利用继承之类的概念和泛型之类的抽象技术来为您完成这项工作。如果您能找到 doA、doB 等之间的共同点，请从它们中创建 UpdateHelper 类并将它们放入列表中。然后简单地遍历列表。

这只是一种的方法:

public class Updater
{
    public Updater(List<IUpdateHelper> helpers)
    {
        helpers = new ArrayList<UpdateHelper>();
        this.helpers.add(helpers);
    }
    public void update()
    {
        for (IUpdateHelper helper : helpers)
        {
            helper.performHelp();
        }
    }

    protected List<IUpdateHelper> helpers;
}

public class UpdaterCommon extends Updater
{
    public UpdaterCommon()
    {
        helpers.add(new UpdateHelperA());
        ... // Etc.
    }
}

/*
 * This uses inheritance for common helpers, but it could just as well use
 * delegation. Also, this assumes that order of invocation for each helper 
 * doesn't matter.
 */
public class UpdaterOne extends UpdaterCommon {...}

interface IUpdateHelper
{
    public void performHelp();
}
public class UpdateHelperA implements IUpdateHelper {...}

绝对 replace those arrays with objects并添加一个接口(interface)。

结束语

根据我的经验，通常只需要定期应用其中的一些概念，就能显着提高代码质量。如果一个包、类、方法、条件等变得不守规矩，把它分成一个更小的单元。继续将细节功能分解为非常小的方法，以便您可以从较高的层次查看代码。