Konwencje nazewnictwa dla metod Java, które zwracają wartość logiczną (bez znaku zapytania)

Lubię używać znaku zapytania na końcu nazw metod / funkcji w innych językach. Java mi na to nie pozwala. Jako obejście, jak inaczej mogę nazwać logiczne metody zwracające w Javie? Korzystanie z is, has, should, canz przodu dźwięk metoda dobrze dla niektórych przypadkach. Czy jest lepszy sposób na nazwanie takich metod?

Na przykład createFreshSnapshot?

Konwencja polega na zadawaniu pytania w imieniu.

Oto kilka przykładów, które można znaleźć w JDK:

isEmpty()

hasChildren()

W ten sposób nazwiska są odczytywane tak, jakby miały na końcu znak zapytania.

Czy kolekcja jest pusta?
Czy ten węzeł ma dzieci?

A zatem trueoznacza tak i falseoznacza nie.

Możesz też przeczytać to jak stwierdzenie:

Kolekcja jest pusta.
Węzeł ma dzieci

Uwaga:
czasami możesz chcieć nazwać metodę podobną do createFreshSnapshot?. Bez znaku zapytania nazwa sugeruje, że metoda powinna tworzyć migawkę, zamiast sprawdzać, czy jest wymagana.

W takim przypadku powinieneś przemyśleć, o co tak naprawdę prosisz. Coś w rodzaju isSnapshotExpiredjest o wiele lepszą nazwą i przekazuje to, co powie ci metoda, gdy zostanie wywołana. Postępowanie według takiego schematu może również pomóc w utrzymaniu większej liczby funkcji w czystości i bez skutków ubocznych.

Jeśli do wyszukiwarki Google dla isEmpty()w API Javy, można uzyskać wiele wyników.

Jeśli chcesz, aby Twoja klasa była zgodna ze specyfikacją Java Beans , tak aby narzędzia wykorzystujące odbicie (np. JavaBuilders , JGoodies Binding ) mogły rozpoznawać boolowskie metody pobierające , użyj getXXXX()lub isXXXX()jako nazwy metody. Ze specyfikacji Java Beans:

8.3.2 Właściwości boolowskie

Dodatkowo, dla właściwości logicznych, pozwalamy metodzie pobierającej na dopasowanie do wzorca:

public boolean is< PropertyName > ();

Ta metoda „is < PropertyName >” może być dostarczona zamiast metody „get < PropertyName >” lub może być dostarczona jako dodatek do metody „get < PropertyName >”. W każdym przypadku, jeśli metoda „is < PropertyName >” jest obecna dla właściwości boolowskiej, użyjemy metody „is < PropertyName >” do odczytania wartości właściwości. Przykładową własnością logiczną może być:

public boolean isMarsupial();
public void setMarsupial(boolean m);

Chcę opublikować ten link, ponieważ może to jeszcze bardziej pomóc użytkownikom sprawdzającym tę odpowiedź i szukającym bardziej konwencji w stylu java

Wskazówki dotyczące stylu programowania w języku Java

Punkt „2.13 to przedrostek powinien być używany dla zmiennych i metod boolowskich”. jest szczególnie istotne i sugeruje przedrostek is .

Przewodnik po stylu sugeruje:

Istnieje kilka alternatyw dla przedrostka is, które lepiej pasują do niektórych sytuacji. Są to prefiksy, które mają , mogą i powinny :

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

Jeśli zastosujesz się do Wytycznych, uważam, że odpowiednia metoda będzie nazwana:

shouldCreateFreshSnapshot()

W przypadku metod, które mogą się nie powieść, to znaczy określasz wartość logiczną jako typ zwracany, użyłbym przedrostka try:

if (tryCreateFreshSnapshot())
{
  // ...
}

We wszystkich innych przypadkach użyj przedrostków, takich jak is.. has.. was.. can.. allows.....

Standardowo używa się przedrostka „jest” lub „ma”. Na przykład isValid, hasChildren.

isto ten, z którym się spotykałem częściej niż jakikolwiek inny. Cokolwiek ma sens w obecnej sytuacji, jest jednak najlepszą opcją.

Chcę wskazać inne spojrzenie na tę ogólną konwencję nazewnictwa, np .:

zobacz java.util.Set :boolean add​(E e)

gdzie uzasadnieniem jest:

wykonaj pewne przetwarzanie, a następnie zgłoś, czy się powiodło, czy nie .

Chociaż returnrzeczywiście jest booleanto nazwa metody, powinna wskazywać na zakończenie przetwarzania zamiast typu wyniku (boolean w tym przykładzie).

Twój createFreshSnapshotprzykład wydaje mi się bardziej związany z tym punktem widzenia, ponieważ wydaje się oznaczać to: utwórz nową migawkę, a następnie zgłoś, czy operacja tworzenia zakończyła się powodzeniem. Biorąc pod uwagę to rozumowanie, nazwa createFreshSnapshotwydaje się być najlepsza dla twojej sytuacji.