도서 요약

[클린 코드] 17. 냄새와 휴리스틱

클린 코드 도서 요약 내용입니다. 17장 냄새와 휴리스틱 마틴 파울러의 Refactoring에서 '코드 냄새'와 내가 맡은 냄새를 추가했다. 주석 C1: 부적절한 정보 다른 시스템에 (예를 들어, 소스 코드 관리 시스템, 버그 추적 시스템, 이슈 추적 시스템, 기타 기록 관리 시스템에) 저장할 정보는 주석으로 적절하지 못하다. 일반적으로 작성자, 최종 수정일, SPR(Software Problem Report) 번호 등과 같은 메타 정보만 주석으로 넣는다. 주석은 코드와 설계에 기술적인 설명을 부연하는 수단이다. C2: 쓸모 없는 주석 오래된 주석, 엉뚱한 주석, 잘못된 주석은 더 이상 쓸모가 없다. 주석은 빨리 낡는다. 쓸모 없어질 주석은 아예 달지 않는 편이 가장 좋다. 쓸모 없어진 주..

2022. 12. 19. 10:18

도서 요약

[클린 코드] 14. 점진적인 개선

클린 코드 도서 요약 내용입니다. 14장 점진적인 개선 Args 구현 여기저기 뒤적일 필요 없이 위에서 아래로 코드가 읽힌다는 사실에 주목한다. 어떻게 짯느냐고? 나는 위 프로그램을 처음부터 저렇게 구현하지 않았다. 더욱 중요하게는 여러분이 깨끗하고 우아한 프로그램을 한 방에 뚝딱 내놓으리라 기대하지 않는다. 지난 수십여년 동안 쌓아온 경험에서 얻은 교훈이라면, 프로그래밍은 과학보다 공예에 가깝다는 사실이다. 깨끗한 코드를 짜려면 먼저 지저분한 코드를 짠 뒤에 정리해야 한다는 의미다. 초등학교 시절 선생님들도 작문할 때 초안부터 쓰라고 하셨다. 먼저 1차 초안을 쓰고, 그 초안을 고쳐 2차 초안을 만들고, 계속 고쳐 최종안을 만들라 말씀하셨다. 깔끔한 작품을 내놓으르면 단계적으로 개선해야 한다고 가르치려..

2022. 12. 19. 10:18

도서 요약

[클린 코드] 13. 동시성

클린 코드 도서 요약 내용입니다. 13장 동시성 동시성과 깔끔한 코드는 양립하기 어렵다. 아주 어렵다. 스레드를 하나만 실행하는 코드는 짜기 쉽다. 겉으로 보기에는 멀쩡하나 깊숙한 곳에 문제가 있는 다중 스레드 코드도 짜기 쉽다. 이런 코드는 시스템이 부하를 받기 전까지 멀쩡하게 돌아간다. 동시성이 필요한 이유 동시성은 결합(coupling)을 없애는 전략이다. 무엇(what)과 언제(when)를 분리하는 전략이다. 무엇과 언제를 분리하면 애플리케이션 구조와 효율이 극적으로 나아진다. 구조적인 관점에서 프로그램은 거대한 루프 하나가 아니라 작은 협력 프로그램 여럿으로 보인다. 따라서 시스템을 이해하기가 쉽고 문제를 분리하기도 쉽다. 예를 들어, 웹 애플리케이션이 표준으로 사용하는 서블릿 모델을 살펴보자...

2022. 12. 19. 10:17

도서 요약

[클린 코드] 12. 창발성

클린 코드 도서 요약 내용입니다. 12장 창발성 창발성: 남이 모르거나 하지 아니한 것을 처음으로 또는 새롭게 밝혀내거나 이루어 내는 성질. 착실하게 따르기만 한다면 우수한 설계가 나오는 간단한 규칙 네 가지가 있다면? 그래서 SRP나 DIP와 같은 원칙을 적용하기 쉬워진다면? 네 가지 규칙이 우수한 설계의 창발성을 촉진한다면? 창발적 설계로 깔끔한 코드를 구현하자 켄트 벡이 제시한 단순한 설계 규칙 네 가지 모든 테스트를 실행한다. 중복을 없앤다. 프로그래머 의도를 표현한다. 클래스와 메서드 수를 최소로 줄인다. 단순한 설계 규칙 1: 모든 테스트를 실행하라 무엇보다 먼저, 설계는 의도한 대로 돌아가는 시스템을 내놓아야 한다. 문서로는 시스템을 완벽하게 설계했지만, 시스템이 의도한 대로 돌아가는지 검증..

2022. 12. 19. 10:17

도서 요약

[클린 코드] 11. 시스템

클린 코드 도서 요약 내용입니다. 11장 시스템 "복잡성은 죽음이다. 개발자에게서 생기를 앗아가며, 제품을 계획하고 제작하고 테스트하기 어렵게 만든다." 레이 오지, 마이크로소프트 최고 기술 책임자 도시를 세운다면? 여러분이 도시를 세운다면? 온갖 세세한 사항을 혼자서 직접 관리할 수 있을까? 이미 세워진 도시라도 한 사람의 힘으로는 무리다. 그럼에도 불구하고 도시는 잘 돌아간다. 왜? 수도 관리팀, 전력 관리팀, 교통 관리 팀, 치안 관리 팀, 건축물 관리 팀 등 각 분야를 관리하는 팀이 있기 때문이다. 도시에는 큰 그림을 그리는 사람들도 있으며 작은 사항에 집중하는 사람들도 있다. 도시가 돌아가는 또 다른 이유는 적절한 추상화와 모듈화 때문이다. 시스템 제작과 시스템 사용을 분리하라 우선 제작(con..

2022. 12. 19. 10:16

도서 요약

[클린 코드] 10. 클래스

클린 코드 도서 요약 내용입니다. 10장 클래스 클래스 체계 정적 공개(static public) 상수가 있다면 맨 처음에 나온다. 다음으로 정적 비공개(private) 변수가 나오며 이어서 비공개 인스턴스 변수가 나온다. 변수 목록 다음에 공개 함수가 나온다. 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다. 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다. 캡슐화 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다. 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다. 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다. 클래스는 작아야 한다 클래스를 만들 때 첫 번째 규칙은 크기다. 클래..

2022. 12. 19. 10:15

도서 요약

[클린 코드] 9. 단위 테스트

클린 코드 도서 요약 내용입니다. 9장 단위 테스트 TDD 법칙 세 가지 첫째 법칙: 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다. 둘째 법칙: 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다. 셋째 법칙: 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다. 이렇게 일하면 매일 수십 개, 매달 수백 개, 매년 수천 개에 달하는 테스트케이스가 나온다. 하지만 실제 코드와 맞먹을 정도로 방대한 테스트 코드는 심각한 관리 문제를 유발하기도 한다. 깨끗한 테스트 코드 유지하기 테스트 코드가 지저분할수록 변경하기 어려워진다. 테스트 코드가 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸리기 십상이다. 새 버전이 출시할 때마다 ..

2022. 12. 19. 10:15

도서 요약

[클린 코드] 8. 경계

클린 코드 도서 요약 내용입니다. 8장 경계 시스템에 들어가는 모든 소프트웨어를 직접 개발하는 경우는 드물다. 때로는 패키지도 사고, 때로는 오픈 소스를 이용한다. 때로는 사내 다른 팀이 제공하는 컴포넌트를 사용한다. 어떤 식으로든 이 외부 코드를 우리 코드에 깔끔하게 통합해야만 한다. 외부 코드 사용하기 Map은 굉장히 다양한 인터페이스로 수많은 기능을 제공한다. 하지만 그만큼 위험도 크다. Map 사용자라면 누구나 Map 내용을 지울 권한이 있다는 말이다. 객체 유형을 제한하지 않는다. Map sensors = new HashMap(); Sensor s = (Sensor) sensors.get(sensorId); 이 코드를 다음 처럼 제네릭을 사용하면 코드 가독성이 크게 높아진다. Map sensor..

2022. 12. 19. 10:14

도서 요약

[클린 코드] 7. 오류 처리

클린 코드 도서 요약 내용입니다. 7장 오류 처리 여기 저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능하다는 의미다. 오류 처리는 중요하다. 하지만 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다. 오류 코드보다 예외를 사용하라 public class DeviceController { public void sendShutDown() { DeviceHandle handle = getHandle(DEV1); // 디바이스 상태를 점검한다 if (handle != DeviceHandle.INVALID) { // 레코드 필드에 디바이스 상태를 저장한다. retrieveDeviceRecord(handle); // 디바이스가 일시정지 상태가..

2022. 12. 19. 10:14

도서 요약

[클린 코드] 6. 객체와 자료 구조

클린 코드 도서 요약 내용입니다. 6장 객체와 자료 구조 변수를 비공개(private)로 정의하는 이유가 있다. 남들이 변수에 의존하지 않게 만들고 싶어서다. 자료 추상화 두 클래스 모두 2차원 점을 표현한다. 그런데 한 클래스는 구현을 외부로 노출하고 다른 클래스는 구현을 완전히 숨긴다. public class Point { public double x; public double y; } public interface Point { double getX(); double getY(); void setCatesian(double x, double y); double getR(); double getTheta(); void setPolar(double r, double theta); } 추상 인터페이스를 ..

2022. 12. 19. 09:56

도서 요약

[클린 코드] 4. 주석

클린 코드 도서 요약 내용입니다. 4장 주석 나쁜 코드에 주석을 달지 마라. 새로 짜라. 브라이언 W. 커니핸, P.J.플라우거 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. 주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. 우리는 코드로 의도를 표현하지 못해, 그러니깐 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 ..

2022. 12. 19. 09:55

도서 요약

[클린 코드] 5. 형식 맞추기

클린 코드 도서 요약 내용입니다. 5장 형식 맞추기 뚜껑을 열었을 때 독자들은 코드가 깔끔하고 일관적이며 꼼꼼하다고 감탄하면 좋겠다. 질서 정연하다고 탄복하면 좋겠다. 모듈을 읽으며 두 눈이 휘둥그래 놀라면 좋겠다. 전문가가 짰다는 인상을 심어주면 좋겠다. 프로그래머라면 형식을 깔깜하게 맞춰 코드를 짜야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. 형식을 맞추는 목적 코드 형식은 중요하다! 너무 중요해서 무시하기 어렵다. 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다. 어쩌면 '돌아가는 코드'가 전문 개발자의 일차적인 의무라 여길지도 모르겠다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 코드가 바뀌어도 맨 처음 잡아놓은 구..

2022. 12. 19. 09:55

도서 요약

[클린 코드] 3. 함수

클린 코드 도서 요약 내용입니다. 3장 함수 작게 만들어라! 함수를 만드는 첫째 규칙은 '작게!'다. 둘째 규칙은 '더 작게'다. 얼마나 짧아야 하느냐고? public static String renderPageWithSetupsAndTeardowns(PageData pageData, boolean isSuite) { if (isTestPage(pageData)) includeSetupAndTeardownPages(pageData, isSuite); return pageData.getHtml(); ) 블록과 들여쓰기 if문/else문/while 문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 한 가지만 해라! 함..

2022. 12. 19. 09:54

도서 요약

[클린 코드] 2. 의미 있는 이름

클린 코드 도서 요약 내용입니다. 2장 의미 있는 이름 들어가면서 소프트웨어에서 이름은 어디나 쓰인다. 변수, 함수, 인수와 클래스, 패키지, 소스파일, 디렉토리, jar파일, war파일, ear 파일 이 장에서는 이름을 잘 짓는 간단한 규칙을 몇가지 소개한다. 의도를 분명히 밝혀라 의도가 분명한 이름이 정말로 중요하다는 사실을 거듭 강조한다. 좋은 이름을 지으려면 시간이 걸리지만 좋은 이름으로 절약하는 시간이 훨씬 더 많다. 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다. int d; // 경과 시간(단위: 날짜) 이름 d는 아무 의미도 드러나지 않는다. 경과시간이나 날짜라는 느낌이 안든다. 측정하려는 값과 단위를 표현하는 이름이 필요하다. int elapsedTimeInDays; int d..

2022. 12. 19. 09:54

도서 요약

[클린 코드] 1. 깨끗한 코드

클린 코드 도서 요약 내용입니다. 1장 깨끗한 코드 이 책을 읽고 있다면 이유는 두 가지다. 프로그래머라서 더 나은 프로그래머가 되려고 이 책은 좋은 프로그램 작성 요령을 설명하는 책이다. 코드를 최대한 다양한 각도에서 살펴본다. 이 책을 읽고 나면 코드에 대한 많은 사실을 배운다. 좋은 코드와 나쁜 코드를 구분하는 능력도 생긴다. 좋은 코드를 작성하는 방법도 익힌다. 나쁜 코드를 좋은 코드로 바꾸는 실력도 쌓인다. 코드가 존재하리라 코드를 자동으로 생성하는 시대가 다가온다? 헛소리! 앞으로 코드가 사라질 가망은 전혀 없다. 왜? 코드는 요구사항을 상세히 표현하는 수단이니까! 어느 정도 수준이 되면 코드의 도움없이 요구사항을 표현하기란 불가능하다. 요구사항을 명시하는 수밖에 없다. 기계가 실행할 정도로 ..

2022. 12. 19. 09:54