Чистый кот (Clean cat)

Публикация № 1321306

Методология - Рефакторинг и качество кода

От автора легендарного бестселлера "Совершенный кот".

Вступление

Когда двадцать лет назад я сдал все существующие тогда экзамены уровня 1С:Специалист, то почувствовал себя стесненно: расти некуда. Но потом прочитал чью-то мысль, что после сертификации 1С карьера 1С программиста только начинается. Дышать стало легче. Поэтому я до сих пор начинающий программист. Согласитесь, в условиях нашей динамичной жизни "начинающий программист" звучит лучше, чем "программист с двадцатилетним стажем".

Статья "Совершенный кот" делала упор на наглядность. Сначала хотел просто опубликовать картинки с котом. Поэтому содержательная часть была небольшая. Текущую статью писал к митапу, но чуть-чуть не успел.

Наш основной "манифест" - группа статей "Соглашения при написании кода" очевидно пересекается с классиками (Steve McConnell, Robert C.Martin) И дело не в общих идеях, а в мелочах: максимальная ширина строки, названия переменных, процедур, количество аргументов процедур и прочее. Уверен, что специалисты, которые ее писали, читали классиков гораздо внимательнее, чем мы. Итак, основной признак плохого кода - не использовать преимущества и тренды современного языка 1С. Что бы я еще хотел найти на ИТС ?

1. Большое расстояние между операторными скобками, большое число вложений.

Функция - КонецФункции, Процедура - КонецПроцедуры

По количеству строк функция должна помещаться на экран, чем меньше тем лучше. О том же пишет Robert C.Martin (Clean code) глава 3, Функции, компактность.

Попытка - КонецПопытки. Не каждый код может дать исключение - зачем помещать все в попытку ?

//Некрасиво
Попытка
	НовыйДокумент = Документы.ЗаказПокупателя.СоздатьДокумент();
	ЗаполнитьЗначенияСвойств(НовыйДокумент, Источник,"Дата,Номер");
	НовыйДокумент.Записать();
Исключение
	//ЗаписьЖурналаРегистрации(...);
КонецПопытки;	

//Красиво
НовыйДокумент = Документы.ЗаказПокупателя.СоздатьДокумент();
ЗаполнитьЗначенияСвойств(НовыйДокумент, Источник,"Дата,Номер");
Попытка
	НовыйДокумент.Записать();
Исключение
	//ЗаписьЖурналаРегистрации(...);
КонецПопытки;

Пока - КонецЦикла Меньше уровней вложенности.

//Некрасиво
Пока ВыборкаДетальная.Следующий() Цикл
	
	Если ПроверитьУсловие() Тогда
	
		//многабукв
	
	КонецЕсли; 
	
КонецЦикла;

//Красиво
Пока ВыборкаДетальная.Следующий() Цикл
	
	Если НЕ ПроверитьУсловие() Тогда	
		
		Продолжить;	
	КонецЕсли; 
	
	//многабукв
КонецЦикла;

Если многабукв - очень большой фрагмент кода, то его можно оформить отдельной процедурой

2. Недостаток абстрактного мышления.

Например, вместо функции ЗаполнитьЗначенияСвойств() используют присваивание.

На картинке обычные формы, но на управляемых я видел похожее решение.

Возможно, одинаковые поля лучше выводить в таблицу, как это сделано в настройках СКД ?

3. Памяти Рэя Бойса и Эдгара Кодда посвящается.

Если данные нужны для одного процента документов, то это точно не реквизит документа. Добавьте его в регистр "ЗначенияСвойствОбъектов", добавьте в табличную часть "ДополнительныеСвойства", сделайте отдельный регистр сведений, отдельную табличную часть, в котором будет значение реквизита и ссылка на документ, только не в сам документ и не в общие реквизиты! Особенность современных баз данных - они гораздо эффективнее, когда растут вниз, а не вправо. В СУБД такие горе-реквизиты выглядят так:

Нравится заполнять диск нулями ?

Вопросы из зала ZOOM (после продолжительных аплодисментов):

Вопрос: - Почему такой логотип ?

Ответ: - Кот на логотипе вымытый, то есть чистый.

Вопрос: - Есть код, которым Вы гордитесь ?

Ответ: - Да, есть такой код (десять строк) - парсинг технологического журнала. Описание проблемы можно найти ИТС, задача поставлена более 10 лет назад, а решить ее удалось только в этом году.

Вопрос: - Почему бы не упомянуть про особенные требования к коду в цикле, коду внутри транзакции ?

Ответ: - Это обычные случаи, как правило все знают.

Вопрос: - Что нужно, чтобы код наших программистов был идеальным ?

Ответ: - Прежде всего, нужно договориться внутри команды, "установить правила игры", одинаковые для всех. Что-то вроде устава, в котором прописать конкретные паттерны и антипаттерны ?

Вопрос: - Что главное для программиста ?

Ответ: - Каждая бочка меда должна содержать хотя бы ложку самоиронии. Может, это то что отличает умного человека от заумного ?

Вопрос:  - Ваш любимый мем ?

Ответ:  - Наверное, это "Гарольд сдерживает боль" с подписью "Когда увидел большой кусок квазикода..."

и маленькими буквами "...а потом понял, что ты его написал в прошлом году"

Вопрос: - Ваше любимое изречение Конфуция ?

Ответ: -

"Написать красивый код может каждый.

Настоящее искусство программирования

- развивать существующий квазикод,

чтобы он давал квазирезультаты на квазиданных,

и получать за это настоящую зарплату."

 

Специальные предложения

Комментарии
В избранное Подписаться на ответы Сортировка: Древо развёрнутое
Свернуть все
1. kolya_tlt 24 04.11.20 15:43 Сейчас в теме
Добрый день.
1ый пункт даже в стандартах описан
2ой кажется вы правильно поняли Роберта Мартина, либо метод ЗаполнитьЗначенияСвойств принятую "за уши". Бывают случае на проектах, когда пользователям по какой-то не понятной религии ну очень не удобно пользоваться таблицами вместо полей ввода
3 где ж вы были 10 лет назад? ранее работа в компании с огромным количеством докуметов ЧекККМ и на каждый проект добавляли 3-5 реквизита, потом целых 2 года разносили по разным регистрам ...
2. vasilev2015 2067 04.11.20 16:54 Сейчас в теме
(1) Спасибо за комментарий.

1) Пришлите ссылку, буду внимательнее ?

2) Это не про Роберта Мартина, это про нашу жестокую действительность.
Если пользователь очень хочет однотипные поля, то их тоже можно выводить программно, образец - тоже СКД.

3) Зато все при деле, зарплата капает :-))
3. aspirator23 451 04.11.20 18:04 Сейчас в теме
(1) Есть один франчайзи, который разрабатывает продукт 1с для страховщиков. Когда я увидел их документ - договор, у меня выпали предпоследние волосы. С тех пор я не причесываюсь. В этом документе было все. И при всем том, этот продукт был сертифицирован. Может тогда все были добрее?
4. CheBurator 3444 04.11.20 19:41 Сейчас в теме
(3) тогда было больше программистов 1С. они порождали больше кода и больше доставляли.
сейчас программистов гораздо меньше, всё больше раставлятели галочек. Поэтому разннообразия - гораздо меньше.. ;-)
FatPanzer; +1 Ответить
5. vasilev2015 2067 04.11.20 20:01 Сейчас в теме
6. FatPanzer 13 04.11.20 20:13 Сейчас в теме
(3) Я видел заказ клиента в котором рассчитывались и хранились(!) всякие складские оборачиваемости товаров по складам на момент заказа с учетом количества из заказа (в деньгах и килограммах), исполнения планов продаж по товарам, а также всякие себестоимости и рентабельности... В табличной части, да.
rudnitskij; user1464234; +2 Ответить
7. protexprotex 129 04.11.20 20:49 Сейчас в теме
А я видел когда программисты одной известной фирмы данные по табличной части хранили в файлах типа txt. Правда, это была еще 1С 7.7. - и там надо было хранить подчиненные таблицы другу другу. На мой вопрос - "а почему не хранить в справочниках с id строки строки - владельца" - на меня очень долго смотрели и далее выдали - "а как это?"
user1464234; +1 Ответить
8. FatPanzer 13 04.11.20 20:56 Сейчас в теме
(7) Ну незнают люди про старые добрые реляционные БД типа dBase и FoxPro...
9. protexprotex 129 04.11.20 22:40 Сейчас в теме
(8) Современные программисты на слово DOS - говорят - "Вы имеете ввиду? dDOS - атака?" :-)
rudnitskij; sanytch; alex-l19041; user1464234; +4 Ответить
10. user1464234 04.11.20 22:46 Сейчас в теме
Кстати да. А зачем прописывать статические ip адреса в сети, если принтеры по вайфай подключаются? И еще у нас в базе когда то был справочник принтеры, где пользователь выбирал на что печатать без предварительного просмотра.
Как в этот справочник добавить принтеры по вайфай подключенные - мак адрес использовать?
Или имени-отчества достаточно?
11. ivanov660 2426 04.11.20 22:53 Сейчас в теме
1. Написать код сразу идеально - это не жизненная позиция, логично требовать отсутствие "г*вно кода". И для выполнения этого требования идеальности существует процедура называемая - рефакторинг.
2. Про пример вложенности обычно я представляю ситуацию с "матрешкой если тогда". Здесь скорее всего имелов ввиду повышение прозрачности при анализе кода, выполнения код-ревью.
3. Третьему утверждению я бы также следовал не всегда. Давайте рассмотрим ситуацию, когда эти реквизиты требуется получить в запросе, то в итоге мы вместо обращения к одной таблице документа будем вынуждены добавлять левые соединения, что может уменьшить быстродействие. Особенно будет заметно на больших объемах баз данных (1% от 100 документов - это 1 документ, а 1% от 1 000 000 это уже 10 000 документов).
К тому же, как я говорил выше, когда выполняются решения о добавлении реквизитов в документ, то вряд ли, кто-то адекватно оценивает возможные объемы данных и понятие приходит постфактум. А в этом случае постфактум выполняем рефакторинг и возможно переосмысление архитектуры.
15. vasilev2015 2067 06.11.20 09:38 Сейчас в теме
(11) Здравствуйте, Владимир !

вместо обращения к одной таблице документа будем вынуждены добавлять левые соединения, что может уменьшить быстродействие


Вдумайтесь: левые соединения не самая медленная операция СУБД.
Самая медленная операция - это сканирование таблицы. Считываются не только все строки, но и все колонки.
Создавая одну большую таблицу мы провоцируем СУБД именно на скан ВСЕЙ таблицы для поиска данных конкретного реквизита.

Индексы ВСЕЙ таблицы не решают проблемы:
Индекс документа устроен так, что не может содержать два реквизита. Поэтому если в запросе нужно получить два реквизита, то СУБД выбирает между левым соединением двух индексов ВСЕЙ таблицы и сканом всей таблицы. Чаще всего это скан.

Однако, если использовать отдельный регистр, то индексы меньше, скан не нужен, левое соединение выгоднее.

Поэтому нормальную архитектуру нужно планировать сразу.
19. ivanov660 2426 06.11.20 15:17 Сейчас в теме
(15)тут вопрос в полях по которым идет отбор и целях получения данных.
Если мы рассматриваем отбор по индексному полю - ссылка, а реквизит как условие был кредит или не было, который влияет на дальнейший путь логики, то никакого скана не будет и вопрос быстродействия появляется)
12. SlavaKron 05.11.20 10:30 Сейчас в теме
Возможно, одинаковые поля лучше выводить в таблицу, как это сделано в настройках СКД ?
Долго не мог понять эту фразу. Наверно, лучше сказать "одинаковые по назначению" или "схожие по назначению" вместо "одинаковые". Вот пример публикации к этому пункту https://infostart.ru/public/1312768/ – реквизиты объекта выводятся каждый в отдельный элемент формы и поиск по имени реквизита преподносится как "фишка" публикации, хотя если сделать это через таблицу значений, в которой уже реализован поиск по колонкам, "киллерфича" будет уже в комплекте.
13. Hatson 425 05.11.20 13:34 Сейчас в теме
Работая уже в N-ой конторе который раз убеждаюсь, что всё, что связано с программированием и технологичностью за рамками типового кода типовых решений 1С лежит исключительно в плоскости перфекционизма. А перфекционизм - это прямое следствие низкой самооценки, и как известно, своими корнями уходит в детские психо-травмы, а это уже область психиатрии. И ЗП программиста при текущей ситуации на рынке труда не зависит от умения писать хороший код. Вы будете удивлены, но она зависит только от качества и здоровья личной самооценки.

Коллеги, если вам кажется, что чей-то код недостаточно хорош, то это отличный повод начать разбираться со своими психо-травмами - скорее всего вы страдаете "синдромом самозванца", или перфекционизмом. И то и другое - заниженная самооценка.
kMidas; kuzyara; +2 1 Ответить
14. ImHunter 213 06.11.20 06:52 Сейчас в теме
(13) Вот так вот))) Нафига всякие DRY, KISS и проч лабуда. Всем к психологу!
oleganatolievich; +1 Ответить
16. Hatson 425 06.11.20 11:46 Сейчас в теме
(14) за DRY, KISS и пр лучше идти в Java и др true-языки программирования, но сдается мне и там перфекционисты счастья не найдут ))
23. oleganatolievich 148 30.01.21 18:31 Сейчас в теме
(16)
отличный повод начать разбираться со своими психо-травмами

воу воу воу, в ветке появился диванный психиатр?
почему вы считаете нормально написанный код - результатом психо-травм? или так модно сейчас?
за DRY, KISS и пр лучше идти в Java и др true-языки программирования

KISS: в 1С нельзя спроектировать систему проще?
DRY: в 1С нельзя упаковать код в общий модуль или функцию?
имхо, какая-то дичь.
PS: оттираю себя с пола (ведь у меня комплексы и низкая самооценка).
17. vasilev2015 2067 06.11.20 12:06 Сейчас в теме
Чтобы все правильно понимали: я сейчас сижу на месте Василия (Hatson) и вижу его код.
Поверьте, с кодированием у него все в порядке, он _хороший_ инженер.
А в последних комментариях он показывает себя с положительной стороны и как менеджер.
Так что талантливый человек - талантлив во всем :-)))
18. Hatson 425 06.11.20 14:36 Сейчас в теме
Теперь по существу

1) Есть хорошая статья - там не только про операторные скобки.
Вы не умеете работать с транзакциями

2) ЗаполнитьЗначенияСвойств() - так и есть, как бы удобно. Только спустя пару месяцев попробуйте найти в коде место, где используется какое-нибудь поле чего-нибудь там. По-хорошему, придется оставлять длинные комментарии в коде.

3) С картинкой с нулями - вообще красота!!! У нас корпоративный стандарт добавить в справочник номенклатура 50 дополнительных реквизитов и столько же табличных частей, а потом в коде написать Номенклатура.Артикул .... и конечно же в цикле!))))
Terve!R; FatPanzer; +2 Ответить
20. Hatson 425 12.11.20 15:22 Сейчас в теме
Еще один способ получения среза последних. И кто бы мог подумать! Гениально!
PS
Наша ERP пронизана такими паттернами
Прикрепленные файлы:
21. buganov 157 09.12.20 22:19 Сейчас в теме
//Красиво
Пока ВыборкаДетальная.Следующий() Цикл

Если НЕ ПроверитьУсловие() Тогда

Продолжить;
КонецЕсли;

//многабукв
КонецЦикла;


А мне нравится
ДействияВыполнены = ПроверитьУсловие() И ДействияПриИстина();
Функция ДействияПриИстина()
    //многабукв
КонецФункции 


Всегда предпочитаю //многабукв утащить в отдельную функцию. Если она не летит с клиента на сервер, конечно=)
22. oleganatolievich 148 30.01.21 18:25 Сейчас в теме
1. у дяди Стива было про определение переменных как можно ближе к месту использования и многое чего другое. как бы само собой разумеется, что легче, когда в голове не надо держать условие оператора if при изучении кода.
2. абстракции - это было про ООП, а не про "ЗаполнитьЗначенияСвойств".
3. это для типовых подходит, а для нетиповых так не получится.
и да, надо уметь правильно декомпозировать задачу.

ради этих трех пунктов надо было городить статью? зачем?
24. vasilev2015 2067 30.01.21 18:48 Сейчас в теме
(22) Проблема не в том, что статья короткая, а в том, что никто не старается программировать.

"Недостаток абстрактного мышления" - это не в контексте ООП, а когда программисты тупят активно пользуются копипастом.

Правила Кодда-Бойса нужно соблюдать и для нетиповых конфигураций тоже.

Верьте в себя, начинайте программировать лучше - все у Вас получится.
25. oleganatolievich 148 30.01.21 19:26 Сейчас в теме
(24) бывает так, что при использовании ЗаполнитьЗначенияСвойств не пишется, что нужно заполнить. и вот это не очень хорошо, я для наглядности всегда пишу список свойств, которые мне надо заполнить.
да и так бывает что если базу писали плохо, имена свойств в разных таблицах различаются, и тут тоже указанная выше функция не подходит.
может быть у меня проблемы с логикой, но "избегайте копипаста" != наличие или отсутствие абстрактного мышления.
"Верьте в себя, начинайте программировать лучше - все у Вас получится."
спасибо, желаю и вам того же.
Оставьте свое сообщение

См. также

Ускорение расчета себестоимости УПП 1.3 в несколько раз

Закрытие периода Рефакторинг и качество кода v8 УПП1 БУ УУ Бесплатно (free)

Как определить причину медленного расчёта себестоимости в УПП 1.3, один из вариантов поиска проблем производительности с помощью инструментов 1С и ускорения расчёта средствами встроенного языка

02.02.2021    2414    RPGrigorev    19    

Реальный кейс по внедрению CodeReview

Рефакторинг и качество кода v8 1cv8.cf Бесплатно (free)

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

20.01.2021    1194    Alexsandr_Retunskiy    3    

Операторы перехода в программном коде: использовать или нет?

Рефакторинг и качество кода v8 1cv8.cf Бесплатно (free)

Рассмотрим ситуации использования операторов перехода Перейти (GoTo), Возврат (Return), Прервать (Break), Продолжить (Continue). Как вы считаете - это дурной тон, нормальная практика или зависит от ситуации?

16.11.2020    2159    ivanov660    22    

Доработайте это "немедленно", или как уменьшить доработки конфигурации

Рефакторинг и качество кода v8 Россия Бесплатно (free)

Доработки конфигурации - необходимое зло. Автор предлагает несколько простых подходов и приемов, позволяющих хотя бы немного, но оптимизировать объем доработок конфигурации, упростить их, и облегчить дальнейшие доработки и обновления конфигурации. Все примеры и подходы взяты автором из реальной жизни и основаны на собственных наблюдениях.

25.09.2020    3810    Богатырев Артур    20    

Метод борьбы с большим количеством комментариев в коде

Практика программирования Рефакторинг и качество кода v8 1cv8.cf Бесплатно (free)

Решил поделиться нашим способом борьбы с сильно закомментированным кодом.

08.09.2020    1348    tambu    9    

Как поставить качество кода на поток и при этом не разориться? Какие шаги стоит сделать уже завтра, чтобы повысить планку качества?

Рефакторинг и качество кода v8 Бесплатно (free)

Наличие в 1С-решениях некачественного кода мешает их поддержке и эффективному развитию. Как добиться соблюдения стандартов разработки при написании кода и внедрить бюджетный Code Review с помощью инструментария на основе АПК (Автоматизированной проверки конфигураций) на конференции Infostart Event 2019 Inception рассказал технический руководитель компании Бизнес Лоджик Иван Козлов.

22.06.2020    3508    kozlov.alians    1    

Молчание "best practices": тестовые и эталонные данные, структура и связность, падения и новая функциональность, и другие неудобные вопросы к сценарному тестированию

Рефакторинг и качество кода Сценарное тестирование v8 Бесплатно (free)

Непонимание некоторых базовых вопросов мешает программистам начать применять инструменты тестирования в процессе разработки для 1С. Как разобраться в терминологии и интегрировать процесс тестирования в разработку 1С-решений на конференции Infostart Event 2019 Inception рассказал руководитель отдела разработки компании C.T.Consultants Решитко Дмитрий.

29.05.2020    4620    grumagargler    14    

Рефакторинг в редакторе модулей

Рефакторинг и качество кода v8 1cv8.cf Бесплатно (free)

Для тех, кто не пользуется Ctrl+Alt+R. “Контролируемый процесс улучшения кода без написания новой функциональности”, “Равносильное преобразование алгоритмов” и т.п в данной статье НЕ рассматриваются. Тема статьи: замечательные команды из подменю Рефакторинг контекстного меню редактора модулей в конфигураторе. В статье описано, как команды из подменю Рефакторинг помогают при написании кода

10.03.2020    4305    pparshin    5    

Качество кода: Поведенческие паттерны проектирования

Рефакторинг и качество кода v8 Бесплатно (free)

Поговорим про применение паттернов проектирования в разработке на 1С.

03.03.2020    7946    ivanov660    0    

Боремся с запросами в циклах. Мой опыт рефакторинга запросов

Рефакторинг и качество кода v8::Запросы 1cv8.cf Бесплатно (free)

В текущей публикации я предлагаю вам несколько простых примеров с решениями, в которых будет представлено решение "единым запросом", без использования запросов в цикле.

02.03.2020    7734    aximo    55    

Стабильность превыше всего

Рефакторинг и качество кода v8 Бесплатно (free)

Странная заметка о поддержании стабильности в условиях интенсивного изменения конфигурации.

07.11.2019    9868    YPermitin    40    

Оценка скорости кода. Сложность алгоритма

Практика программирования Рефакторинг и качество кода v8 1cv8.cf Бесплатно (free)

Эта тема одной из первых всплывает на собеседовании программистов языков вроде Java и C, но она почти неизвестна в "мире 1С". Поговорим о вычислительной сложности алгоритмов.

07.10.2019    5813    m-rv    12    

Управление качеством кода

Математика и алгоритмы Рефакторинг и качество кода v8 Бесплатно (free)

О SonarQube, АПК, EDT. Какие преимущества дает их использование. Для каких команд подходит.

22.07.2019    18145    Stepa86    34    

По следам код-ревью

Рефакторинг и качество кода v8 Бесплатно (free)

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

09.07.2019    13395    ivanov660    110    

Совершенный коТ (Cat complete)

Практика программирования v8 1cv8.cf Бесплатно (free)

Стандарты программирования в картинках. Самоирония прилагается.

03.06.2019    9716    vasilev2015    150    

Что такое рефакторинг и в чем его цели

Практика программирования Рефакторинг и качество кода v8 Бесплатно (free)

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

30.10.2018    12341    eu_genij    34    

Мастер-класс от Poppy (практикум по рефакторингу)

Практика программирования Рефакторинг и качество кода v8 1cv8.cf Россия Бесплатно (free)

Попался на глаза код неопытного программиста. Не смогла пройти мимо, захотелось выполнить рефактроинг. Вот что из этого получилось.

04.11.2008    18821    poppy    33