Skip to content

Требования к коду

Alex Anakin edited this page Mar 11, 2016 · 17 revisions

Данные требования согласованы с Виктором Кучиным и Александром Анакиным. Они не отменяют правил на других страницах вики.

  1. Использовать в рест-запросах under_score стиль.
  2. Роллбек если есть, то должен приводить базу в то состояние, которое было до запуска ченчсета.
  3. Тесты не должны использовать интернет.
  4. Соблюдаем принцип YAGNI: нужно реализовывать минимум методов, который полностью удовлетворяет постановке задачи. Особенно это касается дао и сервисов.
  5. Группировать методы в дао и сервисах по выходным параметрам. Если метод возвращает void, то по логике применения метода. Иллюстрация
  6. Запрещена операция DELETE в БД, так как информация может быть полезной в будущем. Нужно добавить в таблицы поле active.
  7. Перед созданием нового changeset, зарезервировать номер в Liquibase changeset LOG
  8. Все объекты должны быть имьютебл (immutable). Узнать, почему это полезно, можно в этой статье. Узнать, как сделать объект имьютебл - в документации.
  9. Запрещено создание статических утилитных методов; [25:00]. Почитайте статью о том, почему это плохо и чем нужно их заменить.

###Дополнительно

Clone this wiki locally