Socket.IO を使用して AngularJS アプリを作成する

はじめに

AngularJS は、使いやすく高速な双方向データ バインディング、再利用可能なカスタム コンポーネントを作成できる強力なディレクティブ システムなど、優れた JavaScript フレームワークです。Socket.IO は、WebSocket のクロスブラウザ ラッパーとポリフィルであり、リアルタイム アプリケーションの開発を容易にします。なお、この 2 つは非常に相性が良いです。

以前、Express で AngularJS アプリを作成する方法について説明しましたが、今回は Socket.IO を統合して AngularJS アプリケーションにリアルタイム機能を追加する方法について説明します。このチュートリアルでは、インスタント メッセージ アプリの作成について説明します。これは、以前のチュートリアル(サーバー上で同様の node.js スタックを使用)をベースに作成されているため、Node.js や Express に慣れていない場合は、まずそちらを確認することをおすすめします。

デモを開く

いつものように、GitHub で完成版を入手できます。

前提条件

Socket.IO をセットアップして Express と統合するには、ボイラープレートが少し必要になるため、Angular Socket.IO Seed を作成しました。

始めに、GitHub から angular-node-seed リポジトリのクローンを作成します。

git clone git://github.com/btford/angular-socket-io-seed my-project

または、ZIP ファイルとしてダウンロードします。

シードができたら、npm でいくつかの依存関係を取得する必要があります。シードを含むディレクトリのターミナルを開き、次のコマンドを実行します。

npm install

これらの依存関係がインストールされたら、スケルトンアプリを実行できます。

node app.js

ブラウザの http://localhost:3000 で確認し、シードが想定どおりに機能していることを確認します。

アプリの機能の決定

チャット アプリケーションを作成する方法はいくつかありますが、ここでは、作成するアプリケーションに最低限必要な機能を説明します。すべてのユーザーが属するチャットルームは 1 つだけです。ユーザーは名前を選択して変更できますが、名前は一意である必要があります。サーバーは、この一意性を適用し、ユーザーが名前を変更したときに通知します。クライアントには、メッセージのリストと、現在チャットルームに入っているユーザーのリストが表示されます。

シンプルなフロントエンド

この仕様を使用すると、必要な UI 要素を提供する Jade でシンプルなフロントエンドを作成できます。views/index.jade を開き、block body 内に次を追加します。

div(ng-controller='AppCtrl')
.col
  h3 Messages
  .overflowable
    p(ng-repeat='message in messages') : 

.col
  h3 Users
  .overflowable
    p(ng-repeat='user in users') 

.clr
  form(ng-submit='sendMessage()')
    | Message: 
    input(size='60', ng-model='message')
    input(type='submit', value='Send')

.clr
  h3 Change your name
  p Your current user name is 
  form(ng-submit='changeName()')
    input(ng-model='newName')
    input(type='submit', value='Change Name')

public/css/app.css を開き、列とオーバーフローを指定する CSS を追加します。

/* app css stylesheet */

.overflowable {
  height: 240px;
  overflow-y: auto;
  border: 1px solid #000;
}

.overflowable p {
  margin: 0;
}

/* poor man's grid system */
.col {
  float: left;
  width: 350px;
}

.clr {
  clear: both;
}

Socket.IO の操作

Socket.IO は windowio 変数を公開しますが、AngularJS の依存関係注入システムでカプセル化することをおすすめします。まず、Socket.IO から返された socket オブジェクトをラップするサービスを作成します。これは、後でコントローラをテストする際に非常に便利です。public/js/services.js を開き、内容を次のように置き換えます。

app.factory('socket', function ($rootScope) {
  var socket = io.connect();
  return {
    on: function (eventName, callback) {
      socket.on(eventName, function () {  
        var args = arguments;
        $rootScope.$apply(function () {
          callback.apply(socket, args);
        });
      });
    },
    emit: function (eventName, data, callback) {
      socket.emit(eventName, data, function () {
        var args = arguments;
        $rootScope.$apply(function () {
          if (callback) {
            callback.apply(socket, args);
          }
        });
      })
    }
  };
});

各ソケット コールバックを $scope.$apply でラップしていることに注意してください。これにより、AngularJS は、渡されたコールバックの実行後に変更があった場合は、アプリケーションの状態を確認し、テンプレートを更新する必要があることを認識します。内部的には、$http は同じ方法で動作します。XHR が返された後、$scope.$apply を呼び出し、AngularJS がビューを適切に更新できるようにします。

このサービスは Socket.IO API 全体をラップしているわけではありません(これは読者の演習として残しておきます)。ただし、このチュートリアルで使用したメソッドが含まれているため、拡張する場合の参考になります。完全なラッパーの作成については、後で説明するかもしれませんが、このチュートリアルでは説明しません。

これで、コントローラ内で、$http の場合と同様に socket オブジェクトをリクエストできます。

function AppCtrl($scope, socket) {
  /* Controller logic */
}

コントローラ内に、メッセージの送受信のロジックを追加します。js/public/controllers.js を開き、内容を次のように置き換えます。

function AppCtrl($scope, socket) {

  // Socket listeners
  // ================

  socket.on('init', function (data) {
    $scope.name = data.name;
    $scope.users = data.users;
  });

  socket.on('send:message', function (message) {
    $scope.messages.push(message);
  });

  socket.on('change:name', function (data) {
    changeName(data.oldName, data.newName);
  });

  socket.on('user:join', function (data) {
    $scope.messages.push({
      user: 'chatroom',
      text: 'User ' + data.name + ' has joined.'
    });
    $scope.users.push(data.name);
  });

  // add a message to the conversation when a user disconnects or leaves the room
  socket.on('user:left', function (data) {
    $scope.messages.push({
      user: 'chatroom',
      text: 'User ' + data.name + ' has left.'
    });
    var i, user;
    for (i = 0; i < $scope.users.length; i++) {
      user = $scope.users[i];
      if (user === data.name) {
        $scope.users.splice(i, 1);
        break;
      }
    }
  });

  // Private helpers
  // ===============

  var changeName = function (oldName, newName) {
    // rename user in list of users
    var i;
    for (i = 0; i < $scope.users.length; i++) {
      if ($scope.users[i] === oldName) {
        $scope.users[i] = newName;
      }
    }

    $scope.messages.push({
      user: 'chatroom',
      text: 'User ' + oldName + ' is now known as ' + newName + '.'
    });
  }

  // Methods published to the scope
  // ==============================

  $scope.changeName = function () {
    socket.emit('change:name', {
      name: $scope.newName
    }, function (result) {
      if (!result) {
        alert('There was an error changing your name');
      } else {

        changeName($scope.name, $scope.newName);

        $scope.name = $scope.newName;
        $scope.newName = '';
      }
    });
  };

  $scope.sendMessage = function () {
    socket.emit('send:message', {
      message: $scope.message
    });

    // add the message to our model locally
    $scope.messages.push({
      user: $scope.name,
      text: $scope.message
    });

    // clear message box
    $scope.message = '';
  };
}

このアプリには 1 つのビューしかないため、public/js/app.js からルーティングを削除して、次のように簡素化できます。

// Declare app level module which depends on filters, and services
var app = angular.module('myApp', ['myApp.filters', 'myApp.directives']);

サーバーの作成

routes/socket.js を開きます。ユーザー名が一意になるように、サーバーの状態を維持するオブジェクトを定義する必要があります。

// Keep track of which names are used so that there are no duplicates
var userNames = (function () {
  var names = {};

  var claim = function (name) {
    if (!name || userNames[name]) {
      return false;
    } else {
      userNames[name] = true;
      return true;
    }
  };

  // find the lowest unused "guest" name and claim it
  var getGuestName = function () {
    var name,
      nextUserId = 1;

    do {
      name = 'Guest ' + nextUserId;
      nextUserId += 1;
    } while (!claim(name));

    return name;
  };

  // serialize claimed names as an array
  var get = function () {
    var res = [];
    for (user in userNames) {
      res.push(user);
    }

    return res;
  };

  var free = function (name) {
    if (userNames[name]) {
      delete userNames[name];
    }
  };

  return {
    claim: claim,
    free: free,
    get: get,
    getGuestName: getGuestName
  };
}());

これは基本的に一連の名前を定義しますが、チャット サーバーのドメインに適した API を使用します。これをサーバーのソケットに接続して、クライアントからの呼び出しに応答しましょう。

// export function for listening to the socket
module.exports = function (socket) {
  var name = userNames.getGuestName();

  // send the new user their name and a list of users
  socket.emit('init', {
    name: name,
    users: userNames.get()
  });

  // notify other clients that a new user has joined
  socket.broadcast.emit('user:join', {
    name: name
  });

  // broadcast a user's message to other users
  socket.on('send:message', function (data) {
    socket.broadcast.emit('send:message', {
      user: name,
      text: data.message
    });
  });

  // validate a user's name change, and broadcast it on success
  socket.on('change:name', function (data, fn) {
    if (userNames.claim(data.name)) {
      var oldName = name;
      userNames.free(oldName);

      name = data.name;

      socket.broadcast.emit('change:name', {
        oldName: oldName,
        newName: name
      });

      fn(true);
    } else {
      fn(false);
    }
  });

  // clean up when a user leaves, and broadcast it to other users
  socket.on('disconnect', function () {
    socket.broadcast.emit('user:left', {
      name: name
    });
    userNames.free(name);
  });
};

これで申請は完了です。node app.js を実行して試してみましょう。Socket.IO により、アプリケーションはリアルタイムで更新されます。

まとめ

このインスタント メッセージ アプリには、他にも多くの機能を追加できます。たとえば、空のメッセージを送信できます。ng-valid を使用してクライアント側でこれを防ぎ、サーバーでチェックすることもできます。新しいユーザーがアプリに参加できるように、サーバーで最近のメッセージの履歴を保持することもできます。

他のライブラリを使用する AngularJS アプリを作成するのは、ライブラリをサービスにラップしてモデルが変更されたことを Angular に通知する方法を理解すれば簡単です。次に、一般的な可視化ライブラリである D3.js で AngularJS を使用する方法について説明します。

参照

Angular Socket.IO Seed 完成したインスタント メッセージ アプリ AngularJS Express Socket.IO`