Создание PHP XML-RPC сервера, клиента и приложения для Android

Предположим, что вы уже настроили на своей системе Zend Framework и установили Android SDK (а также эмулятор Android). В этом уроке я буду использовать Eclipse для написания PHP кода и кода для Android. Кроме того, я буду использовать инструмент ZF tool для того, чтобы создать проект, контроллеры и модели.

Итак, начнём с создания серверного компонента XML RPC.

Серверный компонент XML RPC

В корневой папке вашего сервера запустите следующую команду: zf create project xmlrpc-test. В результате выполнения данной строки вы создадите Zend Framework проект.

Теперь мы создадим необходимые контроллеры и модели.

Сперва запустите команду zf create controller Server (что создаст вам ServerController); теперь пришла очередь создания модели: zf create model Data. Поскольку мы также создадим клиентскую часть для XML RPC, то давайте создадим ещё один контроллер специально для этой области действия: zf create controller Client.

Теперь самое время протестировать наш проект. Наберите в адресной строке вашего браузера http://localhost/xmlrpc-test/public; Результат должен совпадать с рисунком, который я выложил ниже.

Теперь мы готовы приступить к нашему проекту в Eclipse. Давайте создадим новый PHP проект File->New->PHP project. В качестве названия введите xmlrpc-test и после этого нажмите кнопку Finish. Наш проект готов, а все файлы созданы на предыдущем шаге.

Теперь давайте откроем контроллер Server (application/controllers/Server.php) и начнем создавать сервер XML RPC.

class ServerController extends Zend_Controller_Action
{
    public function indexAction()
    {
        $this->_helper->viewRenderer->setNoRender();

        $server = new Zend_XmlRpc_Server();
      $server->setClass('Application_Model_Data', 'cf');

      echo $server->handle();
    }
}

Во-первых, мы отключаем наше представление (view). Далее происходит инициализация объекта класса Zend_XmlRpc_Server, который будет отвечать на вызовы клиента. В качестве аргумента передаём название модели Application_Model_Data, и указываем пространство имен как cf (любой набор символов).

Далее мы выводим то, что возвращает нам метод hanle, и вуаля – наш простой XML RPC сервер готов.

Теперь давайте откроем нашу модель (application/models/Data.php) и создадим парочку методов, которые будут возвращать какие-то данные.

class Application_Model_Data
{
    /**
     * Test method
     *
     * @return string
     */
    public function test()
    {
        return 'Hello XMLRPC!';
    }
}

Класс Application_Model_Data представляет собой классический PHP класс. Самой важной частью в коде на данный момент являются комментарии. Указание типа является обязательным условием, так как когда происходит вызов Zend_XmlRpc_Server, в первую очередь будет осуществлена проверка на наличие подобного метода, за которой последует проверка на соответствие параметров (включая тип). Таким образом, мы должны определить типы всех входящих параметров . В этом примере входящих параметров нет, но зато есть возвращаемое значение.

Давайте создадим клиент XML RPC, чтобы проверить, все ли в порядке.

XML RPC клиент

Ранее мы создали класс ClientController (расположенный в application/controller/Client.php); indexAction – это метод, который запускается по умолчанию. Впишем в него следующее содержание:

class ClientController extends Zend_Controller_Action
{
    public function indexAction()
    {
        $client = new Zend_XmlRpc_Client('http://localhost/xmlrpc-test/public/server/');
        try {
            $data = $client->call('cf.test');
            $this->view->data = $data;
        } catch (Zend_XmlRpc_Client_HttpException $e) {
            require_once 'Zend/Exception.php';
            throw new Zend_Exception($e);
        } catch (Zend_XmlRpc_Client_FaultException $e) {
            require_once 'Zend/Exception.php';
                throw new Zend_Exception($e);
        }
    }
}

Сначала мы инициализируем Zend_XmlRpc_Client и передаём ему URI нашего XML RPC сервера. Затем пытаемся сделать запрос к методу test (‘cf’ - это пространство имен, определенное для нашего класса Application_Model_Data). Далее передаём полученные данные в представление.

Наше представление расположено в application/views/scripts/client/index.phtml. В этом скрипте мы просто выводим полученные данные.

<h1>Via XMLRPC</h1>
<?php echo $this->escape($this->data); ?>

Если мы зайдёте по адресу http://localhost/xmlrpc-test/public/client, то увидите что-то подобное:

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

/**
 * Fetches data
 *
 * @param integer $num
 * @return array
 */
public function getData($num)
{
    $data = array();

    for ($a = 0; $a < $num; $a++) {
        $data[] = array(
            'title' => 'Codeforest.net',
            'number' => $a + 1,
            'datetime' => date('Y-m-d H:i:s')
        );
    }

    return $data;
}

Новый метод будет называться getData (не очень креативно), а его содержание не будет слишком сложным. Ещё раз акцентирую ваше внимание на комментарий, в котором мы описываем параметры @param и возвращаемое значение @return.

Теперь мы должны обновить наш класс ClientController, и вместо того, чтобы вызвать метод cf.test, вызовем метод cf.getData. Заменяем:

$data = $client->call('cf.test');

на это:

$data = $client->call('cf.getData’, 15);

Все остальное в классе ClientController остается неизменным.

Далее мы должны обновить представление:

<h1>Via XMLRPC</h1>
<?php if (count($this->data) > 0):?>
<ul>
    <?php foreach ($this->data as $row):?>
    <li><?php echo $this->escape($row['number'])?> - <?php echo $this->escape($row['title'])?>, <?php echo $this->escape($row['datetime'])?></li>
    <?php endforeach;?>
</ul>
<?php endif; ?>

Снова запускаем наш браузер и переходим по адресу http://localhost/xmlrpc-test/public/client. Результат:

На этом мы завершаем часть, посвящённую PHP и Zend Framework.

Клиент Android XM LRPC

Теперь нам следует переключиться на рабочее пространство Android (File->Switch Workspace, pick your Android workspace).

После этого, создадим новый Android проект (File->New->Android Project); Введите название проекта.

Далее нам нужно загрузить клиентскую библиотеку XML RPC Android вот отсюда http://code.google.com/p/android-xmlrpc/.

Далее в нашем проекте создаём новый пакет (правый щелчок мышью по названию проекта в проводнике Пакета, и выберите New->Package). Назовите этот пакет org.xmlrpc.android и скопируйте каталог архива файлов, android-xmlrpc/src/org/xmlrpc/android в только что созданный пакет.

Ваша структура каталогов должна выглядеть подобный образом:

Поскольку для работы программы требуется интернет-соединение (чтобы соединиться с нашим XML RPC сервером), мы должны выставить соответствующие права нашему файлу. Откройте AndroidManifest.xml и добавьте следующую строку в конец документа:

<uses-permission android:name="android.permission.INTERNET"></uses-permission>

В нашем примере мы будем использовать файл, расположенный в res/layout/main.xml. Также мы добавим ID к элементу TextView, чтобы у нас была возможность вносить полученные данные. Откройте файл res/layout/main.xml и определите местоположение элемента TextView. Добавьте атрибут android.id со значением @+id/text_view:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    >
<TextView
    android:id="@+id/text_view"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:text="@string/hello"
    />
</LinearLayout>

Теперь мы можем начать создавать наш Android клиент. Откройте Client.java в нашем пакете com.cf.xmlrpc и введите следующий код:

public class Client extends Activity {

    private XMLRPCClient client;
    private URI uri;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);

        uri = URI.create("http://10.0.2.2/xmlrpc-test/public/server/");
      client = new XMLRPCClient(uri);

      TextView textView = (TextView) findViewById(R.id.text_view);
    }
}

Во-первых, мы создаем переменные класса, которые будет содержать наш Клиент XMLRPC и URI для нашего сервера.

В методе onCreate мы присваиваем переменную uri объекту URI. Вы наверное заметили, что мы используем адрес 10.0.2.2, чтобы получить доступ к нашему собственному локальному веб-серверу.

Затем мы создаем XMLRPCClient.

Также мы получаем ссылку на элемент TextView, где мы выведем на экран полученные результаты.

Затем создадим метод, который вызовет функцию test на нашем XML RPC сервере (который мы создали на Zend Framework).

private String testMethod() {
    String text = "";
    try {
        text = (String) client.call("cf.test");
    } catch (XMLRPCException e) {
        Log.w("XMLRPC Test", "Error", e);
        text = "XMLRPC error";
    }
    return text;
}

Как вы уже заметили, я часто использую блоки try/catch, чтобы иметь возможность отловить все возникающие ошибки. Далее нам необходимо вызвать метод onCreate для того, чтобы вывести значения элементу TextView. Изменения выглядят следующим образом:

public class Client extends Activity {

    private XMLRPCClient client;
    private URI uri;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);

        uri = URI.create("http://10.0.2.2/xmlrpc-test/public/server/");
      client = new XMLRPCClient(uri);

      TextViewtextView = (TextView) findViewById(R.id.text_view);
      textView.setText(testMethod());
    }

    private String testMethod() {
      String text = "";
        try {
        text = (String) client.call("cf.test");
      } catch (XMLRPCException e) {
        Log.w("XMLRPC Test", "Error", e);
        text = "XMLRPC error";
      }
      return text;
    }
}

Теперь мы готовы протестировать наш Android клиент. Выберите Run->Run configurations и создайте новую конфигурацию приложения Android для нашего проекта:

После того, как эмулятор загрузится, результат должен быть примерно таким:

Ура! Наш Android клиент использует веб-сервис RPC XML!

Теперь давайте создадим метод который будет вызывать getData:

private String getDataMethod(int num) {
    String text = "";
    try {
        Object[] data = (Object[]) client.call("cf.getData", num);
        for(Object o: data) {
            HashMap map = (HashMap) o;
            text = text + "'datetime' => " + map.get("datetime") + ", 'number' => " + map.get("number") + ", 'title' => " + map.get("title") + "\n\n";
        }
    } catch (XMLRPCException e) {
        Log.w("XMLRPC Test", "Error", e);
        text = "XMLRPC error";
    }
    return text;
}

Метод, который мы вызываем (cf.getData), ожидает один параметр (целое число) и возвращает ассоциативный массив. В Java мы всё это приняли.

Далее заменим строку:

textView.setText(testMethod());

на:

textView.setText(getDataMethod(12));

После сохранения и запуска (Run->Run configurations) наш измененный Android клиент должен выглядеть примерно так:

Вот и всё. В этом уроке я показал вам всё необходимое для создания XML RPC PHP сервера и Android клиента.

Источник: http://feedproxy.google.com/~r/ruseller/CdHX/~3/6v4Ixet7uCo/lessons.php

Статьи по теме

Комментирование кода и генерация документации в PHP

Зачем нужны комментарии к программному коду? В каком виде их писать? Где они нужны, а где нет? Как правильно комментировать код? Как прид�...

2024-04-22

Что такое CSS-модули и зачем они нам?

В последнее время меня интригуют CSS-модули. Если вы о них не слышали — эта статья для вас. Мы рассмотрим, что это за проект, какие задачи о�...

2024-04-22

23 сервиса для эффективного экспресс-аудита любого сайта

Аудит сайта – комплексный процесс, который позволяет оценить эффективность сайта и понять, на каком этапе теряются продажи, почему люди...

2024-04-17

Яндекс переходит на новую версию Wordstat

Часть старой функциональности уже недоступна. Обновленный Яндекс Вордстат полностью перейдет на основной домен wordstat.ru 20 марта. С...

2024-04-08

Яндекс интегрировал в свой облачный сервис эмпатичную нейросеть

Она умеет распознавать эмоции человека по голосу. Алгоритм-эмпат определяет характер речи пользователя: говорит он с явным негатив...

2024-04-08

Новая версия нейросети Claude превзошла по мощности аналоги Google и OpenAI

Скорость обработки сложных научных статей составляет менее трех секунд. Новое поколение моделей ИИ от компании Antropic под названием Cl...

2024-04-08

Как пользоваться GPT 4 и Claude бесплатно и без VPN

Как бесплатно пользоваться GPT 4, его плагинами, а также новой нейросетью Claude 3? Это можно делать в рамках одного сайта, который называет�...

2024-04-08

Как использовать анимацию с помощью JavaScript-библиотеки GSAP

Узнайте, как использовать мощную JavaScript-библиотеку GSAP для создания захватывающих анимаций на веб-страницах, освоив основы и примеры. GSAP...

2024-03-13

Использование GSAP 3 для веб-анимации

Использование GSAP 3 для веб-анимации От автора: Greensock Animation Platform (GSAP) — это простая в использовании библиотека JavaScript для веб-анимации....

2024-03-13

Мерч и IT: на что обратить внимание в 2024 году

Оглавление Смена поколений Живой контакт Трансляция ценностей Офлайн-мероприятия Пользоввательский контент Биг б�...

2024-02-17

Копируем с RSync: основные примеры синхронизации файлов

RSync это быстрый и чрезвычайно универсальный инструмент для синхронизации (копирования) файлов. Его самое основное преимущество это пер...

2024-02-16

Лучшие noCode AI платформы для создания диалоговых ботов

Про GPT знают уже все, да? Но даже про его возможности не все осведомлены. Например, знаете ли вы, что GPT можно обучать непосредственно н�...

2024-02-15

Факторы ранжирования Google 2024 — исследование Semrush

Рассказываем самое важное об исследовании более 60 предполагаемых факторов ранжирования. Компания Semrush провела исследование...

2024-02-14

Перенос сайта на другой хостинг

Как перенести сайт на хостинг самостоятельно, что подготовить до и проверить после смены хостинг-провайдера. Содержание Бэ...

2024-02-12

В России сформирован реестр хостинг-провайдеров

Роскомнадзор сформировал реестр провайдеров хостинга. С 1 февраля компаниям, не включенным в этот реестр, запрещено оказывать услуги х�...

2024-02-05