👩🏾‍🤝‍👩🏼 🙀 🕳️ IOS मोबाइल बैंकिंग एप्लिकेशन में SwiftLint स्टेटिक कोड विश्लेषक का उपयोग करना 🤰🏿 🌊 🎎

ओलेग इवानोव, दूरस्थ सेवा चैनलों के लिए सक्षमता केंद्र के प्रमुख

सभी को नमस्कार! जैसा कि "ICD मोबाइल बैंक: विकास इतिहास" लेख में वादा किया गया था, आज मैं स्टेटिक कोड एनालाइज़र और बैंक के iOS मोबाइल अनुप्रयोगों में उनके आवेदन के अनुभव के बारे में बात करना चाहता हूं।

आइए उस लक्ष्य को निर्धारित करें जिसे हम इस टूलकिट का उपयोग करके प्राप्त करना चाहते हैं:

त्रुटियों और कमियों का शीघ्र पता लगाना;
Code Style ( — , ).

हमारे लक्ष्यों को प्राप्त करने का एक सामान्य तरीका कोड - कोड की समीक्षा को मैन्युअल रूप से जांचना है ।

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

यहाँ स्थैतिक कोड विश्लेषक हमारी सहायता के लिए आते हैं।

स्टेटिक कोड एनालाइजर- कार्यक्रमों के स्रोत कोड में त्रुटियों और कमियों का पता लगाने के लिए एक स्वचालित प्रक्रिया शुरू करें।

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

हमारी iOS परियोजनाओं में एक स्थिर कोड विश्लेषक के रूप में हम SwiftLint का उपयोग करते हैं।

SwiftLint एक स्विफ्ट कोड ऑटो-चेकिंग उपयोगिता है जो एक परियोजना के निर्माण चरण के दौरान चलती है। उपयोगिता में आपके कस्टम नियमों के साथ इस सेट को पूरक करने की क्षमता के साथ नियमों का एक सेट है। टूल का उपयोग कोड स्टाइल के अनुपालन के लिए भी किया जाता है।

एप्लिकेशन में कोड स्टाइल का पालन करना क्यों महत्वपूर्ण है?
जब आप किसी प्रोजेक्ट पर एक डेवलपर होते हैं, तो सब कुछ सरल होता है: आप अपनी शैली में लिखते हैं और आप इस तरह से कोड को वहन कर सकते हैं:

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

उपकरण से परिचित होने के लिए, मैं आधिकारिक दस्तावेज पढ़ने की सलाह देता हूं ।

SwiftLint को स्थापित करना सरल है:

फली 'SwiftLint' को प्रोजेक्ट पॉडफाइल में जोड़ें
प्रोजेक्ट में एक नया "रन स्क्रिप्ट चरण" जोड़ें।
```
"${PODS_ROOT}/SwiftLint/swiftlint"
```
SwiftLint .swiftlint.yml
.swiftlint.yml , SwiftLint

यदि SwiftLint एम्बेडिंग प्रोजेक्ट में पहले से ही कोड शामिल है, तो आपको धैर्य रखना होगा और सभी SwiftLint सिफारिशों को व्यवस्थित रूप से ठीक करना होगा। वह सिफारिशों के बारे में व्यापक सुझावों के साथ सामान्य त्रुटि और चेतावनी प्रदर्शित करता है।

कोष्ठक में भी, यह उस नियम का नाम प्रदर्शित करता है जिसने सिफारिश शुरू की थी (संचालक_सेज_व्हाइटस्पेस) ।

इस स्थिति में, ये हैं:

ऑपरेटर उपयोग व्हाट्सएप
ऑपरेटरों को एक ही स्थान से घिरा होना चाहिए।

सही कोड:

अनुशंसित कोड:

: प्रत्येक नियम विशेषताओं का एक सेट है

पहचानकर्ता : operator_usage_whitespace
डिफ़ॉल्ट रूप से सक्षम किया गया : विकलांग
समर्थन स्वत: सुधार :हां
प्रकार : शैली
विश्लेषक नियम : स्विफ्ट कंपाइलर का कोई
न्यूनतम संस्करण नहीं : 3.0.0
डिफ़ॉल्ट कॉन्फ़िगरेशन : चेतावनी "स्विफ्ट कंपाइलर का न्यूनतम संस्करण" पर

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

।

नीचे मैं उन नियमों को प्रस्तुत करूंगा जिन्हें हमने अपनी टीम में चुना है, आप उन्हें अपनी परियोजना बनाने के लिए एक उदाहरण के रूप में उपयोग कर सकते हैं।

हमने सभी नियमों को कार्यात्मक और शैलीगत में विभाजित किया है - हां, हां, हां, और प्रत्येक घुंघराले ब्रेस के अंदर एक स्थान, और समापन पैरामीटर उद्घाटन कोष्ठक के समान लाइन पर होना चाहिए, और ... :)। मैं नियमों को चित्रित नहीं करता, आप ऊपर दिए गए लिंक का उपयोग करके उनके बारे में आसानी से जानकारी प्राप्त कर सकते हैं।

कार्यात्मक :

- private_outlet
- force_unwrapping
- force_cast
- force_try
- strong_iboutlet
- private_action
- block_based_kvo
- contains_over_first_not_nil
- discarded_notification_center_observer
- discouraged_direct_init
- discouraged_object_literal
- discouraged_optional_boolean
- discouraged_optional_collection
- duplicate_imports
- dynamic_inline
- empty_count
- empty_parameters
- empty_parentheses_with_trailing_closure
- empty_string
- explicit_enum_raw_value
- function_default_parameter_at_end
- generic_type_name
- identical_operands
- implicit_getter
- is_disjoint
- notification_center_detachment
- nsobject_prefer_isequal
- redundant_set_access_control
- unused_capture_list

की शैली :

- unneeded_parentheses_in_closure_argument
- let_var_whitespace
- yoda_condition
- पेट
- अल्पविराम
- closure_parameter_position
- closure_spacing
- collection_alignment
- leading_whitespace
- मार्क
- opening_brace
- operator_usage_whitespace
- operator_whitespace
- protocol_property_accessors_order
- return_arrow_whitespace
- switch_case_alignment
- statement_position
- trailing_comma
- trailing_newline
- unneeded_break_in_switch
- custom_rules
- closure_end_indentation
- file_name_no_space
- unowned_variable_capture
- no_space_in_method_call
- contains_over_filter_count
- contains_over_filter_is_empty
- contains_over_range_nil_comparison
- duplicate_enum_cases
- empty_collection_literal

भी एक लक्ष्य SwiftLint की हम विन्यास फाइल .swiftlint.yml में उपयुक्त सेटिंग जोड़कर हमारे कोड आधार के साथ ही सूची चुना है:

शामिल हैं:

- <कोड बेस निर्देशिका>

हम अमान्यता के लिए अपने नियम बनाया है प्रिंट कार्य। प्रिंट एक बहुत कठिन ऑपरेशन है। कॉन्फ़िगरेशन के माध्यम से .swiftlint.yml फ़ाइल:

custom_rules:
  disable_print:
    included: ".*\\.swift"
    name: "print usage"
    regex: "((\\bprint)|(Swift\\.print))\\s*\\("
    message: "Prefer os_log over print"
    severity: error

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

func logApp(level: Constants.LogLevel, items: Any...) {
    if Constants.logLevel == .none {
        return
    }
    
    if level.rawValue <= Constants.logLevel.rawValue {
        // swiftlint:disable disable_print
        if let strings = items as? [String] {
            for string in strings {
                print(string)
            }
        } else {
            print(items)
        }
        // swiftlunt:enable disable_print
    }

लेकिन प्रिंट फ़ंक्शन का उपयोग करने के लिए, हमें एक विशेष निर्देश के साथ चिह्नित कोड ब्लॉक पर अपने स्वयं के नियमों को अनदेखा करने के लिए स्विफ्टलिंट का उपयोग करके अपने लॉगिंग फ़ंक्शन में इसकी कॉल को बंद करना पड़ा।

// swiftlint:disable disable_print
// swiftlunt:enable disable_print

SwiftLint में अपने स्वयं के नियमों को अनदेखा करने की क्षमता है:

// swiftlint:disable <rule1 [rule2 rule3…]>
<,   SwiftLint   rule1 [rule2 rule3…]>
// swiftlunt:enable <rule1 [rule2 rule3…]>

या

// swiftlint:disable all
<,   SwiftLint   >
// swiftlint:enable all

इस अवसर का उपयोग करें, पूरी तरह से जानते हैं कि यह आवश्यक है!

अंत में, मैं ध्यान देता हूं : हमारी टीम में स्विफ्टलिंट के उपयोग ने मैनुअल कोड समीक्षा की लागत को 20% कम कर दिया। अब हमारे समीक्षक विशिष्ट त्रुटियों (फोर्स कास्ट, आदि), कोड स्टाइल पर ध्यान नहीं देते हैं और नए कोड की जांच करने पर पूरी तरह से ध्यान केंद्रित कर सकते हैं। जिसने समग्र टीम दक्षता में काफी वृद्धि की (ऐसी त्रुटियों को ठीक करने की कोई आवश्यकता नहीं है, ये योग्य कर्मचारी हैं, जिनका समय बहुत महत्वपूर्ण है)।

सब! अब SwiftLint हमेशा तुम्हारे साथ है :)

IOS मोबाइल बैंकिंग एप्लिकेशन में SwiftLint स्टेटिक कोड विश्लेषक का उपयोग करना

More articles: