🧜🏽 👨🏿‍⚖️ 🥂 एनोटेशन के साथ संकलन समय पर हैश तार 🚅 🔌 🤞🏽

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

public final class HandlerConst { public static final String ACTION_LOGIN = "com.example.app.ACTION_LOGIN"; }

यह डिबगिंग के लिए सुविधाजनक है, लेकिन कोड की गुणवत्ता को बहुत कम करता है। मैं उदाहरण के लिए, कार्यक्रम के रिलीज में इस लाइन के बजाय इसके एमडी 5 हैश को देखना चाहूंगा।

 public final class HandlerConst { public static final String ACTION_LOGIN = "7f315954193d1fd99b017081ef8acdc3"; }

कट के तहत, यह वर्णित है कि हाथ में साइकिल की मदद से इस व्यवहार को कैसे प्राप्त किया जाए।

कुछ गीत

मुझे यह जानकर बहुत आश्चर्य हुआ कि प्रोगार्ड तार के साथ काम नहीं करता है। आधिकारिक वेबसाइट पर प्रलेखन से यह पता लगाना संभव था कि एक उन्नत भुगतान संस्करण तार के साथ काम करने में सक्षम है। यह केवल यह है कि यह प्रोग्राम को चालू करते समय मूल संस्करण में डिक्रिप्ट करने के लिए स्ट्रिंग्स को एन्क्रिप्ट करता है। मुझे इसके एमडी 5 मूल्य में एक स्ट्रिंग को बदलने का कोई समाधान नहीं मिला।
इस समस्या का हल खोजने के प्रयासों ने मुझे C ++ कंपाइलर के अनुकूलन के चमत्कार को प्रदर्शित करने वाले एक लेख की ओर अग्रसर किया: संकलन-समय में CRC32 लाइनों का संकलन । लेकिन जावा में, एक समान विधि ने नहीं लिया। ProGuard ने तरीकों को थोड़ा कम कर दिया, लेकिन एक स्ट्रिंग से बाइट्स की एक सरणी प्राप्त करने पर ठोकर खाई।
उसके बाद, मैंने फैसला किया कि मैं समय को बर्बाद करने की कोशिश नहीं करूंगा और बस अपने हाथों से समस्या को हल करूंगा:

 public final class HandlerConst { public static final String ACTION_LOGIN; static { if (BuildConfig.DEBUG) ACTION_LOGIN = "com.example.app.ACTION_LOGIN"; else ACTION_LOGIN = "7f315954193d1fd99b017081ef8acdc3"; } }

लेकिन जब मैंने हब पर कस्टम एनोटेशन प्रीप्रोसेसर लेख देखा - इंटेलीज आईडीईए में एक एंड्रॉइड-आधारित एप्लिकेशन और कॉन्फ़िगरेशन बनाना , मुझे एहसास हुआ कि यह मेरी समस्या का समाधान था।

एनोटेशन लागू करें

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

एनोटेशन का वर्णन करें;
AbstractProcessor वर्ग के वंशज को लागू करें, जो हमारे एनोटेशन की प्रक्रिया करेगा;
कंपाइलर को बताएं कि हमारे प्रोसेसर को कहां देखना है।

एक एनोटेशन विवरण इस तरह दिखाई दे सकता है:

 package com.example.annotation; @Target({ElementType.FIELD}) @Retention(RetentionPolicy.SOURCE) public @interface Hashed { String method() default "MD5"; }

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

एक एनोटेशन हैंडलर javax.annotation.processing.AbstractProcessor से इनहेरिट करता है । न्यूनतम हैंडलर वर्ग इस तरह दिखता है:

 package com.example.annotation; @SupportedAnnotationTypes(value = {"com.example.annotation.Hashed"}) @SupportedSourceVersion(SourceVersion.RELEASE_7) public class HashedAnnotationProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { return false; } }

SupportedAnnotationTypes - एनोटेशन वर्गों के नामों को परिभाषित करता है जो हमारे प्रोसेसर द्वारा संसाधित किए जाएंगे।
SupportedSourceVersion - स्रोत का समर्थित संस्करण। मुद्दा यह है कि प्रोसेसर एनोटेशन को संसाधित करते समय भाषा के नए संस्करणों में दिखाई देने वाले भाषा निर्माणों को नहीं तोड़ता है।
इन एनोटेशन के बजाय, आप getSupportedAnnotationTypes और getSupportedSourcenotersion तरीकों को ओवरराइड कर सकते हैं।
प्रक्रिया विधि को कच्चे समर्थित एनोटेशन की एक सूची और संकलक के साथ बातचीत करने के लिए एक वस्तु मिलती है। यदि विधि गलत आती है, तो संकलक अगले प्रोसेसर पर प्रसंस्करण के लिए एनोटेशन पास करता है, जो इस प्रकार के एनोटेशन का समर्थन करता है। यदि विधि ने सच्चाई लौटा दी, तो एनोटेशन को संसाधित माना जाता है और कहीं और नहीं मिलेगा। यह ध्यान में रखा जाना चाहिए ताकि गलती से अन्य लोगों के एनोटेशन को नाखून न दें।
यदि किसी प्रोसेसर के संचालन के दौरान स्रोत कोड बदल गए हैं या जोड़े गए हैं - संकलक अगले पास पर जाएगा।

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

  private JavacProcessingEnvironment javacProcessingEnv; private TreeMaker maker; @Override public void init(ProcessingEnvironment procEnv) { super.init(procEnv); this.javacProcessingEnv = (JavacProcessingEnvironment) procEnv; this.maker = TreeMaker.instance(javacProcessingEnv.getContext()); }

अब हमें बस अपने एनोटेट क्षेत्रों पर पुनरावृति करना है और स्ट्रिंग स्थिरांक के मूल्यों को बदलना है। मैं संक्षेप में कोड देता हूं। लेख के अंत में GitHub से लिंक करें।

  @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { if ( annotations == null || annotations.isEmpty()) { return false; } for (TypeElement annotation : annotations) { //   ,      final Set<? extends Element> fields = roundEnv.getElementsAnnotatedWith(annotation); JavacElements utils = javacProcessingEnv.getElementUtils(); for (final Element field : fields) { // ,      . Hashed hashed = field.getAnnotation(Hashed.class); //     JCTree blockNode = utils.getTree(field); if (blockNode instanceof JCTree.JCVariableDecl) { //,       . JCTree.JCVariableDecl var = (JCTree.JCVariableDecl) blockNode; //  (    = ) JCTree.JCExpression initializer = var.getInitializer(); //      ,     : // "" + 1 // new String("new string") if ((initializer != null) && (initializer instanceof JCTree.JCLiteral)){ JCTree.JCLiteral lit = (JCTree.JCLiteral) initializer; //  String value = lit.getValue().toString(); try { MessageDigest md = MessageDigest.getInstance(hashed.method()); //      . md.update(value.getBytes("UTF-8")); byte[] hash = md.digest(); StringBuilder str = new StringBuilder(hash.length * 2); for (byte val : hash) { str.append(String.format("%02X", val & 0xFF)); } value = str.toString(); lit = maker.Literal(value); var.init = lit; } catch (NoSuchAlgorithmException e) { // :    } catch (UnsupportedEncodingException e) { // :   ?? } }else{ // :   . } } } } }

विधि में, हम एनोटेशन की सूची से गुजरते हैं (क्या हमें याद है कि सामान्य स्थिति में प्रोसेसर एनोटेशन से अधिक प्रक्रिया करता है?), प्रत्येक एनोटेशन के लिए हम तत्वों की एक सूची का चयन करते हैं। उसके बाद, जादू शुरू होता है। हम तत्वों को स्रोत वृक्ष में बदलने के लिए com.sun.tools.javac द्वारा प्रदान किए गए टूल का उपयोग करते हैं, जिसमें बड़ी संख्या में विशेषताएं हैं और, परंपरा से, रूसी-भाषा प्रलेखन की पूर्ण अनुपस्थिति। इसलिए, कृपया आश्चर्यचकित न हों कि इस पेड़ के साथ काम करने का कोड आदर्श से बहुत दूर है।
जब हमें JCTree.JCVariableDecl var ट्री के रूप में वेरिएबल डिक्लेरेशन मिला - हम यह सुनिश्चित कर सकते हैं कि यह एक स्ट्रिंग वेरिएबल है। मेरे मामले में, यह जाँच बैसाखी के साथ की गई है:

 if (!"String".equals(var.vartype.toString())){ // :     . continue; }

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

दूसरा दिलचस्प बिंदु यह है कि हम केवल लेख की शुरुआत से ही उदाहरण के समान लाइनों को संसाधित कर सकते हैं। बात यह है कि इस स्तर पर हम स्रोत पाठ के साथ काम कर रहे हैं। इसलिए, यदि कंस्ट्रक्टर में वैरिएबल को इनिशियलाइज़ किया जाता है, तो JCTree.JCExpression initializer = var.getInitializer (); हमें अशक्त कर देगा । यदि हम प्रपत्र के निर्माण को संसाधित करने का प्रयास करते हैं तो समान रूप से अप्रिय स्थिति निकल जाएगी:

 public String demo1 = new String("habrahabr"); public String demo2 = "habra"+"habr"; public String demo3 = "" + 1;

ऐसा करने के लिए, एक दूसरा चेक पेश किया जाता है (इनिशियलाइज़र इंस्टॉफ़ट JCTree.JCLiteral) । यह सभी वर्णित उदाहरणों को काट देगा, क्योंकि वे अपने शुद्ध रूप में शाब्दिक नहीं हैं और पेड़ में कई तत्वों की अभिव्यक्ति द्वारा प्रतिनिधित्व किया जाएगा।
आगे कोड स्पष्ट है। हम एक लाइन लेते हैं, हैश, रिप्लेस, आनन्द? नहीं।
टिप्पणियां कई स्थानों को इंगित करती हैं जहां स्पष्ट त्रुटियां होती हैं। और हमारे मामले में, उन्हें अनदेखा करना सही व्यवहार नहीं है। उपयोगकर्ता को त्रुटि के बारे में सूचित करने के लिए, हमें javax.annotation.processing.Messager ऑब्जेक्ट की आवश्यकता है। यह आपको एक चेतावनी, एक संकलन त्रुटि, या सिर्फ एक सूचना संदेश फेंकने की अनुमति देता है। उदाहरण के लिए, हम एक अमान्य हैश एल्गोरिथम की रिपोर्ट कर सकते हैं:

 catch (NoSuchAlgorithmException e) { javacProcessingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, String.format("Unsupported digest method %s", hashed.method()), field); }

यह समझा जाना चाहिए कि त्रुटि संदेश फेंकने से विधि का निष्पादन बाधित नहीं होता है। संकलन प्रक्रिया को बाधित करने से पहले संकलक कम से कम हमारी पद्धति के अंत का इंतजार करेगा। यह आपको उपयोगकर्ता को एनोटेशन लागू करने की सभी त्रुटियों को तुरंत दूर करने की अनुमति देता है। PrintMessage पद्धति का तीसरा तर्क हमें उस ऑब्जेक्ट को निर्दिष्ट करने की अनुमति देता है जिस पर हमने ठोकर खाई थी। यह अनिवार्य नहीं है, लेकिन जीवन को बहुत सुविधाजनक बनाता है।

कनेक्ट एनोटेशन प्रोसेसर

यह संकलक को बताने के लिए बना हुआ है कि हम फाड़ के लिए एनोटेशन स्वीकार करने के लिए तैयार हैं। कई लेख निर्देश के साथ आते हैं कि अपने प्रोसेसर को <विकास पर्यावरण नाम> से कैसे जोड़ा जाए। जाहिर है, यह प्राचीन काल में वापस जाता है, जब कारीगरों द्वारा घुटनों पर ऐसी चीजें की जाती थीं। हालांकि, काफी समय पहले, प्रसंस्करण एनोटेशन का तंत्र javac का हिस्सा रहा है और वास्तव में, हमारे वर्ग हैंडलर javac के लिए प्लग-इन है। इसका मतलब यह है कि हम अपने एनोटेशन को बिना मानकता के साथ किसी भी वातावरण में कनेक्ट कर सकते हैं।
हमें मेटा- इन निर्देशिका में सेवाओं की एक उपनिर्देशिका बनाने की आवश्यकता होगी, और इसमें javax.annotation.processing.Processor फ़ाइल। फ़ाइल में ही, हमें अपने प्रोसेसर वर्गों की एक सूची डालनी होगी। विशिष्ट मामले में, com.example.annotation.HashedAnnotationProcessor । और वह यह है। अब हम अपने पुस्तकालय का निर्माण कर रहे हैं जिसमें एनोटेशन और उसका प्रोसेसर है। हम इस लाइब्रेरी को प्रोजेक्ट से जोड़ते हैं। और यह काम करता है।
उसी समय, न तो पुस्तकालय, और न ही एनोटेशन के अवशेष संकलित कोड में गिर जाएंगे।

के उपयोग

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

 @SupportedOptions({"Hashed"}) public class HashedAnnotationProcessor extends AbstractProcessor { private boolean enable = true; @Override public void init(ProcessingEnvironment procEnv) { //  java.util.Map<java.lang.String,java.lang.String> opt = javacProcessingEnv.getOptions(); if (opt.containsKey(ENABLE_OPTIONS_NAME) && opt.get(ENABLE_OPTIONS_NAME).equals("disable")){ enable = false; } } @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { if (!enable){ javacProcessingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Annotation Hashed is disable"); return false; } //... } }

हमने घोषणा की कि हम "हशेड" विकल्प की प्रतीक्षा कर रहे हैं और यदि यह "अक्षम" है, तो हम कुछ भी नहीं करते हैं और उपयोगकर्ता को जानकारी प्रदर्शित करते हैं। Diagnostic.Kind.NOTE जैसे संदेश सूचनात्मक हैं और डिफ़ॉल्ट सेटिंग्स पर हैं, कई विकास वातावरण इन संदेशों को बिल्कुल नहीं दिखाएंगे।
उसी समय, हम संकलक को सूचित करते हैं कि उन्होंने एनोटेशन की प्रक्रिया शुरू नहीं की थी। यदि सिस्टम में अभी भी प्रोसेसर हैं जो इस प्रकार के एनोटेशन को प्रोसेस करते हैं, या टाइप को पार्स नहीं करते हैं, तो वे हमारा एनोटेशन प्राप्त कर सकते हैं। यह सच है, मैं उस आदेश के बारे में बिल्कुल कुछ नहीं कह सकता जिसमें संकलक एनोटेशन को निपटाने की कोशिश करेगा। अब तक, हमारे पास केवल हमारी लाइब्रेरी है और वास्तव में एक एनोटेशन है - यह प्रासंगिक नहीं है, लेकिन यदि आप एनोटेशन के कई पुस्तकालयों का उपयोग करते हैं, तो सरफेसिंग नुकसान के लिए तैयार रहें।
यह इस विकल्प को संकलक को पास करना बाकी है। प्रोसेसर के लिए विकल्प ए-स्विच के साथ संकलक को दिए जाते हैं। हमारे मामले में, "-हेडेड = अक्षम"।
यह सब कुछ सही समय पर ग्रेडल को इस विकल्प को स्थानांतरित करने के लिए मजबूर करने के लिए है। और बैसाखी फिर से:

 tasks.withType(JavaCompile) { if (name == "compileDebug"){ options.compilerArgs << "-AHashed=disable" } }

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

  @Hashed public static final String demo1 = "habr"; @Hashed (method="SHA-1") public static final String demo2 = "habrahabr"; @Hashed(method="SHA-256") public static final String demo3 = "habracadabra";

विधि समर्थित MessageDigest में से कोई भी हो सकती है।

परिणाम

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

एनोटेशन के साथ संकलन समय पर हैश तार

कुछ गीत

एनोटेशन लागू करें

कनेक्ट एनोटेशन प्रोसेसर

के उपयोग

परिणाम

More articles: