#17 Clean Code

● 도입

- 하나의 API에서 너무 많은 기능을 수행하고 있으면 유지보수 및 오류 대응에 어려움이 있을 수 있다.

- 아래의 UPDATE API만 보더라도 3가지의 기능을 담고 있다.

@RestController
public class UserController {
    // JdbcTemplate를 이용해 DB에 접근한다.
    private final JdbcTemplate jdbcTemplate;

    // jdbcTemplate을 생성자에 직접 넣어주지 않아도 spring이 알아서 jdbcTemplate을 넣어준다.
    public UserController(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    1. API 진입 지점으로써 HTTP Body를 객체로 변환
    @PutMapping("/user")
    public void updateUser(@RequestBody UserUpdateRequest request) {
    
        2. 현재 유저가 있는지 없는지 확인하고 예외 처리
        String readSql = "SELECT * FROM USER WHERE ID = ?";
        boolean isUserNotExist = jdbcTemplate.query(readSql, (rs, rowNum) -> 0, request.getId()).isEmpty(); // 조회했을 때 데이터가 있으면 0을 반환
        if(isUserNotExist) {
            throw new IllegalArgumentException();
        }
        
        3. SQL을 사용해 실제 DB와 통신
        String sql = "UPDATE USER SET NAME = ? WHERE ID = ?";
        jdbcTemplate.update(sql, request.getName(), request.getId());
    }
}

- 위의 코드는 그나마 간단한 수준이지만 만약 하나의 API에서 10개 이상의 테이블을 사용하는 경우 그 복잡도는 매우 크게 증가할 것이며 코드 가독성도 매우 떨어진다.

- best는 위의 updateUser 함수를 각각의 역할에 맞게 3단으로 분리하는 것이다.

[결론]
- 하나의 함수(메소드)에서 모든 기능을 구현하면 안 된다.
- 이 문제는 Spring을 이용해 해결할 수 있다.

---

● Clean Code

- 아래 왼쪽 사진에서 상단의 지저분한 코드는 하단의 코드로 간단하게 나타낼 수 있다. 딱 봐도 가독성의 수준이 다르다.

- 또한 함수명을 이용해 어떠한 기능을 하는 코드인지 대략적이나마 파악이 가능하다.

- 당연한 얘기로 안 좋은 코드의 양과 개발 생산성은 반비례하게 된다.

인프런 - 자바와 스프링 부트로 생애 최초 서버 만들기, 누구나 쉽게 개발부터 배포까지!(최태현)

---

- 그렇다면 도대체 왜 하나의 API 메소드 내에서 모든 기능을 구현하면 안될까?

Clean Code
- 함수는 최대한 작게 & 한 가지 일만 수행하는 것이 좋다.
- class는 작아야 하며 하나의 책임만을 가져야한다.

ex) 하나의 함수가 1000줄이 넘어가는 경우 발생할 수 있는 부작용

1. 함수를 동시에 여러 명이 수정할 수 없다.
2. 함수를 읽고 이해하는 것이 너무 어렵다.
3. 함수의 일부분만 수정하더라도 함수 전체에 영향을 미칠 수 있기 때문에 수정하기 쫄린다.

(영향을 미치는지조차 제대로 파악하기가 힘들다.)
4. 너무 큰 기능이기 때문에 테스트도 힘들다.
5. 종합적으로 유지보수성이 떨어진다.