[소프트웨어 공학] 클린코드 & 시큐어코딩

클린코드

---

클린코드란? '코드를 작성하는 의도와 목적이 명확하며, 다른 사람이 읽기 쉬운 코드'

한 가지의 기능만 맡는다.
단순하며, 직접적으로 표현한다.
하나의 목적을 달성하는 방법은 한가지여야 한다.
중복 X, 표현력 높이기, 초반부터 간단한 추상화 고려하기 를 신경써야함 
코드를 읽으며 보이던 기능을 각 루틴이 그대로 수행하는 것

 

가독성이 높다는 것은? 

• 어떤 사람이 봐도 코드 수정이 쉬움
• 버그를 찾고, 변경된 내용이 어떻게 상호작용하는지 이해하기 쉬움 

 

클린코드를 만들기 위한 규칙

---

 

1. 네이밍

• 변수, 클래스, 메소드에 의도가 분명한 이름을 사용
• elapsedTimeInDays, daySinceCreation, fileAgeInDays..
• 잘못된 정보를 전달할 수 있는 이름은 사용하지 않음 
• 범용적으로 사용되는 단어 또한 사용하지 않는다.
• 연속된 숫자나 불용어를 덧붙이는 방식도 사용하지 않는다.

 

2. 주석달기 

• 반드시 달아야 하는 경우만 작성(유추할 수 있는 경우는 달지 않는다.) 
• 설명을 위한 설명은 달지 않는다.

 

3. 꾸미기

• 규칙적인 들여쓰기와 줄바꿈
• 일관성 있고 간결한 패턴을 적용해 줄바꿈한다.
• 메소드를 이용하여 중복 코드를 제거한다. 
• 클래스 내에서도 여러 그룹으로 나누는 것이 읽기에 좋다.

 

4. 흐름제어 만들기

• 비교문의 경우 왼쪽에는 변수, 오른쪽에는 상수
• 부정이 아닌 긍정을 다루자 
• if/else를 사용하며, 삼항 연산자는 매우 간단한 경우만 사용한다. 
• do/while 루프는 최대한 쓰지 않는다. 

 

5. 착한 함수 

• 함수는 가급적 하나의 기능만 수행한다. 

 

코드리뷰 & 리팩토링 

---

코드리뷰 & 리팩토링이란?

코드리뷰를 통해 냄새나는 코드를 발견하면, 리팩토링을 통해 점진적으로 개선해나감

 

리팩토링 대상

• 메소드 정리 : 그룹으로 묶을 수 있는 코드, 수식을 메소드로 변경 
• 객체 간의 기능 이동 : 메소드 기능에 따른 위치 변경, 클래스 기능을 명확히 구분 
• 데이터 구성 : 캡슐화 기법을 적용해 데이터 접근 관리 
• 조건문 단순화 : 조건 논리를 단순하고 명확하게 작성 
• 메소드 호출 단순화 : 메소드 이름이나 목적이 맞지 않을 때 변경 
• 클래스 및 메소드 일반화 : 동일 기능 메소드가 여러개 있으면 수퍼클래스로 이동 

 

시큐어 코딩 

---

 

시큐어 코딩이란?

안전한 소프트웨어를 개발하기 위해, 소스코드에 존재할 수 있는 잠재적인 보안약점을 제거하는 것 

 

대표적인 사례 

• SQL 인젝션 
• URL 파라미터 조작 
• 무작위 대입공격 

 

REFERENCE

 

https://github.com/gyoogle/tech-interview-for-developer

gyoogle/tech-interview-for-developer