[매일읽기] How to Write Clean Java Code

자바 개발자를 위한 간단한 클린 코드 팁

1. 구조화

• 프로그램을 작성함에 있어서 클래스, 함수, 구조를 먼저 생각해볼 것
• 하나의 패키지에 너무 많은 클래스를 넣지 말고, 적절히 카테고라이징 할 것
• 잘 구조화되면 추후에 재구조화나 리팩토링 과정에서의 공수를 제거하거나 줄일 수 있음

2. 네이밍

• 클래스, 함수, 변수들의 이름은 그들 자신을 표현하는 것이므로 최대한 명시적으로 이름을 지정할 것
• 정확한 이름은 부수적인 설명을 줄일 수 있음
• 카멜 케이스는 기본

3. 클래스의 적절한 책임 분배

• 하나의 클래스는 그 클래스 목적에 맞는 책임만 가지도록 구성
• 너무 많은 책임을 가지는 클래스가 있다면 분해하거나 클래스 이름(목적)을 변경
• 하나의 책임을 가지는 하나의 클래스가 베스트
• 메소드는 하나의 문제만 해결.

4. 적절한 메소드 파라미터의 수

• 메소드의 파라미터 갯수가 너무 많아지면 작업하는 데에 어려움
• 데이터 클래스로 통합하거나 하여 파라미터 갯수를 줄일 수 있음

5. 코드 중복을 피하자

• 동일한 작업에 대해선 하나의 메소드로 관리하자
• IDE에서 적절하게 관리해주니 참고

6. 하드 코딩을 피하자

• 하드 코딩은 쉽지만 유지보수하기 어렵고 버그 발생의 근원이 됨
• 가능한 외부 주입으로 구성

7. 적절한 로깅

• 적절한 로깅은 장애, 인수인계 등 다양한 문제 상황에서 쉽게 빠르게 문제를 해결할 수 있도록 함

 

출처 : https://medium.com/javarevisited/clean-java-code-79b6da1878c9

Clean Java Code