მოდულური არქიტექტურა (TMA)
TMA არის არქიტექტურული მიდგომა აპლიკაციების სტრუქტურირებისთვის, რაც უზრუნველყოფს მასშტაბურობას, აოპტიმიზებს კომპილაციისა და ტესტირების ციკლებს და გუნდში საუკეთესო პრაქტიკებს. მისი ძირითადი იდეაა აპლიკაციების აწყობა დამოუკიდებელი ფუნქციებით, რომლებიც ერთმანეთთან დაკავშირებულია ნათელი და ლაკონური API-ებით.
ეს გაიდლაინები წარმოადგენს არქიტექტურის პრინციპებს, გეხმარებათ ამოიცნოთ და დააორგანიზოთ თქვენი აპლიკაციის ფუნქციები სხვადასხვა შრეში. ასევე შემოაქვს რჩევები, ინსტრუმენტები და რეკომენდაციები, თუ გადაწყვეტთ ამ არქიტექტურის გამოყენებას.
ეს არქიტექტურა ადრე ცნობილი იყო როგორც µFeatures. ჩვენ მას გადავარქვით სახელი მოდულურ არქიტექტურად (TMA), რათა უკეთესად ასახავდეს მის დანიშნულებას და მის საფუძვლად მდებარე პრინციპებს.
ძირითადი პრინციპი#
დეველოპერებს უნდა შეეძლოთ სწრაფად ააწყონ, შეამოწმონ და გამოსცადონ თავიანთი ფუნქციები, ძირითადი აპლიკაციისგან დამოუკიდებლად, ისე, რომ Xcode-ის ისეთი ფუნქციები, როგორიცაა UI-ის პრევიუები, კოდის ავტოდამატება და დებაგინგი, საიმედოდ მუშაობდეს.
რა არის მოდული#
მოდული წარმოადგენს აპლიკაციის ფუნქციას და შედგება შემდეგი ხუთი თარგეტისგან (სადაც თარგეტი ეხება Xcode-ის თარგეტს):
- Source: შეიცავს ფუნქციის საწყის კოდს (Swift, Objective-C, C++, JavaScript...) და მის რესურსებს (სურათები, შრიფტები, storyboards, xibs).
- Interface: ეს არის თანმხლები თარგეტი, რომელიც შეიცავს ფუნქციის საჯარო ინტერფეისსა და მოდელებს.
- Tests: შეიცავს ფუნქციის unit და ინტეგრაციულ ტესტებს.
- Testing: უზრუნველყოფს სატესტო მონაცემებს, რომლებიც შეიძლება გამოყენებულ იქნას ტესტებში და მაგალითის აპლიკაციაში. ასევე უზრუნველყოფს mock-ებს მოდულის კლასებისა და პროტოკოლებისთვის, რომლებიც სხვა ფუნქციებს შეუძლიათ გამოიყენონ, როგორც მოგვიანებით ვნახავთ.
- Example: შეიცავს მაგალითის აპლიკაციას, რომლის გამოყენებაც დეველოპერებს შეუძლიათ ფუნქციის გამოსაცდელად გარკვეულ პირობებში (სხვადასხვა ენები, ეკრანის ზომები, პარამეტრები).
ჩვენ გირჩევთ დაიცვათ თარგეტების სახელდების კონვენცია, რასაც Tuist-ის DSL-ის მეშვეობით თქვენს პროექტში შეძლებთ აღსრულებას.
| თარგეტი | დამოკიდებულებები | შემცველობა |
|---|---|---|
Feature |
FeatureInterface |
საწყისი კოდი და რესურსები |
FeatureInterface |
- | საჯარო ინტერფეისი და მოდელები |
FeatureTests |
Feature, FeatureTesting |
Unit და ინტეგრაციული ტესტები |
FeatureTesting |
FeatureInterface |
სატესტო მონაცემები და mock-ები |
FeatureExample |
FeatureTesting, Feature |
მაგალითის აპლიკაცია |
Feature-ს შეუძლია გამოიყენოს FeatureTesting განვითარების რესურსად (Development Asset), რათა შესაძლებელი იყოს UI პრევიუები
ალტერნატიულად, შეგიძლიათ გამოიყენოთ კომპილატორის დირექტივები სატესტო მონაცემებისა და mock-ების ჩასართავად Feature ან FeatureInterface თარგეტებში Debug-ზე კომპილაციისას. თქვენ ამარტივებთ გრაფს, მაგრამ საბოლოოდ დააკომპილირებთ კოდს, რომელიც აპლიკაციის გასაშვებად არ დაგჭირდებათ.
რატომ მოდული#
ნათელი და ლაკონური API-ები#
როდესაც აპლიკაციის მთელი საწყისი კოდი ერთ თარგეტშია, ძალიან მარტივია კოდში არაცხადი დამოკიდებულებების აწყობა და საბოლოოდ ცნობილი „სპაგეტის კოდის“ მიღება. ყველაფერი მჭიდროდ არის დაკავშირებული, მდგომარეობა ზოგჯერ არაპროგნოზირებადია და ახალი ცვლილებების შეტანა кошмарად იქცევა. როდესაც ფუნქციებს დამოუკიდებელ თარგეტებში ვაღწერთ, საჯარო API-ების დაპროექტება ჩვენი ფუნქციის იმპლემენტაციის ნაწილი ხდება. უნდა გადავწყვიტოთ, რა უნდა იყოს საჯარო, როგორ უნდა მოხმარდეს ჩვენი ფუნქცია, რა უნდა დარჩეს პრივატული. გვაქვს უფრო მეტი კონტროლი იმაზე, თუ როგორ გვინდა, რომ ჩვენი ფუნქციის კლიენტებმა გამოიყენონ იგი და შეგვიძლია დავამკვიდროთ საუკეთესო პრაქტიკები უსაფრთხო API-ების დაპროექტებით.
პატარა მოდულები#
დაყავი და იბატონე. პატარა მოდულებში მუშაობა საშუალებას გაძლევთ მეტი ფოკუსირება მოახდინოთ და ფუნქცია იზოლირებულად შეამოწმოთ და გამოსცადოთ. უფრო მეტიც, განვითარების ციკლები ბევრად უფრო სწრაფია, რადგან გვაქვს უფრო სელექციური კომპილაცია — ვაკომპილირებთ მხოლოდ იმ კომპონენტებს, რომლებიც აუცილებელია ჩვენი ფუნქციის სამუშაოდ. მთლიანი აპლიკაციის კომპილაცია მხოლოდ ჩვენი მუშაობის ბოლოს არის საჭირო, როდესაც ფუნქციის აპლიკაციაში ინტეგრირება გვჭირდება.
გამოყენებადობა#
კოდის ხელახლა გამოყენება აპლიკაციებსა და სხვა პროდუქტებში, როგორიცაა გაფართოებები, წახალისებულია ფრეიმვორკების ან ბიბლიოთეკების გამოყენებით. მოდულების აწყობით მათი ხელახლა გამოყენება საკმაოდ მარტივია. შეგვიძლია ავაწყოთ iMessage გაფართოება, Today Extension ან watchOS აპლიკაცია უბრალოდ არსებული მოდულების გაერთიანებით და (საჭიროების შემთხვევაში) პლატფორმისთვის სპეციფიკური UI შრეების დამატებით.
დამოკიდებულებები#
როდესაც ერთი მოდული მეორეზეა დამოკიდებული, ის აცხადებს დამოკიდებულებას მისი ინტერფეისის თარგეტზე. ამის სარგებელი ორმაგია. ის ხელს უშლის ერთი მოდულის იმპლემენტაციის მეორე მოდულის იმპლემენტაციასთან დაკავშირებას და აჩქარებს სუფთა კომპილაციებს (clean builds), რადგან მათ მხოლოდ ჩვენი ფუნქციის იმპლემენტაციისა და პირდაპირი და ტრანზიტული დამოკიდებულებების ინტერფეისების კომპილაცია სჭირდებათ. ეს მიდგომა შთაგონებულია SwiftRock-ის იდეით iOS-ის კომპილაციის დროის შემცირება ინტერფეისის მოდულების გამოყენებით.
ინტერფეისებზე დამოკიდებულება მოითხოვს, რომ აპლიკაციებმა შექმნან იმპლემენტაციების გრაფი runtime-ში და შეიყვანონ ის დამოკიდებულების ინჟექციის (dependency-injection) გზით იმ მოდულებში, რომლებსაც ეს სჭირდებათ. მიუხედავად იმისა, რომ TMA არ აწესებს კონკრეტულ მიდგომას ამის გასაკეთებლად, ჩვენ გირჩევთ გამოიყენოთ დამოკიდებულების ინჟექციის გადაწყვეტილებები ან შაბლონები, რომლებიც არ ამატებენ კომპილაციის დროის არაპირდაპირობას ან არ იყენებენ პლატფორმის API-ებს, რომლებიც ამ მიზნისთვის არ არის შექმნილი.
პროდუქტის ტიპები#
მოდულის აწყობისას, შეგიძლიათ აირჩიოთ ბიბლიოთეკები და ფრეიმვორკები, ასევე სტატიკური და დინამიური ბმვა თარგეტებისთვის. Tuist-ის გარეშე ამ გადაწყვეტილების მიღება ოდნავ უფრო რთულია, რადგან დამოკიდებულებების გრაფი ხელით უნდა დააკონფიგურიროთ. თუმცა, Tuist Projects-ის მეშვეობით, ეს პრობლემა აღარ არსებობს.
ჩვენ გირჩევთ განვითარების დროს გამოიყენოთ დინამიური ბიბლიოთეკები ან ფრეიმვორკები bundle accessors-ის გამოყენებით, რათა bundle-ზე წვდომის ლოგიკა გამოყოთ თარგეტის ბიბლიოთეკის ან ფრეიმვორკის ბუნებიდან. ეს გადამწყვეტია სწრაფი კომპილაციის დროისთვის და იმის უზრუნველსაყოფად, რომ SwiftUI Previews საიმედოდ მუშაობდეს. ხოლო release აწყობებისთვის — სტატიკური ბიბლიოთეკები ან ფრეიმვორკები, რათა აპლიკაცია სწრაფად ჩაიტვირთოს. შეგიძლიათ გამოიყენოთ დინამიური კონფიგურაცია პროდუქტის ტიპის გენერაციის დროს შეცვლისთვის:
# You'll have to read the value of the variable from the manifest
# and use it to change the linking type
TUIST_PRODUCT_TYPE=static-library tuist generate
// You can place this in your manifest files or helpers
// and use the returned value when instantiating targets.
func productType() -> Product {
if case let .string(productType) = Environment.productType {
return productType == "static-library" ? .staticLibrary : .framework
} else {
return .framework
}
}
Apple-მა სცადა შეემსუბუქებინა სტატიკურ და დინამიურ ბიბლიოთეკებს შორის გადართვის სირთულე შეერთებადი ბიბლიოთეკების წარმოდგენით. თუმცა, ეს შემოაქვს აწყობის დროს არადეტერმინიზმს, რაც ხდის აწყობას არაწარმოებადს და უფრო რთულად ოპტიმიზირებადს, ამიტომ ჩვენ არ გირჩევთ მის გამოყენებას.
კოდი#
TMA არ აწესებს კონკრეტულ მიდგომას კოდის არქიტექტურისა და პატერნებისთვის თქვენს მოდულებში. თუმცა, გვსურს გაგიზიაროთ რჩევები ჩვენი გამოცდილების საფუძველზე:
- კომპილატორის გამოყენება შესანიშნავია. კომპილატორის ზედმეტად გამოყენებამ შეიძლება არაეფექტური აღმოჩნდეს და გამოიწვიოს ის, რომ Xcode-ის ზოგიერთი ფუნქცია, მაგალითად previews, არასაიმედოდ იმუშაოს. ჩვენ გირჩევთ გამოიყენოთ კომპილატორი კარგი პრაქტიკების დასაცავად და შეცდომების ადრეულ ეტაპზე დასაჭერად, მაგრამ არა იმ დონემდე, რომ კოდი უფრო რთული გახდეს წაკითხვისა და შენარჩუნებისთვის.
- Swift Macros ზომიერად გამოიყენეთ. ისინი შეიძლება იყოს ძალიან ძლიერი, მაგრამ ასევე შეუძლიათ გაართულონ კოდის წაკითხვა და შენარჩუნება.
- მიიღეთ პლატფორმა და ენა, ნუ აბსტრაქციებთ მათ. დეტალური აბსტრაქციის შრეების შექმნის მცდელობა შეიძლება საპირისპირო ეფექტი მოახდინოს. პლატფორმა და ენა საკმარისად ძლიერია შესანიშნავი აპლიკაციების შესაქმნელად დამატებითი აბსტრაქციის შრეების საჭიროების გარეშე. გამოიყენეთ კარგი პროგრამირებისა და დიზაინის პატერნები როგორც მინიშნება თქვენი ფუნქციების აწყობისას.
რესურსები#
- µFeatures-ის აწყობა
- ფრეიმვორკზე ორიენტირებული პროგრამირება
- მოგზაურობა ფრეიმვორკებსა და Swift-ში
- ფრეიმვორკების გამოყენება iOS-ზე განვითარების დასაჩქარებლად - ნაწილი 1
- ბიბლიოთეკაზე ორიენტირებული პროგრამირება
- თანამედროვე ფრეიმვორკების აწყობა
- xcconfig ფაილების არაოფიციალური სახელმძღვანელო
- სტატიკური და დინამიური ბიბლიოთეკები