Как и зачем выбирать между методами именования с префиксами «get» и «find»

Мне всегда трудно понять, стоит ли мне называть определенный метод, начиная с « getSomethingпротив» 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()или findRevision()?

Я использую, Getкогда знаю, что время поиска будет очень коротким (как при поиске из хеш-таблицы или btree).

Findподразумевает процесс поиска или вычислительный алгоритм, который требует «более длительного» периода времени для выполнения (для некоторого произвольного значения более длинного).

Я бы сказал, что findможет потерпеть неудачу, но getне должен.

Процитирую разговор, который я часто имею со своими детьми:

я: Эй, малыш! Найди мне батарейки

Малыш: Но где они?

я: Вот почему я сказал вам, чтобы найти их. Если бы я знал , где они были, я сказал бы вам пойти получить их. Или вы могли бы спросить свою мать.

Та же идея имеет место:

• используйте «get» для метода, который возвращает дешевую доступную часть информации (и, вероятно, может быть встроенной или иным образом оптимизированной), или для части информации, уникально принадлежащей этому объекту.

• используйте «find» для метода, который работает, чтобы получить часть информации, или использует другие объекты, чтобы найти ее.

Поиск подразумевает отсутствие результата, например, при выполнении запроса к базе данных с некоторыми параметрами, которые могут изменяться между вызовами. Get, с другой стороны, подразумевает, что результаты известны методу заранее или не изменятся после того, как станут известны, что в вызове нет параметров.
Итак, я бы использовал, например, Customer findCustomerById (long customerId) и Customer getCustomer ()

Я применяю следующий шаблон:

• Foo GetFoo() не может вернуть ноль, и его сложность равна O (log (n)) или меньше
• bool TryGetFoo(out Foo) может вернуть ноль, и его сложность равна O (log (n)) или меньше
• Foo FindFoo() не может вернуть ноль, и его сложность больше, чем O (log (n))
• bool TryFindFoo(out Foo) может вернуть ноль, и его сложность больше, чем O (log (n))

Таким образом, код достаточно ясен в отношении намерений и сложности, которую вы можете ожидать.

Как правило, геттеры предназначены для прямого доступа к списку или словарю / набору.
Искатели - это глубокий поиск, полное сканирование списка и т. Д.

В твоем случае:

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(), т. Е. Где есть какой-то особый алгоритм, который вычисляет возвращаемое значение, а не просто делает запрос к БД, файловой системе, удаленному серверу и т. Д. Для получения некоторых данных.

Не используйте префиксы find или get. Это нарушение UniformAccessPrinciple, придуманное Бертраном Мейером. Почему бы не создать метод, подобный следующему:

public String revision(Item item)

Обычно я буду использовать Getдля получения объекта / значения и Findдля определения его местоположения (например, в массиве).

Например:

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

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

Для меня это findозначает, что может быть более одного результата. getподразумевает только одно.