Несколько примеров
- JDK поставляется с инструментами
Arrays.asList();
Objects.equals();
Collections.sort();
- Класс инструментов Spring Framework
StringUtils.isEmpty();
CollectionUtils.isEmpty()
FileCopyUtils.copy();
- Класс инструментов Hutool
StrUtil.isEmpty();
CollectionUtil.isEmpty();
FileUtil.copy();
Мы обнаружили, что методы именования между примерами группы были различными, суммированы, разделенные на три:
1, JDK в первую очередь назван в виде операционных объектов
2. Классы инструментов среды Spring названы во множественном числе от объекта или назначения + Util.
3. Классы инструментов фреймворка Hutool названы в единственном числе от объекта или цели + Util
Хорошо, прочитав вышеизложенное, давайте посмотрим на метод именования классов инструментов в нашем проекте.
StringUtil.isEmpty();
StringUtils.isEmpty();
StringKit.isEmpty();
StringHelper.isEmpty();
StringTool.isEmpty();
StringTools.isEmpty();
Видно, что простой класс инструментов String может иметь так много методов именования.
Сравнение нескольких методов именования
Главная форма объекта, представленная JDK
преимущество
Это просто и понятно, и для людей, которые знакомы с ним, на самом деле довольно круто использовать его таким образом.
недостаток
Легко неправильно понять роль классов, используя другие слова, оканчивающиеся на s, например, поместив классы pojo, такие как News и Goods, вместе с классами инструментов Objects. Это первое впечатление, что они используются для тех же целей, но это не так.
Форма множественного числа Object Util, представленная фреймворком Spring
преимущество
Назначение класса можно отделить от имени класса, и пользователя нелегко понять неправильно.
недостаток
Имена классов, как правило, носят в единственном числе, а формы именования во множественном числе будут казаться несовместимыми с общим методом именования.
Объект, представленный фреймворком Hutool Util в единственном числе
преимущество
Назначение класса можно разделить в соответствии с именем класса, которое пользователям нелегко понять неправильно, а общий метод именования легко согласуется с другими классами в проекте.
недостаток
Это нормально, и тогда вы не сможете играть в нее снова.
Нейминг в проекте
Я не буду слишком много говорить об именовании Набора и Инструмента в проекте, а в основном проанализирую несколько основных методов именования.
Как именно он называется?
Для чистых инструментов Util или Utils являются наиболее распространенными методами именования в отрасли.Конечно, могут использоваться и другие методы именования, в том числе несколько методов именования в проектах, перечисленных выше.Просто все упоминали Util или Utils.Реакция известно, что это класс инструмента, ответ других методов именования может занять несколько секунд.
Но здесь мне нужно рассказать о разнице между Util и Helper, которая ограничена моим собственным пониманием.
В архитектуре программного обеспечения существует концепция повторного использования программного обеспечения, которая делится на повторное использование по горизонтали и повторное использование по вертикали.
Горизонтальное повторное использование: относится к элементам программного обеспечения, которые можно использовать в различных областях применения, оно просто не зависит от бизнеса и может использоваться в любом бизнес-сценарии.
Вертикальное повторное использование: это относится к повторному использованию компонентов программного обеспечения между классом или полями приложения с большей общностью.Простое понимание состоит в том, что его можно использовать в определенной области бизнеса или бизнес-сценарии.
Тогда класс UTIL относится к вышеупомянутому水平式重用, класс Util больше предназначен для инкапсуляции классов, предоставляемых JDK, или для инкапсуляции использования других классов внутри структуры, предоставляемой технической структурой, но эти классы, как правило, не зависят от бизнеса и предметной области. Его можно использовать в любом бизнесе и сфере. Следовательно, поскольку это класс инструментов, он должен обеспечивать его горизонтальное повторное использование.
Helper переводится как помощник/помощник, буквально такой класс используется как вспомогательный класс, поэтому вопрос, а кто вспомогательный объект? Затем, конечно, это помощь другим классам.Здесь есть диапазон.Каким классам можно помочь.Теоретически, при необходимости можно помочь всем классам или объектам.Но на практике это больше упрощает сложность использования связанных классов в определенном сценарии и предоставляет удобный интерфейс доступа для формирования класса Helper, и этот сценарий обычно имеет характеристики бизнеса или предметной области., поэтому более воплощенное использование垂直式重用.
Суммировать
Лично я на данный момент привык именовать Util в единственном числе, да и другие классы в проекте именуются в единственном числе, например: UserController, UserVo и т.д. Было бы немного неловко вдруг появиться класс во множественном числе.
Если нет особых требований или личных увлечений, он все равно называется так, чтобы публике было проще понять Util или Utils.Вы сказали, что я должен назвать его Tool, и это не проблема.Суть в том, что у компании или команды есть собственный набор стандартов., я человек с чистотой кода, и буду строго унифицировать стандарты в команде.Сначала кажется, что это занимает много времени, ноКогда каждый во внутреннем познании сможет достичь консенсуса, молчаливое понимание всех в команде будет выше в будущем.,Это минимизирует затраты на связь, снизить затраты на техническое обслуживание в более поздний период.
Если он может соответствовать вышеуказанным требованиям, его действительно можно назвать.