एपीआई को सरल रखें

मैं एक मामले के बारे में बात करना चाहता हूं जब हम एक साधारण एपीआई के साथ आने में कामयाब रहे, जब पहली बार में यह काम जटिल लग रहा था।


हाल ही में हमें एक टास्क मिला। हमें हर उपयोगकर्ता कार्रवाई को लॉग करना था जिसे वह हमारी वेबसाइट पर कर सकता है। दूसरे शब्दों में, हमें कुछ प्रकार के वर्ग (एपीआई) बनाने की आवश्यकता थी, जो हमारे सिस्टम में लगभग सभी नियंत्रकों में आसानी से उपयोग किए जा सकते हैं। कठिनाई यह थी कि, कार्रवाई के आधार पर, विभिन्न अतिरिक्त मापदंडों को लॉग इन किया जाना चाहिए।

इस कार्य के साथ, हमें कुछ डेवलपर्स द्वारा तैयार आधा-समाधान मिला।

पहला फैसला

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

private void logUserAction(User user) throws Exception { UserActionModel model = new UserActionModel(); model.setAction("Buy a ticket"); List<String> values = new ArrayList<String>(); values.add("PersonCode"); values.add("UserName"); values.add("ContactInformation.EmailAddress"); values.add("ContactInformation.Language"); model.setParams(LogUtil.getParamsWithFieldNames(user, values)); LogUtil.log(model); } 

यह शायद स्पष्ट है कि LogUtil.getParamsWithFieldNames कैसे काम करता है। उपयोगकर्ता ऑब्जेक्ट और स्ट्रिंग्स की एक सूची प्राप्त करने के बाद, यह संबंधित गेटर्स को कॉल करता है: user.getPersonCode (), user.getUserName (), आदि।

आकर्षक

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

लेकिन

लेकिन आपको पता है क्या? आपको इस बुद्धिमत्ता की ज़रूरत है, जैसे कुत्ते का पाँचवाँ पैर!
एक दूसरे के लिए रुकें और सोचें: क्या यह आसान हो सकता है? बेशक आप कर सकते हैं!

तो हमें यहां प्रतिबिंब का उपयोग करने की आवश्यकता क्यों है? संकलक जो लाभ देता है, उसे क्यों खो देते हैं - यदि आप अचानक एक लिखने वाले से गलती करते हैं तो यह तुरंत एक त्रुटि पा सकता है? अपवाद से निपटने के लिए परेशान क्यों? क्यों न केवल गेटर्स का उपयोग करें?

और हाँ

नतीजतन, समाधान सरल, कम और अधिक विश्वसनीय था। यहाँ एक विशिष्ट नियंत्रक कोड अब कैसा दिखता है:

  Action action = new Action("Buy a ticket") .add("PersonCode", user.getPersonCode()) .add("PersonName", user.getPersonName()) .add("EmailAddress", user.getContactInformation().getEmailAddress()) .add("Language", user.getContactInformation().getLanguage()); LogUtil.log(action); 

वहां तुम जाओ। जितना सरल हो सके।
पुराने आइंस्टीन के रूप में वसीयत की गई।