Mimari katmanlandırma ve API adlandırma

Jetpack Compose A2UI oluşturucu, üzerine geliştirme yapabileceğiniz doğru katmanı seçmenize olanak tanıyan katmanlı bir mimari tanımlar. Anlamsal katmanlamaya ek olarak, net bir adlandırma şeması, API amacını iletir ve sınıf yolunuzu gereksiz dahili türlerle doldurmamak için görünürlüğü kontrol eder.

API'ler, kullanım alanına ve görünürlüğe göre iki ana kategoride düzenlenir:

  1. Uygulama ve bileşen geliştiriciler için API'ler: Doğrudan kullanım için tasarlanan herkese açık API'lerin A2ui önekine (veya MaterialA2ui ve A2uiTest gibi tasarım sistemi ve test öneklerine) sahip net ve kısa adları vardır. Örnekler arasında A2uiCatalog, A2uiComponent ve A2uiException yer alır.
  2. Kullanıcı arayüzü çerçevesi entegrasyoncuları için API'ler: Temel veri katmanı ile kullanıcı arayüzü çerçeveleri arasında köprü görevi gören kitaplıklar tarafından kullanılan API'lerin, A2uiCore ile başlayan açıklayıcı adları vardır. Bu API'ler doğrudan uygulama referansı için tasarlanmamıştır ve standart uygulama kodundan gizli kalır. Örnekler arasında A2uiCoreCatalog, A2uiCoreDataModel ve A2uiCoreSurfaceModel yer alır.

Temel veri katmanı her iki kategoriden de türler içerdiğinden iki ayrı yapıda dağıtılır: androidx.a2ui:a2ui-model (uygulama geliştiriciler için) ve androidx.a2ui:a2ui-engine (çerçeve entegratörleri için). Bu yapı, çerçeve kitaplıklarının a2ui-engine'ya uygulama bağımlılığı olarak bağlı olmasına olanak tanır ve A2uiCore türlerinin herkese açık uygulama sınıf yollarını kirletmesini önler.

1. Kategori: Uygulama geliştirici API'leri

Aşağıdaki tablolarda, uygulama ve bileşen geliştiriciler için tasarlanmış herkese açık API'ler listelenmektedir.

androidx.a2ui:a2ui-model

Tür Açıklama
A2uiSurfaceModel Kullanıcı arayüzü yüzeyini temsil eden salt okunur arayüz
A2uiMessageProcessor Gelen iletileri işlemek için giriş noktası türü
A2uiMessageParser Protokol iletileri için ayrıştırıcı arayüzü
A2uiServerToClientMessage Gelen mesaj yükü
A2uiSchema Bileşen özelliği şemalarını tanımlamak için kullanılan türler
A2uiException Katmanlar arasında oluşturulan ve işlenen istisnalar
A2uiUserAction Kullanıcı etkileşimleri sonucunda oluşturulan işlem yükü
A2uiClientToServerMessage Giden tüm ileti yükleri için temel tür
A2uiActionInterceptor Veri katmanı düzeyinde kullanıcı işlemi yakalayıcı
A2uiFunctionDefinition Yerel istemci işlevinin tanımı
A2uiDataPath JSON işaretçi yolu gösterimi

androidx.a2ui.compose:compose-runtime

Tür Açıklama
a2uiRuntimeMessageProcessor İleti işlemcisinin uzantı oluşturucusu
A2uiMessageParser İleti ayrıştırıcısı için uzantı oluşturucu
A2uiComponentState Reaktif bileşen durumunu temsil eden arayüz
A2uiComponentModel Başarıyla çözülen bir bileşenin veri modeli
A2uiComponentProperties Yeniden oluşturmaları optimize eden sabit mülk kapsayıcısı
A2uiProperty Güçlü şekilde türü belirlenmiş bileşen özelliği tanımı
A2uiComponentScope Bağlamaları ve alt bileşenleri değerlendirmek için alıcı kapsamı
A2uiComponentReference İç içe yerleştirilmiş alt bileşenleri çözmeye yönelik işaretçi

androidx.a2ui.compose:compose-ui

Tür Açıklama
A2uiCatalog Katalogları tanımlamak için arayüz ve uzantı oluşturucu
A2uiComponent Compose bileşen uygulamalarını tanımlama arayüzü
A2uiComponent (birleştirilebilir) Bir bileşen için kullanıcı arayüzü yayan composable işlevi

androidx.compose.material3:material3-a2ui

Tür Açıklama
A2uiSurface Bir yüzeyi oluşturmak için kullanılan birleştirilebilir giriş noktası
materialA2uiBasicCatalogV1 Materyal 3 bileşenlerini kullanan Basic Catalog örneği oluşturmak için fabrika işlevi
MaterialA2uiBasicCatalogV1Defaults Temel Katalog'un varsayılan Material 3 uygulamaları

androidx.a2ui.compose:compose-ui-testing

Tür Açıklama
A2uiTestController Test yürütme işlemini düzenlemek için test denetleyicisi
A2uiComponentStub Stubbed veya geçersiz kılınmış bileşen uygulaması
A2uiTestSurface Test yüzeyi oluşturan composable işlev

2. Kategori: Framework entegratör API'leri

Aşağıdaki tabloda, çerçeve entegratörleri için tasarlanmış API'ler listelenmektedir.

androidx.a2ui:a2ui-engine

Tür Açıklama
A2uiCoreCatalog Bir grup A2uiCoreComponentDefinition nesnesi içerir.
A2uiCoreCatalogSerializer A2UI katalogları için seri oluşturucu
A2uiCoreComponentDefinition Bir bileşeni tanımlayan meta veriler içerir.
A2uiCoreSurfaceModel A2uiSurfaceModel'ı uygular, kayıtları kullanıma sunar
A2uiCoreSurfaceGroupModel Uygulama A2uiSurfaceGroupModel
A2uiCoreMessageProcessor Uygulama A2uiMessageProcessor
A2uiCoreDataModel Reaktif veri modeli sahibi
A2uiCoreComponentRegistry Bileşen kayıt defteri
A2uiCoreValueResolver Dinamik değerlendiricide kullanılacak veri erişimci
A2uiCoreSchemaValidator Bileşen şeması doğrulayıcı