API ve uygulama arasında nesne paylaşma düzeni

Web uygulamamın tasarımı hakkında ciddi şüphelerim var.

İş mantığını arayüzden ayırmak istedim, böylece veritabanına yapılan tüm istekleri işleyen bir Web API'sı yaptım.

Entity çerçeveli bir ASP.NET Web API'sı ve bir iş birimi ve genel veri havuzu modeli. Şimdiye kadar her şey iyi.

SORUN

Yardıma ihtiyacım olduğunda API ile uygulama arasında nesne paylaşmanın etkili bir yolunu bulamıyorum.

Varlık nesnesini doğrudan serileştirmek istemiyorum, kötü bir uygulama olacağını düşündüm çünkü varlık modeli değişirse, büyük nesneleri hiçbir sebeple serileştirebilirim.

Şimdi nasıl uygulandı

Arabirim C # ASP.NET Web uygulaması ve API # C olduğundan, aralarında paylaşmak istediğim tüm sınıflarımın tanımı ile ortak bir kütüphane yaptım.

Bir android uygulaması geliştirdiğimde çözümün işe yaramayacağını biliyorum, sınıflarımı tekrar Java'da oluşturmak zorunda kalacağım, ancak bu benim en büyük sorunum değil.

Sorun şu ki, nesnelerimı her zaman dönüştürüyorum gibi hissediyorum.

MİSAL

İşte iş akışımın bir örneği:

Ben form için tüm nesneler ve veri ek açıklamaları ile bir model ile başlar sonra kullanıcı bir denetleyiciye POST POST olacaktır.

Denetleyicide bu modeli ortak kütüphanemdeki bir sınıfa dönüştürmem ve sonra bu nesneyi API'ma göndermem gerekiyor.

Daha sonra API'mdaki bir denetleyici çağrıyı yakalar ve veritabanını güncellemek için bu nesneyi bir varlık nesnesine dönüştürür.

3 dersim var

1. Doğrulama için tüm veri ek açıklamalarına sahip görünümün modeli (İstemci)
2. Nesneleri paylaşmak için ortak kütüphane sınıfları (DLL)
3. Varlık sınıfları (API)

Gerçekten yanlış bir şey yaptığımı hissediyorum. Daha zarif bir şey var mı? Proje çok büyük hale gelmeden önce bu soruna iyi bir çözüm bulduğumdan emin olmak istiyorum.

Veritabanınızdaki nesneler, veri aktarım nesneleriniz, doğrulama mantığına sahip istemci nesneleriniz arasında nesneleri sürekli olarak dönüştürdüğünüzü biliyor olabilirim, ancak hayır, hayır diyorum, yanlış bir şey yapmıyorsunuz .

Bu nesnelerin her biri aynı bilgi birimini temsil edebilir, ancak çok farklı sorumlulukları vardır. Veritabanı nesnesi, veritabanı ile iletişim arabiriminizdir ve farklı veritabanı meta veri ek açıklamalarına ve / veya içindeki veritabanı uygulamasıyla ilgili gereksiz ayrıntılara sahip olabileceğinden veya olmayabileceğinden veritabanı katmanında tutulmalıdır.

Veri aktarım nesneniz, API tüketicilerinizle iletişim arabirimidir. Farklı dillerden / platformlardan kolay tüketim sağlamak için bunlar mümkün olduğunca temiz olmalıdır. Bu, hangi API tüketicilerini desteklemek istediğinize bağlı olarak bunların nasıl göründüğü ve davranacağı konusunda bazı kısıtlamalar getirebilir.

Doğrulama mantığına sahip istemci nesneleriniz gerçekten API projenizin bir parçası değil, tüketici projenizin bir parçası. Bunlar, sunucunun hakkında hiçbir şey bilmediği (ve hakkında hiçbir şey bilmemesi gereken) ek istemciye özgü mantık (bu durumda doğrulama öznitelikleri) eklediğiniz için bu durumda veri aktarım nesneleriyle aynı olamaz. bu nesneleri API'nizin bir parçası olarak sayın, çünkü gerçekten değildirler. Son derece tüketici uygulamasına özeldirler ve API'nizi tüketen bazı uygulamaların aslında bu nesneyi oluşturması gerekmeyebilir ve sadece veri aktarım nesnelerinizde de hayatta kalabilir. Örneğin, herhangi bir doğrulama gereksiniminiz yoksa, veri aktarım nesnelerinizle tamamen aynı olan fazladan bir nesne katmanına ihtiyacınız olmaz.

Bana göre, üç nesne türünün her biri temiz kodlama ve iyi uygulama olan tek bir sorumlulukla çok güzel bir şekilde eşleşiyor gibi görünüyor. Ne yazık ki, temiz kod ve iyi uygulamalar bazen çok fazla ekstra kod yazdığınız ve "çünkü sadece" ekstra çemberlerden atladığınız anlamına gelir. Kodlama yaparken, bunun size verdiği değeri takdir etmek zor olabilir - ancak uygulamanızı bırakıp desteklemeye veya bir sonraki sürüm için yeni özellikler eklemeye başlar başlamaz muhtemelen zaman ayırdığınızı takdir etmeye başlayacaksınız. bu endişeleri ilk etapta doğru şekilde ayırın. (Sizden bahsetmiyorum bile)

Ayrıca böyle farklı nesne türleri arasında dönüşüm kodu yazmaktan nefret ediyorum, ancak benim çözümüm genellikle aşağıdakilerden biridir:

• Nesne dönüştürme işlemlerinin çoğunu sizin için yapan bir kütüphane kullanın - örneğin, C # kullanıyorsanız, fantastik AutoMapper kütüphanesini ( http://automapper.org/ ) kullanabilirsiniz. Bunun gibi birkaç kütüphane olduğuna inanıyorum, ancak AutoMapper şimdiye kadar gördüğüm en güçlü kütüphanedir.
• Nesne dönüşümlerinizde size yardımcı olacak bir kütüphane bulamazsanız, bunlar arasında dönüştürme için bir dizi yardımcı yöntem yazın. Bu berbat olabilir, ancak uzun vadede buna değer, bir şeyi dönüştürmek için ilk ihtiyacınız olan dönüşüm yöntemini yazın - beklemeyin.