spring-boot
पैकेज स्कैनिंग

परिचय

पैरामीटर

@SpringBootApplication

अच्छे स्वचालित पैकेज स्कैनिंग के लिए स्प्रिंग बूट का उपयोग करके अपने कोड को संरचना करने का सबसे बुनियादी तरीका @SpringBootApplication एनोटेशन का उपयोग @SpringBootApplication । यह एनोटेशन अपने आप में 3 अन्य एनोटेशन प्रदान करता है जो स्वचालित स्कैनिंग में मदद करता है: @SpringBootConfiguration , @EnableAutoConfiguration , @ComponentScan ( Parameters सेक्शन में प्रत्येक एनोटेशन के बारे में अधिक जानकारी)।

@SpringBootApplication को @SpringBootApplication से मुख्य पैकेज में रखा जाएगा और अन्य सभी घटकों को इस फ़ाइल के तहत संकुल में रखा जाएगा:

com
 +- example
     +- myproject
         +- Application.java (annotated with @SpringBootApplication)
         |
         +- domain
         |   +- Customer.java
         |   +- CustomerRepository.java
         |
         +- service
         |   +- CustomerService.java
         |
         +- web
             +- CustomerController.java

जब तक अन्यथा उल्लेख किया है, वसंत बूट का पता लगाता है @Configuration , @Component , @Repository , @Service , @Controller , @RestController एनोटेशन स्कैन किया संकुल के तहत स्वचालित रूप से ( @Configuration और @RestController उठाया जा रहा है, क्योंकि वे द्वारा एनोटेट @Component और @Controller तदनुसार )।

मूल कोड उदाहरण:

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
}

संकुल / कक्षाएं स्पष्ट रूप से सेट करना

संस्करण 1.3 के बाद से आप भी सेट करके स्कैन विशिष्ट संकुल के लिए वसंत बूट बता सकते हैं scanBasePackages या scanBasePackageClasses में @SpringBootApplication के बजाय निर्दिष्ट करने @ComponentScan ।

1. @SpringBootApplication(scanBasePackages = "com.example.myproject") - स्कैन करने के लिए बेस पैकेज के रूप में com.example.myproject सेट करें।
2. @SpringBootApplication(scanBasePackageClasses = CustomerController.class) - के प्रकार के लिए सुरक्षित विकल्प scanBasePackages के पैकेज सेट CustomerController.java , com.example.myproject.web , के रूप में आधार पैकेज स्कैन करने के लिए।

ऑटो-कॉन्फ़िगरेशन को छोड़कर

एक और महत्वपूर्ण विशेषता विशिष्ट ऑटो विन्यास का उपयोग कर वर्गों को बाहर करने की क्षमता है exclude या excludeName ( excludeName संस्करण 1.3 के बाद से मौजूद हैं)।

1. @SpringBootApplication(exclude = DemoConfiguration.class) - ऑटो पैकेज स्कैनिंग से DemoConfiguration को बाहर कर DemoConfiguration ।
2. @SpringBootApplication(excludeName = "DemoConfiguration") - पूरी तरह से वर्गीकृत नाम का उपयोग करके वही करेगा।

@ComponentScan

अधिक जटिल पैकेज स्कैनिंग को कॉन्फ़िगर करने के लिए आप @ComponentScan का उपयोग कर सकते हैं। @ComponentScans भी एक कंटेनर एनोटेशन के रूप में कार्य करता है जो कई @ComponentScan एनोटेशन एकत्र करता है।

मूल कोड उदाहरण

@ComponentScan
public class DemoAutoConfiguration {
}

@ComponentScans({@ComponentScan("com.example1"), @ComponentScan("com.example2")})
public class DemoAutoConfiguration {
}

@ComponentScan जैसी कोई कॉन्फ़िगरेशन क्रियाओं के साथ @SpringBootApplication और इस एनोटेशन के साथ एनोटेट वर्ग के तहत सभी पैकेज स्कैन करना।

इस उदाहरण में मैं @ComponentScan कुछ उपयोगी गुणों के बारे में @ComponentScan :

1. basePackages - स्कैन करने के लिए विशिष्ट पैकेजों को बताने के लिए उपयोग किया जा सकता है।
2. useDefaultFilters - झूठे को यह विशेषता (चूक सही) की स्थापना क्या आप वाकई वसंत नहीं स्कैन करता है बना सकते हैं द्वारा @Component , @Repository , @Service , या @Controller स्वचालित रूप से।
3. includeFilters - पैकेज स्कैनिंग में शामिल करने के लिए विशिष्ट वसंत एनोटेशन / regex पैटर्न शामिल करने के लिए इस्तेमाल किया जा सकता।
4. excludeFilters - विशिष्ट वसंत एनोटेशन / regex पैटर्न बाहर करने के लिए पैकेज स्कैनिंग में शामिल करने के लिए इस्तेमाल किया जा सकता।

कई और विशेषताएं हैं लेकिन पैकेज स्कैनिंग को अनुकूलित करने के लिए उन का सबसे अधिक उपयोग किया जाता है।

अपना स्वयं का ऑटो-कॉन्फ़िगरेशन बनाना

स्प्रिंग बूट बहुत सारे पूर्व-निर्मित ऑटो-कॉन्फ़िगरेशन पैरेंट प्रोजेक्ट्स पर आधारित है। आपको पहले से ही स्प्रिंग बूट स्टार्टर प्रोजेक्ट्स से परिचित होना चाहिए।

आप निम्न आसान चरणों को अपनाकर अपनी स्टार्टर परियोजना आसानी से बना सकते हैं:

1. डिफ़ॉल्ट बीन्स को परिभाषित करने के लिए कुछ @Configuration कक्षाएं बनाएं। आपको अनुकूलन की अनुमति देने के लिए बाहरी गुणों का यथासंभव उपयोग करना चाहिए और ऑटो-कॉन्फ़िगरेशन हेल्पर एनोटेशन जैसे @AutoConfigureBefore , @AutoConfigureAfter , @ConditionalOnBean , @ConditionalOnMissingBean आदि का उपयोग करने की कोशिश करनी @ConditionalOnMissingBean । आप आधिकारिक प्रलेखन स्थिति एनोटेशन में प्रत्येक एनोटेशन पर अधिक विस्तृत जानकारी पा सकते हैं।
2. एक स्वत: कॉन्फ़िगरेशन फ़ाइल / फ़ाइलें रखें जो सभी @Configuration कक्षाओं को एकत्रित करता है।
3. spring.factories नाम की एक फ़ाइल बनाएं और इसे src/main/resources/META-INF ।
4. में spring.factories , सेट org.springframework.boot.autoconfigure.EnableAutoConfiguration अल्पविराम के साथ संपत्ति अलग अपने के मूल्यों @Configuration कक्षाएं:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.mycorp.libx.autoconfigure.LibXAutoConfiguration,\
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration

इस पद्धति का उपयोग करके आप अपने स्वयं के ऑटो-कॉन्फ़िगरेशन कक्षाएं बना सकते हैं जिन्हें स्प्रिंग-बूट द्वारा चुना जाएगा। स्प्रिंग-बूट स्वचालित रूप से स्प्रिंग के लिए सभी spring.factories / spring.factories निर्भरताओं को spring.factories करता है। यदि यह एक मिल जाए, तो यह ऑटो-कॉन्फ़िगरेशन प्रक्रिया में निर्दिष्ट सभी @Configuration कक्षाएं जोड़ता है।

सुनिश्चित करें कि आपके auto-configuration स्टार्टर प्रोजेक्ट में spring boot maven plugin क्योंकि यह परियोजना को एक निष्पादन योग्य JAR के रूप में पैकेज करेगा और spring.factories द्वारा लोड नहीं किया जाएगा जैसा कि इरादा है - वसंत बूट आपके spring.factories को खोजने में सक्षम नहीं होगा। आपके कॉन्फ़िगरेशन को लोड नहीं करेगा