microconfig.io સાથે માઇક્રોસર્વિસ કન્ફિગરેશનને સરળતાથી મેનેજ કરો

માઇક્રોસર્વિસિસના વિકાસ અને અનુગામી કામગીરીમાં મુખ્ય સમસ્યાઓમાંની એક તેમના ઉદાહરણોનું સક્ષમ અને સચોટ ગોઠવણી છે. મારા મતે, એક નવું માળખું આમાં મદદ કરી શકે છે microconfig.io. તે તમને કેટલાક નિયમિત એપ્લિકેશન રૂપરેખાંકન કાર્યોને ખૂબ સુંદર રીતે હલ કરવાની મંજૂરી આપે છે.

જો તમારી પાસે ઘણી બધી માઇક્રોસર્વિસિસ હોય, અને તે દરેક તેની પોતાની રૂપરેખાંકન ફાઇલ/ફાઇલો સાથે આવે છે, તો તેમાંથી એકમાં ભૂલ થવાની ઉચ્ચ સંભાવના છે, જે યોગ્ય કૌશલ્ય અને લોગિંગ સિસ્ટમ વિના પકડવી ખૂબ જ મુશ્કેલ છે. મુખ્ય કાર્ય જે ફ્રેમવર્ક પોતાના માટે સુયોજિત કરે છે તે ડુપ્લિકેટ ઇન્સ્ટન્સ રૂપરેખાંકન પરિમાણોને ઘટાડવાનું છે, ત્યાં ભૂલ ઉમેરવાની સંભાવના ઘટાડે છે.

ચાલો એક ઉદાહરણ જોઈએ. ચાલો કહીએ કે અમારી પાસે રૂપરેખાંકન ફાઇલ સાથેની એક સરળ એપ્લિકેશન છે યામલ. આ કોઈપણ ભાષામાં કોઈપણ માઇક્રોસર્વિસ હોઈ શકે છે. ચાલો જોઈએ કે આ સેવા પર ફ્રેમવર્ક કેવી રીતે લાગુ કરી શકાય.

પરંતુ પ્રથમ, વધુ સુવિધા માટે, ચાલો આઈડિયા IDE માં એક ખાલી પ્રોજેક્ટ બનાવીએ, તેમાં microconfig.io પ્લગઈન ઇન્સ્ટોલ કર્યા પછી:

અમે પ્લગઇન લોન્ચ કન્ફિગરેશન સેટ કર્યું છે, તમે ઉપરના સ્ક્રીનશૉટની જેમ ડિફૉલ્ટ કન્ફિગરેશનનો ઉપયોગ કરી શકો છો.

અમારી સેવાને ઓર્ડર કહેવામાં આવે છે, પછી નવા પ્રોજેક્ટમાં અમે સમાન માળખું બનાવીશું:

સેવાના નામ સાથે રૂપરેખાંકન ફાઇલને ફોલ્ડરમાં મૂકો - application.yaml. બધી માઇક્રોસર્વિસિસ અમુક પ્રકારના વાતાવરણમાં લોંચ કરવામાં આવે છે, તેથી, સેવા માટે રૂપરેખા બનાવવા ઉપરાંત, પર્યાવરણનું જ વર્ણન કરવું જરૂરી છે: આ માટે આપણે એક ફોલ્ડર બનાવીશું. envs અને તેમાં અમારા કાર્યકારી વાતાવરણના નામ સાથે ફાઇલ ઉમેરો. આમ, ફ્રેમવર્ક પર્યાવરણમાં સેવાઓ માટે રૂપરેખાંકન ફાઇલો બનાવશે દેવ, કારણ કે આ પરિમાણ પ્લગઇન સેટિંગ્સમાં સેટ કરેલ છે.

ફાઇલ માળખું 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

આ રૂપરેખાંકનોની મુખ્ય સમસ્યા એ સેવા સેટિંગ્સમાં મોટી માત્રામાં કૉપિ-પેસ્ટની હાજરી છે. ચાલો જોઈએ કે ફ્રેમવર્ક તેનાથી છુટકારો મેળવવામાં કેવી રીતે મદદ કરશે. ચાલો સૌથી વધુ સ્પષ્ટ સાથે શરૂ કરીએ - રૂપરેખાંકનની હાજરી યુરેકા દરેક માઇક્રોસર્વિસના વર્ણનમાં. ચાલો સેટિંગ્સ ફાઇલ સાથે નવી ડિરેક્ટરી બનાવીએ અને તેમાં નવું રૂપરેખાંકન ઉમેરીએ:

અને હવે ચાલો આપણા દરેક પ્રોજેક્ટમાં લાઇન ઉમેરીએ #યુરેકાનો સમાવેશ કરો.

ફ્રેમવર્ક આપમેળે યુરેકા રૂપરેખાંકન શોધી કાઢશે અને તેને સેવા રૂપરેખાંકન ફાઇલોમાં નકલ કરશે, જ્યારે અલગ યુરેકા રૂપરેખાંકન બનાવવામાં આવશે નહીં, કારણ કે અમે તેને પર્યાવરણ ફાઇલમાં સ્પષ્ટ કરીશું નહીં. dev.yaml. સર્વિસ ક્રમમાં:

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

અમે આયાત લાઇનમાં બદલીને ડેટાબેઝ સેટિંગ્સને અલગ ગોઠવણીમાં પણ ખસેડી શકીએ છીએ #યુરેકા, ઓરેકલનો સમાવેશ કરો.

તે નોંધવું યોગ્ય છે કે રૂપરેખાંકન ફાઇલોને પુનઃજનરેટ કરતી વખતે ફ્રેમવર્ક દરેક ફેરફારને ટ્રૅક કરે છે અને તેને મુખ્ય રૂપરેખાંકન ફાઇલની બાજુમાં વિશિષ્ટ ફાઇલમાં મૂકે છે. તેના લોગમાંની એન્ટ્રી આના જેવી દેખાય છે: “સંગ્રહિત 1 પ્રોપર્ટી આમાં બદલાય છે order/diff-application.yaml" આ તમને મોટી રૂપરેખાંકન ફાઈલોમાં ફેરફારોને ઝડપથી શોધવા માટે પરવાનગી આપે છે.

રૂપરેખાંકનના સામાન્ય ભાગોને દૂર કરવાથી તમે ઘણી બધી બિનજરૂરી કોપી-પેસ્ટથી છૂટકારો મેળવી શકો છો, પરંતુ તમને વિવિધ વાતાવરણ માટે લવચીક રીતે રૂપરેખાંકન બનાવવાની મંજૂરી આપતું નથી - અમારી સેવાઓના અંતિમ બિંદુઓ અનન્ય અને હાર્ડ-કોડેડ છે, આ ખરાબ છે. ચાલો આને દૂર કરવાનો પ્રયાસ કરીએ.

એક સારો ઉકેલ એ છે કે તમામ અંતિમ બિંદુઓને એક રૂપરેખાંકનમાં રાખવા કે જે અન્ય લોકો સંદર્ભ આપી શકે. આ હેતુ માટે, પ્લેસહોલ્ડર્સ માટે સપોર્ટ ફ્રેમવર્કમાં દાખલ કરવામાં આવ્યો છે. આ રીતે રૂપરેખાંકન ફાઇલ બદલાશે યુરેકા:

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

હવે ચાલો જોઈએ કે આ પ્લેસહોલ્ડર કેવી રીતે કામ કરે છે. સિસ્ટમ નામનું એક ઘટક શોધે છે અંતબિંદુ અને તેમાં અર્થ શોધે છે eurekaip, અને પછી તેને અમારા રૂપરેખાંકનમાં અવેજી કરે છે. પરંતુ વિવિધ વાતાવરણ વિશે શું? આ કરવા માટે, માં સેટિંગ્સ ફાઇલ બનાવો અંતબિંદુ નીચેના પ્રકાર અરજી.દેવ.યામલ. ફાઇલ એક્સ્ટેંશનના આધારે સ્વતંત્ર રીતે ફ્રેમવર્ક નક્કી કરે છે કે આ રૂપરેખાંકન કયા વાતાવરણનું છે અને તેને લોડ કરે છે:

ડેવ ફાઇલ સમાવિષ્ટો:

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}
ક્યાં તો, કારણ કે ફ્રેમવર્ક લખેલું છે જાવાની, આપણે કોલની જેમ જ સિસ્ટમ વેરીએબલ મેળવી શકીએ છીએ સિસ્ટમ::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