Чистый код, его принципы и правила.
Как писать чистый код? Следуйте этим рекомендациям
Ознакомьтесь с лучшими практиками написания чистого кода.
Привет, ребята, эта статья не о какой-то функции или концепции, связанной с Java, а о чем-то большем. По сути, я собираюсь объяснить все ошибки, которые Java-разработчик делает при написании кода, и, следовательно, как вы можете минимизировать их, и вам не нужно рефакторить свой код. Итак, эта статья посвящена ЛУЧШИМ ПРАКТИКАМ, которым должен всегда следовать разработчик.
1. Что там в названии:
Разработчик всегда должен стараться давать понятные имена переменным, методам и классам. Становится слишком легко понять, что такое метод, класс или переменная, когда кто-то читает ваш код во время его просмотра или отладки. Присвоение переменных таких имен, как a, b и c, не имеет никакого значения и становится менее важным при отладке кода.
1. Всегда начинайте имя класса с верхнего регистра. Например.
public class Employee{
}
здесь Employee — это имя класса, и другие разработчики могут легко понять, что этот класс имеет дело с вещами, связанными с сотрудниками.
2. Всегда начинайте имя переменной с нижнего регистра. Например.
private int salary;
здесь зарплата говорит о зарплате работника.
3. Всегда начинайте имя метода со строчных букв и не включайте слова И и ИЛИ в имя метода. Например.
public int calculateSalary(int noOfDaysWorked , int baseSalary)
4. Пишите константы в верхнем регистре и разделяйте их знаком подчеркивания. Например.
public final int RETIREMENT_AGE = 58;
Примечание: не используйте специальные символы при написании имен переменных, методов, констант или классов.
2. Меньшие методы лучше управлять и отлаживать:
Запись многих вещей в одну функцию приводит к плохой реализации дизайна. Кроме того, не рекомендуется писать слишком большие методы, так как их сложно отлаживать, если в одной функции делается так много вещей. Поэтому напишите свою функцию между 10–15 строками, сосредоточив внимание на одной вещи, которую делает метод.
3. Сократите количество строк кода:
Всегда старайтесь думать, даже прежде чем начать писать какой-либо фрагмент кода. Кроме того, подумайте, есть ли возможность уменьшить количество строк, которые вы хотите написать. Как правило, разработчики проверяют логическое условие в блоке if, а затем возвращают значение. Это неправильный способ написания кода. Позвольте мне объяснить фрагмент кода для лучшего понимания.
boolean isContractor(Employee employee) {
if(employee.isCtr) {
return true;
} else {
return false;
}
}
приведенный выше код можно сократить до:
boolean isContractor(Employee employee) {
return employee.isCtr;
}
Теперь вы видите, что мы сократили код до одной строки вместо шести.
4. Нужны ли комментарии?
Да, комментарии добавляют смысл сложным методам или алгоритмам, но они не нужны для вашего кода. Если вы пишете код и думаете, что любой разработчик сможет его понять, просто прочитав код, то нет необходимости добавлять комментарии к понятному коду. Но не забудьте добавить комментарии там, где, по вашему мнению, вы объяснили или написали сложную логику или алгоритм, чтобы позже любой разработчик мог понять это при отладке кода.
5. Одна задача в одном методе:
Добавление множества задач/вещей в один метод не является хорошим решением. Поэтому разработчики всегда должны стараться поддерживать разные функции для выполнения разных задач. Например.
public void addUser(String userName , String password) {
//perform user addition operation to DB
}
6. Структурируйте свой код:
Всегда пишите функции в порядке их вызова. Кроме того, записывайте все переменные в начало всех методов, чтобы их было легче найти. Если некоторые переменные используются только в одной функции, попробуйте сделать эти переменные локальными переменными для этой функции.
7. Рецензенты не любят повторяющийся код:
Всякий раз, когда вы начинаете писать код, вы можете взглянуть на связанные функции и классы в кодовой базе, чтобы проверить, существуют ли уже подобные функции или нет. Если есть какой-то метод, который выполняет ту же задачу, что и вы, используйте его повторно.
Если есть метод с похожим кодом, который вы хотите написать, напишите одну функцию, которая будет выполнять задачу обеих функций, одна из которых уже есть в кодовой базе, а другая, которую вы хотели написать. Это лучший способ удалить повторяющийся код.
8. Проверьте функциональность своего кода, написав тестовые примеры:
Как только вы закончите писать свои методы и связанные с ними классы, приступайте к определению тестовых сценариев и крайних случаев для функциональности вашего кода.
Теперь вы можете включить тестовые наборы для всех этих определенных сценариев и проверить, проходит ли ваш код эти тестовые наборы или нет. При написании кода, если вы пропустили некоторые угловые случаи, попробуйте включить их.
9. Не используйте жесткий код:
Жесткое кодирование — плохая идея, и я обычно вижу, что многие разработчики делают это во время кодирования. Если вы жестко кодируете некоторые строки, становится сложно протестировать реализованную вами функциональность. Это может привести к ошибкам в вашем коде, если что-то изменится, связанное с вашим кодом.
private static String serverIpAddress = "1.2.3.4";
Никогда не делайте эту ошибку. Вы можете написать функцию, которая будет получать IP-адрес, а затем использовать ее в своем коде.
10. Логирование упрощает отладку кода:
При написании кода каждый разработчик должен стараться регистрировать необходимые моменты о функциональности, чтобы получить представление о потоке или важной информации. Это облегчает другому разработчику чтение журналов и проверку потока кода, а также отладку и устранение проблемы.
Код без журналов или неправильных журналов не помогает другим разработчикам легко понять код, и самому разработчику приходится прилагать дополнительные усилия для устранения проблемы.
Кроме того, обратите внимание, что разработчик не должен регистрировать каждый результат оператора, поскольку чрезмерное ведение журнала может снизить производительность приложения.
11. Уменьшить параметры метода:
Передача множества параметров в одну функцию не является хорошей практикой. Вместо этого вы должны попытаться создать объект, а затем передать этот объект в качестве параметра функции. Это улучшает читаемость кода и, следовательно, повышает качество кода.
Eg.
public void addUser(String name , String gender ,
String age ,String userName , String password) {
//perform user addition operation to DB
}
Приведенный выше код можно сократить, передав объект User в качестве параметра.
public void addUser(User user) {
//perform user addition operation to DB
}
//where user will be a class
class User{
private String name ;
private String gender ;
private int age ;
private String userName;
private String password;
//here we can have constructors and getters and setters
//for above instance variables
}
Вы видите, как легко стало читать аргумент, переданный в функцию.
12. Повторное использование кода:
Я уже говорил о дублирующемся коде, которого следует избегать. По сути, вы всегда должны искать свою функциональность, прежде чем записывать ее в базу кода или связанную с ней область кода, и если вы обнаружите, что они ее используют, а если нет, то продолжайте использовать свой собственный метод и напишите их.
13. КОНЕЦ ПРИМЕЧАНИЕ
Я написал много лучших практик, которым должен следовать каждый разработчик при написании кода на любом языке. Эти лучшие практики улучшат ваши навыки написания кода и определенно помогут в ближайшем будущем. Я надеюсь, что вы приняли к сведению эти важные моменты и внедрите их в свою практику написания кода.
Вы можете использовать подключаемый модуль SonarLint для Eclipse и IntelliJIDE для улучшения качества кода. Этот подключаемый модуль предлагает вам рекомендации по написанию кода. .
В заключение, написание чистого кода является важным аспектом разработки программного обеспечения, который может оказать существенное влияние на качество, ремонтопригодность и общий успех проекта. Чистый код характеризуется удобочитаемостью, простотой и ясностью и соответствует установленным соглашениям о написании кода и лучшим практикам.
Конечная цель написания чистого кода — облегчить понимание и работу другим (и будущим версиям вас самих), что приведет к повышению эффективности и уменьшению числа ошибок. Соблюдение принципов чистого кода требует дисциплины и постоянных усилий по улучшению, но преимущества того стоят вложений.
