質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.23%

JavaScriptの記述量を減らし、ソースコードの保守性を向上させたい。

解決済

回答 3

投稿

  • 評価
  • クリップ 0
  • VIEW 1,715

tarotarosu

score 109

前提・実現したいこと

JavaScriptの記述量が多くて非常に困っています。
原因の一つとして考えられるのは、xmlファイルの操作です。
例えば、

該当のソースコード

$.ajax({
  url: "xml/test.xml",
  type: "GET",
  dataType: "xml",
  timeout: 1000,
  error: function(){
    alert("ロード失敗");
  },
  success: function(xml){
    //以下の処理は様々
    $(xml).find('shape[type="' + shape + '"] > item > category > id').each(function(){
      if ($(this).text() == category) {
        $(this).parent("category").parent("item").each(function(){
          $("#tabBox1 ul").append('<li><img src="' + $(this).find('sample').text() + '"></li>');
        });
      }
    });
  }
});

上記のような処理がソースコードのいたるところに存在します。
あるボタンをクリックしたらxmlファイルから必要なデータを取得してくる、という処理が非常に多いためです(具体的記述すると長くなりますが、画像の操作です)。
操作するxmlファイルも押したボタンにより異なりますし、$.ajax()内のsuccess内の記述も様々です(もちろん共通のものもありますが)。

このような理由からソースコードがかなりカオスになってきていて、自分でもこれは汚い!と思うレベルです。
上記コードを丸々関数化したところで、success以降の処理が様々なので対して意味がないし、逆に読みづらくなりそうです。
何かいい方法はないかと模索中です。
似たような処理や経験をしたことがある方、何かアドバイスを頂けると以上に助かります_(._.)_

補足情報

全く見当違いなことを言っているかもしれませんが、AngularJSのようなフレームワークを使用したら、記述量は減るのでしょうか?
今からそれらのフレームワークを導入すること自体難しいのかもしれませんが…

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • kei344

    2016/06/22 11:45

    コードはなるべく省略されないほうが回答もしやすいと思います。

    キャンセル

  • coco_bauer

    2016/06/22 12:27

    処理が様々な部分は、それぞれに記述する以外にないと思います。とりあえず共通化できそうなところは関数を使って統一した記述にするところから始めては如何でしょうか。そうすると次に解決すべきコード部分が見つけやすくなります。

    キャンセル

回答 3

+2

以下の点を検討してみてはどうでしょうか?

  • ajax部分をPromiseやasync/awaitを使ってまとめる(コールバック地獄の解消)
  • jQueryを使ったDOMの追加や変更が頻繁に発生するのであれば、React.jsやVue.js、Riot.js等を用いて仮想DOMを利用する
  • 他の回答にもあるように、AltJSを導入する(おすすめはTypeScriptかBabel(ES6,7)です)

特に、AngularのようなフルスタックJSフレームワークに比べて、React.jsのようなViewを作るためのライブラリは後から導入することも容易ですので是非試してみてください。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

checkベストアンサー

+1

R7038XXさんが仰るように、AltJSにするのがベターですね。
Node.js+Common.jsで他の言語のようにファイル分割しつつ管理して、
ブラウザで開いた時にWebpackやGulp+Browserifyで1ファイルに固めるのが大規模になってくると必要かと思います。


上記コードを丸々関数化したところで、success以降の処理が様々なので対して意味がないし、逆に読みづらくなりそうです。

これピンポイントなら部分適用である程度解決しそうですね。

my_ajax = function(url, fn){
  $.ajax({
    url: url,
    type: "GET",
    dataType: "xml",
    timeout: 1000,
    error: function(){
      alert("ロード失敗");
    },
    success: fn
  });
};

hoge = my_ajax("xml/test.xml", function(xml){
  //以下の処理は様々
  $(xml).find('shape[type="' + shape + '"] > item > category > id').each(function(){
    if ($(this).text() == category) {
      $(this).parent("category").parent("item").each(function(){
        $("#tabBox1 ul").append('<li><img src="' + $(this).find('sample').text() + '"></li>');
      });
    }
  });
});

これ以上多くなるようなら引数をオプション一つにしてしまって、こんな風にするとコード量を減らせるでしょう。

// urlとsuccessは必須項目
my_ajax = function(options){
  $.ajax({
    url: options.url,
    type: options.type || "GET",
    dataType: options.dataType || "xml",
    timeout: options.timeout || 1000,
    error: options.error || function(){
      alert("ロード失敗");
    },
    success: options.success
  });
};

更にそこから派生する関数を作っても面白いですね。
やり過ぎるとカオスになるので、上手く調整してください。

customized_my_ajax = function(options){
  options.error = function(){
    $(".error").append("<span>ロード失敗しました。</span>");
  }
  my_ajax(options);
}

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/06/30 12:53

    皆さんの仰られているように、AltJSの使用を試みてみたいと思います。
    中でもまずはRuby似ていると書かれていたCoffieScriptを試してみたいと思います。
    また、ご回答のコードを参考にさせて頂くと、全体的に少しスッキリしそうです。
    ありがとうございました_(._.)_

    キャンセル

+1

typescriptやcoffeescriptなどのaltJSをご検討されては如何でしょうか?
Codeの保守性は格段に上がると思いますよ

■参考サイト
typescript
coffeescript

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.23%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる