1. 이해하기 힘든 이름

2. 함수 선언 변경하기(Change Function Declaration)

3. 변수 이름 바꾸기(Rename Variable == Local Variable)

4. 필드 이름 바꾸기(Rename Field == Global Variable)

1. 이해하기 힘든 이름(Mysterious Name)

• 깔끔한 코드에서 가장 중요한 것 중 하나가 바로 좋은 이름이다.

• 함수, 변수, 클래스, 모듈의 이름 등 모두 어떤 역할을 하는지 어떻게

  쓰이는지 직관적이어야 한다.

• 사용할 수 있는 리팩토링 기술

  • 함수 선언 변경하기(Change Function Declaration)
  • 변수 이름 바꾸기(Rename Variable)
  • 필드 이름 바꾸기(Rename Field)

2. 함수 선언 변경하기(Change Function Declaration)

2-1) 함수 변경하기-1

• 함수 이름 변경하기, 메소드 이름 변경하기, 매개변수 추가하기,

  매개변수 제거하기, 시그니처 변경하기

2-2) 함수 변경하기-2

• 좋은 이름을 가진 함수는 함수가 어떻게 구현되었는지 코드를 보지 않아도 이름만

  보고도 이해할 수 있다.

• 좋은 이름을 찾아내는 방법은?

  • 함수에 주석을 작성한 다음, 주석을 함수 이름으로 만들어보기

• 함수 매개변수

  • 함수 내부의 문맥을 결정한다.(예, 전화번호 포매팅 함수)
  • 의존성을 결정한다.(예, Payment 만기일 계산 함수)

2-3) 함수 변경하기 리팩토링

2-3)-1. 리팩토링 전

• 코드

  public class StudyDashboard {
  
      private Set<String> usernames = new HashSet<>();    // 리뷰어
      private Set<String> reviews = new HashSet<>();      // 리뷰
  
  		// '스터디 리뷰 이슈'에 작성되어 있는'리뷰어'목록과'리뷰'를 읽어온다.
  		private void studyReviews(GHIssue issue) throws IOException {
          List<GHIssueComment> comments = issue.getComments();
  
          for (GHIssueComment comment : comments) {
              usernames.add(comment.getUserName());
              reviews.add(comment.getBody());
          }
      }
  
      public Set<String> getUsernames() {return usernames;}
      public Set<String> getReviews() {return reviews;}
  
      public static void main(String[] args) throws IOException {
  
          GitHub gitHub = GitHub.connect();
          GHRepository repository = gitHub
  											.getRepository("whiteship/live-study");
          GHIssue issue = repository.getIssue(30);
  
          StudyDashboard studyDashboard = new StudyDashboard();
  
          studyDashboard.studyReviews(issue);
          studyDashboard.getUsernames().forEach(System.out::println);
          studyDashboard.getReviews().forEach(System.out::println);
      }
  }
  

• 이미지

  • 1. 함수 변경

    • studyReviews라는 메소드명을 대신 직관적인 이름으로 변경할 거임.

      studyReviews 메소드의 역할은 ‘리뷰어’와 ‘리뷰'를 읽어오는 역할을 하기 때문에

      studyReviews라는 이름은 모호하다.

  • 2. 메소드에 파라미터 값 없애기
    • id : 30 하나를 받고 있기 때문에 굳이 메소드에 파라미터를 추가할 필요가 없어짐.
    • main 메소드에서 기존 메소드로 옮겨서 파라미터값 없애주기

  

2-3)-2. 리팩토링 후

• 코드

  public class StudyDashboard {
  
      private Set<String> usernames = new HashSet<>();    // 리뷰어
      private Set<String> reviews = new HashSet<>();      // 리뷰
  
  		// 1) studyReviews의 이름 변경과 2) 메소드 파라미터 값 없애기
      private void loadReviews() throws IOException {
          // main메소드에 있는 부분을 loadReviews메소드로 옮겨와
  				// loadReviews(GHIssue issue)에서 loadReviews()로 변경해보기
  				GitHub gitHub = GitHub.connect();
          GHRepository repository = gitHub
  											.getRepository("whiteship/live-study");
          GHIssue issue = repository.getIssue(30);
  
          List<GHIssueComment> comments = issue.getComments();
          for (GHIssueComment comment : comments) {
              usernames.add(comment.getUserName());
              reviews.add(comment.getBody());
          }
      }
  
      public Set<String> getUsernames() {return usernames;}
      public Set<String> getReviews() {return reviews;}
  
      public static void main(String[] args) throws IOException {
  
  				// 2) 메소드의 파라미터 값 없애기
  				// GitHub gitHub = GitHub.connect();
  				// GHRepository repository = gitHub
  								//.getRepository("whiteship/live-study");
  				// GHIssue issue = repository.getIssue(30);
          StudyDashboard studyDashboard = new StudyDashboard();
  
  				// studyDashboard.studyReviews(issue);
          studyDashboard.loadReviews();
          studyDashboard.getUsernames().forEach(System.out::println);
          studyDashboard.getReviews().forEach(System.out::println);
      }
  }
  
  

3. 변수 이름 바꾸기(Rename Variable)

3-1) 개념 잡기

• 더 많이 사용되는 변수일수록 그 이름이 더 중요하다.
  • 람다식에서 사용하는 변수 vs 함수의 매개변수
• 다이나믹 타입을 지원하는 언어에서는 타입을 이름에 넣기도 한다.
• 여러 함수에 걸쳐 쓰이는 필드 이름에는 더 많이 고민하고 이름을 짓기
• 처음부터 좋은 이름을 짓기 어렵다. 자연스럽게 받아들이기

3-2) 리팩토링 전

• 코드

  public class StudyDashboard {
  
      private Set<String> usernames = new HashSet<>();    // 리뷰어
      private Set<String> reviews = new HashSet<>();      // 리뷰
  
      private void loadReviews() throws IOException {
          GitHub gitHub = GitHub.connect();
          GHRepository repository = gitHub
  												.getRepository("whiteship/live-study");
          GHIssue issue = repository.getIssue(30);
  	
  				// 지역변수(바꿀 필요 있음)
          List<GHIssueComment> comments = issue.getComments();
          for (GHIssueComment comment : comments) {
              usernames.add(comment.getUserName());
              reviews.add(comment.getBody());
          }
      }
  
      public Set<String> getUsernames() {return usernames;}
      public Set<String> getReviews() {return reviews;}
  
      public static void main(String[] args) throws IOException {
          // 지역 변수(OK)
          StudyDashboard studyDashboard = new StudyDashboard();
          studyDashboard.loadReviews();
  
          // 람다식에서 사용하는 변수(인텔리제이에서 추천하는 메소드 레퍼런스로 바꾸기)
          studyDashboard.getUsernames()
  												.forEach(name -> System.out.println(name));
          studyDashboard.getReviews()
  												.forEach(review -> System.out.println(review));
      }
  }
  

• 이미지

  • 지역변수(Local Variable)
    • comments → reviews
    • comment → review
    • 지역 변수(리뷰에 달린 댓글이 맞기 하지만 구체적으로 한다면 리뷰를 읽어오는 함수이기에 reviews나 review가 좀 더 적절하다.
  • 람다식
    • 람다식 → 인텔리제이에서 추천하는 레퍼런스 메소드로 변경

  

3-3) 리팩토링 후

public class StudyDashboard {

    private Set<String> usernames = new HashSet<>();
    private Set<String> reviews = new HashSet<>();

    private void loadReviews() throws IOException {
        GitHub gitHub = GitHub.connect();
        GHRepository repository = gitHub
												.getRepository("whiteship/live-study");
        GHIssue issue = repository.getIssue(30);

        // 지역 변수 : Local Variable(comments와 comment를 reviews와 review)
        List<GHIssueComment> reviews = issue.getComments();
        for (GHIssueComment review : reviews) {
            usernames.add(review.getUserName());
            reviews.add(review.getBody());
        }
    }

    public Set<String> getUsernames() {return usernames;}
    public Set<String> getReviews() {return reviews;}

    public static void main(String[] args) throws IOException {
        // 지역 변수 : Local Variable(OK)
        StudyDashboard studyDashboard = new StudyDashboard();
        studyDashboard.loadReviews();

        // 람다식에서 사용하는 변수(인텔리제이 레퍼런스 함수)
        studyDashboard.getUsernames().forEach(System.out::println);
        studyDashboard.getReviews().forEach(System.out::println);
    }
}

4. 필드 이름 바꾸기(Rename Field == Global Variable)

4-1) 개념

• Record 자료 구조의 필드 이름은 프로그램 전반에 걸쳐 참조될 수 있개 때문에 매우 중요
• 자바 14버전부터 지원.
• 자바에서는 Getter와 Setter 메소드 이름도 필드의 이름과 비슷하게 간주 됨.

4-2) 리팩토링 전

• 코드

  public class StudyDashboard {
  
      // 전역변수(Global)
      private Set<String> usernames = new HashSet<>();    // 리뷰어
      private Set<String> reviews = new HashSet<>();      // 리뷰
  
      private void loadReviews() throws IOException {
          GitHub gitHub = GitHub.connect();
          GHRepository repository = gitHub
  												.getRepository("whiteship/live-study");
          GHIssue issue = repository.getIssue(30);
  
          List<GHIssueComment> reviews = issue.getComments();
          for (GHIssueComment review : reviews) {
              usernames.add(review.getUserName());
              reviews.add(review.getBody());
          }
      }
  
      public Set<String> getUsernames() {return usernames;}
      public Set<String> getReviews() {return reviews;}
  
      public static void main(String[] args) throws IOException {
          StudyDashboard studyDashboard = new StudyDashboard();
          studyDashboard.loadReviews();
  
          studyDashboard.getUsernames().forEach(System.out::println);
          studyDashboard.getReviews().forEach(System.out::println);
      }
  }
  

• 이미지

  • 전역변수(Global Variable)
    • usernames → reviewers로 변경하는 게 좀 더 직관적이다.

  

4-3) 리팩토링 후

public class StudyDashboard {

    // 전역변수(Global)
    private Set<String> reviewers = new HashSet<>();    // 리뷰어
    private Set<String> reviews = new HashSet<>();      // 리뷰

    private void loadReviews() throws IOException {
        GitHub gitHub = GitHub.connect();
        GHRepository repository = gitHub.getRepository("whiteship/live-study");
        GHIssue issue = repository.getIssue(30);

        List<GHIssueComment> reviews = issue.getComments();
        for (GHIssueComment review : reviews) {
						// 전역변수 수정 후 
            reviewers.add(review.getUserName());
            reviews.add(review.getBody());
        }
    }

		// 전역 변수 수정 후 
    public Set<String> getReviewers() {return reviewers;}
    public Set<String> getReviews() {return reviews;}

    public static void main(String[] args) throws IOException {
        StudyDashboard studyDashboard = new StudyDashboard();
        studyDashboard.loadReviews();

        studyDashboard.getReviewers().forEach(name -> System.out.println(name));
        studyDashboard.getReviewers().forEach(System.out::println);
        studyDashboard.getReviews().forEach(System.out::println);
    }
}