संसाधन नियंत्रण। स्विफ्टजेन को अनुकूलित करें

संभवतः, हर बड़े आईओएस-प्रोजेक्ट में, लंबे समय तक रहने वाले आइकन उन आइकन पर ठोकर खा सकते हैं जो कहीं भी उपयोग नहीं किए जाते हैं, या स्थानीयकरण कुंजियों तक पहुंच है जो लंबे समय तक अस्तित्व में नहीं हैं। सबसे अधिक बार, ऐसी स्थितियां असावधानी से उत्पन्न होती हैं, और आटोमेशन के लिए स्वचालन सबसे अच्छा इलाज है।

हेडहंटर की आईओएस टीम में, हम उन नियमित कार्यों को स्वचालित करने पर बहुत ध्यान देते हैं जो एक डेवलपर का सामना कर सकते हैं। इस लेख के साथ हम उन उपकरणों और दृष्टिकोणों के बारे में कहानियों का एक चक्र शुरू करना चाहते हैं जो हमारे दैनिक कार्यों को सरल बनाते हैं।

कुछ समय पहले, हम स्विफ्टगैन उपयोगिता का उपयोग करके एप्लिकेशन संसाधनों का नियंत्रण लेने में कामयाब रहे। इसे कैसे कॉन्फ़िगर किया जाए, इसके साथ कैसे रहना है और यह उपयोगिता कैसे संकलक के लिए संसाधनों की प्रासंगिकता के लिए चेक को स्थानांतरित करने में मदद करती है, और हम बिल्ली के बारे में बात करेंगे।

SwiftGen एक उपयोगिता है जो आपको Xcode प्रोजेक्ट के विभिन्न संसाधनों तक पहुँचने के लिए स्विफ्ट कोड उत्पन्न करने की अनुमति देती है, उनमें से:

• फोंट;
• रंग;
• स्टोरीबोर्ड;
• स्थानीयकरण के तार;
• एसेट।

हर कोई छवियों या स्थानीयकरण तार को इनिशियलाइज़ करने के लिए एक समान कोड लिख सकता है:

logoImageView.image = UIImage(named: "Swift") nameLabel.text = String( format: NSLocalizedString("languages.swift.name", comment: ""), locale: Locale.current ) 

छवि या स्थानीयकरण कुंजी का नाम इंगित करने के लिए, हम स्ट्रिंग शाब्दिक का उपयोग करते हैं। दोहरे उद्धरण चिह्नों के बीच जो लिखा गया है वह संकलक या विकास पर्यावरण (Xcode) द्वारा मान्य नहीं है। इसमें निम्नलिखित समस्याएं हैं:

• आप एक टाइपो बना सकते हैं;
• कुंजी / छवि को संपादित करने या हटाने के बाद आप कोड में उपयोग को अपडेट करना भूल सकते हैं।

आइए देखें कि हम स्विफ्टगैन के साथ इस कोड को कैसे सुधार सकते हैं।

हमारी टीम के लिए, पीढ़ी केवल तार और संपत्ति के लिए प्रासंगिक थी, और उन्हें लेख में चर्चा की जाएगी। अन्य प्रकार के संसाधनों के लिए सृजन समान है और, यदि वांछित है, तो आसानी से स्वतंत्र रूप से महारत हासिल है।

परियोजना कार्यान्वयन

सबसे पहले आपको SwiftGen इंस्टॉल करना होगा। हमने इसे कोकोआपॉड्स के माध्यम से सभी टीम के सदस्यों के बीच उपयोगिता को वितरित करने के लिए एक सुविधाजनक तरीके के रूप में स्थापित करना चुना। लेकिन यह अन्य तरीकों से किया जा सकता है, जो प्रलेखन में विस्तार से वर्णित हैं। हमारे मामले में, जो कुछ भी करने की जरूरत है, वह है pod 'SwiftGen' में pod 'SwiftGen' , और फिर एक नया बिल्ड चरण ( Build Phase ) जोड़ना जो प्रोजेक्ट के निर्माण से पहले स्विफ्टजेन को लॉन्च करेगा।

 "$PODS_ROOT"/SwiftGen/bin/swiftgen 

प्रोजेक्ट को संकलित करते समय त्रुटियों से बचने के लिए Compile Sources चरण शुरू करने से पहले स्विफ्टगैन को चलाना महत्वपूर्ण है।

अब हम अपनी परियोजना के लिए स्विफ्टगेन को अनुकूलित करने के लिए तैयार हैं।

SwiftGen कॉन्फ़िगर करें

सबसे पहले, आपको उन टेम्पलेट्स को कॉन्फ़िगर करने की आवश्यकता है जिनके द्वारा संसाधनों तक पहुंचने के लिए कोड उत्पन्न होगा। उपयोगिता में पहले से ही कोड बनाने के लिए टेम्पलेट्स का एक सेट होता है, वे सभी गितुब पर देखे जा सकते हैं और सिद्धांत रूप में, वे उपयोग करने के लिए तैयार हैं। टेम्प्लेट्स को स्टैंसिल भाषा में लिखा जाता है, आप इससे परिचित हो सकते हैं यदि आपने सरसरी का इस्तेमाल किया है या किटुरा के साथ खेला है। यदि वांछित है, तो प्रत्येक टेम्पलेट को अपने स्वयं के गाइड के लिए अनुकूलित किया जा सकता है।
उदाहरण के लिए, स्थानीयकरण के तार तक पहुँचने के लिए enum उत्पन्न करने वाले टेम्पलेट को लें। यह हमें लग रहा था कि मानक में बहुत अधिक फालतू है और इसे सरल बनाया जा सकता है। व्याख्यात्मक टिप्पणियों के साथ एक सरल उदाहरण बिगाड़ने के तहत है।

 {#      #} {% set accessModifier %}{% if param.publicAccess %}public{% else %}internal{% endif %}{% endset %} {#    #} {% macro parametersBlock types %}{% filter removeNewlines:"leading" %} {% for type in types %} _ p{{forloop.counter}}: {{type}}{% if not forloop.last %}, {% endif %} {% endfor %} {% endfilter %}{% endmacro %} {% macro argumentsBlock types %}{% filter removeNewlines:"leading" %} {% for type in types %} p{{forloop.counter}}{% if not forloop.last %}, {% endif %} {% endfor %} {% endfilter %}{% endmacro %} {#       enum        #} {% macro recursiveBlock table item sp %} {{sp}}{% for string in item.strings %} {{sp}}{% if not param.noComments %} {{sp}}/// {{string.translation}} {{sp}}{% endif %} {{sp}}{% if string.types %} {{sp}}{{accessModifier}} static func {{string.name|swiftIdentifier:"pretty"|lowerFirstWord|escapeReservedKeywords}}({% call parametersBlock string.types %}) -> String { {{sp}} return localize("{{string.key}}", {% call argumentsBlock string.types %}) {{sp}}} {{sp}}{% else %} {{sp}}{{accessModifier}} static let {{string.name|swiftIdentifier:"pretty"|lowerFirstWord|escapeReservedKeywords}} = localize("{{string.key}}") {{sp}}{% endif %} {{sp}}{% endfor %} {{sp}}{% for child in item.children %} {{sp}}{{accessModifier}} enum {{child.name|swiftIdentifier:"pretty"|escapeReservedKeywords}} { {{sp}}{% set sp2 %}{{sp}} {% endset %} {{sp}}{% call recursiveBlock table child sp2 %} {{sp}}} {{sp}}{% endfor %} {% endmacro %} import Foundation {#   enum #} {% set enumName %}{{param.enumName|default:"L10n"}}{% endset %} {{accessModifier}} enum {{enumName}} { {% if tables.count > 1 %} {% for table in tables %} {{accessModifier}} enum {{table.name|swiftIdentifier:"pretty"|escapeReservedKeywords}} { {% call recursiveBlock table.name table.levels " " %} } {% endfor %} {% else %} {% call recursiveBlock tables.first.name tables.first.levels " " %} {% endif %} } {#  enum Localization         #} extension Localization { fileprivate static func localize(_ key: String, _ args: CVarArg...) -> String { return String( format: NSLocalizedString(key, comment: ""), locale: Locale.current, arguments: args ) } } 

टेम्प्लेट फ़ाइल को प्रोजेक्ट के रूट में सहेजना सुविधाजनक है, उदाहरण के लिए, SwiftGen/Templates फ़ोल्डर में ताकि यह टेम्प्लेट उन सभी के लिए उपलब्ध हो जो प्रोजेक्ट पर काम करते हैं।
उपयोगिता swiftgen.yml फ़ाइल के माध्यम से कॉन्फ़िगरेशन का समर्थन करती है swiftgen.yml , जिसमें आप स्रोत फ़ाइलों, टेम्पलेट्स और अतिरिक्त मापदंडों के पथ निर्दिष्ट कर सकते हैं। इसे Swiftgen फ़ोल्डर में प्रोजेक्ट की जड़ में बनाएँ, और बाद में स्क्रिप्ट से संबंधित अन्य फ़ाइलों को उसी फ़ोल्डर में समूहित करें।
हमारी परियोजना के लिए, यह फ़ाइल इस तरह दिख सकती है:

 xcassets: - paths: ../SwiftGenExample/Assets.xcassets templatePath: Templates/ImageAssets.stencil output: ../SwiftGenExample/Image.swift params: enumName: Image publicAccess: 1 noAllValues: 1 strings: - paths: ../SwiftGenExample/en.lproj/Localizable.strings templatePath: Templates/LocalizableStrings.stencil output: ../SwiftGenExample/Localization.swift params: enumName: Localization publicAccess: 1 noComments: 0 

वास्तव में, फ़ाइलों और टेम्प्लेटों के पथ को इंगित किया जाता है, साथ ही अतिरिक्त पैरामीटर जो टेम्पलेट संदर्भ में पास किए जाते हैं।
चूंकि फ़ाइल परियोजना की जड़ में नहीं है, इसलिए हमें स्विफ्टजेन को शुरू करते समय इसे पथ निर्दिष्ट करना होगा। हमारी स्टार्टअप स्क्रिप्ट बदलें:

 "$PODS_ROOT"/SwiftGen/bin/swiftgen config run --config SwiftGen/swiftgen.yml 

अब हमारी परियोजना को इकट्ठा किया जा सकता है। असेंबली के बाद, दो फाइलें Localization.swift और Image.swift प्रोजेक्ट फ़ोल्डर में Image.swift में निर्दिष्ट रास्तों में दिखाई Image.swift चाहिए। उन्हें Xcode प्रोजेक्ट में जोड़ा जाना चाहिए। हमारे मामले में, उत्पन्न फ़ाइलों में निम्नलिखित शामिल हैं:

 public enum Localization { public enum Languages { public enum ObjectiveC { /// General-purpose, object-oriented programming language that adds Smalltalk-style messaging to the C programming language public static let description = localize("languages.objective-c.description") /// https://en.wikipedia.org/wiki/Objective-C public static let link = localize("languages.objective-c.link") /// Objective-C public static let name = localize("languages.objective-c.name") } public enum Swift { /// General-purpose, multi-paradigm, compiled programming language developed by Apple Inc. for iOS, macOS, watchOS, tvOS, and Linux public static let description = localize("languages.swift.description") /// https://en.wikipedia.org/wiki/Swift_(programming_language) public static let link = localize("languages.swift.link") /// Swift public static let name = localize("languages.swift.name") } } public enum MainScreen { /// Language public static let title = localize("main-screen.title") public enum Button { /// View in Wikipedia public static let title = localize("main-screen.button.title") } } } extension Localization { fileprivate static func localize(_ key: String, _ args: CVarArg...) -> String { return String( format: NSLocalizedString(key, comment: ""), locale: Locale.current, arguments: args ) } } 

 public enum Image { public enum Logos { public static var objectiveC: UIImage { return image(named: "ObjectiveC") } public static var swift: UIImage { return image(named: "Swift") } } private static func image(named name: String) -> UIImage { let bundle = Bundle(for: BundleToken.self) guard let image = UIImage(named: name, in: bundle, compatibleWith: nil) else { fatalError("Unable to load image named \(name).") } return image } } private final class BundleToken {} 

अब आप प्रपत्र UIImage(named: "") की छवियों के स्थानीयकरण और आरंभीकरण स्ट्रिंग के सभी उपयोगों को प्रतिस्थापित कर सकते हैं जो UIImage(named: "") उत्पन्न किए हैं। इससे हमें परिवर्तनों को ट्रैक करने या स्थानीयकरण स्ट्रिंग कुंजियों को हटाने में आसानी होगी। इनमें से किसी भी मामले में, परियोजना केवल तब तक इकट्ठा नहीं होगी जब तक कि परिवर्तनों से जुड़ी सभी त्रुटियां ठीक नहीं हो जातीं।
परिवर्तनों के बाद, हमारा कोड इस तरह दिखता है:

  let logos = Image.Logos.self let localization = Localization.self private func setupWithLanguage(_ language: ProgrammingLanguage) { switch language { case .Swift: logoImageView.image = logos.swift nameLabel.text = localization.Languages.Swift.name descriptionLabel.text = localization.Languages.Swift.description wikiUrl = localization.Languages.Swift.link.toURL() case .ObjectiveC: logoImageView.image = logos.objectiveC nameLabel.text = localization.Languages.ObjectiveC.name descriptionLabel.text = localization.Languages.ObjectiveC.description wikiUrl = localization.Languages.ObjectiveC.link.toURL() } } 

Xcode में एक परियोजना की स्थापना

उत्पन्न फ़ाइलों के साथ एक समस्या है: उन्हें मैन्युअल रूप से गलती से बदला जा सकता है, और चूंकि वे प्रत्येक संकलन के साथ खरोंच से अधिलेखित हो जाते हैं, इसलिए ये परिवर्तन खो सकते हैं। इससे बचने के लिए, आप SwiftGen स्क्रिप्ट SwiftGen बाद लिखने के लिए फाइलें लॉक कर सकते हैं।
यह chmod का उपयोग करके प्राप्त किया जा सकता है। हम स्विफ्टगैन के लॉन्च के साथ अपने Build Phase को फिर से लिखते हैं:

 PODSROOT="$1" OUTPUT_FILES=() COUNTER=0 while [ $COUNTER -lt ${SCRIPT_OUTPUT_FILE_COUNT} ]; do tmp="SCRIPT_OUTPUT_FILE_$COUNTER" OUTPUT_FILES+=(${!tmp}) COUNTER=$[$COUNTER+1] done for file in "${OUTPUT_FILES[@]}" do if [ -f $file ] then chmod a=rw "$file" fi done $PODSROOT/SwiftGen/bin/swiftgen config run --config SwiftGen/swiftgen.yml for file in "${OUTPUT_FILES[@]}" do chmod a=r "$file" done 

स्क्रिप्ट बहुत सरल है। पीढ़ी शुरू करने से पहले, यदि फाइलें मौजूद हैं, तो हम उन्हें लिखने की अनुमति देते हैं। स्क्रिप्ट चलाने के बाद, हम फ़ाइलों को संशोधित करने की क्षमता को अवरुद्ध करते हैं।
संपादन में आसानी और समीक्षा के लिए स्क्रिप्ट की जांच के लिए, इसे अलग से runswiftgen.sh फ़ाइल में runswiftgen.sh है। मामूली संशोधनों के साथ स्क्रिप्ट का अंतिम संस्करण यहां पाया जा सकता है । अब हमारा Build Phase इस तरह दिखेगा: हम स्क्रिप्ट इनपुट के लिए पॉड्स फोल्डर का रास्ता पास करते हैं:

 "$SRCROOT"/SwiftGen/runswiftgen.sh "$PODS_ROOT" 

हम परियोजना का पुनर्निर्माण करते हैं, और अब जब आप उत्पन्न फ़ाइल को मैन्युअल रूप से संशोधित करने का प्रयास करते हैं, तो एक चेतावनी दिखाई देती है:

तो, स्विफ्टजेन वाले फ़ोल्डर में अब एक कॉन्फ़िगरेशन फ़ाइल, फ़ाइलों को लॉक करने और Swiftgen लॉन्च करने के लिए एक स्क्रिप्ट और अनुकूलित टेम्पलेट्स वाला एक फ़ोल्डर है। यदि आवश्यक हो तो आगे संपादन के लिए इसे परियोजना में जोड़ना सुविधाजनक है।

और चूंकि Localization.swift और Image.swift स्वचालित रूप Image.swift उत्पन्न होती हैं, आप उन्हें Image.swift जोड़ सकते हैं ताकि आपको फिर से git merge होने के बाद संघर्षों का समाधान न करना पड़े।

मैं स्विफ्टजेन चरण के निर्माण के लिए इनपुट / आउटपुट फाइलें निर्दिष्ट करने की आवश्यकता पर भी ध्यान आकर्षित करना चाहूंगा यदि आपकी परियोजना एक्सकोड न्यू बिल्ड सिस्टम का उपयोग करती है (यह एक्सकोड 10 के साथ डिफ़ॉल्ट बिल्ड सिस्टम है)। इनपुट फ़ाइलों की सूची में, आपको उन सभी फाइलों को निर्दिष्ट करना होगा जिनके आधार पर कोड उत्पन्न होता है। हमारे मामले में, यह स्क्रिप्ट, कॉन्फ़िग, टेम्प्लेट, .strings और .xcassets फ़ाइलें ही है:

 $(SRCROOT)/SwiftGen/runswiftgen.sh $(SRCROOT)/SwiftGen/swiftgen.yml $(SRCROOT)/SwiftGen/Templates/ImageAssets.stencil $(SRCROOT)/SwiftGen/Templates/LocalizableStrings.stencil $(SRCROOT)/SwiftGenExample/en.lproj/Localizable.strings $(SRCROOT)/SwiftGenExample/Assets.xcassets 

आउटपुट फाइलों में हम उन फ़ाइलों को रखते हैं जिनमें SwiftGen कोड उत्पन्न करता है:

 $(SRCROOT)/SwiftGenExample/Image.swift $(SRCROOT)/SwiftGenExample/Localization.swift 

इन फ़ाइलों का संकेत आवश्यक है ताकि निर्माण प्रणाली यह तय कर सके कि फाइलों में बदलाव की मौजूदगी या अनुपस्थिति के आधार पर स्क्रिप्ट को चलाया जा सकता है या नहीं, और प्रोजेक्ट की असेंबली में इस स्क्रिप्ट को किस बिंदु पर निष्पादित किया जाना चाहिए।

परिणाम

प्रोजेक्ट संसाधनों के साथ काम करते समय हमारी लापरवाही से बचाने के लिए स्विफ्टगैन एक अच्छा उपकरण है। इसके साथ, हम स्वचालित रूप से एप्लिकेशन संसाधनों तक पहुंचने के लिए कोड तैयार करने में सक्षम थे और कंपाइलर के लिए संसाधनों की प्रासंगिकता की जांच करने पर काम का हिस्सा स्थानांतरित कर दिया, जिसका अर्थ है कि हमारे काम को थोड़ा सरल करना। इसके अलावा, हमने Xcode प्रोजेक्ट स्थापित किया ताकि टूल के साथ आगे का काम अधिक सुविधाजनक हो।

पेशेवरों:

1. परियोजना संसाधनों को नियंत्रित करना आसान।
2. टाइपोस की त्रुटियां कम हो जाती हैं, ऑटो-प्रतिस्थापन का उपयोग करना संभव हो जाता है।
3. संकलन चरण में त्रुटियों की जाँच की जाती है।

विपक्ष:

1. Localizable.stringsdict के लिए कोई समर्थन नहीं।
2. जिन संसाधनों का उपयोग नहीं किया जाता है, उन पर ध्यान नहीं दिया जाता है।

इसका पूरा उदाहरण जीथब पर देखा जा सकता है