Android Architecture Components. Часть 1. Введение

    image

    На Google I/O 2017, было представлено набор библиотек под названием Android Architecture Components. В нескольких словах — это ряд вспомогательных библиотек, которые призваны помочь с такими вещами как, проектирование, тестирование и сопровождение приложений. То, что команда разработки Android начала акцентировать внимание на архитектуре не может не радовать, поскольку проблема является действительно актуальной. Ведь изначально не было предоставлено никаких требований или гайдлайнов по проектированию, и разработчику приходилось отталкиваться от своего предыдущего опыта. Что, в свою очередь, вызывало сложности в сопровождении проекта, а также сомнительные решения для специфических для ОС ситуаций. По факту это не первые шаги в этом направлении. Ранее уже Google представил репозиторий android-architecture с примерами применения разных архитектурных концептов. Надеемся, что развитие будет дальше и может на следующем Google I/O мы сможем увидеть полноценный фреймворк.

    В целом Android Architecture Components можно разделить на четыре блока: Lifecycles, LiveData, ViewModel и Room Persistence.

    Компонент Lifecycle – призван упростить работу с жизненным циклом. Выделены основные понятия такие как LifecycleOwner и LifecycleObserver.

    LifecycleOwner – это интерфейс с одним методом getLifecycle(), который возвращает состояние жизненного цикла. Являет собой абстракцию владельца жизненного цикла (Activity, Fragment). Для упрощения добавлены классы LifecycleActivity и LifecycleFragment.

    LifecycleObserver – интерфейс, обозначает слушателя жизненного цикла owner-а. Не имеет методов, завязан на OnLifecycleEvent, который в свою очередь разрешает отслеживать жизненный цикл.

    Что это нам дает?

    Назначение этого компонента – избавить разработчика от написания рутинного кода и сделать его более читаемым. Довольно частая ситуация, когда в нашем приложении работает ряд процессов, которые зависят от этапа жизненного цикла. Будь-то воспроизведение медиа, локация, связь с сервисом и т.д. Как итог нам приходится вручную отслеживать состояние и уведомлять о нём наш процесс. Что неудобно по двум причинам, захламление основного класса (Activity или Fragment) и снижение модульности, ведь нам нужно позаботиться про поддержку передачи состояния. С помощью же этого компонента мы можем переложить всю ответственность на наш компонент и все что для этого нужно это объявить интересующий наш класс как observer и передать ему в onCreate() методе ссылку на owner. В общем это выглядит так:

    class MyActivity extends LifecycleActivity {
        private PlayerWrapper mPlayerWrapper;
        public void onCreate(…) {
           mPlayerWrapper = new PlayerWrapper (this, getLifecycle());
        }
    }
    

    class PlayerWrapper implements LifecycleObserver {
       private PlayerController mController;
       public PlayerWrapper(Context context, Lifecycle lifecycle) {
          //init controller
       }
       @OnLifecycleEvent(Lifecycle.Event.ON_START)
       void start() {
         mController.play();
       }
       @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
       void stop() {
          mController.stop();
       }
    }
    

    Наш обсервер абсолютно осведомлен о состоянии и может самостоятельно обрабатывать его изменение.

    Компонент LiveData – являет собой holder класс для хранения объекта, а также разрешает подписаться к нему. LiveData знает про жизненный цикл и разрешает от него абстрагироваться.

    Для имплементации компонента нам нужно расширить класс LiveData. Для работы нам нужно знать всего три метода из этого класса.

    onActive() – этот метод вызывается когда у нашего экземпляра есть активный(-ые) обсервер. В нем мы должны инициировать интересующий нас сервис или операцию.

    onInactive() – вызывается когда у LiveData нет активных слушателей. Соответственно нужно остановить наш сервис или операцию.

    setValue() – вызываем если изменились данные и LiveData информирует об этом слушателей.

    class ChatLiveDataHolder extends LiveData<Message>{
      
       private static ChatLiveDataHolder sInstance;
       private ChatManager mChatManager;
       private ChatListener mChatListener = new ChatListener(){
          @Override
          public void newMessage(Message message){
             setValue(message);
          }
       }
       public static ChatLiveDataHolder get() {
          if (sInstance == null) {
             sInstance = new ChatLiveDataHolder();
          }
          return sInstance;
       }
       private ChatLiveDataHolder(){
          //init mChatManager and set listener
       }
       @Override
       protected void onActive() {
          mChatManager.start();
       }
       @Override
       protected void onInactive() {
          mChatManager.stop();
       }
    }
    

    Если вы обратили внимание, то мы реализовали наш класс как Singleton. Это дает нам возможность использовать LiveData в других Activity, Fragment и т.д без переинициализации, если это нам не нужно.

    Для того чтоб подписать слушателя, тоже никаких проблем нет. Все что нужно это вызвать метод observe у нашего экземпляра LiveData, передать в него LifeCycleOwner и реализацию интерфейса Observer. Интерфейс Observer имеет всего один метод onChanged(T t), с помощью него LiveData будет информировать слушателей об изменении в данных(вызов метода setValue(T t) в LiveData).

    Что это нам дает?

    Плюсов действительно много, начиная от защиты от memory leaks(Observer связан со своим Lifecycle и автоматически отписывается в случае, когда его Lifecycle уничтожен), защита от остановленной Activity(если, Lifecycle неактивен(stopped), то и нотификации на Observer не будут отправляться). С функциональных особенностей, это единый доступ к данным(с помощью singleton) и сбережение наших данных(Для таких операций как пересоздание активити, фрагмента). В целом же, назначение все то же, избавить разработчика от рутинной работы связанной с жизненным циклом.

    Компонент ViewModel — спроектирован для хранения и управления данными которые связанные с представлением.

    Задача же данного компонента, помочь разработчику абстрагировать данные и предоставить их хранение между такими операциями как пересоздание Activity. Если же нам необходимо сохранить небольшой набор данных, таких как item в RadioButtonGroup или же введенный данные, нам отлично подходит Bundle в onSaveInstanceState(). Но если это большой список к примеру: пользователей, товаров, каталог чего-нибудь нам приходилось заново доставать этот список. Вот в этом случае ViewModel является нашим основным помощником. Особенностью данного компонента является то что он привязывается к Activity и автоматически сохраняет свое состояние во время таких операций как onCofigurationChange().

    Класс ViewModel, являет собой абстрактный класс, но не имеет абстрактных методов. Для реализации нашего класса нам нужно лишь наследоваться от ViewModel и описать данные которые мы хотим хранить и методы для их получения.

    public class OurModel extends ViewModel {
        private List<User> userList;
        public List<User>  getUserList() {
            return userList;
        }
         public void setUserList(List<User> list) {
            this.userList = list;
        }
    }
    

    И это все, наш холдер для userList готов. Для того чтоб использовать наш холдер необходимо в методе onCreate(..) активити вызвать instance нашей модели:

    @Override
    protected void onCreate(Bundle savedInstanceState){
       // init UI etc.
       OurModel model = ViewModelProviders.of(this).get(OurModel.class);
       If (model.getUserList()==null){
          downloadData();
       } else {
          showData();
       }
    }
    

    С помощью ViewModelProviders, мы берем instance нашей модели. A c помощью if конструкции смотрим есть ли у нас уже данные в нашей модели или еще нет.

    Что это нам дает?

    Также как и предыдущие компоненты, этот помогает нам справится с особенностями и связанными с ними проблемами жизненного цикла Android. В этом случае, это отделение нашей модели представления данных от Activity и обеспечение безопасного механизма их хранения. Также при использовании совместно с LiveData не составляет проблем реализовать асинхронные запросы.

    Компонент Room Persistence — Предлагает уровень абстракции над SQLite, предлагая более простой и продвинутый способ управления.

    В целом же мы получили дефолтную ORM, этот компонент можно разделить на три части: Entity, DAO (Data Access Object), Database.

    Entity — объектное представление таблицы. С помощью аннотаций можно легко и без лишнего кода описать наши поля.

    Для создания нашей Entity нам нужно создать класс POJO (Plain Old Java Object). Пометить класс аннотацией Entity.

    Пример:

    @Entity(tableName = «book»)
    class Book{
       @PrimaryKey
       private int id;
       @ColumnInfo(name = «title»)
       private  String title;
       @ColumnInfo(name = «author_id»)
       private int authorId;
       …
       //Get and set for fields
    }
    

    @PrimaryKey — Для обозначения ключа. @ColumnInfo — для связи поля в таблице. Создавать методы get и set не обязательно, но тогда нужно предоставить доступ к переменным с помощью модификатора public.

    Установление связей объявляется также в теле аннотации Entity: Entity(foreignKeys = @ForeignKey(entity = Other.class, parentColumns = «id», childColumns = «author_id»))

    DAO — Интерфейс который описывает методы доступа к БД.

    Для реализации создаем интерфейс который помечаем аннотацией DAO и объявляем наши методы. Основные аннотации для методов это Insert Update Delete Query, в комментариях не нуждаются.

    Пример:

    @Dao
    public interface OurDao {
       @Insert
       public void insertBook(Book book);
       @Update
       public void updateBook(Book book);
       @Delete
       public void deleteBook(Book book);
    @Query(«SELECT * FROM book»)
       public Book[] loadAllBooks();
    }
    

    В обычном состоянии попытка получить доступ к БД с основного потока закончиться Exception. Если вы все же уверены в своих действиях, то можно воспользоваться методом allowMainThreadQueries(). Для асинхронного доступа рекомендовано использовать LiveData или RxJava.

    Database — используется для создания Database Holder и является точкой доступа к соединению с БД.

    Для создания нашего класса нужно наследоваться от RoomDatabase и использовать аннотацию Database, которой передаем параметры такие как используемые entity и версию базы. В теле описываем абстрактные методы доступа к нашим DAO.

    @Database(entities = {User.class}, version = 1)
    public abstract class AppDatabase extends RoomDatabase {
       public abstract OurDao ourDao();
    }
    

    Для создания instance для нашей БД используем код:

    AppDatabase db = Room.databaseBuilder(getApplicationContext(),  AppDatabase.class, «database-name»).build();
    

    Для хранения db рекомендуют использовать singleton.

    Что это нам дает?

    Упрощение работы с базой данных, отпадает потребность в использовании сторонних ORM.
    Кроме описанных выше плюшек NestedObject, параметры в запросах, коллекции аргументов, TypeConverter, database migration и т.д. Эти темы не входят в скоуп данного материала и будут рассмотрены позже.

    К завершению материала хочу добавить еще несколько слов об архитектуре. С представлением Android Architecture Components была предложена архитектура решений, которая для большинства разработчиков уже и так привычна в той или иной форме. Суть заключается в том, что мы разбиваем архитектуру на 3 основных слоя: View (Activity/Fragment), который общается с ViewModel, а ViewModel работает непосредственно уже с Repository. Для наглядности преведу картинку с developer.android.com.

    image

    Выглядит абсолютно просто, а как на самом деле мы рассмотрим в следующих статьях.
    Где сначала разберем более подробно каждый компонент и в конце реализуем приложение, как говорится с базой данных и… коннектом к сервису.

    Android Architecture Components. Часть 1. Введение
    Android Architecture Components. Часть 2. Lifecycle
    Android Architecture Components. Часть 3. LiveData
    Android Architecture Components. Часть 4. ViewModel
    Метки:
    • +7
    • 10,3k
    • 5
    Поделиться публикацией
    Комментарии 5
    • 0
      А есть опыт использования этих компонентов, особенно Room Persistence в продакшине? очень интересно увидеть скорость работы этой ORM по сравнению c Realm например.
      • +1
        Спасибо за статью, но как я читал на google.developers.com, там поля ViewModel рекомендуют оборачивать в LiveData или в MutableLiveData и потом подписываться на них в Acitvity/Fragments. Интересно, когда они в релиз выпустят всю эту красоту…
        • 0
          Причина, по которой рекомендуют оборачивать, являеться то, что это «единственый» путь уведомить нашу View об изменении данных(мы не должны хранить ссылку на Activity/Fragment в ViewModel).
        • +1
             If (model.getUserList()==null){
                downloadData();
             } else {
                showData();
             }
          

          А почему бы эту проверку не засунуть во ViewModel? Activity же у нас теперь является View :)
          Ну и ViewModel все таки не должен возвращать List напрямую, как я понял. Вместо этого он должен предоставить объект LiveData<List>, на который уже и подписывается Activity.
          • 0
            Все верно, но в этом фрагменте, решил показать примитив взаимодействия со ViewModel. downloadData() можно переименовать в showWaitingMessage(), а showData() в otherInitProcess(), но подумал что это, еще больше запутает.

            По поводу LiveData, этот кейс будет описан в 4 части, которая посвящена ViewModel. Сейчас же это изолированый оверьвью этих компонентов с целью упрощения их понимания.

            Спасибо за коментарий, будет неплохим примечанием к материалу.

          Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.