[Spring] 코드의 아름다움
“토비의 스프링 3.1” 책을 읽으며, 한 문장 한 문장 자세히 공부해 보려고 한다.
1장은 오프젝트와 의존관계이다.
📌 1. 코드의 아름다움이란?
가독성
- 명확한 네이밍 : 변수, 함수, 클래스 등의 이름이 명확하여, 그들의 역할과 기능을 쉽게 이해할 수 있어야 한다.
- 적절한 주석 : 코드에 주석이 적절히 달려 있어, 복잡한 로직이나 중요한 부분에 대한 설명이 제공되어야 한다.
- 적절한 들여쓰기와 공백 : 코드는 적절한 들여쓰기와 공백을 사용하여, 구조와 흐름을 눈으로 쉽게 파악할 수 있어야 한다.
- 좋은 문서화 : 코드에 대한 문서화가 잘 되어 있어야 합니다. 문서화를 통해 코드의 기능과 사용 방법을 쉽게 파악할 수 있다.
일관성
- 코딩 스타일의 일관성 : 변수명 작성 규칙, 들여쓰기 스타일 등의 일관성은 코드를 읽고 이해하는 데 걸리는 시간을 줄여준다.
- 디자인 패턴의 일관성 : 이러한 일관성은 코드의 예측 가능성을 향상시키고, 버그를 줄이는 데 도움이 됩니다.이러한 일관성은 코드의 예측 가능성을 향상시키고, 버그를 줄이는 데 도움이 됩니다.
- 에러 처리의 일관성 : 에러 발생 시 디버깅이 더 쉬워진다.
- 명명 규칙의 일관성 : 프로젝트 내에서 사용되는 클래스, 메서드, 변수 등의 명명 규칙의 일관성은 코드의 가독성을 향상시키며, 개발자가 쉽게 이해하고 사용할 수 있게 한다.
- 프로젝트 구조의 일관성 : 프로젝트의 디렉터리 및 파일 구조의 일관성은 프로젝트 내의 특정 파일을 찾고 이해하는데 도움이 된다.
간결성
- 단순한 로직 : 복잡한 로직이나 중첩된 조건문 없이 명확한 로직을 사용한다.
- 불필요한 코드 제거 : 사용되지 않는 변수, 함수, 불필요한 주석 등을 제거하여 코드를 깔끔하게 유지한다.
- 명확한 변수 및 함수 이름 : 변수와 함수의 이름은 그 역할과 기능을 명확하게 반영해야 한다.
- 코드 재사용 : 중복된 코드 블럭이 있다면, 이를 별도의 함수나 모듈로 분리하여 재사용 가능하게 만든다.
모듈성
: 모듈성은 코드를 독립적이고 재사용 가능한 작은 단위로 분리하는 것을 목표로 한다.
- Single Responsibility Principle : 각 모듈, 클래스 또는 함수는 한 가지 기능만 수행하도록 설계되어야 한다.
- 독립적인 모듈 : 각 모듈은 독립적으로 작동할 수 있으며, 다른 모듈에 대한 최소한의 의존성을 가져야 한다.
- 쉬운 테스트 : 모듈은 독립적으로 테스트할 수 있어야 한다. 이를 통해 버그를 빠르게 찾고 수정할 수 있다.
- 캡슐화 : 모듈은 내부 구현을 잘 숨기며, 외부에서는 명확한 인터페이스만 제공해야 한다.
참고링크 |
Leave a comment