Почему передача Map из параметров непосредственно в Jenkins Pipeline вызывает NotSerializableException при попытке использования LinkedHashMap?

Содержание

Вопрос или проблема
Ответ или решение
I. Понимание проблемы
Причина исключения
II. Сравнение с использованием collectEntries
III. Решения для избежания проблем
IV. Заключение

Вопрос или проблема

Я сталкиваюсь с ошибкой NotSerializableException: java.io.PrintWriter в своем Jenkins Pipeline, когда пытаюсь обработать LinkedHashMap, переданный через параметры. Интересно, что когда я использую метод collectEntries для клонирования карты, ошибка больше не возникает. Я не уверен, почему прямое использование Map приводит к проблемам с сериализацией, и хотел бы понять основную причину.

Вот мой текущий код:

import groovy.text.SimpleTemplateEngine

def call(Map parameters = [:]){

    def bindings = (parameters.bindings ?: error('Нет привязок')).collectEntries { [it.key, it.value] }

    echo "Класс parameters.bindings: ${bindings.getClass()}"

    def bindings2 = parameters.bindings

    def result = generateHelmFromTemplate(bindings as Map) // Работает прекрасно!

    def result2 = generateHelmFromTemplate(bindings2 as Map) // Не работает! -> java.io.NotSerializableException

    echo "Результат:\n${result}"
}

def generateHelmFromTemplate(Map bindings) {
    // Загружаем шаблон из ресурсов библиотеки
    def templateContent = libraryResource('templates/helm-template.yaml')

    def engine = new SimpleTemplateEngine()
    return engine.createTemplate(templateContent).make(bindings).toString()
}

Обходной путь, который решает проблему:

Я изменил код, чтобы клонировать карту привязок, используя collectEntries, что предотвращает NotSerializableException:

    def bindings = (parameters.bindings ?: error('Нет привязок')).collectEntries { [it.key, it.value] }

Пробовал передавать Map напрямую.
Использовал collectEntries для клонирования карты параметров

Ответ или решение

С учетом обсуждаемой проблемы с использованием LinkedHashMap в Jenkins Pipeline и возникновением исключения NotSerializableException, важно рассмотреть детали, которые могут привести к данной ошибке при передаче карты параметров напрямую.

I. Понимание проблемы

Когда вы передаете карту (в данном случае, LinkedHashMap) непосредственно в качестве параметра, в контексте Jenkins Pipeline происходит serialization (сериализация) объектов. Jenkins использует сериализацию для передачи объектов между различными этапами выполнения Pipeline, особенно когда необходимо сохранение состояния (например, во время продолжения выполнения после сбоев).

Причина исключения

NotSerializableException возникает, когда система пытается сериализовать объект, который не поддерживает сериализацию. В вашем случае, LinkedHashMap может содержать элементы, не способные к сериализации. Например, если одним из значений в карте является объект типа java.io.PrintWriter, который не реализует интерфейс Serializable, это и вызывает указанное исключение.

II. Сравнение с использованием `collectEntries`

При использовании метода collectEntries вы фактически создаете новый экземпляр Map, в котором содержатся копии ключей и значений из исходной карты. Этот процесс также может помочь исключить отправку несерриализуемых объектов, особенно если вы отфильтровываете или трансформируете содержимое карты.

Вот как работает collectEntries:

def bindings = (parameters.bindings ?: error('No bindings found')).collectEntries { [it.key, it.value] }

При этом методе, если в оригинальной карте были несерриализуемые объекты, то в новой карте (которая создаётся при помощи collectEntries) вы можете создать только те объекты, которые действительно сериализуемы.

III. Решения для избежания проблем

Клонирование параметров: Используйте collectEntries, чтобы создать новый экземпляр карты, что предотвращает возникновение исключения. Этот подход безопаснее, особенно когда работают с динамическими и изменяемыми структурами данных.
Проверка содержимого карты: Перед передачей карты в другие функции (например, generateHelmFromTemplate), стоит проверить типы значений в карте на предмет их силизации. Это можно сделать с помощью проверки, реализует ли объект интерфейс Serializable.
Избегайте использования сложных объектов: Если возможно, ограничьте использование объектов, которые могут вызывать проблемы с сериализацией, таких как PrintWriter или других потоковых объектов.

IV. Заключение

Ситуация с NotSerializableException в Jenkins Pipeline при использовании LinkedHashMap непосредственно является типичным примером проблем с сериализацией, детально проработанных в Groovy и Jenkins. Использование методов, таких как collectEntries, не только помогает избежать ошибок, но также обеспечивает более чистый и управляемый код. Настоятельно рекомендуется периодически анализировать и тестировать структуру данных, которые вы передаете в методы, чтобы гарантировать, что они безопасны для сериализации.

Этот подход не только поможет в текущих задачах, но и создаст хорошую практику работы с динамическими данными в Jenkins.