CI darbai neveikia: OpenFeign kompiliavimo problemos naudojant Spring Boot 2.5.3 po 2024 m. rugsėjo 29 d.

Netikėtos kompiliavimo problemos su Spring Boot 2.5.3 CI aplinkose

Nuo 2024 m. rugsėjo 29 d. kūrėjai, naudojantys Spring Boot 2.5.3, pranešė susidūrę su netikėtomis kompiliavimo klaidomis. Pažymėtina, kad šios klaidos atsiranda nepaisant jokių kodų bazės pakeitimų, todėl sutrinka nuolatinio integravimo (CI) darbo eigos. Atrodo, kad ši problema yra susijusi su priklausomybės sprendimu Maven versijose, ypač turint įtakos projektams, naudojantiems „Spring Cloud“ priklausomybes.

Problema išryškėja, kai „Maven“ kūrimas nepavyksta ir atsiranda klaidų, nurodančių trūkstamas priklausomybes. Tiksliau, pakuotė org.springframework.cloud.openfeign yra pažymėtas kaip neegzistuojantis. Tai rodo „OpenFeign“ priklausomybės problemą, dėl kurios atsiranda klaidų, pvz., „negaliu rasti simbolio“, ir nurodomos trūkstamos klasės, pvz. FeignClient.

Kūrėjams, susidūrusiems su tokia situacija, tradiciniai derinimo metodai, tokie kaip priklausomybės medžių generavimas arba Maven priverstinis atsijungimas, nebuvo veiksmingi. Šis scenarijus rodo gilesnę problemą, galbūt susijusią su priklausomybės atnaujinimais arba saugyklų pakeitimais.

Šiame straipsnyje išnagrinėsime šių kompiliavimo klaidų pobūdį, galimas priežastis ir pateiksime keletą trikčių šalinimo veiksmų, padėsiančių atgauti savo Maven versijų kontrolę.

„Maven“ pavasario įkrovos kompiliavimo problemų analizė ir sprendimas

Anksčiau pateikti scenarijai skirti spręsti kritinę problemą, kai po 2024 m. rugsėjo 29 d. „Spring Boot“ programose „Maven“ versijos pradeda gesti dėl kompiliavimo klaidų. Šios klaidos yra susijusios su trūkstamais OpenFeign priklausomybė, sukelianti klasę FeignClient tapti neprieinama. Pagrindinis metodas apima šių trūkstamų priklausomybių nustatymą ir pašalinimą naudojant konkrečias Maven komandas. Pavyzdžiui, komanda „mvn dependency:tree -Dverbose“ leidžia kūrėjams detaliai vizualizuoti visą priklausomybės hierarchiją. Tai labai svarbu, nes išryškina pereinamąsias priklausomybes, kurių gali trūkti arba kurios gali būti neteisingai išspręstos, todėl gali atsirasti pastebėta klaida.

Kita klavišų komanda „mvn dependency:go-offline“ įgalina priklausomybės nustatymo procesą neprisijungus. Tai ypač naudinga norint nustatyti, ar problemos priežastis yra išorinė saugykla. CI aplinkoje su tinklu susijusios problemos arba išorinių saugyklų pakeitimai gali sukelti nenuoseklių priklausomybių, pvz., Spring Cloud OpenFeign. Paleidus Maven neprisijungus, galite patikrinti, ar problema kyla dėl trūkstamų ar sugadintų artefaktų vietinėje talpykloje.

Be to, sprendimas apima nurodyti a tinkinta vietinė saugykla „Maven“ versijai naudojant komandą „mvn clean package -Dmaven.repo.local=./custom-m2“. Šis metodas efektyviai izoliuoja numatytąją „Maven“ saugyklą, nukreipdamas „Maven“ į naują, tuščią katalogą, priversdamas jį iš naujo atsisiųsti visas būtinas priklausomybes. Tai padeda išvengti vietinių talpyklos problemų, dėl kurių gali atsirasti sugadinta arba pasenusi priklausomybės versija. Be to, rankiniu būdu išvalius konkrečius paketus iš vietinės saugyklos, pvz., „org/springframework/cloud/openfeign“, užtikrinama, kad „Maven“ atsisiųs naują šių artefaktų versiją.

Galiausiai, norint užtikrinti problemos sprendimą, būtina atlikti vienetiniai testai. Anksčiau pateiktame scenarijuje pristatomi bandomieji atvejai, naudojant JUnit, kad patikrintų Feign klientų konfigūraciją. Šie testai naudoja „Spring Boot“ testavimo sistemą, kad įkeltų programos kontekstą ir patikrintų, ar yra ir konfigūracijos pupelės, pvz., „Feign“ klientai. Tokie tvirtinimai kaip „assertNotNull“ ir „assertEquals“ padeda patikrinti, ar pupelės yra tinkamai inicijuotos ir sukonfigūruotos su laukiamomis savybėmis. Įdiegę šiuos testus, kūrėjai įgyja mechanizmą, patvirtinantį, kad problema išspręsta ir ar projekte tinkamai pritaikytos Feign kliento konfigūracijos.

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

}

Priklausomybės konfliktų ir atnaujinimų sprendimas Maven projektuose

Vienas iš pagrindinių aspektų, galinčių prisidėti prie „Maven“ kūrimo klaidų „Spring Boot“ programose, yra priklausomybės konfliktai. Šie konfliktai dažnai kyla dėl persidengiančių versijų arba nesuderinamų pagrindinių „Spring Boot“ priklausomybių, pvz., „OpenFeign“ ar „Spring Cloud“ bibliotekų, atnaujinimų. Priklausomybės konfliktai gali sukelti vykdymo klaidų, o kai kuriais atvejais ir svarbių paketų, pvz., nebuvimą org.springframework.cloud.openfeign. Norint išspręsti šiuos konfliktus, paprastai reikia giliai pasinerti į projekto priklausomybės valdymą ir užtikrinti, kad nebūtų prieštaringų ar pasenusių versijų.

Kūrėjai taip pat gali susidurti su netikėtomis kūrimo problemomis, kai tam tikros saugyklos ar artefaktai pakeičiami be įspėjimo. Maven projektai dažnai remiasi išorinėmis saugyklomis, kurios gali pakeisti arba panaikinti konkrečias versijas, todėl anksčiau prieinamos priklausomybės laikinai arba visam laikui tampa nepasiekiamos. Reguliariai peržiūrėti projektą priklausomybės valdymas konfigūravimo ir užrakinimo priklausomybės versijos gali sumažinti tokią riziką. Be to, atnaujintos vidinės saugyklos ar veidrodžio palaikymas gali būti atsarginė kopija dingus arba netikėtai pasikeitus išorinėse saugyklose.

Kitas svarbus aspektas, į kurį reikia atsižvelgti, yra visapusiškas naudojimas registravimas ir derinimas. Kai Maven versijos nepavyksta, klaidų pranešimai ne visada gali pateikti visą informaciją. Įjungus derinimo žurnalą naudojant „-X“ vėliavėlę, kūrėjai gali surinkti išsamių įžvalgų apie tai, kas vyksta užkulisiuose. Ši praktika gali atskleisti problemas, susijusias su trūkstamomis priklausomybėmis, netinkamomis konfigūracijomis arba prieigos prie saugyklos problemomis. Sistemingų registravimo ir derinimo metodų įtraukimas padės veiksmingiau nustatyti ir išskirti sudėtingas klaidas.