リファクタリング＝読みやすいプログラムを書こう！

コードの臭い（Code smell）とは、コンピュータプログラミングにおいてプログラムのソースコードに深刻な問題が存在することを示す何らかの兆候のことを言う。

リファクタリングを実施するプログラマの視点からは、コードの臭いはいつリファクタリングするか、どのリファクタリング手法を用いるか、発見するための方法である。

一般的なコードの臭い

重複したコード
同一あるいは同様のコードが複数箇所に存在。

長すぎるメソッド
メソッド、関数、手続きが長くなりすぎている。

巨大なクラス
大きくなりすぎたクラス。神オブジェクト参照。

機能の横恋慕
他クラスのメソッドを過度に用いるクラス。

不適切な関係
他のクラスの実装の詳細に依存しているクラス。

相続拒否
基底クラスの規約が尊重されない形でのメソッドオーバーライド。リスコフの置換原則参照。

怠け者クラス
行うことが少なすぎるクラス。

重複メソッド
同一あるいは同様のメソッドが複数箇所に存在。

不自然な複雑さ
簡潔な設計で十分なところに、過剰に複雑なデザインパターンの使用を強制する。

先人の工夫によって、リファクタリングのノウハウがまとめられています。

d.hatena.ne.jp

リファクタリングの事例

上記のお話では、リファクタリングの見本として、重複の解消などを紹介していました。

コードが無駄に冗長になっていないか？

本来なら関数やループでまとめられるところを、繰り返し同じコードを書いてはいませんか？先の処理では、出力にゼロを追加するコードは単独の関数にまとめられます。これで重複が減り、コードも読みやすくなります。

●Before

const seconds = ('0' + Math.floor((remainingTime/1000) % 60)).slice(-2);
const minutes = ('0' + Math.floor((remainingTime/(60*1000)) % 60)).slice(-2);
const hours = ('0' + Math.floor((remainingTime/(60*60*1000)) % 24)).slice(-2);
const days = ('0' + Math.floor(remainingTime/(24*60*60*1000))).slice(-2);

「ゼロ詰め」（ゼロ埋め、ゼロを付ける処理）が、個別に何回も出てきます。

↓↓↓

●After

function pad(value){
  return ('0' + Math.floor(value)).slice(-2);
}

const seconds = pad((remainingTime/1000) % 60);

「ゼロ詰め」の関数pad()を用意すれば、同じようなコードの繰り返しを減らせます。

個人的には、

なんか面倒くさいな～

と感じたら、リファクタリングが必要なサインだと思います。（笑）

コードゴルフ

「コードゴルフ」という、リファクタリングのような遊びがあります。

コードゴルフ - Wikipedia

コードゴルフはコンピュータプログラミング・コンテストの一種である。

参加者は与えられたアルゴリズムを、可能な限りもっとも短いソースコードで記述することを競う。

ショートコーディング、コードパズル等とも呼ばれる。

プログラマのためのコードパズル ~JavaScriptで挑むコードゴルフとアルゴリズム

作者: 柳井政和
出版社/メーカー: 技術評論社
発売日: 2014/02/04
メディア: 単行本（ソフトカバー）
この商品を含むブログを見る

コードゴルフは、ゴルフがカップインまでの打数を競うように、プログラムのソースコードの文字数を削って、なるべく短く書く遊びです。

１行だけのプログラム「ワンライナー」（One-Liner）

文字数を削る遊びだけでなく、行数を削る遊びもあります。

ワンライナーとは - はてなキーワード

「ワンライナー」とは、たった1行だけのプログラムです。

プログラムを書きたいが、エディタを起動するほどの手間はかけたくない、というときに威力を発揮します。

達人ともなると、ちょっとした文字置換や計算をするワンライナーを、即興で作って使い捨てることもあります。

プログラミングが速い人によると、

プログラミングはパズルと同じ

だそうです。

（知り合いのプログラマーで、「知恵の輪」を数秒眺めただけで解ける人がいました！！！）

知恵の輪読本―その名作・分類・歴史から解き方、集め方、作り方まで

作者: 秋山久義
出版社/メーカー: 新紀元社
発売日: 2003/08
メディア: 単行本
この商品を含むブログを見る

小さいコード（コード断片）は、パズルのピースのようなもの
小さいコードを組み合わせて、大きなコードを組み立てる
頭の中ではパズルを解くように、コード断片をいろいろ組み合わせている
似たような機能を何度も作っていると、必要なコード断片をすぐに揃えられる

プログラミングが速い人は、何か特別なことをやっているわけではなく、必要な部品が何かを考えて、思い出すのが早いだけ！？

プログラマ脳を鍛える数学パズルシンプルで高速なコードが書けるようになる70問

作者: 増井敏克
出版社/メーカー: 翔泳社
発売日: 2015/10/14
メディア: 単行本（ソフトカバー）
この商品を含むブログを見る

念力デバッグ！？

仕事でプログラミングをやると、納期に追われて大変なときもあります。

＝大量のテストやデバッグを短期間でやらなければいけないときは、面倒くさい？

プログラミングテクニック番外編

念力デバッグ

経験を積んだプログラマの特技．デバッグ用のコードやデバッガなしに，気合いのみでデバッグを行う．理論的な考察は不可能だが，納期後の現場デバッグ状況でよく見られる．

サーバ管理者日誌続・クロールとDoSの違いと業務妨害罪と

「念力デバッグ」という仕事があって、ごく稀にお仕事を頂く。

念力デバッグというのは、安楽椅子探偵に似たようなデバッグで、デバッガやデバッグ用のコードを使わずに、直観と論理に基づく推理だけでバグを探すデバッグだ。

通常のデバッグでは、デバッガを用いたり、デバッグ用のコードを走らせたりできるので、念力デバッグの出番はあまりないのだが、既に仕様書やソースコードが存在しなかったり、実機に触れることができなかったり、その全てがなくて、バグレポートだけでバグ解析して運用回避手段を見つける必要があったりという状況があって、そういう場合に、念力デバッグの登場となる様だ。

念力デバッグの結果は、材料が少ないときは特に占いめいていて、「午前2時に、おにぎりを大量に買ってみて下さい。日配品の集計モジュールを書いた人が、コードを書いた当時に経験が浅かったとしたら、集計タイミングに売上が発生する可能性を考慮しておらず、一貫性が保てなくなった可能性があります。推理が正しければ、件の現象が再現すると思われます。」といったレポートを書いて、推理が当たれば一件落着となる訳だ。