Clean Code - 제 1장. 의미 있는 이름

-

Clean Code - 의미 있는 이름

모두 좋은 내용이지만, 개인적으로 핵심만 정리했다.

의미있게 구분하자

애매한 -Info, -Data, -Manager, -Processor 같은 접미사는 피하자. 정확한 정보제공을 위한 단어만 사용하자.

발음과 검색이 쉬운 단어를 사용하자.

 타 프로그머와 육성으로 소통하기 쉬운 단어를 사용하자. 그리고 검색이 쉬운 단어가 프로그램 수정을 더 쉽게 할 수 있다. 만약 알파벳 1글자로 사용하는 변수를 사용하려면, 메서드에서 로컬변수 혹은 Loop 의 변수 초기화 때만 사용하자.

해법 영역/문제 영역의 이름을 활용하자.

 해법 영역은 컴퓨터 공학 분야를 이야기하는 것 같다. Visitor 패턴을 사용할 때는 AccountVisitor, Queue를 사용하면 JobQueue 같은 이름을 사용하자. 해법 영역에서 답을 못찾으면 구현하려는 Domain 영역에서 작명해보자.

구현에 관련된 작명.

인터페이스와 구현클래스

인터페이스와 구현 클래스 이름 중 인코딩 방식을 넣어야 한다면 구현 클래스를 추천한다. 
  • 인터페이스 : ShapeFactory
  • 구현 : ShapeFactoryImpl

생성자 메서드

 생성자를 중복정의 할때, 정적 팩토리 메서드를 사용하자. 메서드는 인수를 설명하는 이름을 사용하자.
  • 생성자 : Complex fulcrumPoint = new Complex(23.0)
  • 정적 메서드 : Complex fulcrumPoint = Complex.FromRealNumber(23.0);

마치며

  사람들이 이름을 바꾸지 않으려는 이유 하나는 다른 개발자가 반대할까 두려워서다. 하지만 좋은 코드를 만드는 우리의 책임감이 있다면 일단 Nudge 부터 시작해야 한다. 




댓글

댓글 쓰기

이 블로그의 인기 게시물

JPA 와 함께 - 느낀점

-
이미지
Java Persistence API(JPA)  김영한님의 JPA 기초편 을 끝까지 수강했다. 작년부터 새벽에 짬내서 들었지만, 아이들의 방해(?)로 6개월 걸렸다. 듣고 많은 내용에 대해서 생각이 들었다. JPA 란?  자바 퍼시스턴스 API 이라 불리는 객체와 관계형 DB 를 관리하는 자바 API다. 2006년 1.0을 발표했으며 현재 2.1버젼까지 발전했다. Mybatis도 좋지만...  Mybatis로 Web개발을 하면, 마음 한켠이 찝찝(?)했다. 분명 Mybatis가 직관적으로 SQL을 관리해서 편하다. 하지만 점점 SQL 중심 개발로 진행할 수록, Spring의 역활에 의구심이 들었다. Web 서버, JSON 변환 외 비즈니스 로직은 점점 Mybatis 중심으로 만들어졌다.  그러다 객체설계 책을 접하고, Spring JPA를 알게 되었고, 유료 강의수강를 수강했다. Oracle Forms와 비교   가장 오래한 직업인 Oracle Forms 개발 관점에서 봤을 때, 비슷하면서 더 발전한 API라고 생각한다. 비슷한 점은 Primary Key 기준 CRUD Transaction 자동 실행과 부모-자식 관계 자동 설정이다.   더 발전한 API로 느낀 이유는 특정 DB를 위한 API가 아닌 범용 API라는 점이다. ANSI 표준 SQL과 Dialect로 DB Vendor별 차이를 좁히기도 한다. 그래서 개발자는 SQL보다는 객체에 좀더 집중할 수 있도록 도와준다. 객체지향으로 가는 길.  이제 비즈니스 로직을 객체에 자연스럽게 녹일 수 있다. 비즈니스 로직과 SQL 문장을 만들필요 없이 객체의 로직의 결과가 저장되어야 한다면 JPA를 사용하면 된다.  마치며... 홍보글은 아니지만, 꼭 듣기를 바란다. 이제 DB 없는 프로그램은 상상하기 힘들다. 객체와 DB설계 중 고민 하나를 덜어낼 수 있는 좋은 기회다. (물론 DB를 전혀 신경쓰지 않아도 되는 건 아니다.)
자세한 내용 보기

Scott 과 함께 - Recursive Query 구현하기

-
이미지
Recursive Query   Recursive Query는 계층형(hierarchical) 데이터를 조회할 때 사용하는 쿼리다. 기업에서 흔히 조직도와 BOM(Bill of Materials)에서 사용한다. Oracle은 'Connect By' 그리고 타 DB는 CTE(Common Table Expressions)로 계층형 데이터를 조회할 수 있다. Java의 경우, Entity를 연결해 Graph탐색할 수 있다. 이번 Post는 JPA로 Employee객체의 조직도를 구현하는 기록을 남긴다. Oracle Native Query 결과.  EMP 테이블은 직원 1명에 관리자 1명으로 구성되어 있다. 관리자는 다른 상위 관리자 1명과 연결한다. 'KING'은 사장님이시기 때문에 관리자 값이 Null이다.   'Connect By' 문장은 연결할 데이터 컬럼을 정의한다. 'Start with'는 계층형 데이터의 시작이 어디인지 알려준다. 'Prior' 은 상향식과 하향식으로 데이터 조회 방향을 결정한다. SELECT LEVEL , lpad ( ' ' , LEVEL * 3 , '.' ) || decode ( LEVEL , 1 , NULL , '└▶ ' ) || e . ename AS hierarchy , e . * FROM emp e WHERE 1 = 1 START WITH e . mgr IS NULL CONNECT BY e . mgr = PRIOR e . empno 상향식 결과 SELECT LEVEL , lpad ( ' ' , LEVEL *...
자세한 내용 보기
-
Clean Code - 형식 맞추기. 형식을 맞추는 목적  형식을 맞추는 것은 프로그래머들의 소통을 위해서 가장 중요한 업무다.  개녑은 빈 행으로 분리한다.  member 변수는 행으로 분리하지 않지만, method는 빈행으로 분리하자. 세로 밀집도 변수 선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다. 종속 변수  : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 개념적 유사성 : 중요한 개념을 먼저 표현한다. 그리고 그 개념을 지원하는 함수들을 순서대로 작성하면 '내려읽기'가 편해진다.  팀규칙  프로그래머는 각자 선호하는 규칙이 있다. 하지만 팀이 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
자세한 내용 보기