Android RESTful веб-приложение с использованием Zend Framework - PullRequest
5 голосов
/ 27 марта 2012

Я написал веб-приложение, основанное на Zend Framework (версия 1.11.11), и хочу использовать один и тот же внутренний код для кодирования мобильной версии этого приложения (Android).Чтобы добиться этого, я хочу получить ответ для каждого из действий в контроллерах в XML и JSON - для мобильного приложения.

Но проблема, с которой я сталкиваюсь, заключается в следующем:

Каждое из действий в моих контроллерах будет возвращать переменную представления, которая затем будет интерпретироваться сценарием представления.Но я хочу, чтобы каждое из действий возвращало массив JSON в случае мобильного приложения и обычную / обычную вещь (просмотр переменных) для веб-приложения на основе браузера.

Может кто-нибудь из вас привести примеркак это может быть достигнуто для loginAction() in UsersController.

URL будет выглядеть следующим образом:

http://{servername}/service/login

Чтобы сделать это, я хочу немного понятьи советы о том, как сделать это наиболее эффективным и ПРАВИЛЬНЫМ способом.Я гуглил ответы, но не нашел хороших примеров кода или примеров реализации того, как этого добиться.Я ценю любую помощь и руководство.

Способ, которым я это сделал: есть API, который вызывается с параметрами, которые будут анализировать вызов, а затем загружать его в контроллер.Но безуспешно в кодировании.

Код, который у меня есть до сих пор:

A UserController с loginAction() (для пользователей, которые входят в систему):

По мнеЯ должен использовать ту же логику или, скорее, ту же функцию, что и loginAction в UsersController (для веб-приложений и приложений для мобильных устройств):

public function loginAction()
  {
// Already logged in
if( Engine_Api::_()->user()->getViewer()->getIdentity() ) {
  $this->view->status = false;
  $this->view->error = Zend_Registry::get('Zend_Translate')->_('You are already signed in.');
  if( null === $this->_helper->contextSwitch->getCurrentContext() ) {
    $this->_helper->redirector->gotoRoute(array(), 'default', true);
  }
  return;
}

// Make form
$this->view->form = $form = new User_Form_Login();
$form->setAction($this->view->url(array('return_url' => null)));
$form->populate(array(
  'return_url' => $this->_getParam('return_url'),
));

// Render
$this->_helper->content
    //->setNoRender()
    ->setEnabled()
    ;

// Not a post
if( !$this->getRequest()->isPost() ) {
  $this->view->status = false;
  $this->view->error = Zend_Registry::get('Zend_Translate')->_('No action taken');
  return;
}

// Form not valid
if( !$form->isValid($this->getRequest()->getPost()) ) {
  $this->view->status = false;
  $this->view->error = Zend_Registry::get('Zend_Translate')->_('Invalid data');
  return;
}

// Check login creds
extract($form->getValues()); // $email, $password, $remember
$user_table = Engine_Api::_()->getDbtable('users', 'user');
$user_select = $user_table->select()
  ->where('email = ?', $email);          // If post exists
$user = $user_table->fetchRow($user_select);

// Get ip address
$db = Engine_Db_Table::getDefaultAdapter();
$ipObj = new Engine_IP();
$ipExpr = new Zend_Db_Expr($db->quoteInto('UNHEX(?)', bin2hex($ipObj->toBinary())));

// Check if user exists
if( empty($user) ) {
  $this->view->status = false;
  $this->view->error = Zend_Registry::get('Zend_Translate')->_('No record of a member with that email was found.');
  $form->addError(Zend_Registry::get('Zend_Translate')->_('No record of a member with that email was found.'));

// Code
  return;
}

// Check if user is verified and enabled
if( !$user->enabled ) {
  if( !$user->verified ) {

   // Code here.
    // End Version 3 authentication

  } else {
    $form->addError('There appears to be a problem logging in. Please reset your password with the Forgot Password link.');

   // Code

    return;
  }
} else { // Normal authentication
  $authResult = Engine_Api::_()->user()->authenticate($email, $password);
  $authCode = $authResult->getCode();
  Engine_Api::_()->user()->setViewer();

  if( $authCode != Zend_Auth_Result::SUCCESS ) {
    $this->view->status = false;
    $this->view->error = Zend_Registry::get('Zend_Translate')->_('Invalid credentials');
    $form->addError(Zend_Registry::get('Zend_Translate')->_('Invalid credentials supplied'));

   //Code
    return;
  }
}

// -- Success! --

// Register login
$loginTable = Engine_Api::_()->getDbtable('logins', 'user');
$loginTable->insert(array(
  'user_id' => $user->getIdentity(),
  'email' => $email,
  'ip' => $ipExpr,
  'timestamp' => new Zend_Db_Expr('NOW()'),
  'state' => 'success',
  'active' => true,
));
$_SESSION['login_id'] = $login_id = $loginTable->getAdapter()->lastInsertId();
$_SESSION['user_id'] = $user->getIdentity();

// Some code.

// Do redirection only if normal context
if( null === $this->_helper->contextSwitch->getCurrentContext() ) {
  // Redirect by form
  $uri = $form->getValue('return_url');
  if( $uri ) {
    if( substr($uri, 0, 3) == '64-' ) {
      $uri = base64_decode(substr($uri, 3));
    }
    if($viewer->is_vendor) {
        return $this->_helper->redirector->gotoRoute(array('module' => 'user' ,'controller' => 'vendors', 'action' => 'mydeals'), 'vendor_mydeals', true);
    } else {
        return $this->_helper->redirector->gotoRoute(array('action' => 'index'), 'user_searchquery', true);
    }
    //return $this->_redirect($uri, array('prependBase' => false));
  }

  return $this->_helper->redirector->gotoRoute(array('action' => 'index'), 'user_searchquery', true);
}

}

Итак, яЯ хочу использовать вышеупомянутое loginAction() даже для мобильного приложения.

Далее у меня есть класс с именем Service_Api с множеством функций.Ниже приведена функция, позволяющая получить пользователя на основе идентификатора.

private function getUser(array $params)
{
    $userData = array();
    $usersTable = Engine_Api::_()->getDbtable('users', 'user'); 
    $select = $usersTable->select()->where('user_id = ?', $params['user']);

    $user = $usersTable->findOne($params['user']);
    if($user) {
        $userData = $user->exportToArray();
    }

    return Zend_Json_Encoder::encode($userData);
}

Точно так же я хочу иметь loginAction для входа в систему. Как будет выглядеть loginAction() и как я получу только значения JSON (произнесите пользовательские значения из db и success / fail для успешного входа / отказа) для мобильного приложения.

Я хочу иметь RESTful URL.

Таким образом, мои URL будут выглядеть так:

http://{servername}/service/login
http://{servername}/service/groups/list etc.

У меня есть контроллер под названием ServiceController с loginAction следующим образом:

public function loginAction()
{
    $this->_helper->viewRenderer->setNoRender();
    $this->_helper->layout->disableLayout(true);
    /*
     * Fetch Parameters and Parameter Keys
     * We don't need the controller or action!
     */
    $params = $this->_getAllParams();
    unset($params['controller']);
    unset($params['action']);
    unset($params['module']);
    unset($params['rewrite']);
    $paramKeys = array_keys($params);

    /*
     * Whitelist filter the Parameters
     */
    Zend_Loader::loadClass('Zend_Filter_Input');
    $filterParams = new Zend_Filter_Input($params);

    /*
     * Build a request array, with method name to call
     * on handler class for REST server indexed with
     * 'method' key.
     *
     * Method name is constructed based on valid parameters.
     */
    $paramKeysUc = array();
    foreach($paramKeys as $key)
    {
        $paramKeysUc[] = ucfirst($key);
    }

    $methodName = 'getBy' . implode('', $paramKeysUc);
    $request = array(
        'method'=>$methodName   
    );

    /*
     * Filter parameters as needed and add them all to the
     * $request array if valid.
     */
    foreach($paramKeys as $key)
    {
        switch($key)
        {
            case'tag':
                $request[$key] = $filterParams->testAlnum($key);
                break;
            default:
                $request[$key] = $params[$key];
        }
        if(!$request[$key])
        {
            // need better handling of filter errors for a real webservice…
            throw new Exception($request[$key] . ' contained invalid data');
        }
    }

    /*
     * Setup Zend_Rest_Server
     */
    require_once 'Zend/Rest/Server.php';

    $server = new Zend_Rest_Server;
    $server->setClass('Service_API');
    echo $server->handle($request);
}

Но это использует отдельное действие контроллера.

Любая помощь приветствуется.

Спасибо.Abhilash

1 Ответ

5 голосов
/ 27 марта 2012

Отключение макетов работает для JSON, но не позволяет перенаправить запрос на хороший контроллер в соответствии с запрошенным форматом (XML, JSON и т. Д.).

Оттуда, как решить, какие действия вызывать в соответствии с запрошенным форматом?

Ajax Context

Используйте AjaxContext в вашем контроллере _init() метод:

$ajaxContext = $this->_helper->getHelper('AjaxContext');
$ajaxContext->addActionContext('login', 'json')
            ->addActionContext('login', 'xml')
            ->initContext();

Это приведет к тому, что ваш XML-запрос будет перенаправлен на то же действие, что и ваш JSON-запрос.

Как узнать, какой формат следует использовать? Просто добавьте ?format=xml или /format/xml (или json) к параметрам URL. Ваш URL скорее будет выглядеть так: http://{servername}/service/login/format/json.

Из ваших действий, как узнать, какой формат был запрошен? Вам нечего делать, AjaxContext уже обо всем позаботится.

В случае запроса JSON:

JSON. Контекст JSON устанавливает для заголовка ответа «Content-Type» значение 'application / json' и суффикс скрипта представления к 'json.phtml'.

Однако по умолчанию сценарий просмотра не требуется. Это будет просто сериализовать все переменные представления и немедленно выдать ответ JSON.

В случае запроса XML:

Измените суффикс представления на «xml.phtml» (или, если вы используете альтернативный суффикс представления 'xml. [ваш суффикс]').

Обратите внимание, что при использовании AjaxContext заголовки ответа будут автоматически установлены в соответствии с запрошенным форматом ответа.

Сознавая это, вам не нужно больше использовать Zend_Json_Encoder.

Если вы хотите узнать больше о RESTful API, я прочитал очень интересный ppt слайд, написанный Мэтью Вейером О'Финни (в настоящее время руководитель проекта ZF), я определенно рекомендую его.

Еще одна вещь, ваше приложение, кажется, не соответствует Skinny-контроллеру и соглашению о модели Fat , рекомендованным Zend Framework, я полагал, что если вы будете следовать этому принципу, это сделает вещи более понятными тебе. Кроме того, ваш loginAction() только получит сообщение об успехе или неудаче от вашей модели , которое будет легко преобразовать в JSON или XML, используя метод, описанный выше.

RESTful API

Чтобы узнать, является ли запрос GET-запросом или POST-запросом, используйте эти методы в своих контроллерах:

  • $this->_getAllParams(); или $ this-> getRequest () -> getParams (); `перехватит все параметры, POST и GET.
  • $this->getRequest()->getPost() извлекает параметры POST.
  • $this->getRequest()->getQuery() извлекает параметры GET.

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

  • isGet()
  • isPost()
  • isPut()
  • isDelete()

Дополнительная информация здесь, в руководстве .

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