코드프레소 체험단 5 : SW 유지보수성 향상을 위한 Clean Code

이번에는 Clean Code 관련 강의를 수강했다. 먼저 Clean Code가 무엇인지에 대해 알아보도록 하자.

 

Clean Code란?

Clean Code에 대해 Robert C.Martin은 아래와 같이 소개하고 있다.

clean code는 이해하기 쉽고, 변경하기 쉬운 코드 by Robert C.Martin, Clean Code

Clean Code의 표준이나 엄격한 정의는 존재하지 않는다. 하지만 공통된 의견이 존재한다.

• 사람이 읽고 이해하기 쉽다
• 단순한 한 가지 역할을 하고, 명확한 이름(표현)을 갖고 있다.
• 중복이 없다
• 테스트 케이스가 있다.

그렇다면 Clean Code란 왜 중요할까?

일반적으로 SoftWare는 한 번 개발되고, 오랜 기간동안 유지보수된다. 이때 기존 코드에 추가 작업하는 시간이 압도적으로 많다. 대부분의 시간을 기존 코드를 읽고, 이해하는데 사용한다는 뜻이다.

만일 코드의 품질이 낮아지면 코드를 읽고 이해하는데 더 많은 시간이 걸리고, 수정하는데 오랜 시간이 걸릴 것이다. 회사로 놓고 보면 개인과 조직 모두에게 커다란 비효율이 발생하는 것이다.

 

Clean Code가 무엇인지에 대해 알아보았다. 이제 Clean Code를 작성하는 방법을 보도록 하자.

 

Clean Code를 작성하는 방법

1 . Clean Name

우리는 개발의 약 75%의 시간을 코드를 읽고 이해하는데 사용한다. 변수, 상수, 함수, 클래스 등 SW의 주요 요소는 이름을 갖고 있다. 좋은 이름을 사용하면내부를 들여다보지 않아도 동작과 목적을 쉽게 이해할 수 있게 한다. 나아가 코드를 읽는 사람의 인지적 부하를 최소화 할 수 있다. Clean Name이란 아래와 같다.

💡 Variables / Constants : 어떤 데이터가 담겨 있는지 명확히 설명하는 이름

Functions / Methods : 어떤 동작을 하는지 명확히 설명하는 이름

Classes : 어떤 종류의 객체를 생성하는지 명확히 설명하는 이름

 

위와 같이 Clean Name을 짜려면 규칙을 정하고 일관성 있게 코드를 짜는 것이 좋다. 아래 예시와 같이 말이다. 이런 규칙은 팀원과 상의하는 것이 좋다. 또는 언어별 Naming Standard를 참고하는 것이 좋다. 대표적인 예로 Java는 Oracle, Google 등에서 Style Guide를 제작하여 배포하고 있다.

💡 ex) 우리 팀은 정보를 조회할 때 get 동사를 사용하기로 했다.
→User정보를 조회하는 함수를 찾기 위해 getUser()함수를 찾았다.

 

코드 리뷰시에는 Naming 등이 사전에 정한 규칙을 잘 지키고 있는지 반드시 확인해야 한다.

 

2 . Clean Method

Method와 Function은 SW에서 가장 기본이 되는 모듈이다. 우선 Clean Method란 호출하는 사람이 사용하기 쉽고, 유지보수 하는 사람이 이해/변경/테스트 하기 쉬워야 한다. Clean Method의 특징은 아래와 같다.

• 가능한 한 충분히 작아야 한다.
• 한 가지를 해야한다.
• 테스트 가능해야 한다.
• 중복이 없어야 한다.

또 Parameter 에 대한 원칙들도 있다.

• Method를 호출하는 사람의 인지적 부하를 최소로 만들어 주어야한다.
• Method를 호출할 때 마다 내부 코드를 보거나 API 문서를 보지 않게 해야한다.
• Parameter의 개수는 가능한 한 적어야 한다. →0~2개까지는 보통 →3개는 개선 가능성 검토 필요, 4개는 개선 필요

Parameter가 너무 많을 경우, 이는 Method가 너무 많은 역할을 하고 있다는 뜻일 수 있다. 이때는 Method를 분할하면 된다. 또는 Parameter Data를 저장하는 Object를 활용하도록 하자.

 

💡 참고
Cyclomatic Complexity
→ Method 내부의 복잡도를 즉정하는 지표
→ Method 내부의 조건문 중첩이 복잡할 수록 높아진다.
→ CC(Cyclomatic Complexity)가 높을수록 테스트가 어렵고, 수정이 어렵다.

 

3 . Clean Comment

Comment는 Code에 대한 사람이 읽을 수 있는 부가설명이다. 일반적으로 사람이 Code를 더 쉽게 이해할 수 있게 하기 위해 주석을 작성한다. 하지만 Comment로 부가 설명이 필요하다면 Code가 충분히 의미있지 못하다는 뜻이다.

일반적으로 코드를 수정할 때 Comment는 수정이 되기도 하고, 되지 않기도 한다. 즉 Comment의 정보는 잘못되거나 오래된 정보를 담고 있을 가능성이 높다. 즉 코드 수정 이력을 Comment로 남겨주는 것이 좋다.

 

4. Clean Formatting

Code Formatting은 코드의 가독성과 이해도를 높여주는 일련의 작업이다. 수직적 Formatting 원칙과 수평적 Formatting 원칙으로 분류된다.

💡 수직적(Vertical) Formatting
코드의 위에서 아래로 진행되는 흐름과 관련된 코드 작성 규칙
코드 라인간의 간격, 밀접한 관계를 가지는 코드 간 그룹화 등이 포함된다

💡 수평적(Horizontal) Formatting
하나의 코드 행에서 왼쪽에서 오른쪽으로 진행되는 흐름과 관련된 코드 작성 규칙
들여쓰기, 코드 간 간격, 코드 행의 넓이 등이 포함된다.

 

5 . Clean Control Structure

Control Structure이란 조건, 루프, 흐름을 제어하는 선언문을 말한다. Control Structure는 코드 복잡도에 가장 큰 영향을 주는 요소이다. 중첩된 Control Structure는 코드의 가독성과 테스트 용이성을 낮추고, 코드를 복잡하게 한다.

이와 같은 소스 코드의 복잡도를 나타내는 지표로 Cyclomatic Complexity가 있다. 복잡도가 낮을수록 프로그램이 구조적으로 안정되었다는 의미이며, 복잡도가 높을수록 프로그램이 비 구조적이며 불안정하다는 뜻이다. 프로그램의 제어 흐름을 node, edge로 표현한 그래프를 기반으로 계산한다.

 

계산방법은 아래 2가지가 있다.

💡 계산방법 1
복잡도 V(G) = edge의 수 - node의 수 + 2

💡 계산방법 2
복잡도 V(G) = 분기문의 수 + 1

 

📌코드프레소 Java 웹 개발 체험단 활동으로 제공받은 강의입니다.

📌코드프레소에서 "SW 유지보수성 향상을 위한 Clean Code" 강의를 수강 후 작성한 글입니다.

📌코드프레소 바로가기 링크 : https://www.codepresso.kr/