Рефакторинг legacy кода на C++: пошаговое руководство

Рефакторинг legacy кода на C++: как превратить «зоопарк» в поддерживаемый проект

Работа с устаревшим (legacy) кодом на C++ — неизбежная реальность для многих разработчиков. Часто такой код лишен тестов, изобилует неопределенным поведением (UB), глобальными переменными и ручным управлением памятью. Однако рефакторинг legacy кода на C++ — это не просто «причесывание» файлов, а системный процесс повышения надежности и производительности. В этой статье мы разберем ключевые шаги, которые помогут вам безопасно модернизировать старый проект без риска все сломать.

1. Подготовка: тестирование и изоляция

Первый и самый важный этап — создать «сеть безопасности». Без тестов любой рефакторинг превращается в игру в русскую рулетку.

• Характеризационное тестирование: Напишите тесты, которые фиксируют текущее поведение кода. Даже если оно кажется ошибочным, сначала зафиксируйте его.
• Статический анализ: Используйте инструменты вроде clang-tidy или Cppcheck. Они выявят потенциальные утечки, неиспользуемый код и нарушения стиля.
• Санитайзеры: Запустите код с AddressSanitizer и UndefinedBehaviorSanitizer. Это поможет найти скрытые UB до начала изменений.

Пример добавления санитайзера в CMake:

# CMakeLists.txt
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address,undefined -fno-omit-frame-pointer")

2. Избавление от «голых» указателей и ручного управления памятью

Legacy C++ часто страдает от утечек памяти и двойных удалений. Современный C++ (C++11 и новее) предлагает RAII-обертки.

• Замена new/delete на умные указатели: std::unique_ptr для единоличного владения, std::shared_ptr для разделяемого.
• Использование std::vector вместо сырых массивов: Это снижает риск выхода за границы.

Пример рефакторинга:

До:

class LegacyBuffer {
    char* data;
    size_t size;
public:
    LegacyBuffer(size_t sz) : size(sz) {
        data = new char[sz];
    }
    ~LegacyBuffer() { delete[] data; }
    // Забыт копирующий конструктор и оператор присваивания (нарушение "правила трех")
};

После:

class ModernBuffer {
    std::vector<char> data;
public:
    ModernBuffer(size_t sz) : data(sz) {}
    // Деструктор, копирование и присваивание генерируются компилятором автоматически
};

3. Устранение макросов и глобальных состояний

Макросы (#define) — частая причина трудноуловимых багов. Их следует заменять на constexpr, enum class или шаблоны. Глобальные переменные усложняют тестирование и параллелизм.

• Замена #define BUFFER_SIZE 1024 на constexpr size_t BUFFER_SIZE = 1024;
• Инкапсуляция глобалов: Вынесите глобальное состояние в класс-синглтон или, лучше, передавайте зависимости через конструктор.

Пример с макросом:

// Плохо: макрос не имеет области видимости
#define MAX_CONNECTIONS 100

// Хорошо: константа с типом и областью видимости
namespace Config {
    constexpr int maxConnections = 100;
}

Использование enum class вместо #define для флагов:

// Вместо #define FLAG_READ 1
enum class FileMode : uint8_t {
    Read = 1,
    Write = 2,
    ReadWrite = 3
};

4. Упрощение сложных функций и удаление мертвого кода

Legacy-функции нередко представляют собой «простыни» кода на 500+ строк с множеством вложенных условий. Стратегия:

• Извлечение метода: Разбейте функцию на несколько маленьких с понятными названиями.
• Удаление закомментированного кода: Храните его в системе контроля версий, а не в рабочем файле.
• Замена кастов в стиле C на static_cast, dynamic_cast и т.д.

Пример рефакторинга сложного условия:

// До: магические числа и сложное условие
if (status && (flags & 0x0F) == 0x05 && timeout > 1000) {
    // ...
}

// После: именованные константы
constexpr uint8_t kReadyFlag = 0x05;
constexpr int kTimeoutThreshold = 1000;

if (status && (flags & kReadyMask) == kReadyFlag && timeout > kTimeoutThreshold) {
    // ...
}

5. Постепенная миграция на современные стандарты

Не пытайтесь переписать все сразу. Используйте стратегию «Strangler Fig» (удушение лианой):

• Обновляйте компилятор: Переход с C++98 на C++11, затем на C++17 — это поэтапный процесс.
• Внедряйте auto: Начните с простых случаев, например, итераторов.
• Используйте nullptr вместо NULL или 0.

Пример замены итераторов:

// C++98 стиль
for (std::vector<int>::iterator it = vec.begin(); it != vec.end(); ++it) { ... }

// C++11 стиль
for (auto it = vec.begin(); it != vec.end(); ++it) { ... }

// C++11 range-based for (если индекс не нужен)
for (const auto