Завдання CI не працюють: проблеми компіляції OpenFeign із Spring Boot 2.5.3 після 29 вересня 2024 р.

Несподівані проблеми компіляції з Spring Boot 2.5.3 у середовищах CI

Починаючи з 29 вересня 2024 року, розробники, які використовують Spring Boot 2.5.3, повідомляють про неочікувані помилки компіляції. Примітно, що ці помилки виникають, незважаючи на відсутність змін у кодовій базі, що спричиняє значні збої в робочих процесах безперервної інтеграції (CI). Здається, ця проблема пов’язана з вирішенням залежностей у збірках Maven, особливо впливаючи на проекти, що використовують залежності Spring Cloud.

Проблема проявляється в тому, що збірки Maven виходять з ладу з помилками, які вказують на відсутність залежностей. Зокрема, пакет org.springframework.cloud.openfeign позначено як неіснуючий. Це вказує на проблему із залежністю OpenFeign, яка викликає помилки на зразок «не вдається знайти символ» і посилання на відсутні класи, як-от FeignClient.

Для розробників, які зіткнулися з такою ситуацією, традиційні методи налагодження, такі як створення дерев залежностей або примусовий відключення Maven, не були ефективними. Цей сценарій свідчить про глибшу проблему, імовірно пов’язану з оновленнями залежностей або змінами в сховищах.

У цій статті ми дослідимо природу цих помилок компіляції, потенційні причини та надамо деякі кроки з усунення несправностей, які допоможуть вам відновити контроль над збірками Maven.

Аналіз та вирішення проблем компіляції Spring Boot у Maven

Надані раніше сценарії зосереджені на вирішенні критичної проблеми, через яку після 29 вересня 2024 року збірки Maven починають виходити з ладу через помилки компіляції в програмах Spring Boot. Ці помилки зосереджені навколо відсутності OpenFeign залежність, викликаючи кл FeignClient стати недоступним. Основний підхід передбачає ідентифікацію та вирішення цих відсутніх залежностей за допомогою спеціальних команд Maven. Наприклад, команда `mvn dependency:tree -Dverbose` дозволяє розробникам детально візуалізувати всю ієрархію залежностей. Це вкрай важливо, оскільки воно підкреслює транзитивні залежності, які можуть бути відсутніми або неправильно вирішеними, що призводить до спостережуваної помилки.

Інша ключова команда, `mvn dependency:go-offline`, умикає процес вирішення залежностей в автономному режимі. Це особливо корисно для визначення того, чи зовнішнє сховище є причиною проблеми. У середовищах CI проблеми, пов’язані з мережею, або зміни у зовнішніх сховищах можуть призвести до неузгодженості у вирішенні залежностей, як-от Весняна хмара OpenFeign. Запуск Maven в офлайн-режимі допомагає перевірити, чи виникає проблема через відсутні або пошкоджені артефакти в локальному кеші.

Крім того, рішення передбачає визначення a спеціальний локальний репозиторій для збірки Maven за допомогою команди `mvn clean package -Dmaven.repo.local=./custom-m2`. Цей підхід ефективно ізолює репозиторій Maven за замовчуванням, вказуючи Maven на новий порожній каталог, змушуючи його повторно завантажити всі необхідні залежності. Це допомагає виключити будь-які проблеми з локальним кешуванням, які можуть призвести до пошкодженої або застарілої версії залежностей. Крім того, ручне очищення певних пакетів із локального сховища, як-от `org/springframework/cloud/openfeign`, гарантує, що Maven завантажить нову версію цих артефактів.

Нарешті, щоб забезпечити вирішення проблеми, важливо провести модульні тести. Сценарій, наданий раніше, представляє тестові випадки за допомогою JUnit для перевірки конфігурації клієнтів Feign. Ці тести використовують тестову структуру Spring Boot для завантаження контексту програми та перевірки наявності та конфігурації bean-компонентів, таких як клієнти Feign. Такі твердження, як `assertNotNull` і `assertEquals`, допомагають перевірити, чи правильно ініціалізовано компоненти та налаштовано їх з очікуваними властивостями. Впроваджуючи ці тести, розробники отримують механізм перевірки того, що проблему вирішено та що конфігурації клієнта Feign правильно застосовано в проекті.

# Step 1: Generate a fresh dependency tree to inspect possible issues
mvn dependency:tree -Dverbose > dependency-tree.log

# Step 2: Run Maven in offline mode to identify missing or outdated artifacts
mvn dependency:go-offline > dependency-offline.log

# Step 3: Clear your local Maven repository (optional, ensures a clean state)
rm -rf ~/.m2/repository/org/springframework/cloud/openfeign

# Step 4: Rebuild the project with debug information and custom local repository
mvn clean package -Dmaven.repo.local=./custom-m2 -DskipTests -X > build-debug.log

# Step 5: Review the generated logs for errors and fix any missing dependencies

# Step 1: Create or update a custom settings.xml file in your Maven configuration directory
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0">
  <mirrors>
    <mirror>
      <id>custom-mirror</id>
      <url>https://repo.spring.io/milestone/</url>
      <mirrorOf>central</mirrorOf>
    </mirror>
  </mirrors>
</settings>

# Step 2: Specify the custom settings file during the Maven build
mvn clean install -s ./settings.xml -DskipTests

# Step 3: Validate if the dependency resolution issue is fixed

@RunWith(SpringRunner.class)
@SpringBootTest
public class FeignClientTest {

  @Autowired
  private ApplicationContext context;

  @Test
  public void testFeignClientBeanExists() {
    Object feignClient = context.getBean("feignClientName");
    assertNotNull(feignClient);
  }

  @Test
  public void testFeignClientConfiguration() {
    FeignClient client = (FeignClient) context.getBean("feignClientName");
    // Add relevant assertions for configurations
    assertEquals("https://api.example.com", client.getUrl());
  }

}

Вирішення конфліктів залежностей і оновлень у проектах Maven

Одним із ключових аспектів, який може сприяти збою збірки Maven у програмах Spring Boot, є конфлікти залежності. Ці конфлікти часто виникають через дублювання версій або несумісні оновлення основних залежностей Spring Boot, таких як бібліотеки OpenFeign або Spring Cloud. Конфлікти залежностей можуть призвести до помилок виконання, а в деяких випадках до відсутності критичних пакетів, як-от org.springframework.cloud.openfeign. Розв’язання цих конфліктів зазвичай вимагає глибокого занурення в керування залежностями проекту, гарантуючи відсутність суперечливих або застарілих версій.

Розробники також можуть зіткнутися з неочікуваними проблемами збирання, коли певні репозиторії або артефакти змінюються без попередження. Проекти Maven часто покладаються на зовнішні сховища, які можуть змінювати або застаріти певні версії, роблячи доступні раніше залежності тимчасово або назавжди недоступними. Регулярний перегляд проектів управління залежностями версії конфігурації та блокування залежностей можуть зменшити такі ризики. Крім того, підтримка оновленого внутрішнього сховища або дзеркала може служити резервною копією на випадок збоїв або неочікуваних змін у зовнішніх сховищах.

Ще один важливий аспект, на який слід звернути увагу, — це комплексне використання журналювання та налагодження. Коли збірки Maven виявляються невдалими, повідомлення про помилки можуть не завжди надавати повну інформацію. Увімкнення журналу налагодження через прапорець `-X` дозволяє розробникам збирати детальну інформацію про те, що відбувається за лаштунками. Ця практика може виявити проблеми, пов’язані з відсутніми залежностями, неправильними конфігураціями або проблемами доступу до сховища. Включення методів систематичного журналювання та налагодження допоможе ефективніше ідентифікувати та ізолювати складні помилки.