microconfig.io को साथ सजिलै संग microservice कन्फिगरेसनहरू व्यवस्थापन गर्नुहोस्

माइक्रो सेवाहरूको विकास र पछिको सञ्चालनमा मुख्य समस्याहरू मध्ये एक तिनीहरूको उदाहरणहरूको सक्षम र सही कन्फिगरेसन हो। मेरो विचारमा, नयाँ फ्रेमवर्कले यसमा मद्दत गर्न सक्छ microconfig.io। यसले तपाईंलाई केही नियमित एप्लिकेसन कन्फिगरेसन कार्यहरू राम्ररी राम्ररी समाधान गर्न अनुमति दिन्छ।

यदि तपाईंसँग धेरै माइक्रोसर्भिसेसहरू छन्, र तिनीहरूमध्ये प्रत्येकको आफ्नै कन्फिगरेसन फाइल/फाइलहरू छन् भने, तिनीहरूमध्ये एउटामा त्रुटि हुने उच्च सम्भावना छ, जुन उचित सीप र लगिङ प्रणाली बिना समात्न धेरै गाह्रो हुन सक्छ। मुख्य कार्य जुन फ्रेमवर्कले आफैंको लागि सेट गर्दछ डुप्लिकेट इन्स्ट्यान्स कन्फिगरेसन प्यारामिटरहरू कम गर्नु हो, जसले गर्दा त्रुटि थप्ने सम्भावना कम हुन्छ।

एउटा उदाहरण हेरौं। मानौं हामीसँग कन्फिगरेसन फाइलको साथ एउटा साधारण अनुप्रयोग छ याम। यो कुनै पनि भाषामा कुनै पनि माइक्रोसेवा हुन सक्छ। यस सेवामा फ्रेमवर्क कसरी लागू गर्न सकिन्छ हेरौं।

तर पहिले, अधिक सुविधाको लागि, Idea IDE मा एउटा खाली प्रोजेक्ट सिर्जना गरौं, यसमा microconfig.io प्लगइन स्थापना गरेपछि:

हामीले प्लगइन लन्च कन्फिगरेसन सेट अप गर्यौं, तपाईंले माथिको स्क्रिनसटमा जस्तै, पूर्वनिर्धारित कन्फिगरेसन प्रयोग गर्न सक्नुहुन्छ।

हाम्रो सेवालाई अर्डर भनिन्छ, त्यसपछि नयाँ परियोजनामा ​​हामी समान संरचना सिर्जना गर्नेछौं:

सेवा नामको साथ फोल्डरमा कन्फिगरेसन फाइल राख्नुहोस् - application.yaml। सबै माइक्रोसेवाहरू कुनै न कुनै प्रकारको वातावरणमा सुरू हुन्छन्, त्यसैले, सेवाको लागि कन्फिगरेसन सिर्जना गर्नुको साथै, वातावरण आफैंलाई वर्णन गर्न आवश्यक छ: यसको लागि हामी फोल्डर सिर्जना गर्नेछौं। envs र यसमा हाम्रो कार्य वातावरणको नामको साथ फाइल थप्नुहोस्। यसरी, फ्रेमवर्कले वातावरणमा सेवाहरूको लागि कन्फिगरेसन फाइलहरू सिर्जना गर्नेछ dev, किनकि यो प्यारामिटर प्लगइन सेटिङहरूमा सेट गरिएको छ।

फाइल संरचना dev.yaml यो एकदम सरल हुनेछ:

mainorder:
    components:
         - order

ढाँचाले एकसाथ समूहबद्ध गरिएका कन्फिगरेसनहरूसँग काम गर्दछ। हाम्रो सेवाको लागि, समूहको लागि नाम छान्नुहोस् मुख्य आदेश। फ्रेमवर्कले वातावरण फाइलमा अनुप्रयोगहरूको प्रत्येक समूह फेला पार्छ र ती सबैका लागि कन्फिगरेसनहरू सिर्जना गर्दछ, जुन यसले सम्बन्धित फोल्डरहरूमा फेला पार्छ।

सेवा सेटिङ फाइलमा नै अर्डर अहिलेको लागि एउटा मात्र प्यारामिटर निर्दिष्ट गरौं:

spring.application.name: order

अब प्लगइन चलाउनुहोस्, र यसले गुणहरूमा निर्दिष्ट मार्ग अनुसार हाम्रो सेवाको लागि आवश्यक कन्फिगरेसन उत्पन्न गर्नेछ:

गर्न सक्छन् साथ पाउनुहोस् र प्लगइन स्थापना नगरी, केवल फ्रेमवर्क वितरण डाउनलोड गरेर र कमाण्ड लाइनबाट चलाउनुहोस्।
यो समाधान निर्माण सर्भरमा प्रयोगको लागि उपयुक्त छ।

यो ध्यान दिन लायक छ कि फ्रेमवर्क पूर्ण रूपमा बुझ्दछ सम्पत्ति सिन्ट्याक्स, त्यो हो, साधारण सम्पत्ति फाइलहरू जुन सँगै प्रयोग गर्न सकिन्छ याम कन्फिगरेसनहरू।

अर्को सेवा थपौं भुक्तानी र अवस्थित एक जटिल।
В अर्डर:

eureka:
 instance.preferIpAddress: true
 client:
   serviceUrl:
     defaultZone: http://192.89.89.111:6782/eureka/
server.port: 9999
spring.application.name: order
db.url: 192.168.0.100

В भुक्तानी:

eureka:
 instance.preferIpAddress: true
 client:
   serviceUrl:
     defaultZone: http://192.89.89.111:6782/eureka/
server.port: 9998
spring.application.name: payments
db.url: 192.168.0.100

यी कन्फिगरेसनहरूसँग मुख्य समस्या सेवा सेटिङहरूमा प्रतिलिपि-पेस्टको ठूलो मात्राको उपस्थिति हो। ढाँचाले कसरी छुटकारा पाउन मद्दत गर्नेछ हेरौं। सबै भन्दा स्पष्ट संग सुरु गरौं - कन्फिगरेसन को उपस्थिति युरेका प्रत्येक microservice को विवरण मा। सेटिङ् फाइलको साथ नयाँ डाइरेक्टरी सिर्जना गरौं र यसमा नयाँ कन्फिगरेसन थपौं:

र अब हाम्रो प्रत्येक परियोजनामा ​​लाइन थपौं #युरेका समावेश गर्नुहोस्.

फ्रेमवर्कले स्वचालित रूपमा युरेका कन्फिगरेसन फेला पार्नेछ र यसलाई सेवा कन्फिगरेसन फाइलहरूमा प्रतिलिपि गर्नेछ, जबकि छुट्टै युरेका कन्फिगरेसन सिर्जना हुनेछैन, किनकि हामीले यसलाई वातावरण फाइलमा निर्दिष्ट गर्ने छैनौं। dev.yaml। सेवा अर्डर:

#include eureka
server.port: 9999
spring.application.name: order
db.url: 192.168.0.100

हामी डाटाबेस सेटिङहरूलाई आयात लाइनमा परिवर्तन गरेर छुट्टै कन्फिगरेसनमा सार्न सक्छौं #युरेका, ओरेकल समावेश गर्नुहोस्.

यो नोट गर्न लायक छ कि फ्रेमवर्कले कन्फिगरेसन फाइलहरू पुन: उत्पन्न गर्दा प्रत्येक परिवर्तन ट्र्याक गर्दछ र मुख्य कन्फिगरेसन फाइलको छेउमा विशेष फाइलमा राख्छ। यसको लगमा प्रविष्टि यस्तो देखिन्छ: "भण्डार गरिएको १ गुणमा परिवर्तन हुन्छ order/diff-application.yaml" यसले तपाईंलाई ठूला कन्फिगरेसन फाइलहरूमा परिवर्तनहरू छिटो पत्ता लगाउन अनुमति दिन्छ।

कन्फिगरेसनको साझा भागहरू हटाउनाले तपाईंलाई धेरै अनावश्यक प्रतिलिपि-पेस्टबाट छुटकारा पाउन अनुमति दिन्छ, तर तपाईंलाई लचिलो रूपमा विभिन्न वातावरणका लागि कन्फिगरेसन सिर्जना गर्न अनुमति दिँदैन - हाम्रा सेवाहरूको अन्तिम बिन्दुहरू अद्वितीय र हार्ड-कोड गरिएका छन्, यो खराब छ। यसलाई हटाउन प्रयास गरौं।

एक राम्रो समाधान सबै अन्तिम बिन्दुहरू एक कन्फिगरेसनमा राख्नु हो जुन अरूले सन्दर्भ गर्न सक्छ। यस उद्देश्यका लागि, प्लेसहोल्डरहरूको लागि समर्थन फ्रेमवर्कमा पेश गरिएको छ। यसरी कन्फिगरेसन फाइल परिवर्तन हुनेछ युरेका:

 client:
   serviceUrl:
     defaultZone: http://${endpoints@eurekaip}:6782/eureka/

अब यो प्लेसहोल्डरले कसरी काम गर्छ हेरौं। प्रणालीले नामको कम्पोनेन्ट फेला पार्छ Endpoints र यसको अर्थ खोज्छ eurekaip, र त्यसपछि यसलाई हाम्रो कन्फिगरेसनमा प्रतिस्थापन गर्दछ। तर विभिन्न वातावरणको बारेमा के हो? यो गर्नको लागि, सेटिङ फाइल सिर्जना गर्नुहोस् Endpoints निम्न प्रकार application.dev.yaml। फाइल एक्सटेन्सनको आधारमा ढाँचाले स्वतन्त्र रूपमा, यो कन्फिगरेसन कुन वातावरणसँग सम्बन्धित छ भन्ने निर्णय गर्छ र यसलाई लोड गर्छ:

देव फाइल सामग्री:

eurekaip: 192.89.89.111
dbip: 192.168.0.100

हामी हाम्रा सेवाहरूको पोर्टहरूको लागि समान कन्फिगरेसन सिर्जना गर्न सक्छौं:

server.port: ${ports@order}.

सबै महत्त्वपूर्ण सेटिङहरू एकै ठाउँमा छन्, जसले गर्दा कन्फिगरेसन फाइलहरूमा छरिएका प्यारामिटरहरूको कारण त्रुटिहरूको सम्भावना कम हुन्छ।

फ्रेमवर्कले धेरै रेडिमेड प्लेसहोल्डरहरू प्रदान गर्दछ, उदाहरणका लागि, तपाईंले कन्फिगरेसन फाइल अवस्थित डाइरेक्टरीको नाम प्राप्त गर्न सक्नुहुन्छ र यसलाई असाइन गर्नुहोस्:

#include eureka, oracle
server.port: ${ports@order}
spring.application.name: ${this@name}

यसका लागि धन्यवाद, कन्फिगरेसनमा अनुप्रयोगको नाम थप रूपमा निर्दिष्ट गर्न आवश्यक छैन र यसलाई सामान्य मोड्युलमा पनि राख्न सकिन्छ, उदाहरणका लागि, एउटै युरेकामा:

client:
   serviceUrl:
     defaultZone: http://${endpoints@eurekaip}:6782/eureka/
 spring.application.name: ${this@name}

कन्फिगरेसन फाइल अर्डर एक लाइनमा घटाइनेछ:

#include eureka, oracle
server.port: ${ports@order}

यदि हामीलाई अभिभावक कन्फिगरेसनबाट कुनै सेटिङ आवश्यक पर्दैन भने, हामी यसलाई हाम्रो कन्फिगरेसनमा निर्दिष्ट गर्न सक्छौं र यो पुस्ताको समयमा लागू हुनेछ। त्यो हो, यदि कुनै कारणले हामीलाई अर्डर सेवाको लागि एक अद्वितीय नाम चाहिन्छ भने, हामी केवल प्यारामिटर छोड्नेछौं spring.application.name.

मानौं कि तपाईंले सेवामा अनुकूलन लगिङ सेटिङहरू थप्न आवश्यक छ, जुन छुट्टै फाइलमा भण्डार गरिएको छ, उदाहरणका लागि, logback.xML। यसको लागि सेटिङहरूको छुट्टै समूह सिर्जना गरौं:

आधारभूत कन्फिगरेसनमा, हामीले प्लेसहोल्डर प्रयोग गरेर लगिङ सेटिङ फाइल कहाँ राख्ने भनेर फ्रेमवर्कलाई बताउनेछौँ। @ConfigDir:

microconfig.template.logback.fromFile: ${logback@configDir}/logback.xml

फाइलमा logback.xML हामी मानक एपेन्डरहरू कन्फिगर गर्छौं, जसमा प्लेसहोल्डरहरू पनि समावेश हुन सक्छन् जुन फ्रेमवर्क कन्फिगहरू उत्पादनको क्रममा परिवर्तन हुनेछ, उदाहरणका लागि:

<file>logs/${this@name}.log</file>

सेवा कन्फिगरेसनमा आयात थपेर लगब्याक, हामी प्रत्येक सेवाको लागि स्वचालित रूपमा कन्फिगर गरिएको लगिङ प्राप्त गर्छौं:

#include eureka, oracle, logback
server.port: ${ports@order}

यो ढाँचाका सबै उपलब्ध प्लेसहोल्डरहरूसँग थप विवरणमा परिचित हुने समय हो:

${this@env} - हालको वातावरणको नाम फर्काउँछ।
${…@name} - कम्पोनेन्टको नाम फर्काउँछ।
${…@configDir} - कम्पोनेन्टको कन्फिगरेसन डाइरेक्टरीमा पूर्ण पथ फर्काउँछ।
${…@resultDir} — कम्पोनेन्टको गन्तव्य डाइरेक्टरीमा पूर्ण पथ फर्काउँछ (परिणामी फाइलहरू यस डाइरेक्टरीमा राखिनेछ)।
${this@configRoot} - कन्फिगरेसन स्टोरको रूट डाइरेक्टरीमा पूर्ण पथ फर्काउँछ।

प्रणालीले तपाईंलाई वातावरण चरहरू प्राप्त गर्न अनुमति दिन्छ, उदाहरणका लागि java को मार्ग:
${env@JAVA_HOME}
या त, ढाँचामा लेखिएको हुनाले JAVA, हामी कल जस्तै प्रणाली चर प्राप्त गर्न सक्छौं प्रणाली::getProperty यस्तो संरचना प्रयोग गरेर:
${[ईमेल सुरक्षित]}
यो विस्तार भाषा को लागी समर्थन उल्लेख लायक छ वसन्त EL। निम्न अभिव्यक्तिहरू कन्फिगरेसनमा लागू हुन्छन्:

connection.timeoutInMs: #{5 * 60 * 1000}
datasource.maximum-pool-size: #{${[email protected]} + 10} 

र तपाइँ अभिव्यक्ति प्रयोग गरेर कन्फिगरेसन फाइलहरूमा स्थानीय चरहरू प्रयोग गर्न सक्नुहुन्छ #var:

#var feedRoot: ${[email protected]}/feed
folder:
 root: ${this@feedRoot}
 success: ${this@feedRoot}/archive
 error: ${this@feedRoot}/error

तसर्थ, ढाँचा सूक्ष्म सेवाहरूको फाइन-ट्युनिङ र लचिलो कन्फिगरेसनको लागि एकदम शक्तिशाली उपकरण हो। ढाँचाले यसको मुख्य कार्यलाई पूर्ण रूपमा पूरा गर्दछ - सेटिङहरूमा प्रतिलिपि टाँस्ने मेटाउने, सेटिङहरूलाई समेकित गर्ने र परिणाम स्वरूप, सम्भावित त्रुटिहरू कम गर्दै, तपाईंलाई सजिलैसँग कन्फिगरेसनहरू संयोजन गर्न र तिनीहरूलाई विभिन्न वातावरणका लागि परिवर्तन गर्न अनुमति दिँदै।

यदि तपाइँ यस फ्रेमवर्कमा रुचि राख्नुहुन्छ भने, म यसको आधिकारिक पृष्ठ भ्रमण गर्न र पूर्ण रूपमा परिचित हुन सिफारिस गर्दछु कागजात, वा स्रोतहरूमा खन्नुहोस् यहाँ.

स्रोत: www.habr.com