TIS ENGINEER NOTE

ITエンジニアのためのキャリア向上ノウハウブログ

プログラミング

Ruby on RailsでCSV一覧出力する3つの方法

更新日:

ユーザーが画面に表示されている一覧情報をダウンロードしたい、という場合によく使われるのがcsv形式。

Ruby on Railsでcsv出力をしようとして、情報を集めていると色々な実装手順を見かけました。使っているライブラリなどはほとんど変わらないのですが、実装箇所が異なっているので、ちょっと混乱してしまいました。

今回は自分が調べた結果のまとめとしてRuby on Railsでcsv出力を行う際の3つのアプローチをご紹介していきます。

前提

基本的にRubyのライブラリであるCSV.generateを利用します。もっともシンプルにcsvの出力を行えます。

名前(name),説明(description),価格(price)という情報を持った製品(product)モデルのデータを表示させるとしましょう。

csv_data = CSV.generate do |csv|
  csv_column_names = ["製品名","製品説明","価格"]
  csv << csv_column_names
  @products.each do |product|
    csv_column_values = [
      product.name,
      product.description,
      product.price,
    ]
    csv << csv_column_values
  end
end

上記のように配列を渡していく形で、直感的に1行ずつcsv形式でデータを出力することができます。

注意しておいて欲しいのが、CSV.generate自体はcsvファイルを出力するのではなく、csv文字列を作成しているだけであるということです。上の例だとcsv_dataに入るのはStringのデータとなります。

また、これから話す手順のうち1と2はcsv出力用のviewファイルし、3はコントローラー内でcsvの作成と出力を行います。

いずれの方法も実際に動作確認済みです。

ではそれぞれの手順を見ていきましょう。

①csv出力用のアクションを作成する方法

まずは一番わかりやすいcsv出力用のアクションを作成する実装方法です。

この方法のメリット

  • わかりやすい

この方法のデメリット

  • REST設計に背く形となる

REST設計についての詳細はこちらを参考ください。

実装コード

コントローラー

一覧出力したいモデルのコントローラーにcsv出力専用のアクションを新規作成する。

class ProductsController < ApplicationController
  def csv_output
    @products = Product.all
    send_data render_to_string, filename: "products.csv", type: :csv
  end
end

ルーティング

他の基本アクションも実装する前提とすると以下の通り。collectionの中に作成したいアクションを含めます。

Rails.application.routes.draw do
  root 'products#index'
  resources :products do
    collection do
      get 'csv_output'
    end
  end
end

csv出力ファイル(ビュー)

最後に出力処理本体となるrubyファイル。link_toのパスにformat: :csvを設定すると自動で呼び出されます。なぜこの拡張子なのかは不明。

require 'csv'

CSV.generate do |csv|
  csv_column_names = ["製品名","製品説明","価格"]
  csv << csv_column_names
  @products.each do |product|
    csv_column_values = [
      product.name,
      product.description,
      product.price,
    ]
    csv << csv_column_values
  end
end

ダウンロードリンク

最後にファイル出力を行うためのリンク。できればかっこいいボタンに仕上げましょう。今回は無骨にただのリンク。ポイントはformat: :csvです。

# 省略
<%= link_to "csv出力",csv_output_products_path(format: :csv) %>
# 省略

所感

RESTにこだわる方から石を投げられそうな実装です。確かにindexで実装できそうな内容を新しくルーティングして作るというのは微妙。しかし複数のモデルにまたがる出力をしたい時などは使い所がありそうではあります。あとはどうしてもindexアクションに修正を加えたくない時とか。

②indexアクションからcsv出力ビューへ

一覧出力したいモデルのコントローラーのindexアクションから、formatを判定して、処理を分岐し、csv出力ファイルをレンダリングする形になります。csv出力ファイル(csv_output.csv.ruby)の内容は①と同様。

この方法のメリット

  • REST設計に則っている

この方法のデメリット

  • indexアクションに修正が必要

実装コード

コントローラー

respond_toで呼び出し時のformatを判定し、csvの場合、csv出力ファイルを呼び出します。それ以外の場合は通常通り、html.erbファイルが呼び出されます。

class ProductsController < ApplicationController
  def index
    @products = Product.all
    respond_to do |format|
      format.html
      format.csv do
        send_data render_to_string, filename: "products.csv", type: :csv
      end
    end
  end
end

ルーティング

ルーティングに特別な設定は不要です。indexが呼び出されるルートが設定されていればOKです。

Rails.application.routes.draw do
  resources :products
end

csv出力ファイル(ビュー)

①と同様のソースでOKです。

ダウンロードリンク

いつも通りのindex指定にformat: :csvを付け足すだけです。ボタンはかっこよく仕上げましょう。

<%= link_to "csv出力",products_path(format: :csv) %>

所感

一番ベーシックな実装ではないかと思います。特に欠点も見当たりませんし。もしcsv処理をコントローラーに一任したい場合は③の方法をオススメします。

③indexアクションのみで実装

indexアクション内、またはメソッドを作成してその中でcsvの作成と出力を行います。

この方法のメリット

  • 処理がコントローラー内で完結する

この方法のデメリット

  • コントローラーが複雑になる可能性がある

実装コード

コントローラー

respond_toで呼び出し時のformatを判定する部分までは②と同様。ただし、csv出力ファイルをレンダリングするのではなく、別実装したメソッドにてcsv生成と出力を行います。

一旦CSV.generateを変数に格納し、send_dataでファイルを出力しています。

class ProductsController < ApplicationController
  def index
    @products = Product.all
    respond_to do |format|
      format.html
      format.csv do
        products_csv
      end
    end
  end
  private
  def products_csv
    csv_date = CSV.generate do |csv|
      csv_column_names = ["製品名","製品説明","価格"]
      csv << csv_column_names
      @products.each do |product|
        csv_column_values = [
          product.name,
          product.description,
          product.price,
        ]
        csv << csv_column_values
      end
    end
    send_data(csv_date,filename: "product3.csv")
  end
end

ルーティング

②と同様に特別なルーティングは必要ありません。

csv出力ファイル(ビュー)

csv出力ファイルを作成する必要はありません。

ダウンロードリンク

②と同様です。かっこよく仕上げましょう。

所感

csvをビューに実装するということに気持ち悪さを感じる人にはいい実装方法かと思われます。個人的にはスタイリッシュで嫌いではないです。

おまけ

文字コードを指定したい

CSV.generateにオプションを指定するだけでOKです。①の実装例で試すとこんな感じ。

require 'csv'

CSV.generate(encoding: Encoding::SJIS) do |csv|
  csv_column_names = ["製品名","製品説明","価格"]
  csv << csv_column_names
  @products.each do |product|
    csv_column_values = [
      product.name,
      product.description,
      product.price,
    ]
    csv << csv_column_values
  end
end

タイトルや空白行を出力したい

以下の通りの実装で行けます。渡す値が配列であれば問題ありません。こちらも①の実装例で。

require 'csv'

CSV.generate do |csv|
  # タイトル
  csv << ["製品一覧"]
  # 空白行
  csv << []
  csv_column_names = ["製品名","製品説明","価格"]
  csv << csv_column_names
  @products.each do |product|
    csv_column_values = [
      product.name,
      product.description,
      product.price,
    ]
    csv << csv_column_values
  end
end

出力されるファイルは以下のようになります。

製品一覧

製品名,製品説明,価格
product1,this is product1,1000

まとめ

いかがだったでしょうか。あなた自身や開発現場のコーディング方針に適した手法を選択していただければ。

閲覧いただき、ありがとうございました。

オススメ記事
文系出身エンジニアが26才でフリーランスになった感想

こんにちは。フリーランスエンジニアのてぃすです。 フリーランスエンジニアということは、つまりエンジニアとして独立しているということになり、すごい敷居が高い印象を持っている人が多いです。 けど僕は文系大 ...

続きを見る

よく読まれている記事

エンジニア独立

2019/5/29

エンジニア歴2年の僕がポテパンフリーランスの個人面談を受けてきた

特定派遣会社の正社員からフリーランスエンジニアを目指す活動の一環として、フリーランス初心者に特化したエージェントであるポテパンフリーランスの個人面談に行ってきましたので、その感想と特徴について書いていきます。 前提として僕はエンジニア暦2年半、化石のような超マイナーフレームワークでの開発経験しかないというちょっと残念なエンジニアです。 そんな僕でもフリーランスエンジニアとして活動できるという実感を今回の個人面談で得ることができました。 フリーランスという働き方に興味を持ってはいるが、具体的にどうすれば実現 ...

続きを読む

エンジニア入門

2019/4/15

プログラミングの勉強はモチベーションだけでやると挫折する

こんにちは。フリーエンジニアのてぃすです。 最近は未経験からエンジニアを目指したり、エンジニアとしてのキャリアを向上させるために、プライベートでプログラミングを勉強をし始める人が増えてきています。 僕自身、プライベートの時間に未経験言語の勉強をしてキャリアアップした経験があるので、非常にいい傾向だと思っています。 しかしSNSやブログなどを眺めていると、 「この人モチベーションだけで勉強しているな」 という人を多く見かけます。 個人的な経験と人から聞いてきた話から、このようにモチベーションだけで勉強してい ...

続きを読む

エンジニア入門

2019/4/28

未経験からプログラミングを学ぶための方法を徹底比較

いまの時代、プログラマという仕事ほどインスタントに高収入を目指せる職業は存在しないと考えています。 未経験の言語での参加にも関わらず、最初から残業なしで手取り30万円を得られた経験を以って、そのことを強く実感しました。 で、最近はプログラマ・エンジニアのこういった稼げる側面に気づいて、プログラマになりたいと考える人多くなってきました。 が、実際にどのような手順を踏んでプログラミングを学習して、プログラマになればいいか分からない人も同様に多いようです。 勉強方法によっては遠回りになりかねない 働きながら勉強 ...

続きを読む

エンジニア独立

2019/5/29

パーソルテクノロジースタッフの派遣でエンジニア歴2年の僕が時給2000円を余裕で超えた話

今いる会社を辞めることとなり、今後のエンジニアとしての身の振りを検討中のてぃすです。 今回とある派遣会社にて、業務経験なしのRuby on Railsの案件を紹介してもらい、その時給が2000円を超えていました。 月給換算したら1,2年目の正社員の給与を余裕で超えてきます。派遣という働き方の印象がガラッと変わる体験をしました。 今回はエンジニア歴2年の僕にそんな素敵な待遇を提供してくれたパーソルテクノロジースタッフについて、実体験を交えて語っていこうと思います。 エンジニア派遣の「パーソルテクノロジースタ ...

続きを読む

エンジニア入門

2019/4/15

エンジニアは勉強し続けなければいけない職業なのか

こんにちは。フリーランスエンジニアのてぃすです。 最近は就職・転職する際にエンジニアを選択肢に含める人が増えてきています。 しかしエンジニアという職業を候補にあげるにあたって、 エンジニアは働きながら勉強し続けなければいけないのではないか? という疑問もよく見聞きします。 そこで今回はフリーランスエンジニアとして活動している僕の視点からこの疑問についての答えを説明していこうと思います。 結論 先に結論を述べると、 エンジニアは勉強し続けなければいけないのか? という疑問の答えはNOです。 決してエンジニア ...

続きを読む

-プログラミング
-,

Copyright© TIS ENGINEER NOTE , 2020 All Rights Reserved Powered by AFFINGER5.