SOAP Web Servisleri Eğitimi: SOAP Protokolü Nedir?

SABUN nedir?

SOAP, HTTP üzerinden web servislerine erişmek için kullanılan XML tabanlı bir protokoldür. Tüm uygulamalarda kullanılabilecek bazı özelliklere sahiptir.

SOAP, Basit Nesne Erişim Protokolü olarak bilinir, ancak daha sonra SOAP v1.2 olarak kısaltılmıştır. SOAP bir protokoldür veya başka bir deyişle, web servislerinin birbirleriyle veya onları çağıran istemci uygulamalarıyla nasıl iletişim kurduğunun bir tanımıdır.

SOAP, çeşitli programlama dilleri üzerine kurulu uygulamaların birbirleriyle kolayca konuşabilmesi ve aşırı geliştirme çabalarından kaçınabilmesi için bir ara dil olarak geliştirildi.

SABUN Giriş

Günümüz dünyasında, farklı programlama dilleriyle geliştirilmiş çok sayıda uygulama bulunmaktadır. Örneğin, bir web uygulaması şu dillerden birinde tasarlanmış olabilir: Java, bir diğeri .Net'te ve bir diğeri de PHP.

Uygulamalar arasında veri alışverişi, günümüzün ağ dünyasında hayati öneme sahiptir. Ancak bu heterojen uygulamalar arasındaki veri alışverişi karmaşık olacaktır. Bu veri alışverişini gerçekleştirmek için gereken kodun karmaşıklığı da öyle olacaktır.

Bu karmaşıklığı ortadan kaldırmak için kullanılan yöntemlerden biri, uygulamalar arası veri alışverişinde ara dil olarak XML (Genişletilebilir İşaretleme Dili) kullanmaktır.

Her programlama dili XML biçimlendirme dilini anlayabilir. Bu nedenle XML, veri alışverişinin temelini oluşturan araç olarak kullanıldı.

Ancak, veri alışverişi için tüm programlama dillerinde XML kullanımına ilişkin standart bir spesifikasyon bulunmamaktadır. İşte bu noktada SOAP yazılımı devreye giriyor.

SOAP, HTTP üzerinden XML ile çalışmak ve tüm uygulamalarda kullanılabilecek bir tür spesifikasyona sahip olmak üzere tasarlanmıştır. SOAP protokolü hakkında daha fazla ayrıntıyı sonraki bölümlerde ele alacağız.

SABUNUN AVANTAJLARI

SOAP, uygulamalar arasında veri alışverişi için kullanılan protokoldür. Aşağıda SOAP'ın neden kullanıldığına dair bazı nedenler verilmiştir.

• Geliştirildiğindeping SOAP tabanlı web servisleri için, web servislerinin istemci uygulamalarıyla iletişim kurabileceği bir dile ihtiyaç duyulur. SOAP, bu amaca ulaşmak için geliştirilmiş mükemmel bir araçtır. Bu protokol, tüm web standartlarının yönetim organı olan W3C konsorsiyumu tarafından da önerilmektedir.
• SOAP, uygulamalar arasında veri alışverişi için kullanılan hafif bir protokoldür. ' anahtar kelimesine dikkat edinışıkSOAP programlama dili, kendisi de hafif bir veri alışveriş dili olan XML diline dayandığı için, SOAP protokolü de aynı kategoriye girer.
• SOAP, platformdan bağımsız ve işletim sisteminden bağımsız olacak şekilde tasarlanmıştır. Bu nedenle SOAP protokolü, her iki platformda da herhangi bir programlama dili tabanlı uygulamayla çalışabilir. Windows hem de Linux platformlar.
• SOAP, HTTP protokolü üzerinde çalışır; bu, tüm web uygulamaları tarafından kullanılan varsayılan protokoldür. Bu nedenle, SOAP protokolü üzerine kurulu web servislerinin Dünya Çapında Ağ'da çalışması için herhangi bir özelleştirme gerekmez.

SABUN Yapı Taşları

SOAP spesifikasyonu "olarak bilinen bir şeyi tanımlar"SABUN mesajıBu, web servisine ve istemci uygulamasına gönderilen şeydir.

Aşağıdaki SOAP mimarisi diyagramı, bir SOAP Mesajının çeşitli yapı taşlarını göstermektedir.

SOAP mesajı, aşağıdaki bileşenlere sahip basit bir XML belgesinden başka bir şey değildir.

• An Zarf XML belgesini SOAP mesajı olarak tanımlayan öğe – Bu, SOAP mesajının kapsayıcı kısmıdır ve SOAP mesajındaki tüm ayrıntıları kapsamak için kullanılır. Bu, SOAP mesajındaki kök öğedir.
• A üstbilgi Başlık bilgilerini içeren öğe – Başlık öğesi, çağıran uygulama tarafından kullanılabilen kimlik doğrulama bilgileri gibi bilgiler içerebilir. Ayrıca, SOAP mesajında ​​kullanılabilecek karmaşık türlerin tanımlarını da içerebilir. Varsayılan olarak, SOAP mesajı, dizeler ve sayılar gibi basit türlerde olabilen, ancak karmaşık bir nesne türü de olabilen parametreler içerebilir.

Aşağıda karmaşık bir veri türünün basit bir SOAP servis örneği gösterilmiştir. Diyelim ki, "Eğitim Adı" ve "Eğitim" kombinasyonundan oluşan yapılandırılmış bir veri türü göndermek istiyoruz. DescriptEğer "ion" ise, karmaşık türü aşağıda gösterildiği gibi tanımlarız. Karmaşık tür, element etiketi ile tanımlanır. Yapının gerekli tüm unsurları ve bunlara ait veri tipleri daha sonra karmaşık tip koleksiyonunda tanımlanır.

<xsd:complexType>
   <xsd:sequence>
      <xsd:element name="Tutorial Name" type="string"/>
      <xsd:element name="Tutorial Description" type="string"/>
   </xsd:sequence>
</xsd:complexType>

A Vücut Çağrı ve yanıt bilgilerini içeren öğe – Bu öğe, web servisi ile çağıran uygulama arasında gönderilmesi gereken gerçek verileri içerir. Aşağıda, başlık bölümünde tanımlanan karmaşık tür üzerinde çalışan bir SOAP gövdesi örneği verilmiştir. İşte "Öğretim Adı" ve "Öğretim"in yanıtı. DescriptBu web servisini çağıran arayan uygulamaya gönderilen iyon.

<soap:Body>
   <GetTutorialInfo>
      <TutorialName>Web Services</TutorialName>
      <TutorialDescription>All about web services</TutorialDescription>
   </GetTutorialInfo>
</soap:Body>

SOAP Mesaj Yapısı

Unutulmaması gereken bir nokta, SOAP mesajlarının normalde web servisi tarafından çağrıldığında otomatik olarak oluşturulmasıdır.

Bir istemci uygulaması web servisindeki bir metodu çağırdığında, web servisi otomatik olarak web servisinden istemci uygulamasına gönderilecek verilerin gerekli ayrıntılarını içeren bir SOAP mesajı üretecektir.

Bu SOAP eğitiminin önceki konusunda ele alındığı gibi, basit bir SOAP mesajı aşağıdaki unsurları içerir:

• Zarf öğesi
• Başlık öğesi ve
• Vücut elemanı
• Arıza elemanı (İsteğe bağlı)

Aşağıda basit bir SOAP mesajı örneğine bakalım ve her bir öğenin aslında ne işe yaradığını görelim.

1. Yukarıdaki SOAP mesajından görüldüğü gibi, SOAP mesajının ilk kısmı, SOAP mesajının tamamını kapsüllemek için kullanılan zarf elemanıdır.
2. Bir sonraki öğe, gerçek mesajın ayrıntılarını içeren SOAP gövdesidir.
3. Mesajımızda " adlı bir web servisi bulunmaktadır.Guru99WebService”.
4. "Guru"99Webservice" adlı servis, 'int' türünde bir parametre kabul eder ve adı TutorialID'dir.

Şimdi yukarıdaki SOAP mesajı web servisi ile istemci uygulaması arasında iletilecektir.

Yukarıdaki bilgilerin istemci uygulaması için ne kadar faydalı olduğunu görebilirsiniz. SOAP mesajı, istemci uygulamasına web servisinin adını, beklediği parametreleri ve web servisi tarafından alınan her parametrenin türünü bildirir.

SABUN Zarf Elemanı

Yapı taşının ilk parçası SABUN Zarfıdır.

SOAP Zarfı, web servisi ile istemci uygulaması arasında değiştirilen SOAP mesajlarının gerekli tüm ayrıntılarını kapsüllemek için kullanılır.

SOAP zarf elemanı, bir SOAP mesajının başlangıcını ve sonunu belirtmek için kullanılır. Bu, web servisini çağıran istemci uygulamasının SOAP mesajının ne zaman biteceğini bilmesini sağlar.

SOAP zarf elemanında aşağıdaki noktalara dikkat edilebilir.

• Her SOAP mesajının bir kök Zarf (Envelope) öğesine sahip olması gerekir. Bir SOAP mesajının zarf öğesine sahip olması kesinlikle zorunludur.
• Her Zarf öğesinin en az bir sabun gövdesi öğesine sahip olması gerekir.
• Bir Zarf öğesi bir başlık öğesi içeriyorsa birden fazla içermemeli ve gövde öğesinden önce Zarfın ilk alt öğesi olarak görünmelidir.
• SOAP sürümleri değiştiğinde zarf da değişir.
• V1.1 uyumlu bir SOAP işlemcisi, v1.2 zarf ad alanını içeren bir ileti alındığında hata oluşturur.
• v1.2 uyumlu bir SOAP işlemcisi, v1.2 zarf ad alanını içermeyen bir ileti alırsa Sürüm Uyuşmazlığı hatası oluşturur.

Aşağıda, SOAP zarf öğesinin 1.2 sürümüne ait bir SOAP API örneği bulunmaktadır.

<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.w3.org/2001/12/soap-envelope" SOAP-ENV:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
   <soap:Body>
      <Guru99WebService xmlns="http://tempuri.org/">
         <TutorialID>int</TutorialID>
      </Guru99WebService>
   </soap:Body>
</SOAP-ENV:Envelope>

Arıza mesajı

Bir SOAP web servisine istek gönderildiğinde, döndürülen yanıt iki şekilde olabilir: başarılı yanıt veya hata yanıtı. Başarılı bir yanıt oluşturulduğunda, sunucudan gelen yanıt her zaman bir SOAP mesajı olacaktır. Ancak SOAP hataları oluşursa, bunlar "HTTP 500" hataları olarak döndürülür.

SOAP Hata mesajı aşağıdaki öğelerden oluşur.

1. <faultCode> – Bu kod, hatanın kodunu belirtir. Hata kodu aşağıdaki değerlerden herhangi biri olabilir:
   1. SOAP-ENV:VersionMismatch – Bu, SOAP Envelope öğesi için geçersiz bir ad alanıyla karşılaşıldığı zamandır.
   2. SOAP-ENV:MustUnderstand – MustUnderstand özniteliği “1” olarak ayarlanmış olan Başlık öğesinin hemen bir alt öğesi anlaşılmadı.
   3. SOAP-ENV:Client – ​​İleti yanlış biçimlendirilmiş veya yanlış bilgi içeriyordu.
   4. SOAP-ENV:Server – Sunucuda bir sorun olduğu için mesaj ilerleyemedi.
2. – Bu, hatanın ayrıntılı açıklamasını veren kısa mesajdır.
3. (İsteğe bağlı) – Bu, hataya kimin sebep olduğunu gösteren bir metin dizisidir.
4. (İsteğe bağlı) – Bu, uygulamaya özel hata mesajları için öğedir. Dolayısıyla uygulamanın farklı iş mantığı senaryoları için belirli bir hata mesajı olabilir.

Arıza Mesajı Örneği

Aşağıda bir hata mesajı örneği verilmiştir. Hata, istemcinin GetTutorial sınıfındaki TutorialID adlı bir yöntemi kullanmaya çalıştığı senaryoda oluşur. Aşağıdaki hata mesajı, tanımlanan sınıfta bu yöntemin bulunmaması durumunda oluşturulur.

<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" xmlns:xsd="http://www.w3.org/1999/XMLSchema">
   <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
      <faultcode xsi:type="xsd:string">SOAP-ENV:Client</faultcode>
      <faultstring xsi:type="xsd:string">
         Failed to locate method (GetTutorialID) in class (GetTutorial)
      </faultstring>
      </SOAP-ENV:Fault>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Çıktı:

Yukarıdaki kodu çalıştırdığınızda, "(GetTutorial) sınıfında (GetTutorialID) metodu bulunamadı" gibi bir hata mesajı görüntülenecektir.

SABUN İletişim Modeli

SOAP ile tüm iletişim HTTP protokolü aracılığıyla yapılır. SOAP'tan önce pek çok web hizmetleri iletişim için standart RPC (Uzaktan Prosedür Çağrısı) stilini kullandı. Bu en basit iletişim türüydü ancak birçok sınırlaması vardı.

Şimdi bu SOAP API eğitiminde, bu iletişimin nasıl çalıştığını görmek için aşağıdaki şemayı inceleyelim. Bu örnekte, sunucunun aşağıdaki gibi 2 yöntem sağlayan bir web servisine ev sahipliği yaptığını varsayalım:

• Çalışan Alın – Bu, tüm çalışanların bilgilerini alacaktır.
• Çalışanı Ayarla – Bu, çalışanın departmanı, maaşı vb. detayların değerini buna göre ayarlayacaktır.

Normal RPC tarzı iletişimde, istemci yalnızca isteğindeki yöntemleri çağırır ve gerekli parametreleri sunucuya gönderir ve ardından sunucu da istenen yanıtı gönderir.

Yukarıdaki iletişim modelinin aşağıdaki ciddi sınırlamaları vardır:

1. Dilden Bağımsız Değil – Metotları barındıran sunucu belirli bir programlama dilinde olurdu ve normalde sunucuya yapılan çağrılar yalnızca o programlama dilinde olurdu.
2. Standart protokol değil – Uzaktan prosedüre çağrı yapıldığında, çağrı standart protokol üzerinden gerçekleştirilmez. Bu, çoğunlukla web üzerinden tüm iletişimin HTTP protokolü aracılığıyla yapılması gerektiğinden bir sorundu.
3. Güvenlik duvarları – RPC çağrıları normal protokol üzerinden gitmediğinden, istemcinin sunucuyla iletişim kurabilmesi için sunucuda ayrı bağlantı noktalarının açık olması gerekir. Normalde tüm güvenlik duvarları bu tür trafiği engellerdi ve istemci ile sunucu arasındaki bu tür iletişimin çalışacağından emin olmak için genellikle çok sayıda yapılandırma gerekiyordu.

Yukarıda belirtilen tüm sınırlamaların üstesinden gelmek için SOAP, aşağıdaki iletişim modelini kullanacaktır.

1. İstemci, prosedür çağrısı ve argümanlarla ilgili bilgileri bir SOAP mesajına dönüştürür ve bunu bir HTTP isteğinin parçası olarak sunucuya gönderir. Verilerin bir SOAP mesajına kapsüllenmesi işlemine şu ad verilmiştir: Marshalling.
2. Sunucu daha sonra istemci tarafından gönderilen mesajı açar, istemcinin ne istediğini görür ve ardından uygun yanıtı bir SOAP mesajı olarak istemciye geri gönderir. Mesajı açma işlemi bu şekilde gerçekleştirilir.ping Müşteri tarafından gönderilen bir istek şu şekilde bilinir: Sınırların kaldırılması.

Pratik SABUN Örneği

Şimdi bunda SoapUI Bu eğitimde, pratik bir SOAP örneğine bakalım. SOAP mesajlarının nasıl oluşturulduğunu görmenin en iyi yollarından biri, bir web servisinin çalışmasını bizzat gözlemlemektir.

Bu konu, MicrosoftBir ASMX web hizmeti oluşturmak için .Net çerçevesi. Bu tür web hizmeti hem SOAP sürüm 1.1'i hem de sürüm 1.2'yi destekler.

ASMX web hizmetleri otomatik olarak Web Hizmeti Tanımlama Dili (WSDL) belge. Bu WSDL belgesi, çağrı yapan istemci uygulaması tarafından gereklidir, böylece uygulama, web hizmetinin neler yapabileceğini bilir.

Örneğimizde, web servisini çağıran uygulamaya bir dize döndürecek basit bir web servisi oluşturacağız. Bu web servisi bir sunucuda barındırılacaktır. Asp.Net web uygulaması. Daha sonra web servisini çağıracağız ve web servisinin döndürdüğü sonucu göreceğiz.

Visual Studio ayrıca web servisi ile çağıran uygulama arasında iletilen SOAP mesajının ne olduğunu da bize gösterecektir. Web servis uygulamamızı kurmak için ilk ön koşul, aşağıdaki adımları izleyerek yerine getirilebilir. Bu örnek için lütfen sisteminizde Visual Studio 2013'ün kurulu olduğundan emin olun.

) 1 Adım İlk adım boş bir ASP.Net Web uygulaması oluşturmaktır. Visual Studio 2013'ten, Dosya->Yeni proje menü seçeneğine tıklayın.

Yeni Proje seçeneğine tıkladığınızda, Visual Studio size proje türünü seçmeniz ve projenin gerekli ayrıntılarını vermeniz için başka bir iletişim kutusu sunacaktır. Bu bir sonraki adımda açıklanmaktadır.

) 2 Adım Bu adımda,

1. İlk önce seçtiğinizden emin olun C# ASP.NET web uygulaması için web şablonu. SOAP servisleri projesi oluşturmak için projenin bu türde olması gerekir. Bu seçeneği seçtiğinizde, Visual Studio, herhangi bir web tabanlı uygulama tarafından ihtiyaç duyulan gerekli dosyaları eklemek için gerekli adımları gerçekleştirecektir.
2. Projenize bir isim verin; bizim örneğimizde bu isim webservice.asmx'tir. Ardından proje dosyalarının saklanacağı konumu belirtmeyi unutmayın.

İşlem tamamlandığında, Visual Studio 2013'teki çözüm gezgininde oluşturulan proje dosyasını göreceksiniz.

) 3 Adım Bu adımda, projemize bir web servis dosyası ekleyeceğiz.

1. Öncelikle, aşağıda gösterildiği gibi proje dosyasına sağ tıklayın.

2. Proje dosyasına sağ tıkladığınızda, web servis dosyası eklemek için "Ekle -> Web Servisi (ASMX)" seçeneğini seçebilirsiniz. Web servis dosyası adı için "Eğitim Servisi" adını girmeniz yeterlidir.

) 4 Adım Aşağıdaki kodu Tutorial Service asmx dosyanıza ekleyin.

Code Açıklama:

1. Bu kod satırı web hizmeti dosyanız için bir ad sağlar. Bu önemli bir adımdır çünkü istemci uygulamasının web servisini web servisinin adı aracılığıyla aramasına olanak sağlar.
2. Normalde bir sınıf dosyası, bir web hizmetinin işlevselliğini kapsüllemek için kullanılır. Böylece sınıf dosyası, istemci uygulamasına bazı işlevler sağlayacak tüm web yöntemlerinin tanımına sahip olacaktır.
3. Burada [WebMethod], bir işlevi tanımlayan bir özellik olarak bilinir. Sonraki adımda " adlı bir işlev oluşturulur.Guru"99WebService" bileşeninde olduğu gibi, [WebMethod] özniteliğinin eklenmesiyle bu yöntemin bir istemci uygulaması tarafından çağrılabilmesi sağlanır. Bu öznitelik mevcut değilse, yöntem hiçbir zaman bir istemci uygulaması tarafından çağrılamaz.
4. Burada ' adlı bir fonksiyon tanımlıyoruz.Guru'99WebService' fonksiyonu, çağıran istemci uygulamasına bir dize döndürmek için kullanılacaktır. Bu fonksiyon, herhangi bir istemci uygulaması tarafından çağrılabilecek bir web servisidir.
5. "Bu bir" dizesini döndürmek için `return` ifadesini kullanıyoruz. Guru99. İstemci uygulamasına "Web hizmeti".

Kod başarıyla yürütülürse, kodunuzu tarayıcıda çalıştırdığınızda aşağıdaki Çıktı gösterilecektir.

Çıktı:

• Çıktı, web servisimizin adının " olduğunu açıkça göstermektedir.Guru"99 Web Service", web servisimize verdiğimiz isim sonucunda ortaya çıkan bir isimdir.
• Ayrıca web servisini çağırabileceğimizi de görüyoruz. Çağır düğmesine tıkladığımızda, web tarayıcısında aşağıdaki yanıtı alacağız.

Yukarıdaki çıktı:

• Bu, web yöntemini çağırarak "Bu bir" dizesinin elde edildiğini açıkça göstermektedir. Guru"99 Web hizmeti" yanıtı döndürülür.
• Visual Studio ayrıca yukarıdaki web servisi çağrıldığında üretilen SOAP mesaj isteğini ve yanıtını görüntülemenize de olanak tanır.

Web servis çağrıldığında oluşan SOAP isteği aşağıda gösterilmiştir.

Code Açıklama:

1. SOAP mesajının ilk kısmı, önceki bölümlerde ele alınan zarf öğesidir. Bu, her SOAP mesajında ​​bulunan kapsülleme öğesidir.
2. SOAP Gövdesi bir sonraki öğedir ve SOAP mesajının gerçek ayrıntılarını içerir.
3. Üçüncü kısım, ' olarak adlandırılan hizmeti çağırmak istediğimizi belirten öğedir.Guru99WebService'.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <Guru99WebServiceResponse xmlns="http://tempuri.org/">
         <Guru99WebServiceResult>string</Guru99WebServiceResult>
      </Guru99WebServiceResponse>
   </soap:Body>
</soap:Envelope>

Code Açıklama:

1. SOAP mesajının ilk kısmı, önceki bölümlerde ele alınan zarf öğesidir. Bu, her SOAP mesajında ​​bulunan kapsülleme öğesidir.
2. SOAP Gövdesi bir sonraki öğedir ve SOAP mesajının gerçek ayrıntılarını içerir.
3. Şimdi göreceğiniz ilginç kısım 'string' özniteliğidir. Bu, istemci uygulamasına çağrılan web servisinin string türünde bir nesne döndürdüğünü söyler. Bu çok kullanışlıdır çünkü aksi takdirde istemci uygulaması web servisinin ne döndürdüğünü bilemezdi.

SSS