Công việc CI không hoạt động: Sự cố biên dịch OpenFeign với Spring Boot 2.5.3 sau ngày 29 tháng 9 năm 2024

Sự cố biên dịch không mong muốn với Spring Boot 2.5.3 trong môi trường CI

Bắt đầu từ ngày 29 tháng 9 năm 2024, các nhà phát triển sử dụng Spring Boot 2.5.3 đã báo cáo gặp phải các lỗi biên dịch không mong muốn. Đáng chú ý, những lỗi này xảy ra mặc dù không có thay đổi nào trong cơ sở mã, gây ra sự gián đoạn đáng kể trong quy trình Tích hợp liên tục (CI). Vấn đề này dường như có liên quan đến độ phân giải phần phụ thuộc trong các bản dựng Maven, đặc biệt ảnh hưởng đến các dự án sử dụng phần phụ thuộc Spring Cloud.

Sự cố biểu hiện khi Maven xây dựng không thành công với các lỗi cho thấy thiếu phần phụ thuộc. Cụ thể, gói org.springframework.cloud.openfeign được gắn cờ là không tồn tại. Điều này chỉ ra sự cố với phần phụ thuộc OpenFeign, gây ra các lỗi như "không thể tìm thấy biểu tượng" và tham chiếu các lớp bị thiếu như giả vờkhách hàng.

Đối với các nhà phát triển đang gặp phải tình huống này, các phương pháp gỡ lỗi truyền thống như tạo cây phụ thuộc hoặc buộc Maven chuyển sang chế độ ngoại tuyến đều không hiệu quả. Tình huống này gợi ý một vấn đề sâu sắc hơn có thể liên quan đến các cập nhật phụ thuộc hoặc các thay đổi trong kho lưu trữ.

Trong bài viết này, chúng tôi sẽ khám phá bản chất của các lỗi biên dịch này, nguyên nhân tiềm ẩn và cung cấp một số bước khắc phục sự cố để giúp bạn lấy lại quyền kiểm soát các bản dựng Maven của mình.

Phân tích và giải quyết các vấn đề biên dịch khởi động mùa xuân trong Maven

Các tập lệnh được cung cấp trước đó tập trung vào việc giải quyết một vấn đề nghiêm trọng trong đó các bản dựng Maven bắt đầu không thành công kèm theo lỗi biên dịch trong các ứng dụng Spring Boot sau ngày 29 tháng 9 năm 2024. Các lỗi này tập trung vào thiếu sót mởgiả vờ sự phụ thuộc, khiến lớp giả vờkhách hàng trở nên không có sẵn. Cách tiếp cận chính bao gồm việc xác định và giải quyết các phần phụ thuộc còn thiếu này thông qua các lệnh Maven cụ thể. Ví dụ: lệnh `mvn dependency:tree -Dverbose` cho phép các nhà phát triển hình dung chi tiết toàn bộ hệ thống phân cấp phụ thuộc. Điều này rất quan trọng vì nó làm nổi bật các phần phụ thuộc bắc cầu có thể bị thiếu hoặc được giải quyết không chính xác, dẫn đến lỗi được quan sát thấy.

Một lệnh quan trọng khác, `mvn dependency:go-offline`, cho phép quá trình giải quyết phần phụ thuộc ở chế độ ngoại tuyến. Điều này đặc biệt hữu ích để xác định xem kho lưu trữ bên ngoài có phải là nguyên nhân gây ra sự cố hay không. Trong môi trường CI, các sự cố liên quan đến mạng hoặc các thay đổi trong kho lưu trữ bên ngoài có thể dẫn đến sự không nhất quán trong việc giải quyết các phần phụ thuộc như Spring Cloud MởGiả vờ. Chạy Maven ở chế độ ngoại tuyến giúp xác thực xem sự cố có bắt nguồn từ các thành phần bị thiếu hoặc bị hỏng trong bộ đệm cục bộ hay không.

Hơn nữa, giải pháp liên quan đến việc xác định một kho lưu trữ cục bộ tùy chỉnh đối với bản dựng Maven bằng lệnh `mvn clean package -Dmaven.repo.local=./custom-m2`. Cách tiếp cận này cách ly hiệu quả kho lưu trữ Maven mặc định bằng cách trỏ Maven đến một thư mục trống, mới, buộc nó phải tải xuống lại tất cả các phần phụ thuộc cần thiết. Điều này giúp loại trừ mọi sự cố bộ nhớ đệm cục bộ có thể dẫn đến phiên bản phụ thuộc bị hỏng hoặc lỗi thời. Ngoài ra, việc xóa thủ công các gói cụ thể khỏi kho lưu trữ cục bộ, như `org/springframework/cloud/openfeign`, đảm bảo rằng Maven tải xuống phiên bản mới của các tạo phẩm này.

Cuối cùng, để đảm bảo giải quyết được vấn đề, cần phải tiến hành bài kiểm tra đơn vị. Tập lệnh được cung cấp trước đó giới thiệu các trường hợp thử nghiệm sử dụng JUnit để xác minh cấu hình của máy khách Giả mạo. Các thử nghiệm này sử dụng khung kiểm tra Spring Boot để tải ngữ cảnh ứng dụng và thực hiện kiểm tra sự hiện diện và cấu hình của các Bean, chẳng hạn như máy khách Feign. Các xác nhận như `assertNotNull` và `assertEquals` giúp xác minh rằng các đậu được khởi tạo và định cấu hình chính xác với các thuộc tính mong đợi. Bằng cách triển khai các thử nghiệm này, các nhà phát triển có được cơ chế xác thực rằng sự cố đã được giải quyết và cấu hình máy khách giả được áp dụng chính xác trong dự án.

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

}

Giải quyết xung đột phụ thuộc và cập nhật trong dự án Maven

Một khía cạnh quan trọng có thể góp phần gây ra lỗi xây dựng Maven trong các ứng dụng Spring Boot là xung đột phụ thuộc. Những xung đột này thường phát sinh do các phiên bản chồng chéo hoặc các bản cập nhật không tương thích đối với các phần phụ thuộc cốt lõi của Spring Boot, chẳng hạn như thư viện OpenFeign hoặc Spring Cloud. Xung đột phụ thuộc có thể dẫn đến lỗi thời gian chạy và trong một số trường hợp, thiếu các gói quan trọng như org.springframework.cloud.openfeign. Việc giải quyết những xung đột này thường đòi hỏi phải đi sâu vào quản lý phần phụ thuộc của dự án, đảm bảo rằng không có phiên bản xung đột hoặc lỗi thời.

Các nhà phát triển cũng có thể phải đối mặt với các sự cố xây dựng không mong muốn khi các kho lưu trữ hoặc tạo phẩm nhất định bị thay đổi mà không báo trước. Các dự án Maven thường dựa vào các kho lưu trữ bên ngoài, có thể thay đổi hoặc ngừng sử dụng các phiên bản cụ thể, khiến các phần phụ thuộc có sẵn trước đó tạm thời hoặc vĩnh viễn không khả dụng. Thường xuyên rà soát dự án quản lý phụ thuộc các phiên bản phụ thuộc cấu hình và khóa có thể giảm thiểu những rủi ro như vậy. Ngoài ra, việc duy trì một kho lưu trữ nội bộ hoặc bản sao được cập nhật có thể đóng vai trò là bản sao lưu trong trường hợp ngừng hoạt động hoặc có những thay đổi không mong muốn trong kho lưu trữ bên ngoài.

Một khía cạnh quan trọng khác cần xem xét là việc sử dụng toàn diện ghi nhật ký và gỡ lỗi. Khi quá trình xây dựng Maven không thành công, các thông báo lỗi không phải lúc nào cũng cung cấp thông tin đầy đủ. Việc bật ghi nhật ký gỡ lỗi thông qua cờ `-X` cho phép các nhà phát triển thu thập thông tin chi tiết về những gì đang diễn ra ở hậu trường. Cách thực hành này có thể tiết lộ các vấn đề liên quan đến việc thiếu phần phụ thuộc, cấu hình sai hoặc các vấn đề về truy cập kho lưu trữ. Việc kết hợp các phương pháp ghi nhật ký và gỡ lỗi có hệ thống sẽ giúp xác định và cách ly các lỗi phức tạp hiệu quả hơn.