Podfile: nó là gì, cú pháp và cấu hình thư viện qua CocoaPods

Podfile là gì và tại sao cần nó

Podfile là tập lệnh khai báo viết bằng Ruby liệt kê các phụ thuộc bên ngoài cho dự án iOS, macOS, tvOS hoặc watchOS. Nó nằm trong thư mục gốc của dự án và đóng vai trò là điểm cấu hình duy nhất cho trình quản lý gói CocoaPods. Không có Podfile, nhà phát triển phải tải thư viện thủ công, sao chép vào dự án và cấu hình cờ linker trong Xcode.

CocoaPods phân tích Podfile và tạo tệp Podfile.lock để cố định phiên bản chính xác của các thư viện đã cài đặt. Điều này đảm bảo build có thể tái tạo trên tất cả máy của nhóm phát triển: nếu một nhà phát triển cập nhật Alamofire lên phiên bản 5.9, Podfile.lock sẽ cố định thay đổi này và tất cả những người khác khi chạy pod install sẽ nhận được chính xác cùng phiên bản. Không có cơ chế này, các nhà phát triển khác nhau có thể có phiên bản phụ thuộc khác nhau, dẫn đến lỗi khó tìm.

Podfile giải quyết ba nhiệm vụ chính: quản lý phụ thuộc với kiểm soát phiên bản, cấu hình nền tảng mục tiêu với phiên bản OS tối thiểu và tích hợp thư viện tự động qua Xcode Workspace. Mỗi lần cài đặt, CocoaPods tạo tệp Pods.xcodeproj được liên kết với dự án chính qua workspace. Nhà phát triển không cần suy nghĩ về cách thư viện được kết nối — chỉ cần chỉ định chúng trong Podfile.

Cú pháp và cấu trúc Podfile

Podfile sử dụng cú pháp Ruby nhưng yêu cầu kiến thức ngôn ngữ tối thiểu. Cấu trúc cơ bản bao gồm các chỉ thị xác định nền tảng, mục tiêu build và danh sách phụ thuộc. Mỗi chỉ thị được thực thi trong ngữ cảnh của trình thông dịch Ruby, do đó Podfile hỗ trợ cấu trúc điều kiện, vòng lặp và biến cho cấu hình phức tạp.

Khối target

Mỗi mục tiêu build ứng dụng được mô tả bên trong khối target. Đối với dự án Xcode tiêu chuẩn, thường có một mục tiêu với tên ứng dụng. Các mục tiêu lồng nhau có thể được sử dụng cho kiểm thử đơn vị, kiểm thử giao diện và tiện ích mở rộng. Nên cách ly phụ thuộc của các mục tiêu khác nhau: thư viện chính trong mục tiêu chính, framework kiểm thử trong mục tiêu kiểm thử, để tránh phụ thuộc không cần thiết trong sản xuất.

# Ví dụ Podfile tối thiểu cho dự án iOS
target 'MyApp' do
  use_frameworks!
  pod 'Alamofire', '~> 5.8'
  pod 'Kingfisher', '~> 7.10'
  pod 'SnapKit', '~> 5.6'
end

Chỉ thị nền tảng

Chỉ thị platform đặt phiên bản OS tối thiểu mà dự án được build cho. Đây là tham số bắt buộc ảnh hưởng đến tương thích thư viện. Các thư viện trong CocoaPods thường chỉ định phiên bản OS tối thiểu trong podspec và nếu nền tảng dự án thấp hơn yêu cầu, pod install sẽ báo lỗi. Đối với dự án iOS, phiên bản tối thiểu thường là 15.0 trở lên, đối với macOS — 12.0 trở lên.

platform :ios, '15.0'
platform :macos, '12.0'
platform :tvos, '16.0'

Phụ thuộc toàn cục và cục bộ

Phụ thuộc có thể được chỉ định toàn cục bên ngoài khối target hoặc cục bộ bên trong một mục tiêu cụ thể. Các pod toàn cục được kết nối với tất cả mục tiêu của dự án, thuận tiện cho thư viện đa năng như CocoaLumberjack để ghi log. Phụ thuộc cục bộ hữu ích để tách framework kiểm thử và mã sản xuất: Quick và Nimble cho kiểm thử, Firebase cho phân tích, Realm cho lưu trữ dữ liệu.

# Phụ thuộc toàn cục cho tất cả mục tiêu
pod 'CocoaLumberjack'

target 'MyApp' do
  # Phụ thuộc cục bộ của ứng dụng chính
  pod 'Firebase/Crashlytics'
  pod 'Firebase/Analytics'
  pod 'RealmSwift'
end

target 'MyAppTests' do
  # Framework kiểm thử sẽ không được đưa vào bản phát hành
  pod 'Quick'
  pod 'Nimble'
end

Quản lý phiên bản phụ thuộc

CocoaPods hỗ trợ chỉ định phiên bản linh hoạt qua toán tử so sánh. Điều này cho phép kiểm soát cập nhật và tránh thay đổi API không tương thích. Chọn đúng toán tử rất quan trọng cho sự ổn định của dự án: ràng buộc quá chặt chẽ chặn cập nhật sửa lỗi, trong khi ràng buộc quá lỏng lẻo có thể dẫn đến hỏng hóc bất ngờ từ các bản cập nhật lớn.

Nên sử dụng toán tử ~> cho các bản cập nhật tương thích. Nó bảo vệ khỏi thay đổi API lớn trong khi cho phép bản vá và cải tiến nhỏ. Ví dụ, ~> 5.8 cho phép phiên bản 5.8.0, 5.8.1, 5.9.0, nhưng chặn 6.0.0 có thể chứa thay đổi API nghiêm trọng.

Tệp Podfile.lock cố định phiên bản chính xác và phải được lưu trữ trong hệ thống kiểm soát phiên bản. Lệnh pod update cập nhật phụ thuộc lên phiên bản mới nhất được phép và ghi đè tệp khóa, trong khi pod install sử dụng phiên bản đã cố định từ Podfile.lock để đảm bảo build giống hệt nhau.

Cấu hình phát triển và sản xuất

Podfile hỗ trợ phân tách cấu hình qua chỉ thị cho các lược đồ build khác nhau. Có thể kết nối các bộ thư viện khác nhau cho Debug và Release, giúp giảm đáng kể kích thước build sản xuất và tăng tốc biên dịch. Trình lint, trình tạo mã và công cụ gỡ lỗi chỉ nên hoạt động trong cấu hình Debug.

target 'MyApp' do
  # Chỉ cho Debug: trình lint và gỡ lỗi
  pod 'SwiftLint', :configurations => ['Debug']
  # Sản xuất: phân tích và giám sát
  pod 'Fabric'
  pod 'TestFairy', :configurations => ['Release']
end

Chỉ thị inhibit_all_warnings! tắt cảnh báo từ tất cả pod. Điều này hữu ích cho các dự án lớn nơi thư viện bên thứ ba tạo nhiều nhiễu trong nhật ký build, gây khó khăn cho việc tìm cảnh báo và lỗi của riêng bạn. Để tắt cảnh báo có chọn lọc, có thể sử dụng inhibit_warnings trên một pod cụ thể.

Các thư viện chỉ sử dụng trong phát triển nên được cách ly qua cấu hình Debug. SwiftLint, OHHTTPStubs, RevealServer và các công cụ tương tự không nên có sẵn trong build sản xuất. Điều này không chỉ giảm kích thước IPA mà còn ngăn chặn việc lộ thông tin gỡ lỗi trong phiên bản phát hành của ứng dụng. Mỗi pod để lại trong Release không cần thiết làm tăng thời gian khởi động và tiêu thụ bộ nhớ. Ngoài ra, CocoaPods hỗ trợ chỉ thị abstract_target, nhóm các phụ thuộc chung mà không tạo mục tiêu build vật lý.

Đối với dự án lớn có kiến trúc mô-đun, nên sử dụng cấu trúc Podfile đa mục tiêu: mỗi mô-đun ứng dụng nhận mục tiêu riêng với bộ phụ thuộc cách ly. Điều này tăng tốc build gia tăng vì khi thay đổi một mô-đun, chỉ các phụ thuộc của nó được build lại. CocoaPods tự động giải quyết phụ thuộc chồng chéo giữa các mục tiêu, đảm bảo mỗi thư viện được cài đặt ở một phiên bản duy nhất trên tất cả mô-đun của dự án.

Post-Install Hooks và tính năng bổ sung

Hook post_install được thực thi sau khi cài đặt tất cả pod. Nó cho phép thay đổi cài đặt dự án Xcode theo chương trình, như đặt phiên bản iOS tối thiểu cho các mục tiêu riêng lẻ, thêm giai đoạn build hoặc sửa đổi info plists của thư viện. Đây là cơ chế tùy chỉnh mạnh mẽ mà nếu không có, một số thư viện bên thứ ba không thể cấu hình đúng cách.

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # Buộc đặt phiên bản tối thiểu cho tất cả pod
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
    end
  end
end

Chỉ thị use_frameworks! kích hoạt sử dụng framework động thay vì thư viện tĩnh. Đây là tham số bắt buộc cho dự án Swift và thư viện viết bằng Swift vì thời gian chạy Swift yêu cầu liên kết động. Tuy nhiên, đối với dự án Objective-C, có thể sử dụng use_frameworks! :linkage => :static để build framework tĩnh, giảm thời gian khởi động ứng dụng và kích thước bundle.

Cờ static_frameworks trong trình cài đặt cho phép build framework tĩnh, giảm thời gian khởi chạy ứng dụng. Lựa chọn giữa static và dynamic phụ thuộc vào kiến trúc dự án: framework động tải lâu hơn nhưng cho phép hệ thống chia sẻ bộ nhớ giữa các tiến trình. Framework tĩnh nhỏ gọn hơn nhưng mỗi bản sao chiếm bộ nhớ riêng trong mỗi tiến trình.

Ngoài post_install, Podfile hỗ trợ hook pre_install, được thực thi trước khi cài đặt pod. Nó hữu ích để sửa đổi podspec trước khi tích hợp, ví dụ thay đổi mã nguồn thư viện qua bản vá hoặc cấu hình cờ trình biên dịch cụ thể. Hook làm cho Podfile không chỉ là danh sách phụ thuộc mà là tập lệnh cấu hình hoàn chỉnh tự động hóa quy trình build.

Chỉ thị source chỉ định URL của kho lưu trữ CocoaPods Specs. Mặc định, kho chính thức https://github.com/CocoaPods/Specs.git được sử dụng, nhưng đối với dự án có thư viện riêng tư, có thể thêm kho Specs riêng. Nhiều chỉ thị source cho phép kết hợp podspec công khai và riêng tư trong một Podfile. Thứ tự source quan trọng: CocoaPods tìm kiếm pod theo thứ tự đã chỉ định và sử dụng phiên bản đầu tiên tìm thấy, cho phép ghi đè thư viện công khai bằng phiên bản riêng tư.