WeBlog

Webに関する情報を中心に発信してるブログ

アセットパイプラインの仕組みついて

アセットパイプラインとは?

アセットとは、「JavaScript」「CSS」「画像」などのリソースのことをアセットと言います。

このアセットを効率的に扱うための仕組みのことを「アセットパイプライン」と言います。

アセットパイプラインは「Sprockets」というgemによって提供されています。

「Sprockets」というgemはRailsをインストールした時点で、自動でインストールされます。

「Gemfile.lock」には「Sprockets」が記載されています。

アセットパイプラインの仕組み

アセットパイプラインは大きく4つの機能を提供しています。

1、高級言語コンパイル

2、アセットの連結

3、アセットの圧縮

4、ダイジェストの付与

高級言語コンパイル

f:id:weblog_tec:20210503100503p:plain

上記の画像を見てください。

app/assets/stylesheets配下にCSSのファイルがいくつかあります。

しかし、よく見ると拡張子が.scssとなっています。

これはSASSというCSSプリプロセッサーというCSSをもっと楽に記載して、レスポンシブ対応がしやすい書き方ができるものです。

# sample.scss

// ==============================
// 変数
// ==============================
$font-color_sub1: #b6a489;

$site-width: 980px;

$font-size_s: 12px;

// ==============================
// mixin
// ==============================
// @mixinは関数のようなものを作れる
@mixin mq($breakpoint: sm) {
  @media #{map-get($breakpoints, $breakpoint)} {
    @content;
  }
}

// ==================================
// footer
// ==================================
.footer {
  background: #555;
  color: #fff;
  display: flex;
  align-items: center;
  justify-content: center;
  height: 80px;
  @include mq() {
    font-size: $font-size_s;
  }
}

上記のような感じで「CSSで変数」が使えたり、「mixinという関数」みたいなものが使えたり、

CSSを階層構造のように書けるのがSCSSというものです。

で、このSCSSファイルはそのままではブラウザで読み込むことができません。

ブラウザはCSS(拡張子が.css)ファイルは読み込めますが、SCSSファイルは読み込めません。

英語しか理解できない人に、日本語で話しても伝わらないのと同じです。

# sample.css

.footer {
  background: #555;
  color: #fff;
  display: flex;
  align-items: center;
  justify-content: center;
  height: 80px; }
  @media screen and (max-width: 414px) {
    .footer {
      font-size: 12px; } }

ではどうしないといけないかですが、SCSSで書いたファイルをCSSファイルに変える必要があります。

要は「英語」を「日本語」に翻訳すると言うことです。

上記のコードはCSSに変換されたコードです。

この作業をコンパイル(変換)と言います。

なので高級言語コンパイル高級言語は「SCSS」ファイルなどを指します。

それをコンパイル(変換する)ということです。

JavaScriptも同じです。

CoffeeScriptというJSの「AltJS」というものがあります。

AltJSというのは「代わりになるJS」という意味です。

https://w.atwiki.jp/sevenlives/pages/2557.html

AltJSには「TypeScript」なども含まれます。

当然CoffeeScriptで書いた場合は拡張子が.cofeeになります。

しかしブラウザは拡張子が.cofeeのファイルは読み込めません。

なので、JavaScriptファイル(拡張子が.jsのファイル)に変換しないといけません。

これも高級言語コンパイルです。

アセットの連結

f:id:weblog_tec:20210503101012j:plain

アセットの連結を理解するにはブラウザとサーバーの通信を知る必要があります。

上記の画像を見てください。

サーバー側にHTMLファイルがあります。

1、ブラウザはサーバーに「HTMLファイルください」とリクエストを投げます。

2、サーバーはリクエストに対してブラウザが要求しているHTMLファイルを返します。

3、ブラウザはサーバーから受け取ったHTMLを上から1行1行読み込みます。

4、すると<link rel="stylesheet" href="">みたいなコードがあります。これはCSSファイルを読み込むコードですが、ブラウザはCSSのファイルを持っていません。

5、ブラウザはCSSのファイルを持っていないので、サーバーにCSSファイルくださいと「リクエスト」を投げます。

という流れで通信をします。

で、今回は<link rel="stylesheet" href="">というコードが3つあるので、3回サーバーにCSSファイルくださいと「リクエスト」を投げます。

JSファイルも同じです。

<script src="">というコードが3つありますが、ブラウザはJSのファイルを持っていないので、サーバーにリクエストを投げてファイルをもらいます。

なので3回サーバーと通信します。

CSSファイルで3回、JSファイルで3回もサーバーと通信していたら、負荷がかかります。

じゃあCSSを1個に、JSを1個にまとめてしまえー。という話が「アセットの連結」です。

連結するには1番大元のファイルが必要です。

この1番大元のファイルを「マニフェスト」と言います。

app/assets/stylesheets/application.scss
app/assets/javascripts/application.js

それがRailsで言うと上記2つです。(変えることもできる)

# app/assets/stylesheets/application.scss

@import 'top';
@import 'bootstrap';
@import 'font-awesome-sprockets';
@import 'font-awesome';

CSSをこのファイル1つにまとめています。

# app/assets/javascripts/application.js

//= require jquery3
//= require popper
//= require bootstrap-sprockets
//= require rails-ujs
//= require activestorage
//= require_tree .

JSの1つのファイルにまとめています。

JSファイルでは//= require//= require_treeを使います。

・//= require

→ 指定したJSファイルの内容を、記述した位置に取り込みます。(拡張子は不要)

・//= require_tree .

→ 指定したフォルダ配下にある全JSファイルを結合して、記述した位置に取り込みます。

//= require_tree .なので、app/assets/javascripts配下にあるJSファイルを全て取り込みます。なので、app/assets/javascripts配下にあるJSファイルを全て取り込みたくない場合は、ここの記述を//= require_tree .の記述を//= requireで個別に記載してJSファイルを読み込むようにしてあげます。

jquery3とかrails-ujsとかapp/assets/javascripts/application.jsファイルの位置から見当たらないよ?と思うかもしれません。

これはアセットの探索パスに基づいて「Sprokest」が勝手に読み込んでくれます。

アセットの探索パス

アセットの探索パスに基づいて「Sprokest」が勝手に読み込んでくれます。とありますが、どう言う意味でしょうか?

Railではアセットの探索パスはデフォルトで

・app/assts/* (最優先)

・lib/assets/*

・vender/assets/*

が探索パスに設定されています。

この配下にJSファイルやCSSファイルを置くと、勝手に取り込んでくれます。

デフォルトのアセットの探索パスに追加をしたい

Railではアセットの探索パスはデフォルトで

・app/assts/* (最優先)

・lib/assets/*

・vender/assets/*

が探索パスに設定されています。と書きました。

じゃあデフォルトの探索パス以外を探索パスとして設定したい場合はどうするのでしょうか?

例えばyarnと言うフロントエンドのパッケージ管理ツールでAdminLTEと言うライブラリをインストールしてみます。

yarn add admin-lte@^3.0

そうするとnode_modulesというフォルダができて、そのフォルダは以下にAdminLTEを使うために必要はHTMLやCSSやJSファイルが追加されます。

しかし、node_modulesというフォルダはアセットの探索パスに含まれていません。

その場合はconfig/initializars/assets.rbに設定を書きます。

# config/initializars/assets.rb

Rails.application.config.assets.paths << Rails.root.join('node_modules') # マニフェストからの検索パスに追加(デフォルトで記載されている) 

上記のように書くとnode_modules配下もアセットの探索パスに含めることができます。

連結の大元のファイル(マニフェストファイル)を変更したい

app/assets/stylesheets/application.scss
app/assets/javascripts/application.js

今までapplication.scssapplication.jsが連結の大元になるマニフェストファイルと説明しました。

では、この2つ以外を大元のマニフェストファイルにしたい場合はどうするのでしょうか?

例えば

・app/assets/stylesheets/admin.scss

・app/assets/javascripts/admin.js

上記2つのファイルを大元のマニフェストファイルに設定したいとしましょう。

その場合はconfig/initializars/assets.rbに下記のコードを追加します。

# config/initializars/assets.rb

Rails.application.config.assets.precompile += %w[admin.js admin.css] # プリコンパイルの設定

一般ユーザー画面では

・app/assets/stylesheets/application.scss ・app/assets/javascripts/application.js

の2つを使う。

管理者画面では

・app/assets/stylesheets/admin.scss

・app/assets/javascripts/admin.js

を使うと言うように分けることができます。

アセットの圧縮

次はアセットの圧縮です。

# sample.css

.footer {
  background: #555;
  color: #fff;
  display: flex;
  align-items: center;
  justify-content: center;
  height: 80px; }
  @media screen and (max-width: 414px) {
    .footer {
      font-size: 12px; } }

先ほどコンパイルしたCSSファイルで上記のようなコードがありました。

これをよくみてみると、「改行」「空白」が含まれています。

開発している人間にとってはわかりやすいですね。

でもコンピューターからしたら邪魔です。

無駄な改行や空白があると、読み込みが遅くなります。

ではどうするかというと「圧縮」します。

# sample.css

.footer{background:#555;color:#fff;display:flex;align-items:center;justify-content:center;height:80px;}@media screen and(max-width:414px){.footer{font-size: 12px;}}

上記のように「改行」「空白」を無くします。

これが「アセットの圧縮」と言うものです。

JSファイルも同じようの圧縮します。

ダイジェストの付与

ブラウザには「キャッシュ」と言う仕組みがあります。

これは、CSSやJSファイルをサーバー側にいちいち取りにいかなくて済みように何度か通信してサーバーからもらったCSSファイルなどをブラウザがわで持っておいて、再利用すると言う仕組みです。

この仕組みはすごくいいんですが、弊害があります。

それは、CSSファイルの中身を変更したのに、ブラウザはキャッシュに保存しているCSSファイルを見に行くことによって、CSSの変更が画面に反映されないと言う問題です。

そのためにRailsにある「ダイジェスト」というのがとても役に立ちます。

Railsのアプリケーションを画面に表示して、ブラウザの開発者ツールを開いてみてください。

<link rel="stylesheet" media="all" href="/assets/application.self-705864dc129725964dfcbfb5b9a484f633aad8e3a8ebf81baa5d0046edbabbac.css?body=1">

そうすると上記のように705864dc129725964dfcbfb5b9a484f633aad8e3a8eみたいな訳わからない文字や数字がひっついていると思います。

これがダイジェストです。

もしコードが変更されたら、このダイジェストも変わるので、ブラウザのキャッシュの影響で修正が反映されない問題を解決することができます。

ちなみにconfig/initializars/assets.rbに下記のようなコードがあります。

# config/initializars/assets.rb
Rails.application.config.assets.version = '1.0'

この1行がダイジェストの生成に関わっているので、変更することでアセットを期限切れにすることができます。

ブラウザでアセットを読み込む

「アセットパイプライン」と言う仕組みでアセットが色々と裏側でごにゃごにゃとしていることはわかりました。

では、app/assets/stylesheets/application.scssapp/assets/javascripts/application.jsを読み込むにはどう書けばいいのでしょうか?

<%= stylesheet_link_tag    'application', media: 'all' %>
<%= javascript_include_tag 'application' %>

そのためには上記のコードを書いてあげればいいです。

JSやCSSマニフェストファイルはapplication.scssapplication.jsなので、そのファイルを読み込むように記載しています。(拡張子は必要ない)

ここで読み込むのはアセットパイプラインによって連結されたファイルです。

ちなみに「連結の大元のファイル(マニフェストファイル)を変更したい」で記載しましたが、

マニフェストファイルに

・app/assets/stylesheets/admin.scss

・app/assets/javascripts/admin.js

を追加した場合は

<%= stylesheet_link_tag    'admin', media: 'all' %>
<%= javascript_include_tag 'admin' %>

上記のようにadminに変えてあげると、admin.scssadmin.jsを読み込んでくれます。

「連結の大元のファイル(マニフェストファイル)を変更したい」で記載した設定をしないで、

<%= stylesheet_link_tag    'admin', media: 'all' %>
<%= javascript_include_tag 'admin' %>

上記のコードを記載した場合はエラーになります。

エラー内容は下記になります。

Asset was not declared to be precompiled in production. Add Rails.application.config.assets.precompile += %w( admin.css ) to config/initializers/assets.rb and restart your server

内容としては「アセットがプロダクションでプリコンパイルされるように宣言されていませんでした。」と言う内容です。

なので、config/initializers/assets.rbRails.application.config.assets.precompile += %w( admin.css )と設定を追加しろ。言われます。

なので設定を追加していきましょう。

その前にnode_modulesフォルダまでのパスがアセットパイプラインのpathとして通っているか確認します。

% rails c
irb > Rails.application.config.assets.paths

こちらを打つとnode_modulesへのpathが出てくるはずです。

次にプリコンパイルの設定をします。application以外のマニフェストファイルを個別に読み込みたい場合はプリコンパイルの設定をしないとエラーが起きてしまいます。

他のマニフェストや、個別のスタイルシート/JavaScriptファイルをインクルードしたい場合は、config/initializers/assets.rbのprecompileという配列を使用します。(Railsガイド)

# config/initializars/assets.rb

# Add additional assets to the asset load path.
# Rails.application.config.assets.paths << Emoji.images_path
# Add Yarn node_modules folder to the asset load path.
Rails.application.config.assets.paths << Rails.root.join('node_modules') # マニフェストからの検索パスに追加(デフォルトで記載されている) 

# Precompile additional assets.
# application.js, application.css, and all non-JS/CSS in the app/assets
# folder are already added.
Rails.application.config.assets.precompile += %w[ admin.js admin.css ] # プリコンパイルの設定

config配下のファイルは設定ファイルなので、サーバーが起動したタイミングで1度だけ読み込まれます。

なので、何か変更を加えたらサーバーを再起動しないと反映されないので注意が必要です。

# app/views/admin/user_sessions/new.html.erb
# app/views/admin/dashboards/index.html.erb

<%= stylesheet_link_tag    'admin', media: 'all' %>  # admin.scssファイル(マニフェストファイル)を読み込む

<%= javascript_include_tag 'admin' %> # admin.jsファイル(マニフェストファイル)を読み込む

ビューファイルに作成したマニフェストファイルを読み込むようにしたいのでCSSとJSファイルを読み込む記述を記載します。

これで画面を表示すると見た目が整った画面になっていると思います。

https://railsguides.jp/asset_pipeline.html#パスの検索

https://railsguides.jp/asset_pipeline.html#アセットをプリコンパイルする

https://diveintocode.jp/blogs/Technology/AssetPipeline