Консоль кода

У разработчиков 1С есть инструмент, позволяющий проверить алгоритм, разобраться с ошибкой или выполнить разовую операцию без создания отдельной обработки. Он умеет гораздо больше, чем кажется, и при этом остаётся в тени куда более известной консоли запросов. Рассказываем о консоли кода — её возможностях, неожиданных применениях и рисках.

В этой истории

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

Представим обычную ситуацию. В 1С перестали правильно загружаться коды товаров из внешней системы. Вместо 00001234 программа получает 1234. Восемь символов превратились в четыре. Для обычного человека разница невелика. Для системы учёта это могут быть два совершенно разных товара.

Причина, вероятно, скрывается в каком-нибудь преобразовании данных. Но прежде чем искать её среди сотен строк программного кода, неплохо было бы проверить одну простую гипотезу.

Разработчик может открыть конфигуратор, найти нужный участок программы, установить точку останова и попытаться воспроизвести проблему. Или создать внешнюю обработку, написать несколько строк, запустить её и посмотреть, что получится.

Есть и третий способ. Он требует значительно меньше приготовлений.

Консоль, о которой знают не все

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

Существуют разные реализации этой консоли, но принцип везде примерно одинаков: написал запрос, выполнил, посмотрел результат.

У неё есть менее известная родственница — консоль кода.

Идея настолько проста, что даже странно, почему этот инструмент не получил сопоставимой известности. Пользователь открывает специальное окно, вводит фрагмент программы на встроенном языке 1С, нажимает кнопку выполнения и видит результат.

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

Консоль кода обычно поставляется как отдельная внешняя обработка или входит в состав инструментов разработчика. Это не универсальная штатная функция, присутствующая в любой установленной 1С. Конкретные возможности зависят от выбранной реализации.

Но главное у всех подобных инструментов одно: возможность выполнять программный код непосредственно в работающей информационной базе.

Для человека, который регулярно занимается разработкой и сопровождением 1С, это открывает немало интересных перспектив.

Лаборатория на несколько строк

Вернёмся к нашим товарным кодам.

Разработчик подозревает, что проблема связана с преобразованием строковых значений в числовые. Проверить это предположение можно буквально за несколько секунд.

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

КодТовара = "00001234";

Сообщить(КодТовара);
Сообщить(Число(КодТовара));

В первом случае мы получим исходную строку 00001234. Во втором — число 1234.

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

Конечно, этот пример нарочито простой. Но он демонстрирует сам принцип работы: у разработчика была гипотеза, и он проверил её, не создавая ничего лишнего.

На практике вопросы бывают значительно интереснее.

Как конкретная функция поведёт себя на границе месяца? Что произойдёт, если в алгоритм передать пустое значение? Как будет выглядеть результат преобразования JSON? Почему два внешне одинаковых значения при сравнении дают неожиданный результат?

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

Можно изучать документацию, просматривать чужой код и строить догадки. А можно провести небольшой эксперимент.

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

Не только эксперименты

Было бы несправедливо считать консоль кода исключительно инструментом проверки функций. В умелых руках она способна решать куда более серьёзные задачи.

Одна из наиболее полезных областей — диагностика.

Представим, что при проведении документа возникает ошибка, причину которой никак не удаётся установить. На первый взгляд все реквизиты заполнены правильно. Но где-то внутри сложной конфигурации обнаруживается значение, с которым программа не умеет обращаться.

Консоль кода позволяет получить объект, исследовать его свойства, проверить отдельные вычисления или вызвать доступные процедуры и функции конфигурации. Иногда это помогает локализовать проблему без необходимости многократно воспроизводить весь сценарий её возникновения.

Другая область — интеграции.

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

И вот здесь возможность отдельно выполнить фрагмент алгоритма оказывается особенно полезной.

Разработчик может проверить разбор JSON, формирование XML, обработку ответа внешнего сервиса или преобразование полученных значений. Причём для некоторых проверок ему даже не потребуется запускать сам обмен.

Есть и менее очевидное применение — исследование производительности.

Допустим, существуют два способа обработки большой коллекции. Оба дают одинаковый результат, но какой работает быстрее?

Консоль позволяет выполнить каждый вариант и измерить затраченное время. Некоторые реализации даже имеют для этого специальные средства.

Разумеется, такой эксперимент не заменяет полноценного анализа производительности системы. Но получить предварительный ответ зачастую можно довольно быстро.

Наконец, остаётся категория задач, ради которой консоль кода особенно любят специалисты, сопровождающие работающие информационные системы.

Разовые операции с данными.

Предположим, из-за ошибочной настройки в нескольких сотнях документов оказался неверно заполнен определённый реквизит. Ошибку обнаружили, причину устранили, но последствия остались в базе.

Можно написать отдельную обработку для исправления данных. Предусмотреть форму, кнопку запуска, необходимые проверки и механизм записи.

А можно подготовить алгоритм исправления и выполнить его через консоль кода.

Сама по себе такая возможность не означает, что второй путь всегда правильный. Наоборот, здесь возникает вопрос, который отделяет полезный инструмент от потенциально опасного.

Несколько строк с большими последствиями

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

Она позволяет быстро выполнить программу.

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

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

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

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

Поэтому к консоли кода стоит относиться как к полноценному инструменту разработки, а не как к безобидному калькулятору.

Когда речь идёт об изменении данных, сначала следует проверить алгоритм на тестовой копии базы, убедиться в правильности отбора и оценить возможные последствия. Перед выполнением операций в рабочей системе необходимо иметь проверенную резервную копию и понятный способ восстановления.

Полезно также разделять исследование и изменение данных. Сначала получить список объектов, которые должны быть обработаны, проверить его и лишь затем переходить к записи.

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

Иными словами, инструмент облегчает работу, но не освобождает от необходимости понимать, что именно делает написанная программа.

Когда консоль лучше закрыть

У любого хорошего инструмента есть границы разумного применения.

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

Такую задачу правильнее оформить в виде полноценного программного механизма.

То же самое касается операций, которые должны поддерживаться и развиваться в дальнейшем. Код, однажды написанный в консоли и оставшийся исключительно на компьютере разработчика, — сомнительное наследство для следующего специалиста.

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

В этом и заключается её особая ценность.

Она не делает программиста умнее. Не исправляет ошибки автоматически и не превращает сложную задачу в простую.

Зато сокращает расстояние между возникшим вопросом и возможностью получить на него ответ.

А иногда для этого действительно достаточно нескольких строк.

Вам не нужно выбирать формат заранее

Начнём с вашей ситуации

Расскажите, что происходит. Мы начнём с вопросов, разберёмся в ситуации и вместе определим следующий разумный шаг.

Хотите поговорить?

Для Москвы +7 495 033-15-00
Для всей России 8 800 600-23-25
Или написать start@octosmart.ru