CI-jobb fungerar inte: OpenFeign-kompileringsproblem med Spring Boot 2.5.3 efter 29 september 2024

Oväntade kompileringsproblem med Spring Boot 2.5.3 i CI-miljöer

Från och med den 29 september 2024 har utvecklare som använder Spring Boot 2.5.3 rapporterat att de stöter på oväntade kompileringsfel. Dessa fel uppstår särskilt trots att kodbasen inte ändrats, vilket orsakar avsevärda störningar i arbetsflöden för kontinuerlig integration (CI). Det här problemet verkar vara kopplat till beroendeupplösningen inom Maven-byggen, vilket särskilt påverkar projekt som använder Spring Cloud-beroenden.

Problemet visar sig när Maven bygger misslyckas med fel som indikerar saknade beroenden. Närmare bestämt paketet org.springframework.cloud.openfeign flaggas som obefintlig. Detta pekar på ett problem med OpenFeign-beroendet, vilket orsakar fel som "kan inte hitta symbol" och hänvisar till saknade klasser som FeignClient.

För utvecklare som står inför den här situationen har traditionella felsökningsmetoder som att generera beroendeträd eller tvinga Maven att gå offline inte varit effektiva. Det här scenariot antyder ett djupare problem som möjligen är relaterat till beroendeuppdateringar eller ändringar i arkiven.

I den här artikeln kommer vi att utforska arten av dessa kompileringsfel, potentiella orsaker och tillhandahålla några felsökningssteg för att hjälpa dig att återta kontrollen över dina Maven-byggen.

Analysera och lösa problem med Spring Boot Compilation i Maven

Skripten som tillhandahållits tidigare fokuserar på att lösa ett kritiskt problem där Maven-byggen börjar misslyckas med kompileringsfel i Spring Boot-applikationer efter den 29 september 2024. Dessa fel är centrerade kring de saknade OpenFeign beroende, vilket orsakar klassen FeignClient att bli otillgänglig. Det primära tillvägagångssättet innebär att identifiera och lösa dessa saknade beroenden genom specifika Maven-kommandon. Till exempel tillåter kommandot `mvn dependency:tree -Dverbose` utvecklare att visualisera hela beroendehierarkin i detalj. Detta är avgörande eftersom det lyfter fram transitiva beroenden som kan saknas eller felaktigt lösas, vilket leder till det observerade felet.

Ett annat nyckelkommando, `mvn dependency:go-offline`, möjliggör en beroendeupplösningsprocess i offlineläge. Detta är särskilt användbart för att avgöra om ett externt arkiv är orsaken till problemet. I CI-miljöer kan nätverksrelaterade problem eller förändringar i externa arkiv resultera i inkonsekvenser i lösningen av beroenden som t.ex. Spring Cloud OpenFeign. Att köra Maven i offlineläge hjälper till att validera om problemet beror på saknade eller skadade artefakter i den lokala cachen.

Vidare innebär lösningen att specificera en anpassat lokalt arkiv för Maven-bygget med kommandot `mvn clean package -Dmaven.repo.local=./custom-m2`. Detta tillvägagångssätt isolerar effektivt Mavens standardförråd genom att peka Maven till en ny, tom katalog, vilket tvingar den att ladda ner alla nödvändiga beroenden på nytt. Detta hjälper till att utesluta alla lokala cachningsproblem som kan leda till en skadad eller föråldrad beroendeversion. Dessutom, manuell borttagning av specifika paket från det lokala förvaret, som `org/springframework/cloud/openfeign`, säkerställer att Maven laddar ner en ny version av dessa artefakter.

Slutligen, för att säkerställa lösningen av problemet, är det viktigt att utföra enhetstester. Skriptet som tillhandahållits tidigare introducerar testfall som använder JUnit för att verifiera konfigurationen av Feign-klienter. Dessa tester använder Spring Boot-testramverket för att ladda applikationskontexten och utföra kontroller av närvaron och konfigurationen av bönor, såsom Feign-klienter. Påståenden som `assertNotNull` och `assertEquals` hjälper till att verifiera att bönor är korrekt initierade och konfigurerade med de förväntade egenskaperna. Genom att implementera dessa tester får utvecklare en mekanism för att validera att problemet har lösts och att Feign-klientkonfigurationerna är korrekt tillämpade i projektet.

# 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());
  }

}

Ta itu med beroendekonflikter och uppdateringar i Maven-projekt

En nyckelaspekt som kan bidra till Maven-byggfel i Spring Boot-applikationer är beroendekonflikter. Dessa konflikter uppstår ofta på grund av överlappande versioner eller inkompatibla uppdateringar av centrala Spring Boot-beroenden, som OpenFeign eller Spring Cloud-bibliotek. Beroendekonflikter kan resultera i körtidsfel, och i vissa fall, frånvaron av kritiska paket som org.springframework.cloud.openfeign. Att hantera dessa konflikter kräver vanligtvis en djupdykning i projektets beroendehantering, för att säkerställa att det inte finns några motstridiga eller föråldrade versioner.

Utvecklare kan också möta oväntade byggproblem när vissa förråd eller artefakter ändras utan föregående meddelande. Maven-projekt förlitar sig ofta på externa lagringsplatser, som kan ändra eller fasa ut specifika versioner, vilket gör tidigare tillgängliga beroenden tillfälligt eller permanent otillgängliga. Regelbundet granska projektets beroendehantering konfigurations- och låsberoende versioner kan mildra sådana risker. Dessutom kan underhåll av ett uppdaterat internt arkiv eller spegel fungera som en säkerhetskopia i händelse av avbrott eller oväntade ändringar i externa arkiv.

En annan viktig aspekt att överväga är användningen av omfattande loggning och felsökning. När Maven-byggen misslyckas kan det hända att felmeddelandena inte alltid ger fullständig information. Genom att aktivera felsökningsloggning genom flaggan "-X" kan utvecklare samla in detaljerade insikter om vad som händer bakom kulisserna. Denna praxis kan avslöja problem relaterade till saknade beroenden, felkonfigurationer eller problem med åtkomst till arkivet. Genom att integrera systematiska loggnings- och felsökningsmetoder hjälper det att identifiera och isolera komplexa fel mer effektivt.