RetroBase — аналог Retrofit для запросов к базам данных


Многие разработчики, используют в своих проектах библиотеку Retrofit, которая позволяет превратить HTTP API в java-интерфейс. Это очень удобно, так как позволяет избавиться от лишнего кода и использовать ее очень легко. Нужно лишь создать интерфейс и навесить несколько аннотаций.

Недавно я занимался разработкой приложения для Android, которому необходимо было делать запросы к базе данных через JDBC- драйвер. Тогда мне пришла идея создать нечто подобное Retrofit только для запросов к базе данных. Так появился RetroBase, о котором я Вам сейчас и расскажу.

Для того, чтобы интерфейс и аннотации превратились в рабочий код, потребуется Annotation Processing, который открывает поистине огромные возможности для автоматизации написания однотипного кода. А в сочетании с JavaPoet процесс генерации java-кода становится удобным и простым.

На хабре, как и на просторах интернета, имеется несколько хороших статей по этой теме, поэтому разобраться с Annotation Processing не составляет труда, а необходимый мануал библиотеки JavaPoet умещается в ее README.md.

Основу RetroBase составляют две аннотации DBInterface и DBQuery вместе с DBAnnotationProcessor, который и выполняет всю работу. С помощью DBInterface отмечается интерфейс с методами-запросами к БД, а DBQuery отмечает сами методы. Методы могут иметь параметры, которые будут использованы в SQL-запросе. Например:

Самое интересное происходит в DBAnnotationProcessor, где осуществляется генерация класса, реализующего интерфейс, сгенерированный класс будет иметь имя *название_интерфейса* + Impl:

После этого создается соединение с БД:

Также создается PreparedStatement для каждого запроса:

… и реализация метода для этого запроса:

При этом учитывается тип возвращаемого значения метода. Он может быть либо void, если SQL-запрос представляет собой INSERT, DELETE или UPDATE. Либо ResultSet, если SQL-запрос представляет собой SELECT.

Также выполняется проверка на то, может ли метод выбрасывать SQLException. Если может, они будут выброшены и из реализации метода. А если нет — пойманы и выведены в stderr.

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

Конечно же, количество и типы параметров метода должны соответствовать параметрам запроса, переданного с помощью аннотации DBQuery.

После того, как файл был сгенерирован, он записывается средствами Annotation Processing:

 

Rx it!

Конечно, удобно получать ResultSet, определяя лишь интерфейс. А еще удобнее было бы воспользоваться популярной RxJava и получать Observable. К тому же, это позволит легко решить проблему с выполнением запросов в другом потоке.

Для этого был создан DBMakeRxAnnotationProcessor вместе с DBInterfaceRx и DBMakeRx, которые позволяют создать класс с методами-обертками. Применение этих аннотаций Вы уже могли увидеть в примере выше. Созданный класс будет иметь имя *название_интерфейса* + Rx, а также будет иметь открытый конструктор, принимающий объект интерфейса, аннотированного DBInterfaceRx, которому он будет перенаправлять запросы, возвращая результаты в реактивном стиле.

Все, что нужно — это добавить к методу аннотацию DBMakeRx и передать ей название класса модели. Сгенерированный метод-обертка будет возвращать Observable<*класс модели*>. При этом, название класса модели можно и не определять. В этом случае сгенерированный метод будет возвращатьObservable, что удобно для SQL-запросов INSERT, DELETE или UPDATE, для которых не требуется возвращение результата.

Например, для метода интерфейса ResultSet getAllRecords(); из примера выше будет сгенерирован следующий метод-обертка:

Здесь mDB представляет собой объект интерфейса, аннотированного DBInterfaceRx, который был передан в конструктор.

Как видно из сгенерированного метода, нам потребуется создание объектов класса модели из ResultSet, поэтому у класса модели должен быть открытый конструктор, который принимает ResultSet.

Естественно, что параметры сгенерированного метода будут точно соответствовать параметрам метода, вызов которого происходит:

Все исключения, которые происходят при выполнении запроса, передаются Subscriber’у как и положено в Rx.

Пример использования всего описанного выше может выглядеть следующим образом:

А если нужно подменить new SpendDBImpl(); или new SpendDBRx(mSpendDB); для выполнения тестов, можно воспользоваться популярным Dagger.

На github Вы можете найти исходники с комментариями, а также рабочий пример этой небольшой библиотеки.

Целью этой статьи было показать насколько полезным может быть Annotation Processing, позволяющий избавиться от написания однотипного кода. И, надеюсь, у Вас могут появиться новые идее по использованию этого инструмента в своих проектах.

UPD. 1: благодаря замечаниям в комментариях была добавлена проверка отписки подписчика в RX-методах-обертках. (Версия RetroBase 1.0.4)

 

via Alex Zhdanov

Оставьте комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *