Какое имя дать интерфейсу в данном случае?

Question

[baddev]

Здравствуйте.
Прошу помочь с именованием интерфейсов-репозиториев в андроид.
Есть два вида сущностей - пользователи и книги. Хочется написать нечто такое:

interface IUsersRepository {}
class UsersRepository implements IUsersRepository {}

interface IBooksRepository {}
class BooksRepository implements IBooksRepository {}

Но насколько я понял, в java не принято добавлять префикс "I" к названиям интерфейсов. Какие названия применили бы вы в данном случае? Спасибо.

Answer 1

[UNy]

Интерфейсы: BooksRepository и UserRepository
Классы: BooksRepositoryImpl и UserRepositoryImpl

Comments

[Сергей Горностаев]

Или более конкретные названия для реализаций, типа BooksJpaRepository, BooksMongoRepository и т.п.

[baddev]

Сергей Горностаев, UNy

Благодарю за ответы. Если не трудно проясните пожалуйста следующее:

1) если называю класс BooksRepositoryImpl, а у меня есть еще второй, который должен реализовать тот же интерфейс, как в таком случае нужно называть второй класс?

2) нужно ли "Impl" тянуть в названия переменных/членов класса. Вот в примерах встречаю такое:

Название класса: class TasksRepository {}
Объявление члена класса: TasksRepository mTasksRepository;

Вопрос в том, если у меня класс называется BooksRepositoryImpl, нужно ли член класса называть так BooksRepositoryImpl mBooksRepositoryImpl; или можно Impl опустить и назвать так BooksRepositoryImpl mBooksRepository; ?

[baddev]

И еще один момент, только сейчас заметил: вы случайно пропустили букву "s" в случае с UserRepository, или в данном случае book и user не равнозначны в этом плане? Спасибо

[Сергей Горностаев]

baddev,

1. Мой комментарий как раз про такие случаи. В названии реализации должны отображаться детали реализации, позволяющие беглым взглядом определить, чем одна реализация отличается от другой.
   
2. Соглашение об именовании полей и переменных - вопрос индивидуальный и зависит больше от принятого командой стиля. Но например Роберт Мартин в своём хрестоматийном труде "Чистый код" советует не использовать в именах переменных префиксов и другой лишней информации. Я с ним согласен, и назвал бы переменную просто bookRepository или даже просто repository, если из контекста и так ясно на какой репозиторий ссылается переменная.
   

[baddev]

Сергей Горностаев, большое Вам спасибо, очень помогли!

[AWE64]

По возможности используйте ссылку на интерфейс, например TasksRepository mTasksRepository = new TasksRepositoryImpl();

[baddev]

AWE64, а Вы не могли бы просветить, как именно определять когда использовать ссылку на интерфейс а когда на класс?

Просто я ориентируюсь на вот этот пример, на который ссылается гугл, и там в классе одна ссылка на интерфейс, а вторая на класс:

private final TasksRepository mTasksRepository; //класс
private final TasksContract.View mTasksView; //интерфейс

но в зависимости от чего где-то класс где-то интерфейс, как это определять?

P.S.
Сергей Горностаев, может Вы тоже сможете помочь с прояснением этого момента? Всем заранее большое спасибо.

[AWE64]

baddev, я в своей практике стараюсь вегда использовать ссылку на максимально общий класс или интрефейс. Например, если нужен List, то храню ссылку на List, а не на конкретную реализацию (ArrayList, LinkedList). Это правило хорошего тона и основа полиморфизма.

[baddev]

AWE64, спасибо, что подметили этот момент, я запомню. В целом интуитивно понимал, что чем более родительская ссылка, тем больше гибкости в дальнейшем, но в ООП я совсем новичок, поэтому много неуверенности почти в каждом моменте)
А в том примере, который я указал выше, наверняка есть какая-то загвоздка/причина, почему в одном случае ссылаются на интерфейс, а сразу же строчкой ниже на класс. Надеюсь кто-то прольет свет на эту ситуацию, уж очень хочется знать, чем это обусловлено.

[AWE64]

baddev, к сожалению, сейчас нет времени подробно изучать этот пример.
Если интересуетесь темами ООП, архитектуры, паттернов и вот этого всего, могу посоветовать канал Сергея Немчинского, ищите в самых старых видео, там просто шикарно всё изложено.

[baddev]

AWE64, большое спасибо, обязательно посмотрю!

[Dmtm]

это только вопрос соглашений,
во всех проектах с которыми работал - народ приходил к варианту
IUsersRepository - UsersRepository, потому что это короче и нагляднее чем UsersRepository - UsersRepositoryImpl
и кстати глупую выдумку гугла про м - mTasksRepository - ненавидят все
потому что приходится сначала писать эту м, а потом уже значимую букву для автодополнения

[baddev]

Dmtm, полностью согласен с Вами во всем, рад что использование варианта "UsersRepository - UsersRepositoryImpl" не является строго обязательным, ибо вариант с префиксом "I" уж больно удобнее) Спасибо за ответ!