Rails 又一个 MessageVerifier 的使用场景

yue · 2015年09月13日 · 最后由 yue 回复于 2015年10月05日 · 3764 次阅读

问题描述

假设微信应用有转发产品介绍和引导注册的页面，如何知道哪些已有用户的转发带来最多的新注册用户呢？

Short Answer

解决的办法是在每个分享链接里面携带推荐人的用户信息。一旦新用户通过链接完成注册，则通过链接携带的推荐人信息和新用户建立推荐关系。这里分享链接的用户信息可以使用 MessageVerifier 转码签名用户类型 (user_type) 和用户 ID(user_id)，然后作为参数加入链接。

Modelling

目标是保存新用户和推荐人的关联关系。可以使用 self referential model。用户模型（User) 作为新用户 (referred) 有且仅有一个推荐人 (referee)。而老用户可以是多位新用户的推荐人。

More Modelling

如果推荐人是多种用户类型，如学生 (Student) 互相之间，老师 (Teacher) 对学生可以推荐，那么这样的推荐关系可以通过多态 polymorphic 的 self referential 模型来实现。如下是模型的 UML 图。

分享链接携带一个含有推荐人信息的 share_token

那么该如何传递推荐人的信息呢？方法一是为每一位用户创建一个全局唯一的 share_token 字段，然后在分享链接里面携带这个 token，每个点击携带 share_token 的分享链接的潜在用户，在创建新账号的时候就可以通过 token 找到推荐人。第二种方法是使用 MessageVerifier 来签发用户身份信息作为 share_token。在定位推荐人的时候，只需要验证令牌和读取里面的推荐人信息。显然第二种更巧妙，减少了额外的数据库字段。

实现 models

首先是学生，老师和推荐的模型。学生和老师都有多个推荐记录（referrals），而一个新学生只能有一个推荐人（referee）。这里的中间表格 Referral 是为了支持多态而引入的。如果仅仅是学生之间才存在推荐关系，那么不需要这个表。

class Student < ActiveRecord::Base
  has_one :referral, foreign_key: 'referred_id'
  has_many :referrals, foreign_key: "referee_id", as: :referee
end

class Teacher < ActiveRecord::Base
  has_many :referrals, foreign_key: "referee_id", as: :referee
end

class Referral < ActiveRecord::Base
  belongs_to :referee, polymorphic: true
  belongs_to :referred, class_name: 'Student'

  validates_presence_of :referee, :referred
  validates_uniqueness_of :referred_id
end

实现 share_token generator

下面的代码定义了一个单例模式的 TokenGenerator。通过调用 generate_share_token 方法，它可以为某一个用户生成一个 share_token。这个 share_token 含有 "#{user_type}_#{user_id}" 信息，并且使用秘钥签字。

module Utilities::TokenGenerator
  include Singleton
  attr_accessor :verifier
  def initialize
    @secret_key = Rails.application.secrets.secret_key_base || "any_key"
    @verifier = ActiveSupport::MessageVerifier.new(@secret_key)
  end

  def generate_share_token(user)
    return "" unless user
    generate("#{user.class.to_s.downcase}_#{user.id}")
  end

  def generate(message)
    Base64.urlsafe_encode64(verifier.generate(message))
  end
end

同时它可以验证和提取给定 share_token 的用户信息。如验证不通过（token 被修改导致无效），则返回 false。

# token_generator.rb
def verify(encode_token)
  begin
    decode = Base64.urlsafe_decode64(encode_token)
    verifier.verify decode
  rescue ActiveSupport::MessageVerifier::InvalidSignature => e
    false
  rescue ArgumentError => e
    false 
  end
end

组合了推荐人的微信分享链接

最终的分享链接如下：

https://yoursite.com?share_token=QkFoSklnNXpkSFZrWlc1MFh6RUdPZ1pGUmc9PS 0tMDBjMjEzNzMwZmQ5MDA4N2ZkZDZkN2NiYzVkMWIwNDEzNDAyZmNlMw==

# 在 ApplicationController 中定义 share_url 需要携带 share_token
# 生成携带推荐人信息的分享链接
def share_url
  share_token = Utilities::TokenGenerator.instance.generate_share_token(current_user)
  share_path(share_token: share_token)
end

创建新用户并建立推荐关系

在到达创建这一步之前，用户还可能去其他页面，所以 share_token 会先被保存在 session 里面（此处不展示保存代码）。在创建新用户成功后，调用 set_referral 来建立推荐关系。

# 在创建了新用户之后建立推荐关系 #set_referral

def set_referral
  # 获取 share_token 并验证
  return unless share_token = session[:share_token]
  if referee_st = verifier.verify(share_token)
    # 从验证通过的 share_token 中获取用户信息，并还原推荐人
    klass, id = referee_st.split('_')
    referee = klass.classify.safe_constantize.find_by_id(id)
    # 建立推荐关系
    Referral.create(referee: referee, referred: @student)
    # 删除 session 中的 share_token
    session.delete(:share_token)
  end
end