こんにちは。2017年11月にAndroidエンジニアとしてjoinした@katsutomuです。
前回のエントリーから、髪の毛はアップデートされておりません。そろそろ髪の毛切りに行ってさっぱりと4月を迎えたいと思っています！
さて今回は、パッケージ構成のリファクタリングについて紹介いたします。
初めに
コネヒト社で開発しているママリ Android 版は、開発が始まってから 5 年以上経過しました。
開発当初からの歴史の中で、さまざまなコードを継ぎ足してきたママリ Android 版は、いくつもの改善ポイントを抱えています。この記事では、ようやくメスを入れられた 「目的のコードにたどり着くまでに時間がかかる」 という問題への取り組みを紹介します。
結論
まず、問題へ取り組んだ結果を紹介します。
対応としては、パッケージの構成を変更しました。 以下の画像は、ママリ Android 版の今までのパッケージ構成です。
そして、改善後のパッケージ構成がこちらです。
なぜ問題が発生してたか
「目的のコードにたどり着くまでに時間がかかる」 という問題が起こっていた理由を考察したところ、「ある機能を実現しているコードがまとまっていないから」という話になりました。
普段のプロダクト開発では、新規機能の開発もありますが、すでに実装している機能に対しての改修も頻繁に行われています。
その機能を実現している既存のコードが、複数のパッケージに分散している、同じロジックなのに複数箇所に分散している、などまとまっていない状態になっていた場合、まず分散している箇所の把握から始める必要があり、その知識があった上で改修を行う必要があります。
日々開発している我々が「この機能のコードがどこにあるのか」というのを常に覚えられているか、というと、人によってはなかなか難しいことと感じることもあります。思い出す時間や探す時間が少しばかり必要になることもあり、そこにパワーを割けなくてもよいならそれに越したことはないですね。
改修内容
コードをまとめる、にしてもいろいろな観点がありますが、まずパッケージを見直すことを最初の一手としてメスを入れました。
今までのパッケージ構成は以下の通りでした。
この構成で発生していた問題は、例えばある機能を構築するクラス FooActivity FooFragment FooAdapter FooViewModel があった場合、パッケージレベルで分散しているので、これらのクラスを探すことに無駄なパワーを割く必要がありました。
- .activity - FooActivity - .adapter - FooAdapter
改修後のパッケージは以下の通りです。
この構成にのっとると以下のような配置になります。
こうすることで、ある画面への改修をするときに、この .foo パッケージさえ知っていれば探す手間も省けます。またパッケージの命名は、普段の業務中の会話で使われている言葉を流用することで、より直感的なコードに近くなるのも良いです。
- .foo - FooActivity - FooAdapter
おわりに
今回は、なかなか手をつけられていなかったパッケージ構成の改善について紹介させていただきました。今後も継続的に改善を進めていく予定です。最後までお読みいただきありがとうございました！
今回の改修を主導してくれた、もっさん*1に感謝します！！
PR
コネヒトでは、バリバリとリファクタリングを進めてくれるAndroidエンジニアを募集中です！
*1:業務委託で参画してくれている水元さんです
