更新日: 2014年5月12日
Rails

Rails ActiveRecordのSQLでLIKE検索をエスケープ

Rails で ActiveRecord を使って LIKE 検索をする際に、LIKE に渡す文字列をエスケープする方法です。ワイルドカードとして使われる ‘%’, ‘_’ の文字、およびデフォルトでのエスケープ用文字である ‘\’（バックスラッシュ）が、LIKE に渡す文字列に含まれる場合にエスケープする必要がある。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

例えば、”100%完成” みたいな文字列を LIKE 検索にそのまま渡すと、% がワイルドカードとして使われてしまうので、それを防ぐために “100\\%完成” とエスケープする必要がある。バックスラッシュは文字列でもエスケープ用キャラクタとして使われるので、LIKE検索に渡す際にはバックスラッシュが2つ必要なことにも注意。

— 環境 —
Rails 4.0.1

独自に escape_like メソッドを実装

LIKE 検索時に使える API が Rails では特に用意されていなさそうだったので、以下のメソッドを作りました。

def escape_like(string)
  string.gsub(/[\\%_]/){|m| "\\#{m}"}
end

def escape_like(string)

string.gsub(/[\\%_]/){|m| "\\#{m}"}

end

この escape_like メソッドは、実は Sequel という Ruby 用の別の ORM ライブラリからの拝借です。

Method: Sequel::Dataset#escape_like — Documentation for jeremyevans/sequel (master)

使うコントローラー/モデルの private メソッドとして作成する。あるいは、色んな箇所で使う場合は ApplicationController に定義するか、ActiveRecord::Base そのものにクラスメソッドとして追加したほうが便利です。私は以下の方法で ActiveRecord 自体を拡張しました。

ActiveRecord::Base にクラスメソッドとして追加

ActiveRecord::Base をオープンして escape_like クラスメソッドを追加すると、モデルのクラスメソッドとして利用でき、場所を選ばずどこでも使えます。以下 pry での実行。


pry(main)> ActiveRecord::Base.singleton_methods.grep(/like/)
=> []
pry(main)> module ActiveRecord
pry(main)*   class Base
pry(main)*     def self.escape_like(string)
pry(main)*       string.gsub(/[\\%_]/){|m| "\\#{m}"}
pry(main)*     end
pry(main)*   end
pry(main)* end
=> nil
pry(main)> ActiveRecord::Base.singleton_methods.grep(/like/)
=> [:escape_like]
pry(main)> User.escape_like("100%完成")
=> "100\\%完成"

pry(main)> ActiveRecord::Base.singleton_methods.grep(/like/)

=> []

pry(main)> module ActiveRecord

pry(main)* class Base

pry(main)* def self.escape_like(string)

pry(main)* string.gsub(/[\\%_]/){|m| "\\#{m}"}

pry(main)* end

=> nil

pry(main)> ActiveRecord::Base.singleton_methods.grep(/like/)

=> [:escape_like]

pry(main)> User.escape_like("100%完成")

=> "100\\%完成"

アプリケーションのコードとしては、lib 以下にファイルを置いて initializers で require する方法が簡単です。

lib/active_record_extension.rb

module ActiveRecord
  class Base
    def self.escape_like(string)
      string.gsub(/[\\%_]/){|m| "\\#{m}"}
    end
  end
end

module ActiveRecord

class Base

def self.escape_like(string)

string.gsub(/[\\%_]/){|m| "\\#{m}"}

end

config/initiaizers/lib.rb

require "active_record_extension"

1	require "active_record_extension"

ActiveRecordをさらに便利にする方法の紹介 – Hello, world! – s21g

escape_like メソッドの使い方

以下のように使います。

User.where("name LIKE ?", "%#{escape_like(params[:name])}%")

1	User.where("name LIKE ?", "%#{escape_like(params[:name])}%")

where メソッドにプレースホルダーで渡す。

または、ActiveRecord に追加した場合は以下。

User.where("name LIKE ?", "%#{User.escape_like(params[:name])}%")

1	User.where("name LIKE ?", "%#{User.escape_like(params[:name])}%")

これで、Rails で SQL の LIKE を使うのが楽になりました。

パーフェクト Ruby on Rails は、最近読んだ Rails 本の中では一番役に立った本です。Chef や Capistrano など Rails と共によく使用される技術にも触れてあります。Ruby on Rails 4 アプリケーションプログラミングは、入門的な内容で Rails の機能全体を網羅されています。

パーフェクト Ruby on Rails

Ruby on Rails 4 アプリケーションプログラミング