Podfile: шта је то, синтакса и подешавање библиотека преко CocoaPods

Шта је Podfile и зашто је потребан

Podfile је декларативни скрипт у Ruby језику у коме се наводе спољне зависности за iOS, macOS, tvOS или watchOS пројекат. Налази се у кореном директоријуму пројекта и служи као јединствена тачка конфигурације за менаџер пакета CocoaPods. Без Podfile-а, програмери би морали ручно да преузимају библиотеке, копирају их у пројекат и подешавају linker flags у Xcode-у.

CocoaPods анализира Podfile и креира затворени фајл Podfile.lock који фиксира тачне верзије инсталираних библиотека. Ово гарантује поновљивост изградње на свим машинама развојног тима: ако један програмер ажурира Alamofire на верзију 5.9, Podfile.lock ће забележити ову промену, а сви остали при извршавању pod install добиће потпуно исту верзију. Без овог механизма, различити програмери би могли имати различите верзије зависности, што доводи до тешко уочљивих грешака.

Podfile решава три главна задатка: управљање зависностима са контролом верзија, подешавање циљне платформе са минималном верзијом ОС и аутоматску интеграцију библиотека преко Xcode Workspace. При свакој инсталацији, CocoaPods генерише фајл Pods.xcodeproj који се повезује са главним пројектом преко workspace-а. Програмер не мора да размишља о томе како су библиотеке повезане — довољно је да их наведе у Podfile-у.

Синтакса и структура Podfile

Podfile користи синтаксу Ruby-ја, али захтева минимално познавање језика. Основна структура се састоји од директива које дефинишу платформу, мете изградње и листу зависности. Свака директива се извршава у контексту Ruby интерпретатора, тако да Podfile подржава условне конструкције, петље и променљиве за сложене конфигурације.

Блок target

Свака мета изградње апликације се описује унутар блока target. За стандардни Xcode пројекат, ово је обично једна мета са именом апликације. Угнежђени target-и се могу користити за модуларне тестове, UI тестове и проширења. Препоручује се изоловање зависности различитих target-а: главне библиотеке у главном target-у, тестни оквири у тестном, како би се избегло доспевање непотребних зависности у продукцијску верзију.

# Пример минималног Podfile-а за iOS пројекат
target 'MyApp' do
  use_frameworks!
  pod 'Alamofire', '~> 5.8'
  pod 'Kingfisher', '~> 7.10'
  pod 'SnapKit', '~> 5.6'
end

Директиве платформе

Директива platform задаје минималну верзију ОС за коју се пројекат изграђује. Ово је обавезни параметар који утиче на компатибилност библиотека. Библиотеке у CocoaPods-у обично наводе своје минималне верзије ОС у podspec-у, а ако је платформа пројекта нижа од захтеване, pod install ће пријавити грешку. За iOS пројекте, минимална верзија је обично 15.0 и више, за macOS — 12.0 и више.

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

Глобалне и локалне зависности

Зависности се могу наводити глобално ван target блокова или локално унутар одређене мете. Глобални подови се повезују на све мете пројекта, што је згодно за библиотеке опште намене попут CocoaLumberjack за логирање. Локалне зависности су корисне за одвајање тестних оквира од продукцијског кода: Quick и Nimble за тестове, Firebase за аналитику, Realm за складиштење података.

# Глобална зависност за све мете
pod 'CocoaLumberjack'

target 'MyApp' do
  # Локалне зависности главне апликације
  pod 'Firebase/Crashlytics'
  pod 'Firebase/Analytics'
  pod 'RealmSwift'
end

target 'MyAppTests' do
  # Тестни оквири неће ући у релиз
  pod 'Quick'
  pod 'Nimble'
end

Управљање верзијама зависности

CocoaPods подржава флексибилно навођење верзија преко оператора поређења. Ово омогућава контролу ажурирања и избегавање некомпатибилних промена API-ја. Избор одговарајућег оператора је критичан за стабилност пројекта: превише строга ограничења блокирају ажурирања са исправкама грешака, превише блага могу довести до неочекиваних кварова при великим ажурирањима.

Препоручује се коришћење оператора ~> за компатибилна ажурирања. Он штити од великих промена API-ја, истовремено омогућавајући пријем закрпа и мањих побољшања. На пример, ~> 5.8 дозвољава верзије 5.8.0, 5.8.1, 5.9.0, али блокира 6.0.0 где могу бити критичне промене API-ја.

Фајл Podfile.lock фиксира тачне верзије и мора се чувати у систему контроле верзија. Команда pod update ажурира зависности до последњих дозвољених верзија и преписује lock фајл, а pod install користи већ фиксиране верзије из Podfile.lock-а ради гаранције идентичности изградњи.

Развојне и продукцијске конфигурације

Podfile подржава раздвајање конфигурација преко директива за различите шеме изградње. Могу се повезати различити скупови библиотека за Debug и Release, што значајно смањује величину продукцијског билда и убрзава његову компилацију. Линтери, генератори кода и алати за отклањање грешака треба да раде само у Debug конфигурацији.

target 'MyApp' do
  # Само за Debug: линтер и отклањање грешака
  pod 'SwiftLint', :configurations => ['Debug']
  # Продукција: аналитика и праћење
  pod 'Fabric'
  pod 'TestFairy', :configurations => ['Release']
end

Директива inhibit_all_warnings! искључује упозорења са свих подова. Ово је корисно у великим пројектима где библиотеке трећих страна генеришу много шума у логовима изградње, отежавајући проналажење сопствених упозорења и грешака. За селективно искључивање може се користити inhibit_warnings на одређени под.

Библиотеке које се користе само у фази развоја препоручује се изоловати кроз Debug конфигурације. SwiftLint, OHHTTPStubs, RevealServer и слични алати треба да буду недоступни у продукцијској изградњи. Ово не само да смањује величину IPA-а, већ и елиминише случајно откривање информација за отклањање грешака у објављеној верзији апликације. Сваки под остављен у Release без потребе повећава време покретања и потрошњу меморије. Додатно, CocoaPods подржава директиву abstract_target која групише заједничке зависности без стварања физичке мете изградње.

За велике пројекте са модуларном архитектуром препоручује се коришћење вишеструких target структуре Podfile-а: сваки модул апликације добија сопствени target са изолованим скупом зависности. Ово убрзава инкременталну изградњу, јер се при промени једног модула прекомпилирају само његове зависности. CocoaPods аутоматски решава укрштене зависности између target-а, гарантујући да се свака библиотека инсталира у јединственој верзији за све модуле пројекта.

Post-Install Hookови и додатне могућности

Hook post_install се извршава након инсталације свих подова. Омогућава програмску промену подешавања Xcode пројекта, на пример подешавање минималне верзије iOS-а за појединачне target-е, додавање фаза изградње или измену infoplists-а библиотека. Ово је моћан механизам прилагођавања без којег неке библиотеке трећих страна не могу бити правилно конфигурисане.

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # Присилно постављамо минималну верзију за све подове
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
    end
  end
end

Директива use_frameworks! укључује коришћење динамичких оквира уместо статичких библиотека. Ово је обавезни параметар за Swift пројекте и библиотеке написане у Swift-у, јер Swift runtime захтева динамичко повезивање. Међутим, за Objective-C пројекте може се користити use_frameworks! :linkage => :static за изградњу статичких оквира, што смањује време покретања апликације и величину пакета.

Застава static_frameworks у инсталатеру омогућава изградњу статичких оквира, што смањује време покретања апликације. Избор између static и dynamic зависи од архитектуре пројекта: динамички оквири се дуже учитавају, али омогућавају систему да дели меморију између процеса. Статички оквири су компактнији, али свака копија заузима одвојену меморију у сваком процесу.

Поред post_install, Podfile подржава hook pre_install који се извршава пре инсталације подова. Користан је за измену podspec-а пре интеграције, на пример за промену изворног кода библиотека кроз закрпе или за подешавање специфичних заставица компајлера. Hookови чине Podfile не само листом зависности, већ комплетним конфигурационим скриптом који аутоматизује процес изградње.

Директива source указује URL репозиторијума CocoaPods Specs. Подразумевано се користи званични репозиторијум https://github.com/CocoaPods/Specs.git, али за пројекте са привaтним библиотекама може се додати сопствени приватни Specs репозиторијум. Вишеструки source-и омогућавају комбиновање јавних и приватних подспека у једном Podfile-у. Редослед source-а је важан: CocoaPods тражи подове наведеним редоследом и користи прву пронађену инстанцу, што омогућава преписивање јавних библиотека приватним верзијама.