Cycle Finder टूल

इस्तेमाल

यहां दो क्लास, Foo और Bar के बीच के साइकल का एक आसान उदाहरण दिया गया है.

cat Foo.java
package mypkg;
public class Foo {
  Bar myBar;
}

cat Bar.java
package mypkg;
public class Bar {
  Foo myFoo;
}

cycle_finder Foo.java Bar.java
acceptAST: mypkg/Bar.java
acceptAST: mypkg/Foo.java

***** Found reference cycle *****
Bar -> (field myFoo with type Foo)
Foo -> (field myBar with type Bar)
----- Full Types -----
Lmypkg/Bar;
Lmypkg/Foo;

1 CYCLES FOUND.

आउटपुट में आपको पार्स की जा रही हर JavaScript फ़ाइल के लिए acceptAST दिखेगा. यह सिर्फ़ जानकारी देने वाला लॉगिंग है.

हर साइकल के लिए, दो सूचियां प्रिंट की जाएंगी. पहली सूची में साइकल का ब्यौरा होता है. रेफ़रंस ग्राफ़ में हर लाइन में एक किनारे होता है. किनारे के ब्यौरे में, ऑरिजिन का टाइप दिखेगा. इसके बाद, यह बताया जाएगा कि ऑरिजिन टाइप, टारगेट टाइप से किस तरह जुड़ा हो सकता है.

Full Types में दूसरी सूची में, साइकल के हर टाइप के लिए यूनीक टाइप की कुंजियां दिखाई जाती हैं. यह इसलिए फ़ायदेमंद है, क्योंकि इससे हर तरह का पूरा पैकेज उपलब्ध होता है.

सूचियां रोकें

कुछ ऐसे साइकल का पता चला है जिनमें सुधार करने की ज़रूरत नहीं होगी. ऐसा इसलिए हो सकता है, क्योंकि साइकल में लंबे समय से मौजूद ऐसे ऑब्जेक्ट हैं जिन्हें हटाने की ज़रूरत नहीं है. या फिर यह टूल कुछ खास फ़ील्ड के टाइप के आधार पर, सैद्धांतिक चक्र का पता लगा सकता है. ऐसा इसलिए, क्योंकि इसमें शामिल ऑब्जेक्ट कभी भी साइकल नहीं बनाएंगे. ऐसे मामलों में हम इन साइकल की रिपोर्ट नहीं करने के लिए, 'सप्रेस सूची' फ़ाइलों का इस्तेमाल कर सकते हैं.

यह टूल, --suppress-list विकल्प का इस्तेमाल करके, 'सप्रेस वाली सूची' में मौजूद फ़ाइलों को स्वीकार करता है. सप्रेस-लिस्ट फ़ाइलें, एक लाइन वाली सामान्य टेक्स्ट फ़ाइलें होती हैं. सप्रेस-लिस्ट एंट्री, नीचे दिए गए उदाहरण में बताए गए चार फ़ॉर्म में से किसी एक का इस्तेमाल कर सकती हैं. हमारा सुझाव है कि आप सप्रेस-लिस्ट जोड़ते समय, सटीक जानकारी दें, ताकि सही साइकल को दबाने से बचा जा सके. '#' का इस्तेमाल करके, टिप्पणियां जोड़ी जा सकती हैं वर्ण.

# Specifies that "fieldA" in ClassA will not refer to any object that is a subtype of ClassB.
FIELD my.pkg.ClassA.fieldA my.pkg.ClassB

# Suppresses all cycles containing "fieldA" in ClassA.
FIELD my.pkg.ClassA.fieldA

# Suppresses all cycles containing any field of ClassA.
TYPE my.pkg.ClassA

# Suppress all cycles containing the Inner's outer reference to ClassA.
OUTER my.pkg.ClassA.Inner

# Suppress all cycles containing the outer reference from an anonymous class declared in myMethod.
OUTER my.pkg.ClassA.myMethod.$

# Suppresses all cycles containing any type in package "my.pkg".
NAMESPACE my.pkg