Сразу оговорюсь, что я мобильный разработчик, а статья предназначается в основном разработчикам по ту сторону облака — мобильщики итак про все это знают. Последнее веб-приложение я писал много лет назад и могу ошибаться в веб-терминологии, не знать некоторых последних тенденций .NET-, PHP- или Java- веб-сервисов, так что не судите строго.
Как и любому front-end разработчику, мне почти в каждом проекте приходится сталкиваться с клиент-серверными протоколами – без них никак. И очень, крайне часто приходится работать с плохо продуманной архитектурой.
Также очень часто разработка протокола и архитектуры ложится на плечи веб-разработчика, что не всегда верно – она в большинстве случаев должна разрабатываться только совместно с теми, кто под эту архитектуру будет подстраиваться. К сожалению, работая за последние три года на нескольких десятках проектов, мне доводилось участвовать в планировании этого участка архитектуры только 3 или 4 раза – во всех остальных случаях она уже была предоставлена в разной степени готовности заказчиком. А ведь насколько мир мог бы быть лучше!
Обработка ошибок
Чаще всего мне попадалось что-то вроде этого:
HTTP code 200 (OK)
<?xml version="1.0" encoding="utf-8"?><Body>
<Result>
<Success>false</Success>
<Error>The username or password is incorrect. Please try again.</Error>
</Result>
<Response>
</Response>
</Body>
Т.е. результат обработки запроса содержится в самом отдаваемом XML, HTTP-код возврата – 200, т.е. нормально, данные представлены в виде обычного RPC. Например, похожим образом в 90% случаев реализуется обработка ошибок в протоколе SOAP.
В особо запущенных случаях, особенно характерных для индусского кода, false может находиться в различных местах XML, что существенно усложняет парсинг, ведёт к переусложнённым и безмерно радует скучающего программиста.
Но давайте рассмотрим недостатки данного подхода в принципе.
- Во-первых, приходится парсить XML. Это лишние данные, переданные по сети, лишнее процессорное время, затраченное на парсинг XML, лишняя оперативная память для хранения текстовых данных. Всё это не так страшно на современных девайсах в зоне Wi-fi, но даже такие излишества могут иметь значение в метро между станциями в приложении, посылающем одновременно десятки запросов (а ведь при таком подходе пустые блоки для обработки ошибок должны быть в каждом запросе, даже успешном).
- Во-вторых, веб-разработчику приходится самому выдумывать тексты ошибок. Очень часто они совершенно непонятны пользователю, т.к. точность формулировки – последнее, о чём думает веб-разработчик в момент написания сервиса. Текст ошибки в 90% случаев не согласовывается с native-спикерами и последнее, но самое важное – огромное количество мобильных приложений нуждается в локализации. В то время как текст ошибки, скорее всего, пишется всегда только по-английски, следовательно он абсолютно бесполезен для фронтэнд-программиста – он не может его просто взять и вывести.
А ведь время, нужное веб-программисту, чтобы выдумать текст сообщения, потрачено впустую, да ещё и канал загружен ненужной информацией.
Как решить проблему?
В протоколе HTTP уже много лет заложена возможность добавлять свои коды ошибок, для этого они просто должны принадлежать диапазону от 512 до 597. Такого количества ошибок, я уверен, хватит для покрытия всех возможных ошибок в приложении среднего размера. Очевидно, какие плюсы это даёт, но всё же подытожим:
- Нет избыточности. Передаётся только HTTP код в хэдере, тела запроса просто нет.
- На стороне клиента существуют только две ветки кода обработки запросов – успешное выполнение, либо ошибка при выполнении (оба колбэка уже имплементированы из коробки в любой библиотеке запросов). Нет веток “запрос выполнился успешно, но логическая ошибка может быть в теле ответа”.
Интересно будет также посмотреть, как на эту ситуацию смотрит стандарт HTTP и англоязычная википедия:
5xx Server Error
The server failed to fulfill an apparently valid request.[2]
Response status codes beginning with the digit «5» indicate cases in which the server is aware that it has encountered an error or is otherwise incapable of performing the request. Except when responding to a HEAD request, the server should include an entity containing an explanation of the error situation, and indicate whether it is a temporary or permanent condition. Likewise, user agents should display any included entity to the user. These response codes are applicable to any request method.
Т.е. клиенты должны показывать пользователю сообщение, переданное сервером. Сразу видно, что писали американцы. Русские, кстати, тупо перевели.
Хотя не будем обобщать – идею использовать HTTP коды мне подсказал как раз-таки американец несколько лет назад.
В общем, идеология такая — клиент всегда лучше знает, как сообщить об ошибке. А сервер должен проинформировать клиент об ошибке самым быстрым и малозатратным способом.
Привязка к сессии или cookie.
Такая привязка возникает, скорее всего, в том случае, если сначала создавался веб-сайт, и только потом заказчик решил сделать мобильный фронтэнд. Хотя работа с переменными сессии и возможна с мобильной стороны, это не является хорошей практикой, т.к. зачастую отсутствует нормальный инструментарий для работы с этими средствами.
Вторым, глобальным недостатком является то, что Safari (или любой браузер на Android) не шарят свои cookie и переменные сессии с приложением, что, конечно, правильно с точки зрения секьюрности, но приводит к ряду проблем и костылей.
Допустим, ваше мобильное приложение реализует только 70% функционала веб-сайта. Остальные 30% функционала доступны только в вебе, а ваше приложение лишь содержит ссылки на соответствующие веб-страницы.
Также, возможно, эти страницы доступны только для авторизированных пользователей. В итоге пользователю, который уже залогинился в мобильный клиент, будет предложено логиниться ещё раз – теперь уже в неудобную веб-форму, и счастьем будет если после логина пользователь будет перенаправен в искомый раздел сайта.
Вывод – если вы проектируете универсальный протокол, забудьте про такие вещи как переменные сессии и cookie. Намного лучшим способом будет передавать некий уникальный токен, полученный при авторизации, явно в теле каждого запроса. А веб-страницам и веб-приложениям – подстроиться под использование единого API. Я уверен, все мобильные разработчики часто видели две версии API – одно для веб-приложений, другое – для мобильных. А ведь это – дублирование функционала, которое всегда дороже как на этапе разработки, так и на этапе отладки. Лучше всегда с самого начала выделять веб-сервисы в отдельный слой системы, а не встраивать в другие, близкие к веб-технологиям, части.
Возврат HTML
Это уже ведёт корнями к устройству самих веб-серверов, которые изначально были заточены только под браузер. Ошибки 403, 404, а порой и более сложные очень часто отдаются в виде HTML-страницы, которую зачастую просто нет средств показать в мобильном приложении. Точнее, средства есть, но увидев “404 page not found” здоровенным черным Arial Black на белом фоне внутри веб-вью, мобильный пользователь испугается и закроет приложение.
Запомните, сервер на любое обращение к веб-сервисам должен отдавать XML (или JSON), и только в том формате, который был изначально оговорен. Мобильный разработчик не может сделать ничего путного с HTML, который приходит с сервера.
Используйте WSDL
На майкрософтовский технологиях ситуация еще ничего — большинство их современных технологий поддерживает WSDL из коробки. Чего не скажешь про PHP и Java — особенно PHP-разработчики очень любят создавать вручную обычные странички, которые по сути являются веб-сервисами. А ведь для того, чтобы интегрироваться с WSDL-совместимым веб-сервисом, мобильному разработчику достаточно использовать тулзу для генерации кода, в то время как составленные «вручную» ответы веб-сервисов тоже нужно парсить «руками».
Правда, и здесь есть тонкости — стандартные реализации WSDL от MS и Sun (Oracle) всё-таки имеют несовместимости, но все же быстрее подправить напильником эти несовместимости, чем писать все вручную.
Заключение
Я затронул только самые наболевшие ошибки проектирования, с которыми изо дня в день приходится сталкиваться мобильным разработчикам. Если статья будет востребованной, я обязательно напишу ещё о десятке клиент-серверных тонкостей, которые очень хотелось бы видеть в API веб-сервисов, с которыми работаешь каждый день.
Автор: iago
