🌯 🧝🏽 🚵🏾 एल्म। आरामदायक और अजीब। Json.Encoder और Json.Decoder 📊 👩🏽‍🔧 🍼

हम एल्म 0.18 के बारे में बात करना जारी रखते हैं।

एल्म। आरामदायक और अजीब
एल्म। आरामदायक और अजीब। रचना
एल्म। आरामदायक और अजीब। Http, टास्क

यह लेख एनकोडर / डिकोडर्स के मुद्दों को कवर करेगा।

डिकोडर / एनकोडर के लिए उपयोग किया जाता है:

तृतीय-पक्ष संसाधनों (Http, WebSocket, आदि) से प्रतिक्रियाओं का रूपांतरण;
बंदरगाहों के माध्यम से बातचीत। मैं आपको निम्नलिखित लेखों में बंदरगाहों और मूल कोड के बारे में अधिक बताऊंगा।

जैसा कि पहले वर्णित है, एल्म को हमें बाहरी डेटा को आंतरिक एप्लिकेशन प्रकारों में बदलने की आवश्यकता है। Json.Decode मॉड्यूल इस प्रक्रिया के लिए जिम्मेदार है। रिवर्स प्रोसेस Json.Encode है ।

डिकोडिंग नियमों को परिभाषित करने वाला प्रकार Json.Decode.Decoder a है । यह प्रकार उपयोगकर्ता प्रकार से परिचालित होता है और निर्धारित करता है कि उपयोगकर्ता प्रकार को JSON ऑब्जेक्ट से कैसे प्राप्त किया जाए।

एनकोडर के लिए, केवल परिणाम प्रकार को परिभाषित किया गया है - Json.Encode.Value ।

UserData प्रकार के लिए उदाहरणों पर विचार करें।

type alias User = { id: Int , name: String , email: String }

उपयोगकर्ता से डेटा प्राप्त करने के लिए विकोडक:

 decodeUserData : Json.Decode.Decoder UserData decodeUserData = Json.Decode.map3 UserData (Json.Decode.field “id” Json.Decode.int) (Json.Decode.field “name” Json.Decode.string) (Json.Decode.field “email” Json.Decode.string) encodeUserData : UserData -> Json.Encode.Value encodeUserData userData = Json.Encode.object [ ( “id”, Json.Encode.int userData.id) , ( “name”, Json.Encode.string userData.name) , ( “email”, Json.Encode.string userData.email) ]

Json.Decode.map3 फ़ंक्शन प्रकार UserData के एक निर्माता को स्वीकार करता है। इसके बाद, उपयोगकर्ता के प्रकार UserData में उनकी घोषणा के क्रम के अनुसार प्रकार के तीन डिकोडर प्रेषित किए जाते हैं।

DecodeUserData फ़ंक्शन का उपयोग Json.Decode.decodeString या Json.Decode.decodeValue फ़ंक्शन के साथ संयोजन के रूप में किया जा सकता है। पिछले लेखों से उपयोग का एक उदाहरण ।

EncodeUserData फ़ंक्शन Json.Encode.Value प्रकार का एक कस्टम प्रकार एन्कोडिंग पैदा करता है, जिसे बाहर भेजा जा सकता है। सरल शब्दों में, Json.Encode.Value एक JSON ऑब्जेक्ट से मेल खाती है।

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

संघ प्रकार के डिकोडर या प्रकार के विभेदक

मान लीजिए हमारे पास माल की एक सूची है। और प्रत्येक उत्पाद में एक मनमानी संख्या हो सकती है, जिनमें से प्रत्येक में कई में से एक प्रकार है:

पूर्णांक;
स्ट्रिंग;
गणनीय। मान्य मानों में से एक की पसंद मान लेता है।

एक JSON ऑब्जेक्ट निम्नानुसार मान्य है:

 { “id”: 1, “name”: “Product name”, “price”: 1000, “attributes”: [ { “id”: 1, “name”: “Length”, “unit”: “meters”, “value”: 100 }, { “id”: 1, “name”: “Color”, “unit”: “”, “value”: { “id”: 1, “label”: “red” } },... ] }

शेष संभावित प्रकारों पर विचार नहीं किया जाएगा, उनके साथ काम करना समान है। फिर एक कस्टम उत्पाद प्रकार में निम्नलिखित विवरण होगा:

 type alias Product = { id: Int , name: String , price: Int , attributes: Attributes } type alias Attributes = List Attribute type alias Attribute = { id: Int , name: String , unit: String , value: AttributeValue } type AttributeValue = IntValue Int | StringValue String | EnumValue Enum type alias Enum = { id: Int , label: String }

हम वर्णित प्रकारों पर थोड़ा चर्चा करेंगे। एक उत्पाद (उत्पाद) है, जिसमें विशेषताओं / विशेषताओं (गुण) की एक सूची शामिल है। प्रत्येक विशेषता (विशेषता) में एक पहचानकर्ता, नाम, आयाम और मूल्य होता है। विशेषता मान को संघ प्रकार के रूप में वर्णित किया जाता है, प्रत्येक प्रकार के विशेषता मूल्य के लिए एक तत्व। Enum प्रकार एक स्वीकार्य सेट से एक मूल्य का वर्णन करता है और इसमें होता है: पहचानकर्ता और मानव-पठनीय मूल्य।

डिकोडर का वर्णन, Json.Decode उपसर्ग को संक्षिप्त करें:

 decodeProduct : Decoder Product decodeProduct = map4 Product (field “id” int) (field “name” string) (field “price” int) (field “attributes” decodeAttributes) decodeAttributes : Decoder Attributes decodeAttributes = list decodeAttribute decodeAttribute : Decoder Attribute decodeAttribute = map4 Attribute (field “id” int) (field “name” string) (field “unit” string) (field “value” decodeAttributeValue) decodeAttributeValue : Decoder AttributeValue decodeAttributeValue = oneOf [ map IntValue int , map StringValue string , map EnumValue decodeEnumValue ] decodeEnumValue : Decoder Enum decodeEnumValue = map2 Enum (field “id” int) (field “label” string)

पूरी चाल decodeAttributeValue फ़ंक्शन में निहित है। Json.Decode.oneOf फ़ंक्शन का उपयोग विशेषता मान के लिए सभी मान्य डिकोडर पर पुनरावृत्त करता है। डिकोडर्स में से एक द्वारा सफल अनपैकिंग के मामले में, मान को एटवर्टवैल्यू प्रकार से संबंधित टैग के साथ टैग किया जाता है।

उत्पाद प्रकार एन्कोडिंग को Json.Encode.object फ़ंक्शन का उपयोग करके किया जा सकता है, जिसमें एन्कोडेड प्रकार के गुण पारित किए जाएंगे। यह टाइप एट्रीब्यूट वेल्यू की कोडिंग पर ध्यान देने योग्य है। पहले वर्णित JSON ऑब्जेक्ट के अनुसार, एनकोडर को Json.Encode उपसर्ग के रूप में संक्षिप्त किया जा सकता है:

 encodeAttributeValue : AttributeValue -> Value encodeAttributeValue attributeValue = case attributeValue of IntValue value -> int value StringValue value -> string value EnumValue value -> object [ (“id”, int value.id) , (“id”, string value.label) ]

जैसा कि आप देख सकते हैं, हम प्रकार के विकल्पों की तुलना करते हैं और संबंधित एन्कोडर्स का उपयोग करते हैं।

विशेषताओं का विवरण बदलें और उन्हें एक प्रकार के विभेदक का उपयोग करके परिभाषित करें। JSON विशेषता ऑब्जेक्ट, इस मामले में, इस तरह दिखेगा:

 { “id”: 1, “name”: “Attribute name”, “type”: “int”, “value_int”: 1, “value_string”: null, “value_enum_id”: null, “value_enum_label”: null }

इस स्थिति में, विभेदक प्रकार को फ़ील्ड में संग्रहीत किया जाता है और यह निर्धारित करता है कि किस फ़ील्ड में मान संग्रहीत है। इस तरह की एक वर्णन संरचना शायद सबसे सुविधाजनक नहीं है, लेकिन अक्सर पाया जाता है। संभवतः इस JSON ऑब्जेक्ट के प्रकार विवरण को बदलने के लिए इसके लायक नहीं है, आंतरिक उपयोग के लिए सुविधाजनक रूप में प्रकारों को रखना बेहतर है। इस मामले में, डिकोडर का विवरण निम्नानुसार हो सकता है:

 decodeAttribute2 : Decoder Attribute decodeAttribute2 = field "type" string |> andThen decodeAttributeValueType |> andThen (\attributeValue -> map4 Attribute (field "id" int) (field "name" string) (field "unit" string) (succeed attributeValue) ) decodeAttributeValueType : String -> Decoder AttributeValue decodeAttributeValueType valueType = case valueType of "int" -> field "value_int" int |> Json.Decode.map IntValue "string" -> field "value_string" string |> Json.Decode.map StringValue "enum" -> map2 Enum (field "value_enum_id" int) (field "value_enum_label" string) |> Json.Decode.map EnumValue _ -> Json.Decode.fail "Unknown attribute type"

DecodeAttribute2 फ़ंक्शन में, हम पहले डिस्क्रिमिनेटर को डिकोड करते हैं, यदि सफल होता है, तो हम विशेषता मान को डिकोड करते हैं। अगला, हम विशेषता प्रकार के शेष क्षेत्रों को डीकोड करते हैं, और पहले प्राप्त मूल्य को मूल्य फ़ील्ड के मूल्य के रूप में निर्दिष्ट करते हैं।

डिकोडर का स्रोत कोड ।

आंशिक प्रकार अद्यतन

ऐसे मामले हैं जब एपीआई पूरे ऑब्जेक्ट को वापस नहीं करता है, लेकिन इसका केवल एक हिस्सा है। उदाहरण के लिए, किसी वस्तु की स्थिति को देखने या बदलने के लिए पंजीकरण करते समय। इस मामले में, संदेश में अपडेट की गई वस्तु को तुरंत प्राप्त करना और डिकोडर के पीछे सभी जोड़तोड़ को छिपाना अधिक सुविधाजनक है।

उदाहरण के लिए, हम एक ही उत्पाद लेते हैं, लेकिन इसमें स्थिति फ़ील्ड जोड़ते हैं और उत्पाद को बंद करने के अनुरोध को संसाधित करेंगे।

 type alias Product = { id: Int , name: String , price: Int , attributes: Attributes , status: Int } decodeUpdateStatus : Product -> Decoder Product decodeUpdateStatus product = field “status” int |> andThen (\newStatus -> succeed { product | status = newStatus} )

या आप Json.Decode.map फ़ंक्शन का उपयोग कर सकते हैं।

 decodeUpdateStatus : Product -> Decoder Product decodeUpdateStatus product = field “status” int |> map (\newStatus -> { product | status = newStatus} )

तारीख और समय

हम Date.fromString फ़ंक्शन का उपयोग करेंगे, जो दिनांक प्रकार के निर्माता का उपयोग करके कार्यान्वित किया जाता है।

 decodeDateFromString : Decoder Date.Date decodeDateFromString = string |> andThen (\stringDate -> case Date.fromString stringDate of Ok date -> Json.Decode.succeed date Err reason -> Json.Decode.fail reason )

यदि टाइमस्टैम्प का उपयोग दिनांक / समय प्रतिनिधित्व के रूप में किया जाता है, तो सामान्य रूप से डिकोडर को निम्न के रूप में वर्णित किया जा सकता है:

 decodeDateFromTimestamp : Decoder Date.Date decodeDateFromTimestamp = oneOf [ int |> Json.Decode.map toFloat , float ] |> Json.Decode.map Date.fromTime

एल्म। आरामदायक और अजीब। Json.Encoder और Json.Decoder

संघ प्रकार के डिकोडर या प्रकार के विभेदक

आंशिक प्रकार अद्यतन

तारीख और समय

More articles: