Solid Jan 12 2011 at 14:52

Автоматический контроль структуры класса

4 min

Java*

From sandbox

+18

Comments 29

Stepuk Jan 12 2011 at 15:28

Все чаще сталкиваюсь с проблемой чёткого разделения полей класса на свойства (то, что непосредственно характеризует объект) и зависимости (то, что нужно для работы объекта и будет инжектится). А ведь есть еще и константы! Но с ними проще, public static final обычно сразу «выделяются из толпы». Короче, хотелось бы сгруппировать поля по назначению. Приходится писать так (пример взят от балды):

public class BadRobot {

public static final int MAX_HEALTH = 60;
public static final int MAX_SPEED = 15;
// ^ Constants ^
private FuelSupplySystem fuelSupply;
private BulletSupplySystem bulletSupply;
// ^ Dependencies ^
private int currentHealth;
private int currentSpeed;

// Constructors and methods…

}

Можно ли каким-либо образом автоматически отслеживать, чтобы такое разделение всегда соблюдалось?

Solid Jan 12 2011 at 15:46

Если у вас все имена полей начинаются с «current», то вот такое регулярное выражение поможет вам:
Field(public static final) ### Field(private.*current.*) ### Field(private .*)

Тогда в данном случае порядок будет такой: константы, поля, dependencies.
Либо надо придумать как описать dependencies одним регулярным выражением (например делать опору на имена, типы или аннотации)

asm0dey Jan 12 2011 at 20:01

см мой коммент ниже

1nd1go Jan 12 2011 at 15:58

по-моему, смахивает на фашизм. Чекстайла, PMD, Findbugs я думаю в большинстве случае достаточно.

А вот если бы был плагин, который код форматировал в соответствии с чекстайлом — это было бы хорошо. Конечно, не все ошибки чекстайла можно исправить (остутствие комментария например), но стилевые вещи можно. А так приходится два конфига иметь — чекстайл и code formatting

Solid Jan 12 2011 at 16:10

Что подразумевается под фашизмом?
Это и есть модуль к чекстайлу и его можно настроить под свои нужды.
У чекстайла есть данная опция, может она поможет.

1nd1go Jan 12 2011 at 16:16

под фашизмом подразумевается проверка структуры класса на соответствие нормам. В принципе, это не такой уж фашизм, но, например, фэйлить сборку по такой проверке я рассматриваю как перебор

Solid Jan 12 2011 at 16:23

чекстайл позволяет настраивать уровень ошибки: error, warning, info, что позволяет выбрать необходимый уровень, для того чтоб не фейлилась сборка.
+ у нас более 4000 классов проекта описаны правилами, описанными в статье и читабельность кода значительно улучшилась.

stas_agarkov Jan 12 2011 at 16:22

в intellij idea можно задавать порядок размещения элементов класса

Solid Jan 12 2011 at 16:32

предложенное решение c помощью checkstyle позволяет сосуществовать программистам, использующим разные IDE. Более того проверка осуществляется и на уровне билд машины (continius integration system), Sonar и…

asm0dey Jan 18 2011 at 07:26

Не подскажете, как?

Zagrebelion Jan 12 2011 at 18:15

А есть способ спрятать пачку однострочных геттеров и сеттеров?

stas_agarkov Jan 12 2011 at 21:05

да

Solid Jan 13 2011 at 09:15

это вопрос к idea ide или к модулю чекстайла?

Zagrebelion Jan 13 2011 at 11:39

Это вопрос из серии «наболело».

asm0dey Jan 12 2011 at 20:00

Вообще, Jalopy прекрасно умеет добавлять комментарии к разным блокам кода, сортировать их по смыслу и алфавиту, добавлять модификаторы, если надо…

Оно прекрасно интегрируется в нетбинс, и, вероятно, в eclipse не хуже…

malkolm Jan 17 2011 at 18:11

jindent пробовали?

asm0dey Jan 18 2011 at 07:24

jalopy круче, насколько я помню. Рулит автоматическая сортировка блоков кода

malkolm Jan 18 2011 at 08:16

jindent тоже сортирует блоки кода, чем круче то?

asm0dey Jan 18 2011 at 09:01

Видимо был неправ. Исправлюсь

malkolm Jan 18 2011 at 09:25

Да какая разница кто тут прав, просто интересно чем он лучше. В свое время сравнивал их и jindent более цивильно код сортировал и оформлял. Проблема только в том, что jindent платный :) Но он стоит своих денег.

asm0dey Jan 18 2011 at 09:33

А, может поэтому я не стал им пользоваться
А вы вообще следите за ними? Они развиваются?

malkolm Jan 18 2011 at 09:41

Развиваются, вот С++ уже обозначен, но еще не зарелизен. Вроде ява тоже двигатся вперед.

asm0dey Jan 18 2011 at 09:53

Это про индент?
А что с джалопи?

x40c Jun 5 2015 at 06:46

Неделю назад на него наткнулся. Проблему платности решил (последняя статья на краклабе про это), если кому интересно будет.

fls_welvet Jan 13 2011 at 15:58

Недавно была статья про svn-hook для агрессивной проверки форматирования кода на C# (режект коммита если проверка не прошла). Мне кажется, лишним реализовать поддержку «из коробки» такой проверки для CheckStyle не будет.

Solid Jan 13 2011 at 16:35

Если считаете что лишним не будет, то оставте пожалуйста комент на станичке с патчем для автора проекта Checkstyle что бы показать ему заинтересованость в этом чеке и других разработчиков. Зарание спасибо.

Zagrebelion Jan 16 2011 at 09:00

Объясните, пожалуйста, куда вставлять строку «Пример правила из реальной жизни...». По настройкам checkstyle потыкался — не нашёл.

Solid Jan 16 2011 at 10:25

После того, как вы установили себе плагин checkstyle и поставили на него патч с нашими дополнительными модулями, в
Window -> Preferences -> Checkstyle вы создаете, редактируете Check Configuration (New, Configure).
В появившемся окне конфигурации вам надо зайти в группу модулей Coding problems и создать из списка новый модуль Custom Declaration Order Check.
К сожалению, разработчики плагина на checkstyle для Eclipse не предусмотрели multi-line поле для текста, приходится все заполнять в одну строку…

poltora Oct 19 2011 at 06:45

Все эти ваши «конструктор неожиданно появляется в середине класса» и «внутренний класс объявлен где-то в середине внешнего класса» — это все мышиная возня.

Мне вот интересно, что, реально есть люди, которые при открытии класса прокручивают файл, выискивают методы, конструкторы, атрибуты?

А не используют навигаторы струкур классов, которые выдают перед глазами всю логическую структуру, правильно все группируя (гетеры-сетеры с атрибутами; расширения/перепределения в дочерних классах; реализации интерфейсов) и сортируя, если требуется.

А не используют иерархию пакетов, дабы наблюдать (читай — представлять в голове) вложенность пакетов и агрегацию классов.

А не используют иерархию типов, дабы наблюдать зависимости наследований.

Вас реально волнует отсортированы ли методы по названию, рядом ли расположены атрибут и его методы доступа?

Люди, опомнитесь! (с)
Не спускайте время на мышиную возню — пусть всей рутиной занимается компьютер (IDE), а вы — используйте свою жизненную энергию как подобает homo sapiens — реализуйте свой потенциал, добиваясь сдачи интересных проектов в срок, без багов и с изящной архитектурой, которую не прийдется долго и затратно рефакторить.