Share
Embed
Transcript
64 slides
-
ݴޠԽͷίπ Λྨ͢Δ - ʮݴޠԽʯͷൣғΛݶఆ͢Δ - ྨ֊త (ྫ: ໋໊ > Ϋϥεͷ໋໊
> จ๏ > ޠॱ) ྨͱྨܕͷ֬ೝʹຊॻ͕ʹཱ͔ͭ -
ॻ੶ʹ͍ͭͯ ಡΈ͍͢ίʔυͷΨΠυϥΠϯ - ࣋ଓՄೳͳιϑτΣΞ։ൃͷͨΊʹ - Oct. 22, 2022. ٕज़ධࣾ -
ϓϨθϯςʔγϣϯ ʮCode Readabilityʯ͕ϕʔε https://gihyo.jp/book/ 2022/978-4-297-13036-7 -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ /**ɹA collection of `Foo`, which provides ... */ class
FooList(...) { /** True if this list is ordered. */ val ordered: Boolean get() { ... } /** Returns a new instance with reversed order */ fun reversed(): FooList { ... } /** Returns a new mutable `MutableFooList` from the elements. */ fun mutating(): MutableFooList { ... } } -
໊લ͚ͰΑ͋͘Δ ࣍ͷͲΕ͔ʹྨͰ͖Δ͜ͱ͕ଟ͍ - จ๏ - ໊લͷࣔ͢༰ - ޠͷબ - ͞
·ͣͲΕʹͯ·Δ͔Λߟ͑Δ -
໊લ͚ͰΑ͋͘Δ ࣍ͷͲΕ͔ʹྨͰ͖Δ͜ͱ͕ଟ͍ - จ๏ - ໊લͷࣔ͢༰ - ޠͷબ - ͞
·ͣͲΕʹͯ·Δ͔Λߟ͑Δ -
ࠓճͷ จ๏: ಈࢺͷࢺ (...ing, ...ed) ΛҟͳΔҙຯʹ͍ͬͯΔ val ordered: Boolean get()
{ ... } fun reversed(): FooList { ... } fun mutating(): MutableFooList { ... } - ordered: ݅Λຬ͍ͨͯ͠Δ͔ΛਅِͰࣔ͢ - reversed, mutating: ݅Λຬͨ͢৽ͨͳΠϯελϯεΛฦ͢ -
ຊॻͷ׆༻๏ ॻ੶ 2-1 ໋໊ʹ͏จ๏ ϓϩάϥϛϯάݴޠʹΑ໋໊ͬͯͷจ๏มΘΓ͏Δ - ڞ௨ͷจ๏: ໊ࢺ(۟)ɾ໋ྩจ - ҟͳΔจ๏:
ܗ༰ࢺɾ෭ࢺ etc ࠓճͷʮݴޠʹΑͬͯҟͳΔจ๏ʯͷ͍͚͕ -
ঢ়گʹΑ͍ͬͯํ͕มΘΔจ๏ ܗ༰ࢺʢ۟ʣɾಈࢺͷࢺ: iterable, running, finished ࡾਓশͷಈࢺॿಈࢺɾٙจ: contains, shouldRun, isFooValid લஔࢺΛ͏෭ࢺ۟:
toInt, fromString, onClicked ϓϩμΫτͰ༻๏Λ౷Ұ͖͢ -
ঢ়گʹΑ͍ͬͯํ͕มΘΔจ๏ ܗ༰ࢺʢ۟ʣɾಈࢺͷࢺ: iterable, running, finished ࡾਓশͷಈࢺॿಈࢺɾٙจ: contains, shouldRun, isFooValid લஔࢺΛ͏෭ࢺ۟:
toInt, fromString, onClicked ϓϩμΫτͰ༻๏Λ౷Ұ͖͢ -
ܗ༰ࢺɾࢺͷΘΕํ ঢ়ଶੑ࣭Λࣔ͢ɾܕΛࣔ͢ - Iterable (Java/Kotlin), State.RUNNING ੑ࣭Λຬͨ͢ΠϯελϯεΛฦ͢ - sorted(iterable) (Python),
Array.shuffled() (Swift) ੑ࣭Λຬ͍ͨͯ͠Δ͔ΛਅِͰࣔ͢ - val running: Boolean, fun sorted(): Boolean -
ࠓճͷϨϏϡʔίϝϯτྫ val ordered: Boolean get() { ... } fun reversed():
FooList { ... } fun mutating(): MutableFooList { ... } > ໊લΛ࣍ͷΑ͏ʹมߋ͍ͯͩ͘͠͞: ordered -> isSorted, reversed -> toReversedList, mutating -> toMutableList > Kotlin Ͱɺ৽͍͠ΠϯελϯεΛฦ͢߹ʹ໋ྩจ͔෭ࢺΛ ͍ɺਅِΛࣔ͢߹ʹٙจͳͲΛ͍·͢ɻ -
ຊॻͷΧόʔൣғ จ๏ɾ໊લͷࣔ͢༰ɾޠͷબ - ޠͷબଟ͘ͷղઆ͕͋Δ - จ๏ͱ໊લͷࣔ͢༰ ʮ͞ʯΧόʔ֎ - ٞΛ۩ମԽ͍͢͠ (ྫ:
User ͱ͍͏಄ࣙΛೖΕΔ͔) - ݴޠɾϓϥοτϑΥʔϜʹେ͖͘ґଘ͢Δ -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ fun getDescription(keyword: String): String ϨϏϡʔΞ: ͘ΘΕΔؔͳͷͰίϝϯτΛॻ͍ͯԼ͍͞ɻ ྫ͑ɺΤοδέʔεͱ͍ͬͨҙ͕͋Δͱࢥ͍·͢ɻ ϨϏϡʔΠ: ॻ͖·ͨ͠ɻ
/** * Returns an empty string when the keyword is not registered. */ fun getDescription(keyword: String): String -
ίϝϯτͷྨ υΩϡϝϯςʔγϣϯ: /** ... */ - ίʔυΛಡ·ͣʹ ཧղͤ͞Δίϝϯτ -
ؔΫϥεͷઆ໌ ඇܗࣜతͳίϝϯτ: ΠϯϥΠϯίϝϯτ // ... - ίʔυΛಡΈਐΊΔ ͜ͱΛॿ͚Δίϝϯτ - ཧ༝ɾഎܠɾҙ...ͦͷଞԿͰ -
ࠓճͷ /** * Returns an empty string when the keyword
is not registered. */ fun getDescription(keyword: String): String υΩϡϝϯςʔγϣϯͷׂΛՌ͍ͨͯ͠ͳ͍ - ʮ௨ৗʯԿΛ͢Δ͔Θ͔Βͳ͍ - Τοδέʔεʹ͍ͭͯॻ͔Ε͍ͯΔ -
6 ͭͷΞϯνύλʔϯ 1. ࣗಈੜ͞ΕͨυΩϡϝϯςʔγϣϯΛ์ஔ͢Δ 2. એݴͱಉ͡༰Λ܁Γฦ͢ 3. ίʔυΛࣗવݴޠʹ༁͢Δ 4. ֓ཁΛॻ͔ͳ͍
5. ࣮ͷৄࡉʹݴٴ͢Δ 6. ίʔυΛ͏ଆʹݴٴ͢Δ -
ࠓճͷϨϏϡʔίϝϯτྫ > ࣍ͷΑ͏ͳυΩϡϝϯςʔγϣϯΛॻ͍͍ͯͩ͘͞ /** * Returns "description" of [keyword] if
it's registered by * [registerDescription]. * * This returns an empty string when the keyword is not registered. */ > υΩϡϝϯςʔγϣϯͷ࠷ॳͷҰจͰɺͦͷ͕ؔԿΛ͢Δ͔ ΛҰݴͰઆ໌͢Δඞཁ͕͋Γ·͢ɻ -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 1/2 fun getOnlineFollowers(userId: UserId): FollowerModelListResult { return FollowerModelListResult.Followers( if
(!userId.isAlias) { followGraphRepository.getFollowers(userId) } else { val originalId = accountRepository.resolveAlias(userId) ?: return FollowerModelListResult.UnknownId followGraphRepository.getFollowers(originalId) }.filter { onlineStatusRepository.isOnline(it.userId) } .toSet() )} -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 2/2 ϨϏϡʔΞ: getOnlineFollowers ͷॲཧ͕͍ʹ͍͘ͷͰɺϦϑΝ ΫλϦϯά͍ͯͩ͘͠͞ɻ ϨϏϡʔΠ: return FollowerModelListResult.Followers ͕࠷ॳ
ʹ͋ΔͷͰɺ͜ͷ͕ؔԿΛ͢Δ͔໌֬ͩͱࢥ͍·͢ɻ ϨϏϡʔΠ: ·ͨɺҰͭͷࣜͱͯ͠ॻ͘͜ͱͰɺ FollowerModelListResult ͷऔಘҎ֎ʹԿ͍ͯ͠ͳ͍͜ͱ ໌֬ʹͳ͍ͬͯ·͢ɻ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 1/2 (࠶ܝ) fun getOnlineFollowers(userId: UserId): FollowerModelListResult { return FollowerModelListResult.Followers(
if (!userId.isAlias) { followGraphRepository.getFollowers(userId) } else { val originalId = accountRepository.toOriginalId(userId) ?: return FollowerModelListResult.UnknownId followGraphRepository.getFollowers(originalId) }.filter { onlineStatusRepository.isOnline(it.userId) } .toSet() )} -
ࠓճͷ ؔͷྲྀΕ͕Θ͔Γʹ͍͘ - ৄࡉ෦ΛಡΈඈͤͳ͍ -> 5-2-1 ఆٛࢦϓϩάϥϛϯά - ॏཁͳίʔυ͕Ͳ͔͜Θ͔Γʹ͍͘ ->
5-2-2 ૣظϦλʔϯ - ݅ذΛཏ͠ͳ͚ΕͳΒͳ͍ -> 5-2-3 ରʹΑΔׂ -
5-2-3 ରʹΑΔׂ ݅Ͱͳ͘ɺૢ࡞ରʢϨγʔόʣͰίʔυΛׂ͢Δ ݅ذͷϘσΟͷείʔϓΛখ͘͢͞Δ - ݅ذͷ͕૿͑Δ͜ͱࣗମͳ͍ - ཏੑͷ୲อ (ܕϢχοτςετʹΑΔอূ) ͕ඞཁ
݅ຖʹίʔυΛΘͳͯ͘ɺಈ࡞ΛѲͰ͖ΔΑ͏ʹ͢Δ -
ࠓճͷϨϏϡʔίϝϯτྫ 1/4 > ҎԼͷิॿؔΛఆ͍ٛͯͩ͘͠͞ɻ private fun resolveAlias(userId: UserId): UserId? =
if (userId.isAlias) accountRepository.toOriginalId(userId) else userId > ͜ͷؔΛ༻͍ͯɺgetOnlineFollowers ΛҎԼͷΑ͏ʹॻ͖ ͍͑ͯͩ͘͞ɻ -
ࠓճͷϨϏϡʔίϝϯτྫ 2/4 fun getOnlineFollowers(userId: UserId): FollowerModelListResult { val originalId =
resolveAlias(userId) ?: return FollowerModelListResult.UnknownId val onlineFollowers = followGraphRepository.getFollowers(originalId) .filter { onlineStatusRepository.isOnline(it.userId) } .toSet() return FollowerModelListResult.Followers(onlineFollowers) } -
ࠓճͷϨϏϡʔίϝϯτྫ 3/4 > ฦ৴͍͍ͯͨͩͨ͠௨Γ Result ͷฦ٫͕͜ͷؔͷ࠷ॏཁͳ Ͱ͋Δ͜ͱ͔֬Ͱ͢ɻ > ͔͠͠ɺͦΕࣗମؔͷγάωνϟ͔ΒಡΈऔΕ·͢ɻ >
ؔΛಡΉࡍɺͦΕΑΓҰஈৄࡉͳ෦ͰʮԿΛ͍ͯ͠Δ ͔ʯ͕ཧղͰ͖Δඞཁ͕͋Γ·͢ɻ > ͜ͷؔͷྲྀΕɺҎԼͷΑ͏ʹͳ͍ͬͯ·͢ɻ -
ࠓճͷϨϏϡʔίϝϯτྫ 4/4 > 1. ඞཁͳΒ ID ͷΤΠϦΞεΛॲཧ͢Δ > 2. ϑΥϩΞʔΛऔಘ͠ɺΦϯϥΠϯͷ݅ͰϑΟϧλ͢Δ
> 3. ϑΟϧλͷ݁ՌΛ Result ͱͯ͠ฦ͢ > ্هͷίʔυͰɺ͜ͷྲྀΕ͕໌֬ʹͳΔΑ͏ʹ͠·ͨ͠ɻ -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 1/3 // // // class UserNameProvider { fun getName(userId:
String): String = ... } class AccountScreenPresenter( val userNameProvider: UserNameProvider, ... ) { ... } -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 2/3 interface StringProvider { fun getValue(parameter: String): String }
class UserNameProvider : StringProvider { override fun getValue(parameter: String): String = ... } class AccountScreenPresenter( val userNameProvider: StringProvider, ... ) { ... } -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 3/3 ϨϏϡʔΞ: StringProvider ෆཁͳͷͰআ͍ͯͩ͘͠͞ɻ ϨϏϡʔΠ: ґଘؔऑ͘͢Δͷ͕·͍͠ͱݴΘΕ͍ͯ·͢ɻ ϨϏϡʔΠ: StringProvider Λఆٛ͢Δ͜ͱͰɺ
UserNameProvider ʹର͢ΔґଘΛऑΊΔ͜ͱ͕Ͱ͖ΔͷͰɺ͜Ε ͍ͨ͠Ͱ͢ɻ ϨϏϡʔΠ: ·ͨɺґଘੑͷٯసͷ๏ଇʹԊͬͨઃܭʹͳ͍ͬͯ Δͱࢥ͍·͢ɻ -
ͲΜͳϨϏϡʔίϝϯτΛॻ͘ʁ 2/3 (࠶ܝ) interface StringProvider { fun getValue(parameter: String): String
} class UserNameProvider : StringProvider { override fun getValue(parameter: String): String = ... } class AccountScreenPresenter( val userNameProvider: StringProvider, ... ) { ... } -
ґଘؔͷҙ ґଘͷڧ͞ʢ݁߹ʣҎ֎ͷੑ࣭ʹ ண͢Δ͖ੑ࣭Λྨ͢Δ - 6-2 ґଘͷڧ͞ʢ݁߹ʣ - 6-3 ґଘͷํ -
6-4 ґଘͷॏෳ - 6-5 ґଘͷ໌ࣔੑ -
6-5 ґଘͷ໌ࣔੑ - ໌ࣔతͳґଘ: Ϋϥεఆ͔ٛΒ ಡΈऔΕΔ ґଘؔ - ҉తͳґଘ: ΫϥεఆٛͰ
ಡΈऔΕͳ͍ ґଘؔ ڧ͞ʢ݁߹ʣͱ໌ࣔੑผ - ऑ͍ && ໌ࣔతͳґଘ͕ؔ·͍͠ - ʮऑͨͭ͘͠Γ͕ɺ҉తʹͳ͚ͬͨͩʯΛආ͚Δ -
ࠓճͷϨϏϡʔίϝϯτྫ > StringProvider Λఆٛͯ͠ɺґଘͷڧ͞มΘΓ·ͤΜɻ > σʔλ݁߹ͱ͍͏ɺجຊతͳσʔλΛड͚͢͠Δڧ͞Ͱ͢ɻ > ҰํͰɺStringProvider ΛҾͷܕʹ͢Δ͜ͱͰɺ >
UserNameProvider ͷґଘ͕҉తʹͳ͍ͬͯ·͢ɻ > UserNameProvider ΠϯελϯεΛظ͍ͯ͠Δͷʹɺ > ࣮ࡍʹଞͷࢠΫϥεͷΠϯελϯε͕ͤͯ͠·͍·͢ɻ > ... -
τϐοΫ - 2ষ: ໋໊ - 3ষ: ίϝϯτ - 5ষ: ؔ
- 6ষ: ґଘؔ -
ϨϏϡʔίϝϯτͷςΫχοΫ ઌʹʮԿΛ͢Δ͔ʯΛॻ͖ɺޙʹʮཧ༝ʯΛॻ͘ ޙஔ because ! : B C ͱॻ͘΄͏͕ྑ͍ɻͦͷཧ༝
A ͩɻ ! : A ͳͷͰ B C ͱॻ͘΄͏͕ྑ͍ɻ -
ʮཧ༝ʯΛઌʹॻ͍ͨྫ > ࠓͷঢ়ଶͰ ...ͱ͍͏ϛε͕ى͖Δ͔͠Ε·ͤΜɻ > ͦͷͨΊɺ...ͱ͍͏ใΛิ͢Δඞཁ͕͋Γ·͢ɻ > ҎԼͷΑ͏ʹυΩϡϝϯςʔγϣϯΛॻ͍͍ͯͩ͘͞ɻ /** ...
*/ ࠷ޙ·ͰಡΜͰझࢫΛཧղ͔ͯ͠Βɺཧ༝ͷ֬ೝΛ࠶ߦ͏ -
ʮCode ReadabilityʯͷϓϨθϯςʔγϣϯʹ͍ͭͯ 1. (࠷େ) 8࣌ؒͷϓϨθϯςʔγϣϯΛ࣮ࢪՄೳ - ͓ؾܰʹ Twitter: @mntsh ʹ͝࿈བྷ͍ͩ͘͞
2. ۙΞοϓσʔτ༧ఆ - ࠓ݄தʹެ։͍ͨ͠...