A jegyzet az ELTE Informatikai Karának 2016. évi jegyzetpályázatának támogatásával készült

Giachetta, Roberto

ELTE Digital Institutional Repository (EDIT)

Eötvös Loránd Tudományegyetem Informatikai KarWebes alkalmazások fejlesztéseGiachetta RobertoA jegyzet az ELTE Informatikai Karának 2016. évi jegyzetpályázatának támogatásával készült8. fejezetWebszolgáltatások megvalósítása (ASP.NET WebAPI)Webszolgáltatások megvalósítása• A webszolgáltatás (web service) olyan protokollok és szabályok gyűjteménye, amely lehetővé teszi alkalmazások közötti platform független adatcserét hálózaton keresztül• azaz a rendszernek egy, vagy szolgáltatója (serviceprovider) biztosítja a funkcióknak olyan felületét, amelyet a fogyasztók (service consumer) elérhetnek• a fogyasztó lehet bármilyen alkalmazás, weblap, …• a kommunikációra számos protokollt és megoldást használhat, pl. SOAP (Simple Object Access Protocol) és WSDL (Web Services Description Language), vagy REST• lehetővé teszi a szolgáltatásorientált architektúra (Service Oriented Architecture, SOA) létrehozásátELTE IK, Webes alkalmazások fejlesztése 8:2A webszolgáltatásWebszolgáltatások megvalósítása• A REST (Representational State Transfer) egy szoftver architektúra típus, amely lehetővé teszi skálázható, nagy teljesítményű elosztott hálózati alkalmazások fejlesztésére• elsősorban HTTP alapon kommunikál alapvető HTTP utasítások (GET, POST, PUT, DELETE, …) segítségével• megszorításokat ad a rendszernek: • kliens-szerver modell, • egységes interfész, • állapotmentes kommunikáció, • kiegészíthetőség (code on demand), …• a támogató szoftverek a RESTful alkalmazásokELTE IK, Webes alkalmazások fejlesztése 8:3RESTWebszolgáltatások megvalósítása• Az ASP.NET WebAPI egy RESTful alkalmazások fejlesztését lehetővé tevő keretrendszer• az MVC architektúrát valósítja meg, a tevékenységeket vezérlők felügyelik, amelyek adott erőforrásra és utasításra reagálnak• az adatokat alapértelmezetten JSON (Javascript ObjectNotation) formátumban továbbítja, de a kliens kérésének megfelelően automatikusan tudja a formátumot módosítani• könnyen integrálható az ASP.NET MVC webalkalmazásokkal• NuGet-ből telepíthető (ASP.NET WebAPI csomag)ELTE IK, Webes alkalmazások fejlesztése 8:4ASP.NET WebAPIWebszolgáltatások megvalósítása• A JSON egy egyszerű formátum objektumok szöveges leképezése, pl.:{ // objektum"id": 1234, // attribútum"group": "tool","name": "hammer","resposible": { "name" : "John" },// összetett attribútum"materials": [ // tömb attribútum{ "name": "steel" },…]}ELTE IK, Webes alkalmazások fejlesztése 8:5JSONWebszolgáltatások megvalósítása• A vezérlőkben (ApiController) valósítjuk meg a HTTP akcióműveleteket (Get, Post, …)• a visszatérési érték a HTTP válasz törzsébe (body) kerül, ekkor egy OK (200) válasz készül• amennyiben nincs visszatérési érték (void), akkor egy No Content (204)  válasz kerül kiküldésre• a műveletek feloldása az elérési útvonal leképezésének (HttpRoute) megfelelően történik, alapértelmezetten a <domain>/api/<vezérlő>/<paraméterek> formában• a műveletek csak korlátozottan túlterhelhetőek• az erőforrás címe mellett tartalmat is szolgáltathatunk, amit a kérés törzsébe helyezünk  (FromBody)ELTE IK, Webes alkalmazások fejlesztése 8:6VezérlőkWebszolgáltatások megvalósítása• Pl.:public class ProductsController : ApiController {IList<string> products; // modell…// elérés GET /api/products/public IEnumerable<string> Get() {return products; // összes termék lekérése }// elérés: GET /api/products/1public string Get(int id) {return products[id]; // adott termék lekérése}ELTE IK, Webes alkalmazások fejlesztése 8:7VezérlőkWebszolgáltatások megvalósítása• Pl.:// elérés: POST /api/products/public void Post([FromBody] string product) {// meg kell adnunk, hogy a tartalom a// törzsben találhatóproducts.Add(product);}// elérés: DELETE /api/products/1public void Delete(int id) {products.RemoveAt(id);}}ELTE IK, Webes alkalmazások fejlesztése 8:8VezérlőkWebszolgáltatások megvalósítása• A WebAPI használatba vétele előtt az ASP.NET alkalmazást megfelelő konfigurációval (elsősorban az útvonal feloldás leírásával) kell ellátnunk• az útvonalelérés konfigurációját a WebApiConfig osztály Register művelete végzi (az App_Start könyvtárban) :config.Routes.MapHttpRoute(name: "DefaultApi",routeTemplate: "api/{controller}/{id}", …});• az Application_Start eseménykezelőben ezt a műveletet át kell adnunk a globális konfigurációnak:GlobalConfiguration.Configure(WebApiConfig.Register);ELTE IK, Webes alkalmazások fejlesztése 8:9KonfigurációWebszolgáltatások megvalósítása• A webszolgáltatás műveletei nem csak primitív típusokat, de összetett, adatátviteli objektumokat (Data Transfer Object, DTO) is közölhetnek• DTO bármilyen objektum lehet, ami szérializálható (az elvárt formátumban), azaz leképezhető primitív értékekből álló felépítésre• a felépítését úgy kell megválasztanunk, hogy az belső adatokat, illetve szükségtelen, vagy körkörös hivatkozásokat (pl. entitásobjektum esetén) ne tartalmazzon• visszaadhatunk egyedileg konfigurált HTTP üzenetet is (HttpResponseMessage), amelyet aszinkron módon is létrehozhatunk (IHttpActionResult)ELTE IK, Webes alkalmazások fejlesztése 8:10AdatszolgáltatásWebszolgáltatások megvalósítása• Pl.:public class Product { // DTO típuspublic Int32 Id { get; set; }public String Name { get; set; }}public class ProductsController : ApiController {…// elérés GET /api/products/public IEnumerable<Product> Get() {return products; // összes termék lekérése }…}ELTE IK, Webes alkalmazások fejlesztése 8:11AdatszolgáltatásWebszolgáltatások megvalósítása• Pl.:public class ProductsController : ApiController {…// elérés GET /api/products/public HttpResponseMessage Get() {return new HttpResponseMessage(){ // egyedileg összeállított üzenetStatusCode = HttpStatusCode.OK,Content = new ObjectContent<Product>(products,Configuration.Formatters.JsonFormatter)// megadjuk a kódot és a tartalmat};}ELTE IK, Webes alkalmazások fejlesztése 8:12AdatszolgáltatásWebszolgáltatások megvalósítása• A HTTP műveletek társítása megfeleltetése vezérlő műveleteknek lehet • automatikus, a név kezdőszelete alapján történik, pl.:public class ProductsController : ApiController{…// elérés: GET /api/products/1public Product GetSingleProduct(int id) { … }…// elérés: DELETE /api/products/1public void DeleteProduct(int id) { … }…}ELTE IK, Webes alkalmazások fejlesztése 8:13Műveletek eléréseWebszolgáltatások megvalósítása• manuális, attribútumok segítségével megjelölve a HTTP műveletet (HttpGet, HttpPost, HttpDelete, …) és az elérési útvonalat (Route), pl.:public class ProductsController : ApiController{…// elérés: GET /api/myproducts/1[Route("api/myproducts/{id}")][HttpGet]public Product FindProduct(int id) { … }…}• a manuális útvonal feloldást külön kell jeleznünk: config.MapHttpAttributeRoutes();ELTE IK, Webes alkalmazások fejlesztése 8:14Műveletek eléréseWebszolgáltatások megvalósítása• az útvonal megjelölésénél lehetőségünk van• előtagot adni a vezérlőnek (RoutePrefix)• tetszőleges módon elhatárolni a paramétereket (további útvonal komponensek hozzáadásával)• megszorításokat adni a paraméterekre, úgymint típus (bool, datetime, decimal, double, float, guid, int, long), hosszúság (length, maxlength, maxlength), érték (min, max, range , values), alak (alpha, regex)• meghatározni a prioritást (RouteOrder), amennyiben több műveletre is illeszkedik az útvonal• a típusmegjelölés lehetővé teszi a túlterhelést, mivel a típusnak megfelelő műveletet tudja futtatni a rendszerELTE IK, Webes alkalmazások fejlesztése 8:15Műveletek eléréseWebszolgáltatások megvalósítása• pl.:[RoutePrefix("api/myproducts")] // előtagpublic class ProductsController : … {…// elérés: GET /api/myproducts/1[Route("{id:int:min(1)}")]public Product GetProduct(int id) { … }// elérés: GET /api/myproducts/tools/item/1[Route("{group:values(tools|machines)}/item/{id:int:min(1)}")]public Product GetProduct(string group, int id) { … }}ELTE IK, Webes alkalmazások fejlesztése 8:16Műveletek eléréseWebszolgáltatások megvalósításaFeladat: Valósítsuk meg egy utazási ügynökség weblapját, amelyben apartmanok között böngészhetünk.• könnyítsük meg a foglalást az által, hogy a dátumot egy naptár (glDatePicker) segítségével lehessen kiválasztani• a dátumkiválasztó automatikusan lekérdezi (jQuerysegítségével) a szolgáltatástól, mely napok szabadok• a szolgáltatása vezérlője (RentDateApiController) egy műveletet biztosít (Get) a megfelelő napok lekérdezésére• magát a lekérdezést a modell (TravelService) biztosítja (GetRentDates), amely adott egy hónap körüliELTE IK, Webes alkalmazások fejlesztése 8:17PéldaWebszolgáltatások megvalósításaTervezés:ELTE IK, Webes alkalmazások fejlesztése 8:18PéldaApiControllerControllers::RentDateApiController- _service  :ITravelService+ Get(Int32?, Int32?, Int32?)  :IEnumerable<DateTime>+ RentDateApiController()Models::TravelService- _entities  :TravelAgencyEntities+ GetApartment(Int32?)  :Apartment+ GetBuilding(Int32?)  :Building+ GetBuildingImage(Int32?, Boolean)  :Byte[]+ GetBuildingImageIds(Int32?)  :IEnumerable<Int32>+ GetBuildingMainImage(Int32?)  :Byte[]+ GetBuildings(Int32?)  :IEnumerable<Building>+ GetBuildingWithApartments(Int32?)  :Building+ GetPrice(Int32?, RentViewModel)  :Int32+ GetRentDates(Int32, Int32, Int32)  :IEnumerable<DateTime>+ NewRent(Int32?)  :RentViewModel+ SaveRent(Int32?, String, RentViewModel)  :Boolean+ TravelService()«property»+ Buildings()  :IEnumerable<Building>+ Cities()  :IEnumerable<City>Webszolgáltatások megvalósításaMegvalósítás (RentDateApiController.cs):[RoutePrefix("api/rentdate")] // útvonal feloldás megadásapublic class RentDateApiController : ApiController{…[Route("{apartmentId}/{year}/{month}")] // útvonal feloldás megadásapublic IEnumerable<DateTime> Get(Int32? apartmentId, Int32? year, Int32? month) { … }}ELTE IK, Webes alkalmazások fejlesztése 8:19PéldaWebszolgáltatások megvalósításaMegvalósítás (Rent/Index.cshtml):<script type="text/javascript">$(window).load(function () {…jQuery.getJSON("api/rentdate/" +@Model.Apartment.Id + "/" + year + "/" +month,function (data){options.selectableDates =parseDates(data);});…}ELTE IK, Webes alkalmazások fejlesztése 8:20PéldaWebszolgáltatások megvalósítása• A vezérlő nem csupán az alapértelmezett, de tetszőleges HTTP kóddal tud válaszolni a kérésekre, amennyiben általános visszatérési típust specifikálunk (IHttpActionResult)• előre definiált visszatérési függvényekkel könnyedén megadhatjuk az eredményt: Ok(<content>), Created(<location>, <content>), Redirect(<location>), NotFound(), Unauthorized(), BadRequest(<message>), Conflict(), InternalServerError(<exception>))• a megfelelő visszajelzés a hibakezelés szempontjából is fontos (amennyiben nem kezeljük le a műveletben dobott kivételeket, INTERNAL SERVER ERROR (500) üzenetet küld a szolgáltatás)ELTE IK, Webes alkalmazások fejlesztése 8:21Visszajelzés és hibakezelésWebszolgáltatások megvalósítása• pl.:public IHttpActionResult GetProduct(int id) {try {…return Ok(product); // amennyiben sikeres volt a// lekérdezés, 200-as kód}catch {return NotFound(); // ellenkező esetben 404-es kód} }ELTE IK, Webes alkalmazások fejlesztése 8:22Visszajelzés és hibakezelésWebszolgáltatások megvalósítása• A webszolgáltatások tesztelése elvégezhető• manuálisan, kliens oldalon, a kérések küldését biztosító program (böngésző) segítségével• automatikusan, kliens oldalon, a kérések küldését biztosító osztály (pl. HttpClient) segítségével• automatikusan, szerver oldalon, a vezérlő műveleteinek közvetlen tesztelésével• A webszolgáltatás használata a célkörnyezetben (weblap, asztali alkalmazás, …) már integrációs teszt, amelyet csak a megfelelő egységtesztek végrehajtása után kezdeményezhetünkELTE IK, Webes alkalmazások fejlesztése 8:23TesztelésWebszolgáltatások megvalósítása• Amennyiben függőséggel rendelkező programegységet tesztelünk, a függőséget helyettesítjük annak szimulációjával, amit mock objektumnak nevezünk• megvalósítja a függőség interfészét, egyszerű, hibamentes funkcionalitással• használatukkal a teszt valóban a megadott programegység funkcionalitását ellenőrzi, nem befolyásolja a függőségben felmerülő esetleges hiba• Mock objektumokat manuálisan is létrehozhatunk, vagy használhatunk erre alkalmas programcsomagot• pl. NSubstitute, Moq letölthetőek NuGet segítségévelELTE IK, Webes alkalmazások fejlesztése 8:24Mock objektumokWebszolgáltatások megvalósítása• Pl. :class DependencyMock : IDependency// mock objektum{// egy egyszerű viselkedést adunk megpublic Double Compute() { return 1; }public Boolean Check(Double value) {return value >= 1 && value <= 10;}}…Dependant d = new Dependant(new DependencyMock());// a mock objektumot fecskendezzük be a függő// osztálynakELTE IK, Webes alkalmazások fejlesztése 8:25Mock objektumokWebszolgáltatások megvalósítása• Moq segítségével könnyen tudunk interfészekből mockobjektumokat előállítani• a Mock generikus osztály segítségével példányosíthatjuk a szimulációt, amely az Object tulajdonsággal érhető el, és alapértelmezett viselkedést produkál, pl.:Mock<IDependancy> mock = new Mock<IDependancy>();// a függőség mock objektumaDependant d = new Dependant(mock.Object);// azonnal felhasználható• a Setup művelettel beállíthatjuk bármely tagjának viselkedését (Returns(…), Throws(…), Callback(…)), a paraméterek szabályozhatóak (It)ELTE IK, Webes alkalmazások fejlesztése 8:26Mock objektumokWebszolgáltatások megvalósítása• pl. :mock.Setup(obj => obj.Compute()).Returns(1);// megadjuk a viselkedést, mindig 1-t ad// visszamock.Setup(obj =>obj.Check(It.IsInRange<Double>(0, 10,Range.Inclusive))).Returns(true);mock.Setup(obj => obj.Check(It.IsAny<Double>()).Returns(false);// több eset a paraméter függvényében…• lehetőségünk van a hívások nyomkövetésére (Verify(…))ELTE IK, Webes alkalmazások fejlesztése 8:27Mock objektumokWebszolgáltatások megvalósításaFeladat: Teszteljük az utazási ügynökség weblapját, azon belül pedig a szabad napokat lekérdező webszolgáltatást.• egy külön tesztprojektben létrehozzuk a tesztkörnyezetet biztosító osztályt (TravelServiceTest), ezek belül pedig a Get művelet funkcionalitását teszteljük• ehhez leválasztjuk az entitásmodell interfészét (ITravelAgencyEntities), amelyet szimulálunk a teszthez (ehhez a Moq programcsomagot használjuk)• an entitásmodell mellett a foglalások gyűjteményét (DbSet<Rent>) is szimuláljuk, és az adatokat egy listában adjuk megELTE IK, Webes alkalmazások fejlesztése 8:28PéldaWebszolgáltatások megvalósításaTervezés:ELTE IK, Webes alkalmazások fejlesztése 8:29PéldaTests::TravelServiceTest- _data  :IQueryable<Rent>- _entityMock  :Mock<ITravelAgencyEntities>- _rentMock  :Mock<DbSet<Rent>>+ Initialize()  :void+ TravelServiceGetRentDatesTest()  :voidIDisposable«interface»Models::ITravelAgencyEntities+ SaveChanges()  :Int32«property»+ Apartment()  :DbSet<Apartment>+ Building()  :DbSet<Building>+ BuildingImage()  :DbSet<BuildingImage>+ City()  :DbSet<City>+ Guest()  :DbSet<Guest>+ Rent()  :DbSet<Rent>ApiControllerControllers::RentDateApiController- _service  :ITravelService+ Get(Int32?, Int32?, Int32?)  :IHttpActionResult+ RentDateApiController()Models::TravelAgencyEntitiesWebszolgáltatások megvalósításaMegvalósítás (TravelServiceTest.cs):[TestMethod]public void TravelServiceGetRentDatesTest() {…// ellenőrzések júniusraDateTime[] result = service.GetRentDates(0, 2016, 06).ToArray();foreach (DateTime date in _data.Where(rent => rent.ApartmentId == 0).Select(rent => rent.StartDate))Assert.IsFalse(content.Contains(date));…}ELTE IK, Webes alkalmazások fejlesztése 8:30Példa

Webes alkalmazások fejlesztése

https://edit.elte.hu/xmlui/bitstream/10831/33304/8/elte_waf_08.pdf

Webes alkalmazások fejlesztése

Abstract

Similar works

Full text

Available Versions

ELTE Digital Institutional Repository (EDIT)