即时通讯的应用如微信WeChat大家一定很熟悉，那么今天就来详解一下如何用Rails快速开发一款网页版微信（网页版聊天室）

所有代码在Github中，目前已有功能：

  • 即时通讯
  • 增添好友
  • 创建聊天
  • 拉人，删人
  • 转移房屋权限

Todo

  1. UI界面修改（类似WeChat）
  2. 未读信息的提醒（包括声音）
  3. 加入更多的ajax提高用户体验

代码实现

我们主要应用了Render_sync库来提供服务器监听并实时推送信息的功能，下面的实现贴出一些主要的部分，详细的请到Github中下载代码查看：

  1. 首先加入render_sync等库，编辑Gemfile文件，加入以下

    gem 'faye'
gem 'thin', require: false
gem 'render_sync'

  2. 创建User，Message，Chat，FriendShip四个模型，之间的关系分别为：

    class Chat < ActiveRecord::Basehas_and_belongs_to_many :usershas_many :messages, :dependent => :destroy
end
    class Friendship < ActiveRecord::Basebelongs_to :userbelongs_to :friend, :class_name => "User"
end
    class Message < ActiveRecord::Basebelongs_to :userbelongs_to :chatsync :allsync_scope :by_chat, ->(chat) { where(chat_id: chat.id) }
end
    class User < ActiveRecord::Basehas_many :messageshas_and_belongs_to_many :chatshas_many :friendshipshas_many :friends, :through => :friendshipshas_many :inverse_friendships, :class_name => "Friendship", :foreign_key => "friend_id"has_many :inverse_friends, :through => :inverse_friendships, :source => :user.....end

  3. 编写各个模型的migrate文件，这里不贴出来，详细请看这里，创建seed.rb文件，写入初始数据：

    (1..100).each do |index|User.create(name: Faker::Name.name,email: "user#{index}@test.com",password: 'password',role: Faker::Number.between(1, 4),sex: ['male', 'female'].sample,phonenumber: Faker::PhoneNumber.phone_number,status: Faker::Company.profession)
endUser.first.friendships.create(:friend_id => 2)
User.first.friendships.create(:friend_id => 3)

  4. 编写ChatsController，FriendshipsController, MessagesController, SessionsController以及UsersController，如这里所示，以及各个控制器下的试图，如这里所示

  5. 这里主要讲解Render_sync库的用法，在ChatsController的show方法的视图中，这两句起到了推送实时信息的功能：

                    <%= sync partial: 'message_row', collection: Message.by_chat(@chat), refetch: true %><%= sync_new partial: 'message_row', resource: Message.new, scope: @chat, refetch: true %>
    • refetch: true选项能决定推送的方式为ajax
    • scope: @chat 能决定推送消息的范围，例如只给当前聊天室页面的client实时推送新的消息
    • collection: Message.by_chat(@chat) 能决定历史信息为当前聊天室的信息，而不是所有的所有的信息都在当前聊天室显示

    局部视图文件需要位于app/views/sync/messages/refetch/_message_row.html.erb才能生效，这个局部视图负责就是每条消息的显示，例如消息的主题，发送人和发送时间，简化后为：

    <p>
<%= message.user.name %>
<%= message.created_at.to_formatted_s(:db) %>
<%= message.body %>
</p>

  6. 最重要的为MessagesController的create方法，这个方法接受两个参数，一个是发送的message，一个是聊天室的id，创建发送的message后，将此message与当前聊天室关联，然后调用sync_new方法同步推送此message，推送的范围为此聊天室，最后重定向至此聊天室 

    class MessagesController < ApplicationController...def create@message = current_user.messages.build(message_params)chat=Chat.find_by_id(params[:chat_room])@message.chat=chatif @message.savesync_new @message, scope: chatendredirect_to chat_path(chat)end....end

  7. 最后编辑聊天室中的发送框即可，在ChatsController的show方法视图下，加入：

    <%= form_for @new_message, remote: true do |f| %><div class="input-group"><%= f.text_field :body, class: "form-control input-sm", placeholder: "Type your message here..." %><span class="input-group-btn"> <%= f.submit "发送", class: "btn btn-warning btn-sm" %> </span><%= hidden_field_tag :chat_room, @chat.id %></div>
<% end %>
    • 使用hidden_field_tag传入此聊天室的id
    • remote: true 使表单用ajax方法提交

  8. 完成其他模块，运行服务器

结果截屏

[Rails应用实战]WebChat的敏捷开发-编程之家

[Rails应用实战]WebChat的敏捷开发-编程之家

[Rails应用实战]WebChat的敏捷开发-编程之家

[Rails应用实战]WebChat的敏捷开发-编程之家

如何使用

  1. Fork项目，https://github.com/PENGZhaoqing/RailsChat

    git clone https://github.com/your_user_name/RailsChat
cd RailsChat
bundle install
rails server

  2. 然后再打开另外一个终端，运行以下命令启动另外一个server来监听聊天室的用户并实时推送最新的消息：

    rackup sync.ru -E production

Note：如果要部署到云上或者本地局域网内，需要修改config/sync.yml文件

以本地局域网为例：

  1. 若本机的ip地址为192.168.0.14（使用ifconfig查看），那么需要将config/sync.yml中的localhost全改为此ip地址，例如

    development:
server: "http://192.168.0.14:9292/faye"
adapter_javascript_url: "http://192.168.0.14:9292/faye/faye.js"
auth_token:  "97c42058e1466902d5adfac0f83e84c1794b9c3390e3b0824be9db8344eae82b"
adapter: "Faye"
async: truetest:
...
production:
...

  2. 然后运行rake tmp:clear来清除缓存，不然修改不会生效（运行前先将所有相关的运行停止：如rails s,rackup sync.ru等）

  3. 再次运行rails服务器和监听程序，并指定监听程序运行的ip地址

    rails s
rackup sync.ru -E production --host 192.168.0.14

Debug

  1. 当遇到消息并没有实时推送的情况时，先F12查看浏览器的Js文件加载情况，若faye.js加载成功则一般不会出现问题

  2. 以上加载完成但是仍然没有推送的时候，请查看Rails服务器的log文件

  3. 需要在两个浏览器中登录不同的账号来检验聊天室功能