Clean Code

์ข‹์€ ์ฝ”๋“œ

  • ์œ ์ง€๋ณด์ˆ˜์„ฑ

๋‚˜์œ ์ฝ”๋“œ

  • ๋ฐ˜๋ณต์ ์œผ๋กœ ๋‚˜ํƒ€๋‚˜๋Š” ์ค‘๋ณต๋œ ์ฝ”๋“œ๊ฐ€ ์•…์ทจ๋‚˜๋Š” ์ฝ”๋“œ

์ค‘๋ณต ์ฝ”๋“œ

  • ์—ฌ๋Ÿฌ ์ฝ”๋“œ์— ํผ์ ธ์žˆ๋Š” ๋ฐ˜๋ณต๋˜๋Š” ์ฝ”๋“œ๋ฅผ ๋ณ„๋„ ๋ชจ๋“ˆ๋กœ ๋ถ„๋ฆฌํ•˜์—ฌ ์œ ์ง€๋ณด์ˆ˜์„ฑ์„ ๋†’์ด๋Š”๊ฒŒ ์ค‘์š”

  • ํ•จ์ˆ˜๋กœ ๋ถ„๋ฆฌํ•˜๊ณ  ๋ช…ํ™•ํ•œ ๋„ค์ด๋ฐ์„ ์ง€์–ด ๋กœ์ง์„ ์ดํ•ดํ•˜๊ธฐ ์‰ฝ๊ฒŒ ๋งŒ๋“ฆ

๋งค์ง ์ƒ์ˆ˜

  • ๋งค์ง ์ƒ์ˆ˜๋ž€ ํŠน์ • ๊ฐ’์„ ํ•˜๋“œ์ฝ”๋”ฉํ•œ ๊ฒƒ์„ ์˜๋ฏธ

  • ๋‚˜์ค‘๊ฐ€๋ฉด ์ด๊ฒŒ ๋ฌด์Šจ ๋œป์ธ์ง€ ์•Œ์ˆ˜๊ฐ€ ์—†๊ฒŒ๋จ

  • ๊ฐœ์„  ๋ฐฉ๋ฒ•

    • ์ˆซ์ž์— ์˜๋ฏธ๋ฅผ ๋‹ด๊ธฐ

    • ํฉ๋ฟŒ๋ ค์ง„ ์ƒ์ˆ˜ ๋ชจ์œผ๊ธฐ

์ด๋ฆ„ ์ง“๊ธฐ

์ฝ”๋“œ๋ฅผ ์ฝ์—ˆ์„ ๋•Œ ๊ทธ ์ด๋ฆ„๋Œ€๋กœ ์˜ˆ์ธก ๋ฐ ์œ ์ถ”ํ•˜๊ฒŒ ๋œ๋‹ค. ์˜ˆ์ธกํ•œ๋Œ€๋กœ ๋™์ž‘ํ•˜๊ฒŒ ๋งŒ๋“œ๋Š”๊ฒŒ ์ข‹์€ ์ด๋ฆ„ ์ง“๊ธฐ ๋ฐฉ๋ฒ•์ด๋‹ค.

  • ๊ตฌ์ฒด์ ์ธ ์ด๋ฆ„ ์ง“๊ธฐ

  • ๊ด€๋ก€๋ฅผ ๋”ฐ๋ฅด๊ธฐ, ๊ฐ ์–ธ์–ด ์ƒํ…Œ๊ณ„์— ๋”ฐ๋ผ ๊ด€๋ก€๊ฐ€ ์กด์žฌํ•œ๋‹ค.

  • ์ •๋ณด๋ฅผ ๋‹ด๊ธฐ

    • ๋„ค์ด๋ฐ๊ณผ ๋™์ž‘์ด ๋™์ผํ•ด์•ผ ํ•œ๋‹ค.

  • ์ฝ๋Š” ์‚ฌ๋žŒ ์ž…์žฅ์—์„œ ์ตœ๋Œ€ํ•œ ๋‡Œ๋นผ๊ณ  ์ดํ•ดํ• ์ˆ˜ ์žˆ๋„๋ก ์ง“๋Š”๊ฒŒ ์ค‘์š”

  • ์ปจํ…์ŠคํŠธ ๋‚ด์—์„œ ๋ฌผํ๋ฅด๋“ฏ์ด ์ดํ•ดํ•  ์ˆ˜ ์žˆ๋„๋ก ๊ฐ„๋‹จ ๋ช…๋ฃŒํ•˜๊ฒŒ ์ž‘๋ช…ํ•ด์•ผ ํ•œ๋‹ค.

์˜ค๋ฅ˜ ๊ด€๋ จ

  • null ๊ด€๋ จํ•œ ๋ฌธ์ œ

  • ์ž๋ฐ”์˜ null ๋ฌธ์ œ๋ฅผ ์–ธ์–ด ์ฐจ์›์—์„œ ๋ฐฉ์ง€ํ•œ ๊ฒƒ์ด ์ฝ”ํ‹€๋ฆฐ ์–ธ์–ด

ํ๋ฆ„ ์ œ์–ด

  • if๋ฌธ switch๋ฌธ

  • ์ค‘์ฒฉ์„ ์ตœ์†Œํ™”ํ•˜๊ธฐ

  • ์ค‘์ฒฉ์ด ๋งŽ๋‹ค๋Š”๊ฒƒ์€ ๋งŽ์€ ์•…์ทจ๋ฅผ ํฌํ•จํ•œ๋‹ค.

    • ๋„ˆ๋ฌด ๋งŽ์€ ์ผ์„ ํ•จ

    • ๋„ˆ๋ฌด ๋งŽ์€ ์กฐ๊ฑด์„ ๊ฐ–๊ณ  ์žˆ์Œ

    • ๋„ˆ๋ฌด ๋งŽ์€ ์ƒํƒœ๋ฅผ ์•Œ๊ณ  ์žˆ์Œ

    • ์ฆ‰, ๋ณต์žกํ•˜๋‹ค. -> ์œ ์ง€๋ณด์ˆ˜ํ•˜๊ธฐ ์–ด๋ ต๋‹ค.

์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ์ฝ”๋“œ

  • ์‚ฌ์šฉ๋˜์ง€ ์•Š๋Š” ์ฝ”๋“œ๋Š” ์ฝ๋Š”์‚ฌ๋žŒ์œผ๋กœ์จ ํ˜ผ๋ž€์„ ์•ผ๊ธฐ์‹œํ‚ด

  • ์‚ฌ์šฉ๋˜์ง€ ์•Š๋Š” ์ฝ”๋“œ๋Š” ๋‚จ๊ฒจ๋‘์ง€ ์•Š๊ณ  ๊ณผ๊ฐํ•˜๊ฒŒ ์ œ๊ฑฐํ•˜๋Š”๊ฒŒ ํ•„์š”

ํ•จ์ˆ˜

  • ์žฌ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ์ฝ”๋“œ ์กฐ๊ฐ

  • ํŠน์ • ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ช…๋ น์–ด์˜ ์กฐํ•ฉ

  • ์ž…๋ ฅ์„ ๋ฐ›์•„ ํŠน์ • ๋ช…๋ น์„ ์ˆ˜ํ–‰ํ•˜๊ฑฐ๋‚˜, ๊ฒฐ๊ณผ๋ฅผ ๋ฐ˜ํ™˜

  • ๋ชจ๋“ˆํ™”, ์žฌ์‚ฌ์šฉ์„ฑ, ๊ตฌ์กฐํ™”, ๊ด€๋ฆฌ

ํ•จ์ˆ˜ ๊ด€๋ จ ํด๋ฆฐ์ฝ”๋“œ

์ž‘๊ฒŒ ๋งŒ๋“ค๊ธฐ

  • ์ž‘์•„์•ผ ์ฝ๊ธฐ ์‰ฝ๊ณ  ์ˆ˜์ •ํ•˜๊ธฐ ์‰ฝ๋‹ค. ์ฆ‰, ์œ ์ง€๋ณด์ˆ˜ํ•˜๊ธฐ ์‰ฌ์šด ์ฝ”๋“œ๊ฐ€ ๋œ๋‹ค.

  • 15 line ์ดํ•˜๊ฐ€ ์ž‘๋‹ค๊ณ  ํ‘œํ˜„๋จ

ํ•จ์ˆ˜๋ฅผ ์ž‘๊ฒŒ ๋งŒ๋“œ๋Š” ๋ฐฉ๋ฒ•

  • ๋ฉ”์„œ๋“œ ์ถ”์ถœ

  • ๋ฉ”์„œ๋“œ๋ฅผ ๋ฉ”์„œ๋“œ ๊ฐ์ฒด๋กœ ๋Œ€์ฒด

    • ๋ณต์žกํ•œ ๋ฉ”์„œ๋“œ๋ฅผ ๋‹จ์ˆœํ™”ํ•˜๊ณ  ๊ฐ€๋…์„ฑ์„ ๋†’์ด๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉ๋จ

๋ณต์žก๋„๋ฅผ ๋‚ฎ์ถ”๊ธฐ

  • ํ•จ์ˆ˜ ์•ˆ์˜ ๋ถ„๊ธฐ ๊ฐœ์ˆ˜๋ฅผ ์ž‘๊ฒŒ ์œ ์ง€

  • if, switch, ์‚ผํ•ญ์—ฐ์‚ฐ, try & catch, for, &&, ||

  • ๋ถ„๊ธฐ์ ์ด ๋งŽ์„์ˆ˜๋ก ๋ณต์žก๋„๊ฐ€ ์ฆ๊ฐ€ํ•œ๋‹ค.

ํŒŒ๋ผ๋ฏธํ„ฐ ๊ฐœ์ˆ˜๋ฅผ ์ œํ•œํ•˜๊ธฐ

  • 4๊ฐœ ์ดํ•˜

  • 4๊ฐœ๋ฅผ ์ดˆ๊ณผํ•˜๋ฉด ํŒŒ๋ผ๋ฏธํ„ฐ ๊ฐ์ฒด๋ฅผ ๊ณ ๋ ค

๊ฐ ํ•จ์ˆ˜๋Š” ํ•˜๋‚˜์˜ ์ผ๋งŒ ์ž˜ํ•˜๊ธฐ (๋‹จ์ผ ์ฑ…์ž„)

  • ํ•˜๋‚˜์˜ ํ•จ์ˆ˜ ์•ˆ์—์„œ ์—ฌ๋Ÿฌ๊ฐ€์ง€ ์ผ์„ ํ•˜์ง€ ๋ง์ž.

  • ๋ณต์žกํ•˜๊ณ , ํ…Œ์ŠคํŠธ๊ฐ€ ์–ด๋ ต๊ฒŒ๋จ

Class

๋‹จ์ผ ์ฑ…์ž„ ์›์น™ (SRP)

  • ๊ฐ ํด๋ž˜์Šค๋Š” ํ•˜๋‚˜์˜ ์ฑ…์ž„๋งŒ ๊ฐ–์Œ

  • 2๊ฐœ ์ด์ƒ์˜ ์—ญํ• ์„ ์ˆ˜ํ–‰ํ•˜๋ฉด ๋ณต์žก์„ฑ์ด ๋†’์•„์ง

  • ๋” ์ž‘๊ณ , ๋” ์‘์ง‘๋œ ํด๋ž˜์Šค๋ฅผ ๋งŒ๋“ค๋ ค๊ณ  ๋…ธ๋ ฅ

์˜๋ฏธ ์žˆ๋Š” ํด๋ž˜์Šค ์ด๋ฆ„ ์ง“๊ธฐ

  • ํด๋ž˜์Šค ์ด๋ฆ„๋งŒ ๋ณด๊ณ  ์–ด๋–ค ํด๋ž˜์Šค์ธ์ง€ ์•Œ ์ˆ˜ ์žˆ์–ด์•ผ ํ•จ

  • ๋ช…ํ™•ํ•˜๊ณ  ์„ค๋ช…์ ์ธ ์ด๋ฆ„

  • ํด๋ž˜์Šค์˜ ๋ชฉ์ ๊ณผ ์ฑ…์ž„์ด ๋“ค์–ด๋‚˜์•ผ ํ•จ

์บก์Аํ™”

  • ์ ‘๊ทผ ์ œ์–ด์ž public, private, protected๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ํด๋ž˜์Šค ๋ฉค๋ฒ„์˜ ๊ฐ€์‹œ์„ฑ์„ ๊ด€๋ฆฌ

์ƒ์„ฑ์ž

  • ์ƒ์„ฑ์ž์— ๋ณต์žกํ•œ ๋…ผ๋ฆฌ๋‚˜ ์ž‘์—…์„ ํ”ผํ•œ๋‹ค.

    • ๋ณต์žกํ•œ ๋กœ์ง์€ ๋ณ„๋„ ๋ฉ”์„œ๋“œ๋กœ ์ถ”์ถœ

  • ์ƒ์„ฑ์ž๋Š” ๋กœ์ง์„ ๋„ฃ์ง€ ์•Š๋Š” ๊ฒƒ์ด ์ค‘์š”

์˜์กด์„ฑ ์ฃผ์ž…

  • ํด๋ž˜์Šค๋Š” ๋‹ค๋ฅธ ํด๋ž˜์Šค๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์˜์กด์„ฑ์ด ์ƒ๊ธฐ๊ฒŒ ๋จ

  • ์˜์กด์„ฑ์„ ๋‚ฎ์ถ”๋Š”๊ฒƒ์ด ๋ณต์žก์„ฑ์„ ์ค„์ธ๋‹ค.

  • ์™ธ๋ถ€์—์„œ ์ฃผ์ž…ํ•ด์ฃผ๋Š” ๋ฐฉ์‹์œผ๋กœ ์‚ฌ์šฉํ•ด์•ผ ๋ชฉ ๋ฐ์ดํ„ฐ๋กœ ๊ฐˆ์•„๋ผ์›Œ ํ…Œ์ŠคํŠธํ•˜๊ธฐ๋„ ์‰ฝ๊ณ  ๊ต์ฒด ๋ฐฉ์‹์œผ๋กœ ํด๋ž˜์Šค์˜ ๋ณ„๋„ ์ˆ˜์ •์—†์ด ํ–‰๋™์„ ๋ฐ”๊ฟ€์ˆ˜ ์žˆ๊ฒŒ ๋œ๋‹ค.

์ธํ„ฐํŽ˜์ด์Šค ํ™œ์šฉ

  • ์œ ์—ฐ์„ฑ์ด ๋†’์•„์ง€๊ณ , ๋‹คํ˜•์„ฑ์„ ์‚ฌ์šฉํ•˜๊ธฐ ์‰ฌ์›Œ์ง

interface Logger {
  void log(String message);
}

class FileLogger implements Logger {
  @Override
  public void log(String message) {
    //
  }
}

์ƒ์†์„ ๊ณผ์šฉํ•˜์ง€ ์•Š๊ณ , ํšจ๊ณผ์ ์œผ๋กœ ์‚ฌ์šฉ

  • ์ƒ์† ๋Œ€์‹  ์กฐํ•ฉ(Composition)์„ ๊ถŒ์žฅ

  • ์ƒ์†์„ ์‚ฌ์šฉํ•˜๋ฉด ๋ถ€๋ชจ ํด๋ž˜์Šค์— ๋ชจ๋‘ ์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๊ธฐ ๋•Œ๋ฌธ์— ์บก์Аํ™”๊ฐ€ ๊นจ์ง„๋‹ค.

  • ์ƒ์†์€ ๊ฐ„๋‹จํ•œ ๊ณณ์—์„œ๋งŒ ์‚ฌ์šฉํ•˜๋„๋ก!

'์‹ '์„ ๋งŒ๋“ค์ง€ ์•Š๊ธฐ

  • ํด๋ž˜์Šค ํ•˜๋‚˜์— ๋ชจ๋‘ ์ž‘์„ฑํ•˜์ง€ ์•Š๊ณ  ์ฑ…์ž„์— ๋งž๊ฒŒ ๋ณ„๋„ ํด๋ž˜์Šค๋กœ ๋ถ„๋ฆฌํ•˜๋Š”๊ฒƒ์ด ์ค‘์š”

  • ํด๋ž˜์Šค์™€ ๊ด€๋ จ๋œ ๋ชจ๋“  ๋กœ์ง์„ ๋‹ค ๋•Œ๋ ค๋ฐ•์€ ํด๋ž˜์Šค๋ฅผ "God Class" ๋ผ ๋ถ€๋ฅธ๋‹ค.

๊ด€๋ ˆ๋ฅผ ๋”ฐ๋ฅด๊ธฐ

  • ์ผ๊ด€๋œ ์ฝ”๋”ฉ ์Šคํƒ€์ผ๋กœ ์ž‘์„ฑ

ํ•˜๋“œ์ฝ”๋”ฉ ํ”ผํ•˜๊ธฐ

  • ์ƒ์ˆ˜๋‚˜ ๋งค์ง ๋„˜๋ฒ„๋ฅผ ์ฝ”๋“œ์— ์ง์ ‘ ํ•˜๋“œ์ฝ”๋”ฉํ•˜๋Š” ๊ฒƒ์„ ํ”ผํ•œ๋‹ค.

  • ๋ช…๋ช…๋œ ์ƒ์ˆ˜๋‚˜ ์—ด๊ฑฐํ˜•์„ ์‚ฌ์šฉ

ํด๋ž˜์Šค ํฌ๊ธฐ๋ฅผ ์ž‘๊ฒŒ ์œ ์ง€ํ•˜๊ธฐ

  • ํด๋ž˜์Šค์™€ ๊ด€๋ จ ์—†๋Š” ๊ฒƒ๋“ค์„ ๋ณ„๋„ ํด๋ž˜์Šค๋กœ ๋ถ„๋ฆฌ

  • ์ž‘๊ณ  ์‘์ง‘๋„ ๋†’์€ ํด๋ž˜์Šค ๋งŒ๋“ค๊ธฐ

๋ชจ๋“ˆ

  • ์‘์ง‘๋œ ์ฝ”๋“œ์™€ ๊ด€๋ จ ๋ฆฌ์†Œ์Šค ์ง‘ํ•ฉ

๋‹จ์ผ ์ฑ…์ž„ ์›์น™

  • ํ•˜๋‚˜์˜ ์ฑ…์ž„์„ ๊ฐ–๋„๋ก ์œ ์ง€

  • ๋‘˜ ์ด์ƒ์˜ ์ผ์„ ์ˆ˜ํ–‰ํ•˜๋ฉด ๋ณต์žก๋„ ์ฆ๊ฐ€

๋ชจ๋“ˆ์˜ ๋…๋ฆฝ์„ฑ

  • ํ•˜๋‚˜์˜ ๋ชจ๋“ˆ์ด ๋‹ค๋ฅธ ๋ชจ๋“ˆ์˜ ๋‚ด๋ถ€ ์„ธ๋ถ€ ์‚ฌํ•ญ์— ์˜์กดํ•˜์ง€ ์•Š๋„๋ก ํ•œ๋‹ค.

  • ๊ฐ•๊ฒฐํ•ฉ์œผ๋กœ ๋ณ€๊ฒฝ์ด ์–ด๋ ค์›€

๋ชจ๋“ˆ์˜ ํฌ๊ธฐ

  • ์ž‘๊ฒŒ ์œ ์ง€

  • ์‘์ง‘๋˜๊ฒŒ ๊ด€๋ฆฌ

๋ชจ๋“ˆ๊ฐ„์˜ ์˜์กด์„ฑ

  • ์ธํ„ฐํŽ˜์ด์Šค์™€ ์ถ”์ƒํ™” ํ™œ์šฉ

  • ํŠน์ • ๊ตฌํ˜„๋ถ€๋Š” ์ธํ„ฐํŽ˜์ด์Šค ์•ˆ์— ์ˆจ๊น€

๋ชจ๋“ˆ ๋ฒ„์ „ ๊ด€๋ฆฌ

  • ๋ชจ๋“ˆ์„ ์™ธ๋ถ€์— ๋ฐฐํฌํ•˜๊ฑฐ๋‚˜, ๊ณต์œ ํ•˜๋Š” ๊ฒฝ์šฐ ๋ฒ„์ „ ๊ด€๋ฆฌ ํ•„์š”

  • ๋ชจ๋“ˆ์— ์˜์กดํ•˜๋Š” ํ”„๋กœ์ ํŠธ์™€ ํ˜ธํ™˜์„ฑ ์œ ์ง€

๋ชจ๋“ˆ์˜ ์ผ๊ด€์„ฑ

  • ๊ฐ ๋ชจ๋“ˆ์€ ์ผ๊ด€์„ฑ์„ ์œ ์ง€

  • ๋™์ž‘ ๋ฐฉ์‹๋„ ์œ ์‚ฌํ•˜๋„๋ก ์„ค๊ณ„ ๋ฐ ๊ตฌํ˜„

๊ด€์‹ฌ์‚ฌ๋ฅผ ๋ชจ๋“ˆ๋กœ ๋ถ„๋ฆฌ

  • ๊ฐ๊ฐ์˜ ๊ด€์‹ฌ์‚ฌ๊ฐ€ ๋‹ค๋ฅด๋‹ค๋ฉด ๋ณ„๋„ ๋ชจ๋“ˆ๋กœ ๋ถ„๋ฆฌ

Last updated