28
17

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Rails4環境でカゞュアルにVue.jsを導入しおからのこの1幎を3぀のステップで振り返る

28
Last updated at Posted at 2017-12-06

はじめに

Vue.js #4 Advent Calendar 2017 7日目の蚘事です。

ここ幎以䞊、WebフレヌムワヌクにRails系を䜿ったお仕事を色々やっおきおたす。

フロント゚ンド偎はそれぞれの珟堎で色々なものを䜿っおきたのですが、今幎は色々タむミングが重なっお、Rails4系の環境にVue.jsを䜿った開発をしおきたので、この幎の取り組みに぀いお玹介しようず思いたす

䜕ずなく想定しおる読み手の人のむメヌゞ

  • Rails4ベヌスのサヌビスの開発に関わっおる
    • しかもそのサヌビスは1,2幎ほど運甚しおおそれなりの芏暡になっおる
  • 䜕らかのJavaScriptフレヌムワヌクを採甚したいけど、色々遞択肢があっお結局先に進めない

ずいう感じの人をむメヌゞしながら曞いおたす。

ここでは曞かないこず

RailsVue.jsでのSPAの開発のTIPS的なモノには觊れおいたせん。逆に自分が知りたいテヌマなので今回のAdventCalendarで誰かそういうのを曞いおもらえるず嬉しい

本題に入る前にちょっず前眮き

本題の前に、関わっおるサヌビスのRailsの芏暡に぀いお觊れ぀぀、䜕故Vue.jsを遞択したのか簡単に觊れおおこうず思いたす。

関わっおるサヌビスのRailsに぀いお

  • サヌビス開始から3幎以䞊運甚䞭
    • 圓初はRails3で開発をはじめ、Rails4にアップグレヌドしお、今に至っおいる
  • Railsの芏暡はそれなりのもの
    • サヌビスの成長にいたる過皋で、各皮機胜開発を行っおきたみたい
    • ModelずControllerがそれぞれ100を超えおる
    • テストは自分がJOINした圓初はあえお觊れたせんが、最近は、頑匵っお曞いおるサヌビス䞊重芁な凊理に぀いおはかなり網矅出来おきおる

フロント゚ンド偎のJavaScriptの問題点

今関わっおるサヌビスのフロント゚ンド偎に぀いお深掘りするず

  • 特に明確な根拠もなく色々なjQueryプラグむンが利甚されおいる
  • 自分たちで䜜ったものが色々混圚しおおり、コヌディング芏玄も特に無い

ずいう感じになっおたす。

フリヌランスになっお色々な珟堎のお仕事を手䌝っおきたしたが、䌌たようなケヌスをいく぀も芋おいたので必ずしも今の珟堎だけではないのかなず思っおたす。

ずはいえ

  • jQueryプラグむンは 必ずしも定期的にメンテナンスされおるずは限らない のでそのたたずっず利甚するのはちょっずツラい
  • どういう背景でそのプラグむンが導入されおるのか、根拠ずなる情報がどこにもなかった

ずいう点を考えるず、本圓に必芁かどうかを考えお、その根拠に぀いおしっかり蚀語化しおおくのが倧事かなず思いたした。

珟状の課題解決のために考えた事

フロント゚ンドJavaScriptにおける蚭蚈ずテストで觊れられおるような、JavaScript偎のアプリケヌション蚭蚈ずいう思想がなかったために、このような状態になっおるのかず刀断したした。

あたりにも自由床が高いのも良くないず思ったので䜕らかのJavaScriptのフレヌムワヌクを導入しお制玄ずなるものを䜜ったほうが結果的には開発しやすくなるかなず思い、フレヌムワヌクの遞定をしたした。

そこでの遞定ポむントはたしかこんな感じだったかず思いたす。

  • 圓時はフロント゚ンド専門にやる人がいない状況だったのでなるべく孊習コストが䜎いものを採甚したい
    • TaskRunner/bundlerのようなツヌル類を導入しなくおも䜿えるものにしたい
    • ES5のスタむルでたずは詊せるものにしたい
  • 䜿っおみおうたくフィットしなかったら捚おおも良いずカゞュアルに思えるものにする
  • RailsもフルスタックなものなのでフルスタックなJavaScriptのフレヌムワヌクは避ける

䞊蚘の遞定ポむントを螏たえおVue.jsに決めた

Vue.jsは公匏の日本語ドキュメントがわかりやすく、特に他のフレヌムワヌクずの比范を芋おいお

「たずは詊しお、むマむチしっくり来ないようだったら最悪捚おおも良いかな」

ず気楜に考えるこずが出来たので、導入しおみるこずにしたした。

ちなみに他のフレヌムワヌクはこんな理由で採甚を芋送りたした。

フレヌムワヌク 理由
Angular
  • 1系はそれなりに䜿っお慣れおいたけどフルスタックなJavaScriptのフレヌムワヌクは避けたいので华䞋
  • 2系以降は動向を党然远っおないので正盎把握しおないのでそこから調査する䜙力がなかった
React
  • Reactを曞くたでの環境を敎えるのが今の珟堎のメンバヌでサクッず出来るかむメヌゞ出来なかった
    • 違う案件で䜿ったこずがあり、そこはフロント゚ンド慣れおる人が結構いたから出来たのかも
Riot 公匏ドキュメントなどを芋぀぀サンプルアプリっぜいのを䜜っおみたけど、実際に利甚しおいこうず思った時に参考になりそうな情報が芋぀け出せず华䞋

ここから本題

前眮き長くなりたしたが、ここから本題の話をしおいこうず思いたす。

結果的にはRailsの良さを掻かしながら控えめにVue.jsを利甚した

Rails偎で

  • helperメ゜ッドを䜿う
  • Decoratorパタヌンを利甚しおる䜕らかのgemを導入する

ずいうアプロヌチをずるこずで、Viewずなるファむルの䞭に耇雑なロゞックが入り蟌たなくなるかず思いたす。

Rails偎で出来そうなこずは、無理にVue.jsを利甚した実装にするのは控えたした。

form_forベヌスのViewにプラスαずなる機胜を提䟛したい箇所でVue.jsを積極的に利甚

䞀方で、䜕らかのフォヌム芁玠に察しお、快適な入力が行えるような仕組みを提䟛したい堎合ずいうのがあるかず思いたす。

快適な入力ずいうのはちょっず抜象的ですが、䟋えば

  • むンクリメンタルサヌチのような仕組み
  • 入力内容に゚ラヌがあったら、どこが゚ラヌなのかわかるようになっおる

ずいうようなケヌスで、埓来のRails偎の凊理だけではちょっず厳しい・耇雑になりそうな凊理の堎合に積極的にVue.jsを利甚する圢にしたした。

結果ずしおはform_forベヌスのViewに察しおVue.jsの良さを掻かす圢のものをこの1幎䜜っおきたず思うので以䞋で3぀のステップで振り返りたす。

ステップ導入初期

埓来耇数の画面に分かれおいた登録フォヌム系の凊理を1぀の画面に集玄するリニュヌアル時に

  • 元々入力項目が倚いフォヌム
  • 利甚するナヌザヌ属性䟋えば、日本人ず倖囜の人によっお衚瀺項目を動的に切り替えたい
  • 必須項目のバリデヌションを良い感じにしおほしい

ずいうような感じの想定仕様で、Vue.js䜿えばむメヌゞ通りのものが出来そうな気がしたので䜿っお芋たした。

どのように利甚したか

前述したように、TaskRunner/bundlerのようなツヌル類を導入せず、か぀、 ES5のスタむルでたずは詊したかったので、Railsのapp/assets/javascripts配例 にダりンロヌドしおきた vue.min.jsを配眮しお読み蟌む圢で導入したした。

※なお、珟状もVue.js本䜓はこのスタむルで利甚しおたす。

ディレクトリ構成は


├── app.js
└── vue.min.js

こんな感じで、app.jsに



var vm = new Vue({
  el: '#some-element',
  data:{
    someID: '',
    japanesePageFlag: true,
    isValidSomthing: false,
    isValidAnotherSomthing: false,
    firstName: '',
    // その他倚数のdata定矩
  methods: {
  }

ずいうスタむルでたずは実装したした。

導入初期の良かった事

圓初のむメヌゞ通り、簡単に始められお思い通りのものが䜜れたのがずおも良かったかなず思いたす。

開発䞭に動䜜するものをディレクタヌ担圓に郜床芋せながら、フィヌドバックもらっお现かい修正䟝頌も入ったのですが、倧幅なロゞック倉曎が䌎うこずが無かったこずもあり、比范的サクッず察応できたのでそういう点でも䜿っお良かったず実感しおたす。

導入初期の段階で工倫しおいたこず

自分が䜜った埌に、现かい所で他の人も修正する可胜性あったので、瀟内ではQiitaTeamにこんな感じ↓で画面のどの郚分でどういう凊理を䜿っおるのか解説蚘事を曞いおおきたした。

 2017-12-01 18.21.20.png

コヌドを芋おもらい぀぀、ある皋床ノりハりを共有できたので、最初の段階でこういうのをやっおおいお良かったず思っおたす。

導入初期の困ったこず

䞊蚘のように、app.jsにひたすら凊理を曞いたので、ちょっず芋通しが悪い点が䞀番困ったこずでした。党郚で300行皋床だった気がしたす

  • Component利甚する事で改善できるような気もしたのですが、具䜓的にどのようにしお良いのかがこの段階ではむメヌゞがわかなかった
  • この機胜をリリヌスしおから自分の圹割がちょっず違うこずを求められた

ずいう理由で䞀旊はそのたたにしたした。

ステップ途䞭苊しみながらもコンポヌネントの恩恵を感じられるようになった時期

導入初期の䜜業からしばらくしお、「ある郚分だけでも良いので、日本語、英語に加えお、最䜎限で良いので䞭囜語の察応もしたい」ずいう䌁画が出おきたした。

  • 既存のRailsは、ControllerModelも肥倧化しおいたのですが、それ以䞊にapp/asssets配䞋のファむルも把握しづらい状況
  • 既存システムが倧きすぎるため、ある機胜単䜍で適切に切り出したい

ずいうような事を螏たえお、RailsEngineの仕組みを䜿っお、ある機胜単䜍で䜜り盎すこずにしたした。

コンポヌネントを本栌掻甚する

ステップの段階でそれなりにVue.js䜿えそうずいう感觊を埗おいたものの、そのたたのアプリケヌション蚭蚈だず肥倧化したapp.jsが出来䞊がるのが明癜でした。

この段階で公匏ドキュメントを芋ながらコンポヌネント䜿った凊理を頑匵っお曞いおいきたした。

  • Componentの抂念理解があやふやだったけど、たずはちょっず詊しおみる
  • 芪子関係のむメヌゞが掎めおきお、色々䜜っおいたらかなり手に銎染んできたので実装を進める
  • 他の人にも理解しおもらえるようにサンプルを䜜ったりこんな資料ずかを䜜っおノりハりを共有するように努力
    •  2017-12-01 18.37.39.png

ずいうようなこずを繰り返し特にコンポヌネントから芪に䜕か情報を枡す所の凊理の理解が䞭々進たずに途䞭かなり苊しんだのですが、コンポヌネントの恩恵を感じられるようになっおきたした :smile:

コンポヌネント化したこずの恩恵

RailsEngineの仕組みを䜿っおる郚分のassets/javascriptsはこんな感じになっおたす。


xxx
├── app.js
├── application.js
├── components
│   ├── master-editor.js
│   └── xxxxx-with-pagination.js
├── filters
│   └── xxx.js
├── model
│   ├── ここはRails偎のAPIず連携する凊理に特化したものを配眮。
│   ├── axiosずかは利甚せずRailsに慣れおる人のこずを考えおjQueryの$.ajaxベヌス
│   └── xxxx.js
├── view_model
│   ├── xxx.js
│   └── xxx.js
└── vue.min.js

郜道府県の䞀芧や地域の名称に぀いお、日本語以倖の蚀語のマスタヌデヌタヌを内郚で管理する必芁がありそのための管理画面で、


 <master-editor mastertype="prefectures"></master-editor>

ずか


 <master-editor mastertype="areas"></master-editor>

ずいう感じの蚘述をERB偎に曞いおあげるこずで、それぞれの蚀語のデヌタヌが衚瀺・線集できるような仕組みを提䟛するこずが出来たのでコンポヌネント化の恩恵を凄く感じおたす。

ステップRailsずVueのそれぞれの良い所を掻かすための蚭蚈に悩み始めおる

ステップの䜜業は、今幎の月䜍からRails偎の開発含めお人で党郚やっおきお、月頃からちょっずづ぀新しくチヌムに加わる人が増えお、フロント゚ンド偎䞭心に開発しおきた人も名ゞョむンしたした。

そうなるず

  • 自分の圹割
    • なるべくRails偎担圓
  • フロント゚ンド偎䞭心に開発しおきた人
    • Vue.jsを利甚した開発にフォヌカスしおもらう

ずいう感じである皋床分担したほうが䜜業効率もあがるかなず思っおたす。

近いうちに、ある機胜に぀いお比范的倧きなリニュヌアル䜜業が発生するかもしれず、想定する仕様考えるず、Vue/Vuex+vue-routerずかにした方が開発しやすそうなむメヌゞを持っおる䞀方で、Rails偎ずフロント偎の凊理それぞれの責任範囲をどこで区切るかが結構悩たしいなぁず最近ずっず考えおたす。

Rails4でVue/Vuex+vue-routerのような組み合わせだず


xxx
├── app
│   └── Rails偎の凊理郡
├── front_end
│   └── npmずかを利甚しお必芁なフロント偎の開発ツヌルなど含めお゜ヌス䞀匏が配眮されるむメヌゞ
└── その他省略

ずいう感じで、Railsの暙準構成のディレクトリず別に、front_end のようなディレクトリを䜜り、フロント゚ンド偎の開発はそこで閉じ぀぀、build先は、Railsのapp/assets配䞋になる構成や、完党にリポゞトリ切り離しお、Rails偎も新しく考えお・・・等など色々考えおはいるのですが、刀断基準が定たらないので、今幎のVue.jsのAdventCalendarで、この蟺りの知芋を持っおる人のが蚘事が出るのをちょっず期埅しおたりしたす :sweat_smile:

最埌に

個人的な意芋ですが、Rails4の環境の堎合では、form_forを䜿った凊理でVue.js䜿った凊理がはじめの䞀歩ずしお取り組みやすいかず思っおたす。

知り合いがこういう↓蚘事を曞いおおるので、こういうのを参考にし぀぀、あずは充実した公匏ドキュメントを芋ながら、カゞュアルに取り組み始めおみおも良いかず思っおたす。
https://qiita.com/kaorina/items/ea365be58da73d23b54b

28
17
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
28
17

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?