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 các thư viện hoặc gói phần mềm mà một dự án yêu cầu. Tính năng này đạt được điều đó bằng cách lưu trữ kết quả của việc 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ể mô phỏng, đảm bảo môi trường phát triển nhất quán. Ngoài ra, tệp khoá còn nâng cao hiệu quả xây 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á 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 các thư viện bên ngoài, nhờ đó giảm nguy cơ gâ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 phân giải mô-đun và đánh giá tiện ích. 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. Điều quan trọng là tệp này chỉ bao gồm các phần phụ thuộc có trong lệnh gọi hiện tại của bản dựng.
Khi có các thay đổi 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 các phần phụ thuộc cụ thể cần thiết cho bản dựng hiện tại, cung cấp thông tin chính xác về các phần phụ thuộc đã phân giải của dự án.
Sử dụng tệp khoá
Bạn có thể kiểm soát tệp khoá 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ế độ có sẵn là:
update(Mặc định): Nếu trạng thái dự án khớp với tệp khoá, kết quả phân giải sẽ được trả về ngay lập tức từ tệp khoá. Nếu không, quá trình phân giải 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á, kết quả phân giải sẽ được trả về từ tệp khoá. Nếu không, Bazel sẽ đưa ra 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 vẫn không thay đổi và mọi sự khác biệt đều được coi là lỗi.off: Tệp khoá không được kiểm tra.
Lợi ích của tệp khoá
Tệp khoá mang lại một số lợi ích và có thể được sử dụng theo nhiều cách:
Bản dựng có thể mô phỏng. Bằng cách ghi lại các phiên bản hoặc phần phụ thuộc cụ thể của các thư viện phần mềm, tệp khoá đảm bảo rằng các bản dựng có thể mô phỏng 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à có thể dự đoán khi xây dựng dự án của họ.
Bỏ qua quá trình 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 cuối cùng. Đ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 quá trình phân giải có thể tốn thời gian.
Độ ổn định và giảm thiểu rủi ro. Tệp khoá giúp duy trì độ ổ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 các 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ể, rủi ro gây ra 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 đi.
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. Tệp này cũng bao gồm kết quả của việc xây dựng dự án ở trạng thái hiện tại. Tệp khoá bao gồm 2 phần chính:
- Giá trị đầu vào của quá trình phân giải mô-đun, chẳng hạn như
moduleFileHash,flagsvàlocalOverrideHashes, cũng như giá trị đầu ra của quá trình phân giải, đó làmoduleDepGraph. - Đối với mỗi tiện ích mô-đun, tệp khoá bao gồm các giá trị đầu vào ảnh hưởng đến tiện ích đó, được biểu thị bằng
transitiveDigestvà kết quả của việc chạy tiện ích đó được gọi làgeneratedRepoSpecs
Dưới đây là một ví dụ minh hoạ cấu trúc của tệp khoá, cùng với phần 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",
...
}
}
}
}
}
Băm tệp mô-đun
moduleFileHash biểu thị giá trị 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 cờ có thể ảnh hưởng đến kết quả phân giải.
Băm ghi đè cục bộ
Nếu mô-đun gốc bao gồm local_path_overrides, thì phần này sẽ lưu trữ giá trị băm của tệp MODULE.bazel trong kho lưu trữ cục bộ. Tính năng 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ác giá trị đầu vào được đề cập ở 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 không còn được sử dụng 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 và tên chứa tiện ích đó. Giá trị tương ứng cho mỗi mục chứa thông tin liên quan được liên kết với tiện ích đó:
transitiveDigestlà bản tóm tắt của quá trình triển khai tiện ích và các tệp .bzl bắc cầu của tiện ích đó.generatedRepoSpecslà kết quả của việc chạy tiện ích đó với giá trị đầ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 mức 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:
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 dựa trên tập hợp các phần phụ thuộc chính xác và mới nhất.
Đưa tệp khoá vào hệ thống quản lý phiên bản để tạo điều kiện 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á, thúc đẩy 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, giúp quy trình phát triển phần mềm hiệu quả hơn, đáng tin cậy hơn và có tính cộng tác cao hơn.