如何以及为什么在带有“ get”和“ find”前缀的命名方法之间做出决定

我总是很难确定是否应该以getSomethingvs 开头的某个方法findSomething。

问题在于为设计不当的API 创建帮助程序。当从对象获取数据时通常会发生这种情况，这需要对象作为参数。这是一个简单的示例：

public String getRevision(Item item) {
    service.load(item, "revision");
    // there is usually more work to do before getting the data..
    try {
        return item.get_revision();
    }
    catch(NotLoadedException exception) {
        log.error("Property named 'property_name' was not loaded", exception);
    }
    return null;
}

如何以及为什么要在将此方法命名为getRevision()or时做出决定findRevision()？

Get当我知道检索时间将非常短时（例如在从哈希表或btree进行查找时），我就使用该方法。

Find暗示需要“更长”的时间来执行（对于更长的某个任意值）的搜索过程或计算算法。

我会说这find可能会失败，但get不应该。

引用我经常与我的孩子进行的对话：

我： 嘿，小子！去找我一些电池

小子：但是他们在哪里？

我：那就是为什么我告诉你去找他们。如果我知道他们在哪里，我会告诉你去拿他们。或者你可以问你的母亲。

同样的想法成立：

• 对于返回廉价信息（并且可以内联或以其他方式进行优化）的方法使用“ get”，或对该对象唯一拥有的信息使用“ get”。

• 使用“查找”作为一种确实可以获取一条信息或使用其他对象进行查找的方法。

Find表示没有结果，例如执行带有某些参数的数据库查询时，这些参数可能在调用之间改变。另一方面，Get表示结果是方法事先已知的，或者一旦知道就不会更改，即调用没有参数。
因此，我将使用例如Customer findCustomerById（long customerId）和Customer getCustomer（）

我采用以下模式：

• Foo GetFoo() 不能返回null并且复杂度为O（log（n））或更小
• bool TryGetFoo(out Foo) 可以返回null并且复杂度为O（log（n））或更小
• Foo FindFoo() 不能返回null并且它的复杂度大于O（log（n））
• bool TryFindFoo(out Foo) 可以返回null并且它的复杂度大于O（log（n））

这样，代码就可以清楚地表明意图和复杂性。

通常，getter用于直接列表或字典/集合访问。
查找器是深度搜索，列表的完整扫描等。

在您的情况下：

public bool TryGetRevision( Item item, out String revision ) 
{
    service.load( item, "revision" );
    // there is usually more work to do before getting the data..
    try 
    {
        revision = item.get_revision();
        return true;
    }
    catch( NotLoadedException exception )
    {
        log.error( "Property named 'property_name' was not loaded", exception );
        revision = "";
        return false;
    }
}

get在任何情况下都是适用的_实际上，通常会假设为了获得某些东西，您首先需要找到它。因此，如果不确定，请使用get。

我将使用find诸如findMinimum()或之类的方法findOptimal()，即有一些特殊的算法来计算返回值，而不仅仅是向数据库，文件系统，远程服务器等发出请求以接收一些数据。

不要使用查找或获取前缀。这违反了由bertrand meyer创造的UniformAccessPrinciple。为什么不创建如下所示的方法：

public String revision(Item item)

我通常会使用它Get来检索对象/值，并Find检索其位置（例如，在数组中）。

例如：

object o = obj.GetItem( 'name');

integer i = somearray.Find( 'name');

对我来说，find意味着可能存在不止一个结果。 get仅暗示一个。