एलआईसीआईआर पर JSON API एंडपॉइंट को बिना किसी फ्रेमवर्क के कैसे लागू किया जाए?

अनुवादक से:
लेख एक बहुत ही सरल वेब एप्लिकेशन का एक उदाहरण प्रदान करता है जिसे हैलो, वर्ल्ड के रूप में माना जा सकता है! एलिक्सिर पर सबसे सरल एपीआई बनाने में।
पुस्तकालयों के वर्तमान संस्करणों से मिलान करने के लिए नमूना कोड थोड़ा संशोधित है।
परिवर्तन के साथ पूर्ण नमूना कोड GitHub पर देखा जा सकता है ।

नई भाषा चुनौतियां

कई डेवलपर्स रूबी की दुनिया से अमृत के लिए आते हैं । उपलब्ध पुस्तकालयों और रूपरेखाओं की संख्या के संदर्भ में यह एक बहुत ही परिपक्व वातावरण है। और अमृत में कभी-कभी ऐसी परिपक्वता मेरे लिए पर्याप्त नहीं होती है। जब मुझे तीसरे पक्ष की सेवा की आवश्यकता होती है, तो एक उपयुक्त खोज का परिणाम निम्नानुसार हो सकता है:

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

एलिक्जिर पर सरल JSON एपीआई

आपको आश्चर्य हो सकता है, लेकिन रूबी हमेशा रेल पर नहीं है ( रूबी ऑन रेल्स, याद रखें? - अनुवादक का ध्यान रखें )। वेब के साथ संचार भी हमेशा भाग लेने के लिए आवश्यक नहीं है। हालांकि इस विशेष मामले में, चलो वेब के बारे में बात करते हैं।

जब एक एकल समापन बिंदु को लागू करने की बात आती है, तो आमतौर पर कई विकल्प होते हैं:

• रैक एप्लिकेशन
• Hanami
• सिनात्रा
• अंगूर
• रेल :: एपीआई

ये उन औजारों के उदाहरण हैं जिनका मैंने व्यक्तिगत रूप से उपयोग किया है। मेरे सहकर्मी संतुष्ट हैं सिनात्रा उपयोगकर्ता। वे हनमी की कोशिश में कामयाब रहे। मैं किसी भी विकल्प को चुन सकता हूं जो मुझे सूट करता है, यहां तक ​​कि मेरे वर्तमान मूड पर भी निर्भर करता है।

लेकिन जब मैंने एलिक्सिर में स्विच किया, तो यह पता चला कि विकल्प सीमित था। यद्यपि कई वैकल्पिक "फ्रेमवर्क" हैं (जिनके स्पष्ट कारणों के नाम मैं यहां नहीं बताऊंगा), उनका उपयोग करना लगभग असंभव है!

मैंने सारा दिन इंटरनेट पर उल्लिखित हर लाइब्रेरी को छाँटने में बिताया। स्लैक बॉट के रूप में कार्य करते हुए, मैंने हरोकू के लिए एक सरल HTTP2 सर्वर को तैनात करने की कोशिश की, लेकिन दिन के अंत तक मैंने हार मान ली। वास्तव में, जो भी विकल्प मुझे मिले उनमें से कोई भी बुनियादी आवश्यकताओं को लागू करने में सक्षम नहीं था।

हमेशा एक समाधान नहीं - फीनिक्स

फीनिक्स मेरा पसंदीदा वेब फ्रेमवर्क है, यह सिर्फ इतना है कि कभी-कभी यह बेमानी है। मैं इसका उपयोग नहीं करना चाहता था, पूरी रूपरेखा को केवल एक समापन बिंदु के लिए परियोजना में खींच रहा था; और इससे कोई फर्क नहीं पड़ता कि यह बहुत सरल है।

मैं तैयार-किए गए पुस्तकालयों का उपयोग नहीं कर सकता, क्योंकि, जैसा कि मैंने पहले ही कहा था, मैंने जो भी पुस्तकालय पाए, वे मेरी जरूरतों के लिए उपयुक्त नहीं थे (बेसिक रूटिंग और JSON समर्थन की आवश्यकता थी), या हेरोकू के लिए आसान और त्वरित तैनाती के लिए पर्याप्त सुविधाजनक नहीं थे। एक कदम पीछे हटो, मैंने सोचा।

लेकिन वास्तव में, फीनिक्स ही कुछ के आधार पर बनाया गया है , है ना?

प्लग एंड काउबॉय बचाव के लिए आते हैं

यदि आपको रूबी पर वास्तव में न्यूनतर सर्वर बनाने की आवश्यकता है, तो आप बस rack उपयोग कर सकते हैं - रूबी वेब सर्वर के लिए एक मॉड्यूलर इंटरफ़ेस।

सौभाग्य से, कुछ ऐसा ही अमृत में उपलब्ध है। इस मामले में, हम निम्नलिखित तत्वों का उपयोग करेंगे:

• चरवाहा - एर्लांग / ओटीपी के लिए एक छोटा और तेज़ HTTP सर्वर, जो पूर्ण HTTP स्टैक और राउटिंग को लागू करता है, विलंबता और मेमोरी उपयोग को कम करने के लिए अनुकूलित;
• प्लग - Erlang VM में चल रहे विभिन्न वेब सर्वरों के लिए एडेप्टर का एक सेट; प्रत्येक एडाप्टर इसके पीछे स्थित वेब सर्वर को एक सीधा इंटरफ़ेस प्रदान करता है;
• जहर एलिक्सिर पर JSON के प्रसंस्करण के लिए एक पुस्तकालय है।

कार्यान्वयन

मैं एंडपॉइंट (एंडपॉइंट), राउटर (राउटर) और JSON पार्सर (JSON हैंडलर) जैसे घटकों को लागू करना चाहता हूं। तब मैं हर्कोक पर परिणामी तैनाती करना चाहता हूं और आने वाले अनुरोधों को संसाधित करने में सक्षम होऊंगा। आइए देखें कि यह कैसे हासिल किया जा सकता है।

आवेदन

सुनिश्चित करें कि आपकी अमृत परियोजना में एक पर्यवेक्षक शामिल है। ऐसा करने के लिए, इस तरह एक परियोजना बनाएं:

 mix new minimal_server --sup 

सुनिश्चित करें कि मिक्स.क्स शामिल हैं:

 def application do [ extra_applications: [:logger], mod: {MinimalServer.Application, []} ] end 

और फ़ाइल lib/minimal_server/application.ex :

 defmodule MinimalServer.Application do use Application def start(_type, _args), do: Supervisor.start_link(children(), opts()) defp children do [] end defp opts do [ strategy: :one_for_one, name: MinimalServer.Supervisor ] end end 

पुस्तकालयों

निम्नलिखित पुस्तकालयों को mix.exs में निर्दिष्ट किया जाना चाहिए:

 defp deps do [ {:poison, "~> 4.0"}, {:plug, "~> 1.7"}, {:cowboy, "~> 2.5"}, {:plug_cowboy, "~> 2.0"} ] end 

फिर निर्भरता को डाउनलोड और संकलित करें:

 mix do deps.get, deps.compile, compile 

endpoint

अब सर्वर के लिए एक प्रवेश बिंदु बनाने के लिए सब कुछ तैयार है। चलो निम्नलिखित सामग्री के साथ एक lib/minimal_server/endpoint.ex फ़ाइल बनाते हैं:

 defmodule MinimalServer.Endpoint do use Plug.Router plug(:match) plug(Plug.Parsers, parsers: [:json], pass: ["application/json"], json_decoder: Poison ) plug(:dispatch) match _ do send_resp(conn, 404, "Requested page not found!") end end 

Plug मॉड्यूल में Plug Plug.Router उपयोग किए गए पथ और HTTP विधि के आधार पर आने वाले अनुरोधों को पुनर्निर्देशित करने के लिए होता है। अनुरोध प्राप्त होने पर, राउटर मॉड्यूल को कॉल करेगा :match , match/2 फ़ंक्शन द्वारा प्रतिनिधित्व किया जाता है, जो संबंधित मार्ग को खोजने के लिए जिम्मेदार है, और फिर इसे मॉड्यूल पर :dispatch , जो संबंधित कोड को निष्पादित करेगा।

चूँकि हम चाहते हैं कि हमारा API JSON-compliant हो, इसलिए हमें Plug.Parsers को लागू Plug.Parsers । चूंकि यह दिए गए application/json साथ application/json अनुरोधों को संसाधित करता है :json_decoder , हम इसका उपयोग अनुरोध निकाय का विश्लेषण करने के लिए करेंगे।

नतीजतन, हमने एक अस्थायी मार्ग "कोई भी अनुरोध" बनाया जो सभी अनुरोधों से मेल खाता है और HTTP (404) कोड नहीं मिला है।

रूटर

राउटर को लागू करना हमारे एप्लिकेशन को बनाने का अंतिम चरण होगा। यह पूरी पाइपलाइन का अंतिम तत्व है जिसे हमने बनाया है: वेब ब्राउज़र से अनुरोध प्राप्त करना और प्रतिक्रिया के गठन के साथ समाप्त होना।

राउटर क्लाइंट से आने वाले अनुरोध को संसाधित करेगा और वांछित प्रारूप में कुछ संदेश वापस भेज देगा ( उपरोक्त कोड को फ़ाइल में जोड़ें lib/minimal_server/router.ex - अनुवादक के नोट ):

 defmodule MinimalServer.Router do use Plug.Router plug(:match) plug(:dispatch) get "/" do conn |> put_resp_content_type("application/json") |> send_resp(200, Poison.encode!(message())) end defp message do %{ response_type: "in_channel", text: "Hello from BOT :)" } end end 

उपरोक्त Router मॉड्यूल में, अनुरोध तभी संसाधित किया जाएगा जब इसे GET विधि द्वारा भेजा गया हो और / मार्ग पर भेजा गया हो। राउटर मॉड्यूल एक Content-Type हेडर के साथ प्रतिक्रिया करेगा जिसमें application/json और बॉडी होगी:

 { "response_type": "in_channel", "text": "Hello from BOT :)" } 

यह सब एक साथ रखना

अब Endpoint मॉड्यूल को राउटर के आगे के अनुरोधों में बदलने का समय है और Endpoint मॉड्यूल को लॉन्च करने के लिए Application को संशोधित करना है।

पहले MinimalServer.Endpoint से जोड़कर किया जा सकता है [ match _ do ... end से पहले match _ do ... end नियम - लगभग। अनुवादक ] स्ट्रिंग

 forward("/bot", to: MinimalServer.Router) 

यह सुनिश्चित करता है कि /bot सभी अनुरोधों को Router मॉड्यूल द्वारा संसाधित और संसाधित किया जाएगा।

दूसरे start_link/1 endpoint.ex फ़ाइल में child_spec/1 और start_link/1 जोड़कर कार्यान्वित किया जा सकता है:

 defmodule MinimalServer.Endpoint do # ... def child_spec(opts) do %{ id: __MODULE__, start: {__MODULE__, :start_link, [opts]} } end def start_link(_opts), do: Plug.Cowboy.http(__MODULE__, []) end 

अब आप application.ex को संशोधित कर सकते हैं। MinimalServer.Endpoint को जोड़कर सूची children/0 फ़ंक्शन द्वारा लौटा दी गई है।

 defmodule MinimalServer.Application do # ... defp children do [ MinimalServer.Endpoint ] end end 

सर्वर शुरू करने के लिए, बस करें:

 mix run --no-halt 

अंत में आप पता http: // localhost: 4000 / bot पर जा सकते हैं और हमारा संदेश देख सकते हैं :)

तैनाती

config

ज्यादातर, एक स्थानीय वातावरण में और ऑपरेशन के लिए, सर्वर को अलग तरीके से कॉन्फ़िगर किया जाता है। इसलिए, हमें इनमें से प्रत्येक मोड के लिए अलग सेटिंग्स दर्ज करने की आवश्यकता है। सबसे पहले, हमारे config.exs को जोड़कर config.exs करें:

 config :minimal_server, MinimalServer.Endpoint, port: 4000 

इस मामले में, जब आवेदन test , prod और dev मोड में शुरू होता है, तो यह पोर्ट 4000 प्राप्त करेगा यदि ये सेटिंग्स नहीं बदली जाती हैं।

 use Mix.Config config :minimal_server, MinimalServer.Endpoint, port: 4000 import_config "#{Mix.env()}.exs" 

 use Mix.Config 

उत्पादन में, हम आमतौर पर पोर्ट संख्या को मुश्किल से सेट नहीं करना चाहते हैं, लेकिन उदाहरण के लिए कुछ सिस्टम वातावरण चर पर भरोसा करते हैं:

 config :minimal_server, MinimalServer.Endpoint, port: "PORT" |> System.get_env() |> String.to_integer() 

config/prod.exs के अंत तक पाठ जोड़ें - लगभग। अनुवाद

उसके बाद, एक निश्चित मान का उपयोग स्थानीय रूप से किया जाएगा, और परिचालन संचालन में, पर्यावरण चर का एक कॉन्फ़िगरेशन।

आइए इस योजना को endpoint.ex में लागू करें, ( start_link / 1 फ़ंक्शन की जगह - अनुवादक टिप्पणी ):

 defmodule MinimalServer.Endpoint do # ... require Logger def start_link(_opts) do with {:ok, [port: port] = config} <- Application.fetch_env(:minimal_server, __MODULE__) do Logger.info("Starting server at http://localhost:#{port}/") Plug.Adapters.Cowboy2.http(__MODULE__, [], config) end end end 

Heroku

हेरोकू बिना किसी जटिल सेटअप के सबसे सरल वन-क्लिक परिनियोजन प्रदान करता है। हमारे प्रोजेक्ट को परिनियोजित करने के लिए आपको कुछ सरल फ़ाइलों को तैयार करने और एक दूरस्थ अनुप्रयोग बनाने की आवश्यकता है ।

हरोकू सीएलआई स्थापित करने के बाद , आप निम्नानुसार एक नया एप्लिकेशन बना सकते हैं:

 $ heroku create minimal-server-habr Creating ⬢ minimal-server-habr... done https://minimal-server-habr.herokuapp.com/ | https://git.heroku.com/minimal-server-habr.git 

अब अपने आवेदन में अमृत ​​बिल्ड किट जोड़ें:

 heroku buildpacks:set \ https://github.com/HashNuke/heroku-buildpack-elixir.git 

इस अनुवाद के समय में, अमृत और एरलंग के वर्तमान संस्करण (प्लस या माइनस) हैं:

 erlang_version=21.1 elixir_version=1.8.1 

बिल्ड किट को कॉन्फ़िगर करने के लिए, ऊपर लाइनों को elixir_buildpack.config फ़ाइल में जोड़ें।

एक Procfile बनाने के लिए अंतिम चरण है, और, फिर से, यह बहुत सरल है:

 web: mix run --no-halt 

अनुवादक का नोट: हरोकू पर निर्माण के दौरान किसी त्रुटि से बचने के लिए, आपको अनुप्रयोग में उपयोग किए जाने वाले पर्यावरण चर का मान निर्धारित करना होगा:

 $ heroku config:set PORT=4000 Setting PORT and restarting ⬢ minimal-server-habr... done, v5 PORT: 4000 

जैसे ही आप नई फाइल करते हैं [ git - लगभग का उपयोग करते हुए। अनुवादक ], आप उन्हें हरोकू पर अपलोड कर सकते हैं:

 $ git push heroku master Initializing repository, done. updating 'refs/heads/master' ... 

और वह सब है! आवेदन https://minimal-server-habr.herokuapp.com पर उपलब्ध है।

सारांश

इस बिंदु पर, आप पहले से ही समझ गए थे कि एलिक्सिर को सरलतम JSON रेस्टफुल एपीआई और HTTP सर्वर को कैसे लागू किया जाए , केवल 3 ( 4 - लगभग। ट्रांसलेटर ) पुस्तकालयों का उपयोग किए बिना।

जब आपको सरल एंडपॉइंट्स तक पहुंच प्रदान करने की आवश्यकता होती है, तो आपको हर बार फीनिक्स का उपयोग करने की आवश्यकता नहीं होती है, चाहे वह कितना भी अच्छा हो, साथ ही साथ कोई अन्य ढांचा भी।

उत्सुक क्यों plug + cowboy और फीनिक्स के बीच कहीं भी कोई विश्वसनीय, अच्छी तरह से परीक्षण और समर्थित रूपरेखाएं नहीं हैं? शायद सरल चीजों को लागू करने की कोई वास्तविक आवश्यकता नहीं है? शायद प्रत्येक कंपनी अपने स्वयं के पुस्तकालय का उपयोग करती है? या शायद हर कोई फीनिक्स या प्रस्तुत दृष्टिकोण का उपयोग करता है?

रिपॉजिटरी , हमेशा की तरह, मेरे GitHub पर उपलब्ध है।