GRASP पैटर्न और SOLID सिद्धांतों के आधार पर एक कस्टम रैपर एपीआई आर्किटेक्चर बनाना

परिचय

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

इस संबंध में, मैंने लिखने का फैसला किया आपकी मोटरसाइकिलPHP में Bitrix24 एपीआई के लिए खुद के आवरण, के रूप में अधिकारी - उपरोक्त योजना में वांछित होने के लिए बहुत कुछ छोड़ देता है।

लेख में, मैं:

• जीआरएएसपी और एसओएलआईडी के सिद्धांतों के अनुसार वास्तुकला के बारे में सोचते समय मैं अपने सोचने के तरीके का वर्णन करूंगा
• मैं खुद को पैर में गोली मारूंगा, और फिर मैं स्थिति को सही करूंगा
• मैं पहली संस्थाओं और तरीकों के साथ एक प्रोटोटाइप विकसित करूंगा

सही वास्तुकला ढूँढना

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

, - - , . 24.

, API « », - , OAuth2.0.
« », , , .

, . , .

, . , , , , , :

$leads = BX24Wrapper\Engine\WebHook::instane('https://b24-xxxxxx.bitrix24.ru/rest/1/********/')
    ->resources()
    ->leads()
    ->list(['STATUS' => 'NEW']);

$applicationEngine = BX24Wrapper\Engine\Application::instane('client_id', 'client_secret', 'access_token',...);
$leads = $applicationEngine
    ->resources()
    ->leads()
    ->list(['STATUS' => 'NEW']);
//      -  ,   
$responseFromSomeCall = $applicationEngine->get('crm.some.list', ['SOME' => 'VALUE']); 

, 2 (WebHook Application), « », . resources() , , (leads, deals, tasks…), — (list, add, update…). , … ? , , … .

, , UML- :

Engine\AbstractBasic — API.
Resources – , .
Resource\AbstractBasic — , API-, API-, .
Entity\AbstractBasic — -, API-.

, , Engine\AbstractBasic Resources , , . , , GRASP- « », .
_engine Resources – Resource\AbstractBasic . , , « ».

, - orders(), contacts() .. , Resources , « » SOLID- «/». , , .

, , , . !

, Engine Resources? Resources, , , , .

, ? IDE , — . , .

, :

$leads = Resource\Lead::instane(new Engine\WebHook('https://b24-xxxxxx.bitrix24.ru/rest/1/********/'))
    ->list(['STATUS' => 'NEW']);

$applicationEngine = BX24Wrapper\Engine\Application::instane('client_id', 'client_secret', 'access_token',...);
$leads = Resource\Lead::instane($applicationEngine)
    ->list(['STATUS' => 'NEW']);

$responseFromSomeCall = $applicationEngine->get('crm.some.list', ['SOME' => 'VALUE']);

, , , . , :

, , , , . , : → . , , API- , , , . .

, . : « ?» – - , «», , , , , , .

, Resource\AbstractBasic, , . — API- , – API- .
– «», Resource\AbstractBasic …

, . API-, , . . , , , …

! ( , ), ? ? , ?! .

Resource, — , !

$resource = Resource\Batch::instane(new Engine\WebHook('https://wtfkjg.ru/fdsgfds'));
$resource->sendBatchCalls([
    'lead_ids' => Resource\FindByComm::find(['type' => 'EMAIL', 'values' => ['79780001122'], 'entity_type' => 'LEAD']),
    'contacts' => Resource\Contact::list(['ID' => "\$result['lead_ids'][LEAD]"]),
]);

, - API-, . , Request. , .

, , Request. , …

, , ? ? , Resources, ? «» «/» - list, get ..

, , , Request- , . :

$engine = new Engine\WebHook('https://b24-xxxxxx.bitrix24.ru/rest/1/********/');

$leads = $engine->execute(Request\Lead\Items::all(['STATUS' => 'NEW'], ['ID' => 'DESC']));

$responseFromSomeGetCall = $engine->execute(Request\Custom::get('some.api.method', ['SOME' => 'PARAMS']));
$responseFromSomePostCall = $engine->execute(Request\Custom::post('some.api.method', ['SOME' => 'PARAMS']));

$response = $engine->execute([
    'lead_ids' => Request\FindByComm\Find::byPhone('79780001122', 'LEAD'),
    'contacts' => Request\Contact\Items::firstPage(['ID' => "\$result['lead_ids'][LEAD]"], ['ID' => 'ASC']),    
]);  

, (), execute , , http- . , API- . , -, .

, , , , - .

, :
-, , execute, mixed. , IDE , . , .. , .

-, API- , 1 = 1 . - . , , , .

, API . , 24. !

GRASP SOLID, , .

GRASP:

• : .
• : Builder, .
• : .
• : .
• : , , , .
• : , . .
• : Builder.
• : Builder, .

SOLID:

• : , .
• /: API-, , , .
• : , , , .
• : , .
• : , , , 0, .

, , . ? , , 100%, 90%, , . , , — . , …

-, GRASP SOLID - , . . - «», .

, .
: https://github.com/Dangetsu/bitrix24-api-wrapper
, , .

PHP 7.1, , .

:
slyshkin

:

• ( - draw.io)
• code conventions
• - .