Microsoft Dynamics CRM के लिए Linq- सक्षम क्लाइंट (sdk से क्लाइंट का विकल्प)

परियोजनाओं में से एक को विकसित करते समय, मुझे एमएस सीआरएम के साथ एकीकरण की आवश्यकता थी ... एमएसडीएन में मानक क्वेरी तंत्रों को देखते हुए, मुझे एहसास हुआ कि यह थोड़ा असुविधाजनक था, और चूंकि परियोजना लंबी और यहां तक ​​कि अंतहीन (आंतरिक स्वचालन) होने का वादा करती है, इसलिए मैंने फैसला किया कि क्वेरएक्सप्रेशन का उपयोग कर रहा हूं। अपने शुद्ध रूप में श्रम लागतों में गंभीर वृद्धि होगी और असावधानीपूर्ण गलतियों के लिए प्रजनन आधार बन जाएगा (क्योंकि परियोजना के डेवलपर्स अक्सर बदल जाएंगे - जिसके पास समय है वह काम करता है)।

इसलिए, QueryExpression पर एक आवरण लिखने और EF के रूप में धाराप्रवाह प्रश्न बनाने की क्षमता जोड़ने का निर्णय लिया गया। तुरंत एक आरक्षण करें कि इस आवरण को लिखते समय (कहीं बीच में) मुझे sdk से एक पुस्तकालय मिला है जो इस तरह का अवसर प्रदान करता है - sdk crm ग्राहक लेकिन इसे और अधिक निकटता से देखने पर मुझे एहसास हुआ कि कोई प्रलेखन नहीं है (!!!) और कई अन्य विशेषताएं, उदाहरण के लिए !!! : जहां, जहां में शामिल होने के लिए, और कुछ छोटे वाले जोड़ने में उपयोग करना। मैं एक तुलनात्मक तालिका बाद में दूंगा।

चूंकि परियोजना लंबी होने का वादा करती है, इसलिए मैंने अपना कार्यान्वयन समाप्त करने का निर्णय लिया ...

उद्देश्यों:

• आवश्यक CRM संस्थाओं के लिए एक DataContract को परिभाषित करने का अवसर देने के लिए, ताकि जब फ़ील्ड बदलते / हटाते / जोड़ते समय यह केवल एक ही स्थान पर इसे ध्यान में रखना आवश्यक था
• मजबूत टाइपिंग का समर्थन करने के लिए CRM को धाराप्रवाह प्रश्न लिखने की क्षमता प्रदान करें, और संकलन समय पर फ़ील्ड प्रकार को हटाने या बदलने से अधिकतम समस्याओं की पहचान करें
• सीआरएम से प्राप्त परिणाम सेट को अनुकूलित करने की क्षमता प्रदान करें ताकि यह यातायात को कम करने के लिए सुविधाजनक हो (चयन करें, जुड़ें, कहां, आदि)।
• CRM में डेटा की सुरक्षा और भूमिका-आधारित पहुंच प्रदान करें (मेरे मामले में ASP.NET प्रतिरूपण)

आखिरकार क्या हुआ:

प्रोजेक्ट एक असेंबली है, जिसमें केवल एक अतिरिक्त निर्भरता है - microsoft.xrm.sdk.dll, जो प्रोजेक्ट से कनेक्ट करना आसान है।

ग्राहक

असेंबली क्लाइंट बनाने के लिए एक सार आधार वर्ग प्रदान करती है - CrmClientBase। इस वर्ग का एक सार क्षेत्र है जिसे ओवरराइड किया जाना चाहिए:

protected abstract IWcfCrmClient WcfClient { get; } 

IWcfCrmClient एक WCF प्रोजेक्ट में जोड़े गए सेवा संदर्भ क्लाइंट के साथ एक संचार इंटरफ़ेस है।

एक उदाहरण का उपयोग करके एक ग्राहक वर्ग कैसे बनाया जाए, यह दिखाना बेहतर होगा (ज्यादातर मामलों में, इसे प्रोजेक्ट पर कॉपी करें, सही उपयोग करें और जो कुछ भी काम करता है):

 using System; using CrmClient; using Microsoft.Xrm.Sdk; using Microsoft.Xrm.Sdk.Query; using MsCrmClientTest.MSCRM; public class OrgCrmClient : CrmClientBase { private class WcfCrmClient : IWcfCrmClient { private OrganizationServiceClient _client; public Guid Create(Entity entity) { return _client.Create(entity); } public void Update(Entity entity) { _client.Update(entity); } public void Delete(string entityName, Guid id) { _client.Delete(entityName, id); } public EntityCollection RetrieveMultiple(QueryBase query) { return _client.RetrieveMultiple(query); } public OrganizationResponse Execute(OrganizationRequest request) { return _client.Execute(request); } public void Close() { _client.Close(); } public WcfCrmClient() { _client = new OrganizationServiceClient(); } } private IWcfCrmClient _wcfClient; protected override IWcfCrmClient WcfClient { get { if (_wcfClient == null) _wcfClient = new WcfCrmClient(); return _wcfClient; } } } 

OrganizationServiceClient सेवा संदर्भ से एक ग्राहक है

मानचित्रण

सीआरएम संस्थाओं के साथ काम करने के लिए, आपको उन्हें कक्षाओं में मैप करना होगा (डेटा अनुबंध को परिभाषित करना)। इसके लिए 2 विशेषताएँ हैं (microsoft.xrm.sdk.dll असेंबली से मानक विशेषताएँ)

• EntityLogicalNameAttribute (स्ट्रिंग नाम) - CRM में इकाई का नाम परिभाषित करता है
• AttributeLogicalNameAttribute (स्ट्रिंग नाम) - CRM में इकाई क्षेत्र का नाम परिभाषित करता है

यदि कोई विशेषता निर्दिष्ट नहीं की जाती है, तो वर्ग नाम / संपत्ति का नाम CRM में इकाई / फ़ील्ड नाम के रूप में उपयोग किया जाता है।

प्रत्येक डेटा अनुबंध को बेस क्लास CrmDataContractBase से विरासत में प्राप्त किया जाना चाहिए। यह एक सार वर्ग है जिसमें एक सार संपत्ति है।

 public abstract Guid Id { get; set; } 

जिसे अतिरंजित किया जाना चाहिए और विशेषता विशेषता के साथ चिह्नित भी किया जाना चाहिए।
उदाहरण डेटा अनुबंध:

 [EntityLogicalName("systemuser")] public class User : CrmDataContractBase { [AttributeLogicalName("systemuserid")] public override Guid Id { get; set; } [AttributeLogicalName("fullname")] public string Name { get; set; } [AttributeLogicalName("parentsystemuserid")] public EntityReference hief { get; set; } [AttributeLogicalName("caltype")] public OptionSetValue CALType } 

महत्वपूर्ण!

• यदि संपत्ति किसी अन्य CRM इकाई (उदाहरण में मुख्य के रूप में) का संदर्भ है, तो यह EntityReference प्रकार का होना चाहिए
• यदि प्रॉपर्टी CRM एन्यूमरेशन (उदाहरण में CALType) से मान है, तो यह OptionSVVueue प्रकार का होना चाहिए

CRM Enumerations मैपिंग

सीआरएम एन्यूमरेशंस को मैप करने के लिए, आपको एक वर्ग को परिभाषित करने की आवश्यकता है, इसे CrmOptionsSetBase से इनहेरिट करें और इसे EntityLogicalName विशेषता के साथ चिह्नित करें, जिसमें CRM में एन्यूमरेशन का नाम निर्दिष्ट करें:

 [EntityLogicalName("connectionrole_category")] public class ConnectionRoleCategoryEnum : CrmOptionsSetBase { } 

CrmOptionsSetBase प्रकार का एक IEnumerable इंटरफ़ेस लागू करता है CrmOption, अर्थात्। इसे तुरंत नियंत्रण के लिए डेटा स्रोत के रूप में उपयोग किया जा सकता है।
CrmOption वर्ग में 2 गुण हैं:

 public string Label { get; private set; } public OptionSetValue Value { get; private set; } 

लेबल में तत्व का प्रदर्शन नाम है, और मान CRM संस्थाओं के डेटा अनुबंध में उपयोग किया जाने वाला OptionSetValue है

ग्राहक उपयोग

CRM संस्थाओं को जोड़ें, संशोधित करें, हटाएं

ये सरल ऑपरेशन हैं, उदाहरण से सब कुछ स्पष्ट होना चाहिए:

 [EntityLogicalName("new_nsi")] public class NSI : ICrmDataContract { [AttributeLogicalName("new_nsiid")] public override Guid Id { get; set; } [AttributeLogicalName("new_name")] public string Name { get; set; } } // var newnsi = new NSI { Name = "Test NSI" }; _client.Add(newnsi); // 'Add'   'Id'   ,   EF // newnsi.Name = "Test NSI 2"; _client.Update(newnsi); // _client.Delete(newnsi); 

महत्वपूर्ण! सभी परिवर्तन तुरंत सीआरएम पर लागू होते हैं। कोई लेन-देन नहीं है (मुझे अभी तक इसका पता नहीं चला है)

सीआरएम नामांकन प्राप्त करना

स्थानान्तरण प्राप्त करने के लिए ग्राहक के पास एक विशेष विधि है

 public T OptionsSet<T>() 

जहां T अंतरण का डेटा अनुबंध है। उदाहरण (ऊपर वर्णित डेटा समतुल्य):

 var optionSet = _client.OptionsSet<ConnectionRoleCategoryEnum>(); 

Linq का उपयोग करते हुए CRM के लिए प्रश्न

नाम स्थान CrmClient.Linq धाराप्रवाह CRM अनुरोध उत्पन्न करने के लिए निम्नलिखित विस्तार विधियों को परिभाषित करता है:

• CrmSelect
• CrmWhere
• CrmJoin
• CrmOrder
• CrmPaging
• CrmDistinct

इस नाम स्थान से विधियां Crm से शुरू होती हैं, ताकि आप तुरंत देख सकें कि CRM के लिए अनुरोध कहां बना है और जहां पहले से ही अनलोड की गई वस्तुओं के साथ काम चल रहा है।
CRM के लिए अनुरोध करने के लिए प्रारंभिक विधि क्वेरी है:

 public ICrmQueryable<T> Query<T>() 

इसके बाद, अनुरोध बनाने के अन्य तरीकों का उपयोग किया जा सकता है।
CRM अनुरोध स्वयं निष्पादित किया जा रहा है। जब GetEnumerator () विधि को कॉल करते हैं, अर्थात जब डेटा को गणना करने की कोशिश करते हैं (जैसे कि EF में)।

चुनना

अनाम प्रकार

 var users = _client.Query<CrmUser>() .CrmSelect(u => new { u.Id, u.Name, Test = 1 }) .ToList(); 

वर्ग (ईएफ में, कक्षा में पैरामीटर के बिना एक कंस्ट्रक्टर होना चाहिए)

 var users2 = _client.Query<CrmUser>() .CrmSelect(u => new TestUser() { Id = u.Id, FullName = u.Name, Test = 1 }) .ToList(); 

जहाँ

 // var user = _client.Query<CrmUser>() .CrmWhere(i => i.Id == _directorUserId) .Single(); var list = new[] { _directorUserId }; // in var filteredUsers = _client.Query<CrmUser>() .CrmWhere(i => list.Contains(i.Id)) .ToList(); // not in filteredUsers = _client.Query<CrmUser>() .CrmWhere(i => !list.Contains(i.Id)) .ToList(); //like var users = _client.Query<CrmUser>().ToList(); var firstUser = users.First(i => i.Name.Contains(" ")).Name.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries); // like text% var user = _client.Query<CrmUser>() .CrmWhere(i => i.Name.StartsWith(firstUser[0])) .ToList(); // like %text user = _client.Query<CrmUser>() .CrmWhere(i => i.Name.EndsWith(firstUser[0])) .ToList(); // like %text% user = _client.Query<CrmUser>() .CrmWhere(i => i.Name.Contains(firstUser[0])) .ToList(); // not like text% user = _client.Query<CrmUser>() .CrmWhere(i => !i.Name.StartsWith(firstUser[0])) .ToList(); // not like %text user = _client.Query<CrmUser>() .CrmWhere(i => !i.Name.EndsWith(firstUser[0])) .ToList(); // not like %text% user = _client.Query<CrmUser>() .CrmWhere(i => !i.Name.Contains(firstUser[0])) .ToList(); 

महत्वपूर्ण! 'इन' निर्माण के लिए, केवल एक सरणी पास होनी चाहिए। मैं थोड़ी देर बाद इस प्रतिबंध को हटा दूंगा।

यौगिक स्थितियों के लिए भी समर्थन है (जैसा कि EF “WHERE” के लिए मेरे विस्तार में इकाई ढांचे में यौगिक कुंजियों के लिए ):

 var users = _client.Query<CrmUser>().ToList(); var directors = users.Where(u => u.Director != null).Select(u => new { u.Director.Id, u.Director.Name }).Take(2); var users2 = _client.Query<CrmUser>() .CrmWhere(ExpressionType.Or, directors, (u, d) => u.Id == d.Id && u.Name == d.Name, (pn, o) => { switch (pn) { case "Id": return o.Id; case "Name": return o.Name; default: return null; } }) .ToList(); 

क्रम

 var users = _client.Query<CrmUser>() .CrmOrderBy(i => i.Name) .CrmOrderByDescending(i => i.Id) .ToList(); 

परिणाम नाम asc द्वारा क्रमबद्ध किया जाएगा, फिर Id desc द्वारा

अलग

 var users = _client.Query<CrmUser>() .CrmDistinct() .ToList(); 

शामिल हों

C चीजों को मिलाना थोड़ा और जटिल है ... उदाहरण के लिए, आपको उपयोगकर्ताओं को अपने नेताओं में शामिल करने की आवश्यकता है:

 var users = _client.Query<CrmUser>() .CrmJoin(_client.Query<CrmUser>(), s => s.Chief.Id, d => d.Id, (s, d) => new { s.Id, s.Name, ChiefId = d.Id, ChiefFullName = d.Name }) .ToList(); or var users = _client.Query<CrmUser>() .CrmLeftJoin(_client.Query<CrmUser>(), s => s.Chief.Id, d => d.Id, (s, d) => new { s.Id, s.Name, ChiefId = d.Id, ChiefFullName = d.Name }) .ToList(); 

अनुरोध सही तरीके से निष्पादित होगा। लेकिन अगर आप करीब से देखें, तो s.Chief की Id प्रॉपर्टी को कहीं भी मैप नहीं किया जाता है, क्योंकि यह EntityReference क्लास की प्रॉपर्टी है ... लेकिन s.Cief प्रॉपर्टी की मैपिंग 'Parentsystemuserid' 'CRM' के रूप में की जाती है ... क्लाइंट को CRM अनुरोध में पेरेंट्ससिस्टमसाइड को प्रतिस्थापित करके इस स्थिति को हल करता है। 's.Chief से, और नोटेशन s => s.Chief.Id, d => d.Id को टाइप संगतता के लिए आवश्यक है।

एक और समस्या एक अनुरोध में शामिल होने के लिए शर्तों का विनिर्देश है। एक CRM अनुरोध में, यह स्थिति लिंक क्लास में ही निर्दिष्ट है, इसलिए इस स्थिति को इंगित करने के लिए, आपको इसे लॉग इन अनुरोध में पंजीकृत करना होगा:

 var users = _client.Query<CrmUser>() .CrmJoin(_client.Query<CrmUser>().CrmWhere(u => u.Id == _directorUserId), s => s.Chief.Id, d => d.Id, (s, d) => new { s.Id, s.Name, ChiefId = d.Id, ChiefFullName = d.Name }) .ToList(); or var users = _client.Query<CrmUser>() .CrmLeftJoin(_client.Query<CrmUser>().CrmWhere(u => u.Id == _directorUserId), s => s.Chief.Id, d => d.Id, (s, d) => new { s.Id, s.Name, ChiefId = d.Id, ChiefFullName = d.Name }) .ToList(); 

_client.Query () (CrmWhere (u => u.Id == _directorUserId) - यह शामिल होने की शर्त है। यानी यदि यह आंतरिक रूप से जुड़ता है, तो केवल id_directorUserId वाले निर्देशक वाले उपयोगकर्ता वापस आ जाएंगे। यहां आप अन्य शर्तों को निर्दिष्ट कर सकते हैं, उदाहरण के लिए ऑर्डर, लेकिन इसका कोई प्रभाव नहीं होगा, केवल उस स्थिति को ध्यान में रखा जाएगा।

NOLOCK

इस विधि की आवश्यकता है ताकि CRM पक्ष पर अनुरोधों को (nolock) विकल्प के साथ निष्पादित किया जाए, जो पिछले अवधि के लिए रिपोर्ट के लिए डेटा प्राप्त करने के लिए उपयोगी है। एक उदाहरण:

 var users = _client.Query<CrmUser>() .CrmNoLock() .ToList(); 

पेजिंग

CRM क्वेरी परिणामों के पृष्ठ पर अंक लगाना का समर्थन करती है। पृष्ठ अनुरोध निष्पादित करने के लिए एक विधि है

 List<T> CrmGetPage(int pageNumber, int pageSize, out int totalCount, out bool moreRecordsExists) 

यह तुरंत सूची देता है, जिसका अर्थ है कि इसकी कॉल तुरंत CRM के अनुरोध को निष्पादित करती है।
यह विधि रिकॉर्ड की कुल संख्या, और एक संकेत है कि अभी भी CRM पक्ष पर प्राप्त करने के लिए डेटा है। एक उदाहरण:

 int total; bool moreExists; var users = _client.Query<CrmUser>().CrmGetPage(1, 10, out total, out moreExists); 

(सभी उदाहरण परीक्षण परियोजना में पाए जा सकते हैं)

ग्राहक सुविधाएँ

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

एसडीके से ग्राहक के साथ तुलना

गति में, यह क्लाइंट और एसडीके से क्लाइंट लगभग समान हैं (अंतर परीक्षण के दौरान नेटवर्क देरी के भीतर है)। परीक्षण CRM पर डेटा की थोड़ी मात्रा के कारण, मुझे अभी तक यह पता नहीं चला है कि SDK से क्लाइंट CRM पक्ष पर सब कुछ करता है या पहले से ही आवेदन पक्ष पर कुछ (उदाहरण के लिए, सॉर्टिंग ...), मैं इसे परीक्षण कोड से समझ नहीं सकता, क्योंकि यह उपयोग करता है मानक IQueryable और मानक Linq विस्तार विधियाँ।

तुलनात्मक परीक्षण स्वयं स्रोत में है। इसके कार्यान्वयन के परिणाम निम्नानुसार हैं:

 Operation ThisCrmClient SdkCrmClient Query 00:00:25.6005598 00:01:01.1291123 Select 00:00:03.5173517 00:00:03.6273627 Order 00:00:08.2558255 00:00:08.2338233 Where 00:00:04.1074107 00:00:03.9203920 WhereIn 00:00:05.3745374 not supported %Like% 00:00:03.3983398 00:00:03.4093409 %Like 00:00:03.4403440 00:00:03.4163416 Like% 00:00:03.3093309 00:00:03.3033303 Join 00:00:03.4313431 00:00:03.4143414 JoinFilter 00:00:03.3833383 not supported NoLock 00:00:09.6899689 not supported Distinct 00:00:07.9847984 00:00:08.0328032 

बनाता है और सूत्रों का कहना है

आप असेंबली डाउनलोड कर सकते हैं और सोर्स कोडेक्सएक्स - एमएसक्रैम्लिएंट देख सकते हैं। समाधान में 3 परियोजनाएं शामिल हैं:

• MsCrmClient - ग्राहक खुद
• MsCrmClientTest - ग्राहक के लिए परीक्षण
• PerfomanceTest - एसडीके से क्लाइंट के साथ प्रदर्शन की तुलना करने के लिए कंसोल एप्लिकेशन

एक निष्कर्ष के बजाय

मैंने कोडप्लेक्स पर अंग्रेजी में प्रलेखन लिखा था, प्रलेखन का रूसी संस्करण यह लेख है।

सभी त्रुटियां जो मुझे इस क्लाइंट के उपयोग की प्रक्रिया में मिलेगी, मैं तुरंत सही कर दूंगा और कोडप्लेक्स को अपडेट अपलोड कर दूंगा। यदि आप अपनी परियोजनाओं में इस क्लाइंट का उपयोग करने का निर्णय लेते हैं और त्रुटि पाते हैं, तो प्रोजेक्ट पृष्ठ पर एक समस्या बनाएँ। मैंने सूचनाएं प्राप्त करने के लिए साइन अप किया है। मैं जितनी जल्दी हो सके सभी त्रुटियों को ठीक करने की कोशिश करूंगा (यह मेरे हितों में है, यदि केवल इसलिए कि मैं अपनी परियोजनाओं में भी इस क्लाइंट का उपयोग करता हूं)।