함수

• 작게만들어라!
  • 함수를 작게 만들어 명백하게 만든다.
  • if 문/ else 문/ while 문 등에 들어가는 블록은 한 줄이어야 한다. 대게 여기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
  • 중첩 구조가 생길만큼 함수가 커져서는 안 된다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.
• 한 가지만 해라!
  • 함수는 한 가지를 해야 한다. 그 한가지를 잘해야 한다. 그 한 가지만을 해야한다.
• 함수 당 추상화 수준은 하나로!
  • 함수가 확실히 ‘한 가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
  • 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다.
  • 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
  • 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것을 내려가기 규칙이라 부른다.
• Switch 문
  • switch 문을 추상 팩토리에 꽁꽁 숨겨 아무에게도 보여주지 않는다. 팩토리는 switch 문을 사용해 적절한 파생 클래스의 인스턴스를 생성한다.
• 서술적인 이름을 사용하라!
  • 함수가 하는 일을 좀 더 잘 표현할 수 있다.
  • 이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
• 함수 인수
  • 함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
  • 인수 객체를 이용하면 좋다.
  • 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. write(name)
  • 함수 이름에 키워드를 추가하는 형식을 사용한다. 즉, 함수 이름에 인수 이름을 넣는다.
• 부수 효과를 일으키지 마라!
  • 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하면 안 된다.
  • 부수 효과는 시간적인 결합을 초래한다. 시간적인 결합은 혼란을 일으킨다.
  • 일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
• 명령과 조회를 분리하라!
  • 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다. 객체 상태를 변경하거나 객체 정보를 반환하거나 둘 중 하나다.
• 오류 코드보다 예외를 사용하라!
  • 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
  • 반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
  • try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
  • 오류 처리도 ‘한 가지’ 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 한다. 함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다.
  • 오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다. 클래스는 의존성 자석이여서 변경이 어려워진다. 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.
• 반복하지 마라!
  • 중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.
• 구조적 프로그래밍
  • 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다. 즉, 함수는 return 문이 하나여야 한다. 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안 된다.
  • 하지만 함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다. 오히려 때로는 단일 입/풀구 규칙보다 의도를 표현하기 쉬워진다.
  • 반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.
• 함수를 어떻게 짜죠?
  • 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다.
  • 이 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
  • 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다.
  • 이 와중에도 코드는 항상 단위 테스트를 통과한다.

의미 있는 이름

• 의도를 분명히 밝혀라
• 그릇된 정보를 피하라
  • hp, aix, sco는 변수 이름으로 적합하지 않다. 유닉스 플랫폼이나 유닉스 변종을 가리키는 이름이기 때문이다.
  • List라는 단어보다는 Group이나 복수 형태의 s를 붙이는 것이 낫다.
  • 서로 흡사한 이름을 사용하지 않는다.
  • 유사한 개념은 유사한 표기법을 사용한다. 일관성이 떨어지는 표기법은 그릇된 정보다.
  • 소문자 L이나 대문자 O는 1과 0처럼 보일 수 있어 피해야 한다.
• 의미 있게 구분하라
  • 연속된 숫자를 덧붙이거나 불용어를 추가하는 방식은 적절하지 못하다. 이름이 달라야 한다면 의미도 달라져야 한다.
  • 변수 이름에 variable이라는 단어는 사용하지 말아야 한다.
  • 읽는 사람이 차이를 알도록 이름을 지어야 한다.
• 발음하기 쉬운 이름을 사용하라
• 검색하기 쉬운 이름을 사용하라
• 인코딩을 피하라
  • 멤버 변수 접두어를 붙일 필요도 없다.
• 자신의 기억력을 자랑하지 마라
  • 독자가 코드를 읽으면서 변수 이름을 자신이 아는 이름으로 변환해야 한다면 그 변수 이름은 바람직하지 못하다.
  • 명료해야 한다. 자신의 능력을 좋은 방향으로 사용해 남들이 이해하는 코드를 내놓아야 한다.
• 클래스 이름
  • 클래스 이름과 객체 이름은 명사나 명사구가 적합하다.
  • 동사는 사용하지 않는다.
• 메서드 이름
  • 메서드 이름은 동사나 동사구가 적합하다.
  • 접근자, 변경자, 조건자는 javabean 표준에 따라 값 앞에 get, set, is를 붙인다.
  • 생성자를 중복정의할 때는 정적 팩터리 메서드를 사용한다.
  • 메서드는 인수를 설명하는 이름을 사용한다.
• 기발한 이름은 피하라
  • 이름이 너무 기발하면 저자와 유머 감각이 비슷한 사람만, 그리고 농담을 기억하는 동안만, 이름을 기억한다.
  • 의도를 분명하고 솔직하게 표현해야 한다.
• 한 개념에 한 단어를 사용하라
  • 추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다.
  • 메서드 이름은 독자적이고 일관적이어야 한다. 그래야 주석을 뒤져보지 않고도 프로그래머가 올바른 메서드를 선택한다.
• 말장난을 하지 마라
  • 한 단어를 두 가지 목적으로 사용하지 마라.
  • 다른 개념에 같은 단어를 사용한다면 그것은 말장난에 불과하다.
• 해법 영역에서 가져온 이름을 사용하라
  • 전산 용어, 알고리즘 이름, 패턴 이름, 수학 용어 등을 사용해도 괜찮다.
  • 모든 이름을 문제 영역(domain)에서 가져오는 정책은 현명하지 못하다. 같은 개념을 다른 이름으로 이해하던 동료들이 매번 고객에게 의미를 물어야하기 때문이다.
  • 프로그래머에게 익숙한 기술 개념은 아주 많다. 기술 개념에는 기술 이름이 가장 적합한 선택이다.
• 문제 영역에서 가져온 이름을 사용하라
  • 적절한 ‘프로그래머 용어’가 없다면 문제 영역에서 이름을 가져온다.
• 의미 있는 맥락을 추가하라
  • 스스로 의미가 분명한 이름이 없지 않다. 하지만 대다수 이름은 그렇지 못하다. 그래서 클래스, 함수, 이름 공간에 넣어 맥락을 부여한다. 모든 방법이 실패하면 마지막 수단으로 접두어를 붙인다.
  • 맥락을 개선하면 함수를 쪼개기가 쉬워지므로 알고리즘도 좀 더 명확해진다.
• 불필요한 맥락을 없애라
  • 일반적으로는 짧은 이름이 긴 이름보다 좋다. 단, 의미가 분명한 경우에 한해서다. 이름에 불필요한 맥락을 추가하지 않도록 주의해야 한다.
  • ‘고급 휘발유 충전소(Gas Sattion Deluxe)’라는 애플리케이션을 짠다고 모든 클래스 이름을 GSD로 시작하겠다는 생각은 버려야 한다.

깨끗한 코드

비야네 스트롭스트룹: C++ 창시자이자 The C++ Programming Language 저자

나는 우아하고 효율적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지보수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 깨끗한 코드는 한 가지를 제대로 한다.

오라클에서 쿼리문을 작성하다 보면, 하나의 쿼리문으로 INSERT, UPDATE, DELETE 작업을 해야 하는 경우가 있다.

[JavaScript] 문자 인코딩 함수 : escape() encodeURI() encodeURIComponent()