Bu, Scala API'lerini tasarlamak için iyi bir dönüş tipi kalıp mı?

Question

Ben Scala oldukça sık desen (found this example here) bu tür bakın:

class UserActor extends Actor { 
    def receive = { 
    case GetUser(id) => 
     // load the user, reply with None or Some(user) 
     val user: Option[User] = ... 
     sender ! user 
    case FindAll() => 
     // find all users 
     val users: List[User] = ... 
     sender ! users 
    case Save(user) => 
     // persist the user 
     sender ! Right(user) 
    } 
} 

Yani olsun çağrı bağlı: Opsiyon [Kullanıcı], Liste [Kullanıcı], Sağ [Kullanıcı]. Bu yaklaşım iyi! Bu uygunsa, sadece çıkar ilgim var mı? Örneğin (ve bu kötü bir durum olabilir): API'yi her zaman listeye geri döndürerek denemek ve genellemek için daha iyi veya daha kötü hale getirecek mi? [Kullanıcı]? Dolayısıyla, bir kullanıcı bulunmazsa veya bir kayıt başarısız olursa, liste sadece boş olacaktır. Ben sadece merak ediyorum .... yukarıdaki 'desen' nasıl geliştirilebilir başka önerileri?

Sadece bazen bir varlık ve bazen hiçbiri ve bunların bazen bir listesini almak API bu stil için mükemmel bir model belirlemek çalışıyorum. Bunu yapmak için 'en iyi' bir yol var mı, yoksa herkes kendi rolünü oynuyor mu?

Answer 1

dönüş türlerinin API amaçlanan davranışı açıklığa kavuşmasına yardımcı olacaktır. GetUser bir List döndü

varsa, geliştiriciler karışabilir ve birden fazla kullanıcı muhtemelen iade edilebilir merak ediyorum. Bir Option'un döndüğünü gördüklerinde, hemen amaçlanan davranışı anlayacaklardır.

keresinde açıkladığınız şekilde genelleştirilmiş olmuştu CRUD işlemleri sağlanan oldukça karmaşık API ile çalışmak zorunda kaldı. Anlaması zor, belirsiz tanımlanmış ve çalışılması zor buldum. Bence

Answer 2

API tasarımı için çok iyi bir kalıptır. Tek bir eleman döndürmek istiyorsanız null başa gerekmez açıkçası çünkü
Ben, benim fonksiyonların dönüş türü olarak çok sık Option kullanın. Bir Seq döndürmek, birden çok öğe için doğaldır ve bir hata açıklaması döndürmek istiyorsanız, Either en uygunudur, ben genellikle G/Ç'yi ayrıştırırken kullanırım. Bazen Seq'u diğerlerinden biriyle bile birleştiririm. Büyük olasılıkla, API'nızın bir kullanıcısının tercihlerini ve hedeflerini bilmezsiniz. Bu nedenle, kullanıcılara mümkün olduğunca rahat hissettirmek için tüm bu geri dönüş türlerini sağlamaya çalışır.