Tệp Bazel Lockfile

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Tính năng tệp khoá trong Bazel cho phép ghi lại các phiên bản hoặc phần phụ thuộc cụ thể của thư viện phần mềm hoặc gói mà dự án yêu cầu. Để làm được như vậy, phương thức này lưu trữ kết quả của quá trình phân giải mô-đun và đánh giá tiện ích. Tệp khoá thúc đẩy các bản dựng có thể tái tạo, đảm bảo môi trường phát triển nhất quán. Ngoài ra, tính năng này còn giúp tăng hiệu quả của bản dựng bằng cách cho phép Bazel bỏ qua quy trình phân giải khi không có thay đổi nào trong các phần phụ thuộc của dự án. Hơn nữa, tệp khoá giúp cải thiện độ ổn định bằng cách ngăn chặn các bản cập nhật không mong muốn hoặc các thay đổi gây lỗi trong thư viện bên ngoài, từ đó giảm nguy cơ xảy ra lỗi.

Tạo tệp khoá

Tệp khoá được tạo trong thư mục gốc của không gian làm việc có tên là MODULE.bazel.lock. Tệp này được tạo hoặc cập nhật trong quá trình xây dựng, cụ thể là sau khi đánh giá tiện ích và độ phân giải mô-đun. Tệp khoá ghi lại trạng thái hiện tại của dự án, bao gồm tệp MODULE, cờ, ghi đè và các thông tin liên quan khác. Quan trọng là API này chỉ chứa các phần phụ thuộc có trong lệnh gọi bản dựng hiện tại.

Khi những thay đổi xảy ra trong dự án ảnh hưởng đến các phần phụ thuộc của dự án, tệp khoá sẽ tự động được cập nhật để phản ánh trạng thái mới. Điều này đảm bảo rằng tệp khoá vẫn tập trung vào tập hợp phần phụ thuộc cụ thể cần thiết cho bản dựng hiện tại, cung cấp bản trình bày chính xác các phần phụ thuộc đã được phân giải của dự án.

Sử dụng tệp Lockfile

Tệp khoá có thể được kiểm soát bằng cờ --lockfile_mode để tuỳ chỉnh hành vi của Bazel khi trạng thái dự án khác với tệp khoá. Các chế độ hiện có là:

  • update (Mặc định): Nếu trạng thái dự án khớp với tệp khoá, thì kết quả phân giải sẽ được trả về ngay lập tức từ tệp khoá. Nếu không, giải pháp sẽ được thực thi và tệp khoá sẽ được cập nhật để phản ánh trạng thái hiện tại.
  • error: Nếu trạng thái dự án khớp với tệp khoá, thì kết quả phân giải sẽ được trả về từ tệp khoá. Nếu không, Bazel sẽ gửi một lỗi cho biết sự khác biệt giữa dự án và tệp khoá. Chế độ này đặc biệt hữu ích khi bạn muốn đảm bảo rằng các phần phụ thuộc của dự án không thay đổi và mọi khác biệt đều được coi là lỗi.
  • off: Tệp khoá chưa được kiểm tra.

Lợi ích của tệp khoá

Tệp khoá mang lại nhiều lợi ích và có thể được sử dụng theo nhiều cách khác nhau:

  • Bản dựng có thể tái tạo. Bằng cách ghi lại các phiên bản hoặc phần phụ thuộc cụ thể của thư viện phần mềm, tệp khoá đảm bảo rằng các bản dựng có thể tái tạo được trên nhiều môi trường và theo thời gian. Nhà phát triển có thể dựa vào kết quả nhất quán và dự đoán được khi xây dựng dự án.

  • Bỏ qua độ phân giải hiệu quả. Tệp khoá cho phép Bazel bỏ qua quy trình phân giải nếu không có thay đổi nào trong các phần phụ thuộc của dự án kể từ bản dựng gần nhất. Điều này giúp cải thiện đáng kể hiệu quả xây dựng, đặc biệt là trong các trường hợp độ phân giải có thể tốn nhiều thời gian.

  • Ổn định và giảm rủi ro. Tệp khoá giúp duy trì sự ổn định bằng cách ngăn chặn các bản cập nhật không mong muốn hoặc các thay đổi gây lỗi trong thư viện bên ngoài. Bằng cách khoá các phần phụ thuộc vào các phiên bản cụ thể, nguy cơ phát sinh lỗi do các bản cập nhật không tương thích hoặc chưa được kiểm thử sẽ giảm.

Nội dung tệp khoá

Tệp khoá chứa tất cả thông tin cần thiết để xác định xem trạng thái dự án có thay đổi hay không. Báo cáo này cũng bao gồm kết quả của việc tạo dự án ở trạng thái hiện tại. Tệp khoá bao gồm hai phần chính:

  1. Đầu vào của độ phân giải của mô-đun, chẳng hạn như moduleFileHash, flags và localOverrideHashes, cũng như đầu ra của độ phân giải là moduleDepGraph.
  2. Đối với mỗi tiện ích mô-đun, tệp khoá bao gồm các dữ liệu đầu vào ảnh hưởng đến tiện ích đó, được biểu thị bằng transitiveDigest và đầu ra của việc chạy tiện ích đó được gọi là generatedRepoSpecs

Dưới đây là ví dụ minh hoạ cấu trúc của tệp khoá, cùng với nội dung giải thích cho từng phần:

{
  "lockFileVersion": 1,
  "moduleFileHash": "b0f47b98a67ee15f9.......8dff8721c66b721e370",
  "flags": {
    "cmdRegistries": [
      "https://bcr.bazel.build/"
    ],
    "cmdModuleOverrides": {},
    "allowedYankedVersions": [],
    "envVarAllowedYankedVersions": "",
    "ignoreDevDependency": false,
    "directDependenciesMode": "WARNING",
    "compatibilityMode": "ERROR"
  },
  "localOverrideHashes": {
    "bazel_tools": "b5ae1fa37632140aff8.......15c6fe84a1231d6af9"
  },
  "moduleDepGraph": {
    "<root>": {
      "name": "",
      "version": "",
      "executionPlatformsToRegister": [],
      "toolchainsToRegister": [],
      "extensionUsages": [
        {
          "extensionBzlFile": "extension.bzl",
          "extensionName": "lockfile_ext"
        }
      ],
      ...
    }
  },
  "moduleExtensions": {
    "//:extension.bzl%lockfile_ext": {
      "transitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
      "generatedRepoSpecs": {
        "hello": {
          "bzlFile": "@@//:extension.bzl",
          ...
        }
      }
    }
  }
}

Hàm băm tệp mô-đun

moduleFileHash đại diện cho hàm băm của nội dung tệp MODULE.bazel. Nếu có bất kỳ thay đổi nào trong tệp này, giá trị băm sẽ khác.

Cờ

Đối tượng Flags lưu trữ tất cả cờ có thể ảnh hưởng đến kết quả phân giải.

Hàm băm ghi đè cục bộ

Nếu mô-đun gốc có local_path_overrides, thì phần này sẽ lưu trữ hàm băm của tệp MODULE.bazel trong kho lưu trữ cục bộ. Điều này cho phép theo dõi các thay đổi đối với phần phụ thuộc này.

Biểu đồ phần phụ thuộc của mô-đun

moduleDepGraph biểu thị kết quả của quá trình phân giải bằng cách sử dụng các dữ liệu đầu vào nêu trên. Tệp này tạo thành biểu đồ phần phụ thuộc của tất cả các mô-đun cần thiết để chạy dự án.

Tiện ích mô-đun

Phần moduleExtensions là một bản đồ chỉ bao gồm các tiện ích được sử dụng trong lệnh gọi hiện tại hoặc đã được gọi trước đó, đồng thời loại trừ mọi tiện ích không còn được sử dụng. Nói cách khác, nếu một tiện ích hiện không được dùng nữa trên biểu đồ phần phụ thuộc, thì tiện ích đó sẽ bị xoá khỏi bản đồ moduleExtensions.

Mỗi mục trong bản đồ này tương ứng với một tiện ích đã sử dụng và được xác định bằng tệp cũng như tên chứa tiện ích đó. Giá trị tương ứng cho mỗi mục nhập chứa thông tin liên quan được liên kết với phần mở rộng đó:

  1. transitiveDigest chuỗi đại diện của quá trình triển khai tiện ích và các tệp .bzl bắc cầu.
  2. generatedRepoSpecs là kết quả của việc chạy tiện ích đó với đầu vào hiện tại.

Một yếu tố khác có thể ảnh hưởng đến kết quả của tiện ích là mức sử dụng. Mặc dù không được lưu trữ trong tệp khoá, nhưng các trường hợp sử dụng sẽ được xem xét khi so sánh trạng thái hiện tại của tiện ích với trạng thái trong tệp khoá.

Các phương pháp hay nhất

Để tối đa hoá lợi ích của tính năng tệp khoá, hãy cân nhắc các phương pháp hay nhất sau đây:

  • Thường xuyên cập nhật tệp khoá để phản ánh các thay đổi trong phần phụ thuộc hoặc cấu hình của dự án. Điều này đảm bảo rằng các bản dựng tiếp theo sẽ dựa trên tập hợp phần phụ thuộc mới nhất và chính xác nhất.

  • Đưa tệp khoá vào chế độ quản lý phiên bản để tạo điều kiện cho việc cộng tác và đảm bảo rằng tất cả thành viên trong nhóm đều có quyền truy cập vào cùng một tệp khoá, giúp thúc đẩy các môi trường phát triển nhất quán trên toàn dự án.

Bằng cách làm theo các phương pháp hay nhất này, bạn có thể sử dụng hiệu quả tính năng tệp khoá trong Bazel, từ đó mang đến quy trình phát triển phần mềm cộng tác, đáng tin cậy và hiệu quả hơn.