More than 1 year has passed since last update.

【爆速】RailsとDockerで環境構築〜立ち上げまで

Last updated at 2023-03-02Posted at 2022-10-31

今回は、RailsとDockerの環境構築をして簡単なアプリケーション作成までざっくりとまとめてみました。

この記事にした経緯として、これまでは、主にRuby on Rails（以下 Rails）を使った社内のシステムや副業で運営していたサブスク型のサービス開発をしていたのですが、ここ1年以上Railsを触る機会がなかったので、改めて触ってみようというところです。

みなさんにも、これからRubyやRailsに興味を持って頂き、始めやすいように、簡単に紹介・解説していきたいと思います。

では早速、本題に入りましょう！

今回の記事内容

そもそもRubyとは？
RubyとRuby on Railsの違いと開発事例
Dockerとは？
RailsとDockerの環境構築
簡単なアプリケーションの作成

①Rubyとは

Ruby（ルビー）とは、まつもとゆきひろ氏によって生み出された、日本製のプログラミング言語です。ルビーという言語名は、Web開発で使われる「Perl（パール）」という言語に由来します。

「パールと同じようなことができる言語を作りたい」という思いから生まれたのが、Ruby。

パールは日本語だと「真珠」となるため、パールに続く宝石として「ルビー」という名前が採用されたのです。

Rubyができること

Webサービス・サイト制作・ECサイト
Webアプリ開発
API開発
Webスクレイピング
SNS
業務システム
スマホアプリ開発（できなくないが全く向いていない）

②RubyとRailsの違い

Ruby on Railsは、Ruby開発におけるフレームワークの1つです。

ちなみに、フレームワークとは、便利なプログラムをまとめた骨組みのこと。

Railsを使うことで、難しい機能でも簡単なプログラミングで実現でき、開発がスムーズに進みます。

ちな、RailsにVueやReactを導入することなども可能です。

Railsの開発事例

実際に以下の有名なサイトでもRailsが使われています。

③Dockerとは？

クジラさんで有名なDockerですが、

Dockerとは、一言で言うと、パソコン上に仮想環境を作れて、簡単に開発環境を作れて開発・デプロイまでできるツール・仕組みです。

環境構築において大変なことは、ライブラリなどのインストールでAさんは動いているのに、Bさんは動かないみたいなことです。

また、ステージング環境と本番環境での環境構築にも同じようにエラーが起きては修正しての繰り返しがあります。

しかし、Dockerがあれば解決！

「OS・ライブラリ・アプリケーション」を1つにまとめて配布してくれます。

つまり、自分でライブラリのインストール不要。みんな同じ環境で動く。最高ですね。

再度、要点をまとめると、以下のメリットがあるというわけですね。

開発環境を簡単に構築できる
どこでも誰でも同じ開発環境を作れる
ステージング環境と本番環境の統一

Dockerを使った仮想環境の具体例

https://blog.cloud-acct.com/posts/u-docker-basicinfo/

通常の開発環境（画像: 左）

通常、MacやWindowsで作られたRailsのWebアプリケーションは、そのMacやWindowsにインストールされているRubyのバージョンに依存します。

仮に、もしRubyをバージョンアップした場合、依存したRailsのWebアプリケーションは動かなくなります。

動かすためには、RailsのGemfile（RubyやRailsのバージョンが記載されている）を書き換えて、対応するRubyのバージョンも合わせる必要があります。

これがめんどい・・・

Dockerを使った開発環境（画像: 右）

ところが、Dockerを使うことで別のOS上（仮想環境）に新らしくRubyをインストールして、そのRubyに対応したWebアプリケーションを作ることができます。

もちろん仮想環境でRubyをインストールしているため、MacやWindows上のRubyやRailsには全く影響しません。

そして、このDocker上に作られた仮想環境をコンテナと呼びます。

Dockerが動く環境さえあれば、他のパソコン上でも同じ環境のコンテナを動かすことができます。

また、このコンテナのもととなるデータをDockerイメージと呼ばれ、Dockerfile（Dockerイメージを作成するための手順を記述したテキストファイル）などに、「コンテナがどのような構成になるのか」の情報をコードで記述します。

④RailsとDockerの環境構築

諸々の説明はここまでにして、実際に環境構築をしていきます。

流れは以下の通りです。

Dockerのインストール
Dockerに必要なファイルを準備
コンテナのビルド
Railsプロジェクトを作成
データベースの準備と作成
Hello Worldと表示してみる

それでは早速、はじめていきます。

1. Dockerのインストール

以下の公式サイトからDockerをダウンロードして起動します。

コマンドでDockerのバージョンが表示されればOKです。

% docker --version
Docker version 20.10.20, build 9fdeb9c

2. Dockerに必要なファイルを準備

まずは、今回サンプルで作るRailsのプロジェクト用に、任意の名前でディレクトリを作成します。

% mkdir rails_docker
% cd rails_docker

次に、Dockerに必要なファイルを作成します。

Dockerfile
docker-compose.yml
Gemfile
Gemfile.lock
entrypoint.sh

以下コマンドで一括生成

% touch {Dockerfile,docker-compose.yml,Gemfile,Gemfile.lock,entrypoint.sh}

ファイルを作成したら、それぞれ編集します。

Dockerfile

Dockerfile : 新規Dockerイメージを作成するための手順を記述したテキストファイル

各書き方や意味は割愛（以下参考になります）
https://qiita.com/terufumi1122/items/54b574e124de0b24df04

# Rubyバージョン指定
FROM ruby:3.0.2

# yarnパッケージ管理ツールをインストール
RUN apt-get update && apt-get install -y curl apt-transport-https wget && \
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
apt-get update && apt-get install -y yarn

RUN apt-get update -qq && apt-get install -y nodejs yarn
RUN mkdir /myapp
WORKDIR /myapp
COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install
COPY . /myapp

RUN yarn install --check-files
RUN bundle exec rails webpacker:compile

# コンテナ起動時に実行させるスクリプトを追加
COPY entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
ENTRYPOINT ["entrypoint.sh"]
EXPOSE 3000

# Railsサーバー起動
CMD ["rails", "server", "-b", "0.0.0.0"]

docker-compose.yml

docker-compose.yml : Webアプリケーション内で稼働する複数のコンテナ構成をまとめて定義したファイル

docker-compose.yml

version: '3'
services:
  db:
    image: mysql:8.0
    platform: linux/x86_64
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: root
    ports:
      - "3306:3306"
    command: --default-authentication-plugin=mysql_native_password
    volumes:
      - ./tmp/db:/var/lib/mysql
  web:
    build: .
    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
    volumes:
      - .:/myapp
    ports:
      - "3000:3000"
    depends_on:
      - db
    stdin_open: true
    tty: true

Gemfile

Gemfile : Railsアプリで利用するgem（Rubyのライブラリ）が記述されているファイル

source 'https://rubygems.org'
gem 'rails', '~> 6.1.4'

今回インストールするRailsのバージョンを指定します。

ここではRails6に対応するようにしています。（現在はRails7が最新）

このGemfileの内容は、後に実行するrails newで上書きされます。

Gemfile.lock

Gemfile.lock : 実際にインストールしたgemのリスト（バージョンなど細かく書いてある）

まだ何もインストールしていないので、空ファイルのままでOK

entrypoint.sh

entrypoint.sh : 初回起動時のみに処理したい内容を記述するファイル

entrypoint.sh

#!/bin/bash
set -e # エラーが発生するとスクリプトを終了する意味

# server.pid が存在するとサーバーが起動できない対策のために server.pid を削除するように設定
rm -f /myapp/tmp/pids/server.pid

# DockerfileのCMDで渡されたコマンド（Railsサーバー起動）を実行
exec "$@"

3. コンテナのビルド

先ほど作成した Docker関連のファイルを使ってコンテナをビルドします。

% docker-compose build
% docker-compose build --no-cache (← キャッシュを無視して再ビルドできる)

// bundle installを求められたらを実行
% bundle install --path vendor/bundle

4. Railsプロジェクトを作成

次は docker-compose コマンドを使って rails new を実行し、Railsのプロジェクトを作成しましょう。

docker-compose run に続けてサービス名を指定し、さらにコンテナ内で実行したいコマンド（=railsコマンド) を続けていきます。

Railsが動くサービスには web という名前を docker-compose.yml で付けたので、コマンドでのコンテナ名としては web を当てはめます。

以下のコマンドを実行してください。

% docker-compose run web rails new . --force --database=mysql

--force : 今のファイルを上書き
--database=mysql : DBをMySQLに

エラーなく実行が完了したら以下のようにRailsのプロジェクトが入っています。

ここで、RailsのインストールでGemfileが更新されたので、コンテナを再ビルドします。（そうしないとGemfileが反映されない）

% docker-compose build

5. データベースの準備と作成

Railsのデータベースファイルを編集します。

/config/database.yml

default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+ host: db
  username: root
+ password: password

development:
  <<: *default
  database: myapp_development

test:
  <<: *default
  database: myapp_test

production:
  <<: *default
  database: myapp_production
  username: myapp
  password: <%= ENV['MYAPP_DATABASE_PASSWORD'] %>

host: db は docker-compose.ymlで指定したMySQLのコンテナ名ですね。

同じ docker-compose.yml で指定したコンテナ間であれば、コンテナ名をホストとして名前解決してアクセスすることができます。

これでRailsがデータベースと連携できるようになりました。以下のコマンドでコンテナを起動します。

% docker-compose up
// コンテナは起動するけど、このターミナルでコンテナを起動しているので別の作業をさせてくれない

% docker-compose up -d
// コンテナをバックグラウンドで起動して、同ターミナルで作業を続行できる。

http://localhost:3000/ にアクセスして、以下のように表示されていたらOKです。

データベースがないよと怒られたので、データベースを作成します。

% docker-compose run web rails db:create
[+] Running 1/0
 ⠿ Container rails_docker-db-1  Running
Running via Spring preloader in process 21
Created database 'myapp_development'
Created database 'myapp_test'

これで無事にデータベースの作成が完了しました。

再度、http://localhost:3000/ にアクセスすると、Railsの画面が表示されていて、指定したバージョン通りにインストールされているのが分かりました。

6. Hello Worldと表示してみる

環境構築も完了したところで、まずはRailsのリクエストからレスポンスまで一連の流れを解説しておきます。

そもそもRailsはWebサーバーの中にいます。

引用 : https://programingoo.hatenablog.com/entry/2021/01/16/135724

そして、RailsにはMVC（モデル・ビュー・コントローラー）という役割分担のような構造があります。
ちなみに、ほとんどのWebアプリケーションの多くはこのMVCの形です。

引用 : https://programingoo.hatenablog.com/entry/2021/01/16/135724

URLとHTTPメソッドを受け取りControllerに渡すのがRouter
データとして扱うためのModel
Modelを表示するためのView
ModelやViewを制御するController

このようにRailsでは、MVCを考慮して開発する必要があります。

実際に「Hello World」と表示してみましょう。

「Hello World」と表示するだけでは、データを扱うことにはなりませんので、今回はModel部分が不要になります。

要は Router、Controller、Viewがあれば成り立ちます。

まずはControllerの作成です。

Railsには、それぞれ専用のコマンドがあり、ファイルを自動生成してくれます。

% docker-compose run web rails g controller hello index
[+] Running 1/0
 ⠿ Container rails_docker-db-1  Running
Running via Spring preloader in process 21
      create  app/controllers/hello_controller.rb
       route  get 'hello/index'
      invoke  erb
      create    app/views/hello
      create    app/views/hello/index.html.erb
      invoke  test_unit
      create    test/controllers/hello_controller_test.rb
      invoke  helper
      create    app/helpers/hello_helper.rb
      invoke    test_unit
      invoke  assets
      invoke    scss
      create      app/assets/stylesheets/hello.scss

このように、色々とファイルが自動生成していますが、編集するファイルはたった2つです。

View

/app/views/hello/index.html.erb

- <h1>Hello#index</h1>
+ <h1>Hello World</h1>
<p>Find me in app/views/hello/index.html.erb</p>

Router

今回はTOPページに表示させたいので、root に変更します。

/config/routes.rb

Rails.application.routes.draw do
-  get 'hello/index'
+  root to: "hello#index"
end

これで再度TOPページにアクセスすると「Hello World」と表示されます。

⑤ 掲示板アプリを簡単に作ってみる

それでは、もう少し踏み込んでみて、掲示板アプリを簡単に作ってみたいと思います。

完成形は以下の通り

完成形をみたら分かる通り、今回はデータも扱うので、MVCが全て必要になり、CRUDまで作らなければいけないので、やや時間がかかりそうですね。

CRUDとは・・・Create（生成）、Read（読み取り）、Update（更新）、Delete（削除）

なので、RailsのScaffold（基本的な操作(CRUD)を実現するために必要なファイルをまとめて生成してくれる機能）を使って、簡単に実装します。

% docker-compose run web rails generate scaffold Message name:string content:string
// rails generate scaffold モデル名 カラム名:型 ・・・

[+] Running 1/0
 ⠿ Container rails_docker-db-1  Running                                                                                                        0.0s
^CRunning via Spring preloader in process 21
      invoke  active_record
      create    db/migrate/20221031081713_create_messages.rb
      create    app/models/message.rb
      invoke    test_unit
      create      test/models/message_test.rb
      create      test/fixtures/messages.yml
      invoke  resource_route
       route    resources :messages
      invoke  scaffold_controller
      create    app/controllers/messages_controller.rb
      invoke    erb
      create      app/views/messages
      create      app/views/messages/index.html.erb
      create      app/views/messages/edit.html.erb
      create      app/views/messages/show.html.erb
      create      app/views/messages/new.html.erb
      create      app/views/messages/_form.html.erb
      invoke    resource_route
      invoke    test_unit
      create      test/controllers/messages_controller_test.rb
      create      test/system/messages_test.rb
      invoke    helper
      create      app/helpers/messages_helper.rb
      invoke      test_unit
      invoke    jbuilder
      create      app/views/messages/index.json.jbuilder
      create      app/views/messages/show.json.jbuilder
      create      app/views/messages/_message.json.jbuilder
      invoke  assets
      invoke    scss
      create      app/assets/stylesheets/messages.scss
      invoke  scss
      create    app/assets/stylesheets/scaffolds.scss

コマンド実行後に、CRUDに必要なファイルが全て自動作成されます。

ここでポイントなのは、先ほど触れた、Modelです。

コマンド実行時に、Message name:string content:string で、Messageテーブルに name content カラムが追加されました。

以下のマイグレーションファイルで確認できます。（〇〇部分は作成した日時により変わります。）

マイグレーションファイルとは、データベースの設計図で、このファイルを実行することにより記述した内容がデータベースに反映されます。（この時点ではデータベースに反映されていない）

/db/migrate/〇〇_create_messages.rb

class CreateMessages < ActiveRecord::Migration[6.1]
  def change
    create_table :messages do |t|
      t.string :name
      t.string :content

      t.timestamps
    end
  end
end

確認できたら、以下のコマンドでデータベースに反映します。

% docker-compose run web rails db:migrate

[+] Running 1/0
 ⠿ Container rails_docker-db-1  Running
Running via Spring preloader in process 21
== CreateMessages: migrating ===================================
-- create_table(:messages)
   -> 0.2003s
== CreateMessages: migrated (0.2005s) ==========================

これで初めて、テーブルが作成されます。

http://localhost:3000/messages/ にアクセスしてブラウザでも確認してみましょう。

きちんと、CRUD機能が実装されていますね。

データ入れて完成です！

まぁ、こんな感じで、シンプルかつ簡単に作成できます。

結構割愛したところも多かったですが、とにかく簡単にWebアプリケーションが作れることを伝えたかったわけです。

ということで、ぜひ今後、Railsに触ってみてください！

参考サイト

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up