在Job Listing比赛中自定义过devise界面的栈友想必都看过这篇文章,其中有一项是给注册用户提供了用户名选项,但是好像仅仅是有一个用户名而已,还不能够实现利用用户名直接登录,这里就讲讲如何实现在登录界面中实现用户名登录。
步骤一 确保你已经实现了上文链接中提到的增加username功能。
修改application_controller.rb
,添加username
, email
, password
, password confirmation
以及 remember me
到configure_permitted_parameters
class ApplicationController < ActionController::Base
protect_from_forgery with: :exception
before_action :configure_permitted_parameters, if: :devise_controller?
protected
def configure_permitted_parameters
added_attrs = [:username, :email, :password, :password_confirmation, :remember_me]
devise_parameter_sanitizer.permit :sign_up, keys: added_attrs
devise_parameter_sanitizer.permit :account_update, keys: added_attrs
end
end
步骤二 在models/user.rb
中添加参数
def login=(login)
@login = login
end
def login
@login || self.username || self.email
end
步骤三 修改config/initializers/devise.rb
增加(这里只需要使用⌘ + f
查找对应的设置,删除注释符号#
即可。)
- config.authentication_keys = [ :email ]
+ config.authentication_keys = [ :login ]
步骤四 在user.rb重写devise中的find_for_database_authentication
因为我们要改变登录的方式,就需要重写find_for_database_authentication
方法。 在find_for_database_authentication
栈的工作流程是这样的:find_for_database_authentication
调用find_for_authentication
,find_for_authentication
接着会调用find_first_by_auth_conditions
;重写find_for_database_authentication
允许我们去编辑数据库验证。
在app/models/user.rb
中添加
def self.find_for_database_authentication(warden_conditions)
conditions = warden_conditions.dup
if login = conditions.delete(:login)
where(conditions.to_hash).where(["username = :value OR lower(email) = lower(:value)", { :value => login.downcase }]).first
elsif conditions.has_key?(:username) || conditions.has_key?(:email)
where(conditions.to_hash).first
elsif conditions[:email].downcase! if conditions[:email]
where(conditions.to_hash).first
end
end
用户名验证非常容易与邮箱相互冲突,请看栗子:
用户2的用户名使用了用户1的注册邮箱,如果用上面的指令:
where(conditions.to_hash).where(["username = :value OR lower(email) = lower(:value)", { :value => login.downcase }]).first
用户1就永远无法登陆了,因为指令调用会一直返回到#2;
为了解决这个问题,我们需要在app/models/user.rb中添加
+ validates_format_of :username, with: /^[a-zA-Z0-9_\.]*$/, :multiline => true
步骤五 生成并修改devise界面
rails g devise:views
在config/initializers/devise.rb
中修改
config.scoped_views = true
修改界面
sessions/new.html.erb
:
- <%= f.input :email, required: false, autofocus: true %>
+ <%= f.input :login, label: false, required: false, autofocus: true, placeholder: "用户名/邮箱" %>
在sessions/new.html.erb
中使用:login
而不是:username
registrations/new.html.erb
:
+ <%= f.input :username, label: false, required: true, autofocus: true, placeholder: "用户名" %>
registrations/edit.html.erb
:
+ <%= f.input :username, required: true, autofocus: true %>
步骤六 利用用户名恢复密码和账户确认
修改config/initializers/devise.rb
config.reset_password_keys = [ :username ]
config.confirmation_keys = [ :username ]
(使用⌘ + f
查找对应的设置,删除注释符号#
即可)
用find_first_by_auth_conditions
替换find_for_database_authentication
把user.rb中的
def self.find_for_database_authentication(warden_conditions)
conditions = warden_conditions.dup
if login = conditions.delete(:login)
where(conditions.to_hash).where(["username = :value OR lower(email) = lower(:value)", { :value => login.downcase }]).first
elsif conditions.has_key?(:username) || conditions.has_key?(:email)
where(conditions.to_hash).first
elsif conditions[:email].downcase! if conditions[:email]
where(conditions.to_hash).first
end
end
替换成
def self.find_first_by_auth_conditions(warden_conditions)
conditions = warden_conditions.dup
if login = conditions.delete(:login)
where(conditions).where(["lower(username) = :value OR lower(email) = :value", { :value => login.downcase }]).first
else
if conditions[:username].nil?
where(conditions).first
else
where(username: conditions[:username]).first
end
end
end
更新相应的view
passwords/new.html.erb
:
- <%= f.input :email, required: true, autofocus: true %>
+ <%= f.input :username, label: "用户名", required: true, autofocus: true %>
confirmations/new.html.erb
:
- <%= f.input :email, required: true, autofocus: true %>
+ <%= f.input :username, label: "用户名", required: true, autofocus: true %>