[💻 Programming] Clean Code - 깨끗한 함수는 어떻게 작성할까?

안녕하세요 Foma 👟 입니다!

 

항상 함수를 작성하면서 "파라미터는 몇 개가 적당할까?", "어느정도 단위로 써야할까?" 등

 

함수를 적절하기 쓰기 위해서 고민했었는데요.

 

"클린 코드" 책을 통해서 깔끔한 함수를 작성하는 법에 대해 알게 되어 정리해보려고 합니다.

---

1. 더 작게

 

깔끔한 함수를 작성하기 위해선 이 책의 저자인 마틴은 최대한 작게 더 작게 쓰라고 강조합니다.

 

(실제로 익스트림 프로그래밍 개발자인 "켄트 백"이 작성한 함수는 2줄에서 4줄로밖에 이루어져 있지 않다고 하네요)

 

"그렇다면 작게 쓰는 것의 기준은 어느 정도일까요?"

 

함수 안에서 if/else/while문에 쓰이는 블록은 한 줄이 적당하고 들여쓰기는 1단에서 2단을 넘어서면 안된다고 합니다.

 

이렇게 작게 함수를 작성해야 더 이해하기 쉽고 읽기 쉬운 코드를 작성할 수 있습니다.

---

2. 한가지만 해라

 

함수를 작게 쓰기 위해선 어떻게 해야 할까요?

 

적은 일을 해야 할 것입니다.

 

즉, 함수 내에선 여러가지 일을 처리하는 것이 아닌 한 개의 함수에서 한 가지 일만 하도록 하는 것 입니다.

 

예를 들면 아래와 같이 계산을 해주는 연산자에 따라서 함수가 있다고 가정하겠습니다.

 

나쁜 예 ❌

 

func calculate(n1:Int,n2:Int,op:String) -> Int {
    if op == "*" {
        return n1*n2
    }else if op == "+" {
        return n1+n2
    }else if op == "-" {
        return n1-n2
    }else {
        return n1/n2
    }
}

 

한 가지 일만 하도록 함수를 짜게 하면 어떻게 될까요?

 

좋은 예 👍🏻

 

func add(n1:Int,n2:Int) -> Int {
    n1+n2
}

func minus(n1:Int,n2:Int) -> Int {
    n1-n2
}

func multiply(n1:Int,n2:Int) -> Int {
    return n1*n2
}

func divide(n1:Int,n2:Int) -> Int {
   return n1/n2
}

---

3. 서술적인 이름을 사용해라

 

지난 "깨끗한 코드란?" 글에서 위키 창시자인 워드는 "짐작했던 기능이 그대로 수행한다면 좋은 코드다." 라고 했습니다.

 

즉, 함수의 이름을 자세하게 지을수록 함수가 수행하는 기능을 짐작하기 쉬울 것 입니다.

 

아무리 길더라도 충분한 설명이 되는 이름이 짧고 어려운 이름보다 낫다고 말합니다.

 

나쁜 예 ❌

 

func isValid(email:String) -> Bool {
    return email.contains("@")
}

 

좋은 예 👍🏻

 

func isEmailContainsAtsign(email:String) -> Bool {
    return email.contains("@")
}

---

4. 이상적인 인수

 

함수에서 이상적인 인수의 개수는 하나도 없는 것이 가장 좋고 불가피 한 경우 이항에서 삼항까지 사용하지만

 

그 이상 즉, 4개는 특별한 이유가 있더라도 사용하면 안된다고 말합니다.

 

그렇다면 어떻게 인수를 줄일 수 있을까요?

 

바로 객체를 사용하는 것과 한 가지 일만 하도록 하는 것입니다.

 

아래와 같이 풀네임을 만들어 주는 함수가 있습니다.

 

하지만 영어로 된 이름은 성이 뒤로 가게 해야하고 한글로 된 이름은 성이 앞으로 가게 해야합니다.

 

나쁜 예 ❌

 

func makeFullName(firstName:String,lastName:String,isEnglish:Bool) -> String{
    if isEnglish {
        return lastName + firstName
    }else {
        return firstName + lastName
    }
}

 

좋은 예 👍🏻

 

아래와 같이 Name이란 객체를 만들고 영어로 된 이름과 한글로 된 이름 풀네임을 만드는 함수를 분리하면

 

3항에서 단항 함수로 인수를 줄일 수 있습니다.

 

struct Name {
    let first:String
    let last:String
}

func makeKoreanFullName(name:Name) -> String{
    return name.first +  name.last
}

func makeEnglishFullName(name:Name) -> String{
    return name.last +  name.first
}

---

5. 오류 처리

 

보통 오류를 처리할 때 함수 내에서 일어나는 오류라면 바로 처리하는 경우가 많았습니다.

 

그러다보면 오류를 처리하는 코드 try catch 구문 등으로 함수가 길어지게 됩니다.

 

또한 오류도 한가지 작업 중에 하나이기 때문에 따로 분리하는 것이 좋다고 말합니다.

 

 

나쁜 예 ❌

 

enum UserError:Error{
    case emptyString
    case containSpecialSymbol
    case containNumber
    case negativeNumber
}

struct User {
    let name:String
    let age:Int
}

func signUp(user:User) throws -> User{
    let user = User(name: "Fomagran", age: 26)
    
    if user.name.isEmpty {
        throw UserError.emptyString
    }
    
    if user.name.contains("@") {
        throw UserError.containSpecialSymbol
    }
    
    if user.name.filter({$0.isNumber}).count > 0 {
        throw UserError.containNumber
    }
    
    if user.age < 0 {
        throw UserError.negativeNumber
    }
    
    return user
}

 

좋은 예 👍🏻

 

오류를 검사하는 함수와 오류를 체크하는 함수를 따로 만들어서 signUp 함수는 간결하게 작성하도록 합니다.

 

func isValidUserInfo(user:User) throws -> User {
    if user.name.isEmpty {
        throw UserError.emptyString
    }
    
    if user.name.contains("@") {
        throw UserError.containSpecialSymbol
    }
    
    if user.name.filter({$0.isNumber}).count > 0 {
        throw UserError.containNumber
    }
    
    if user.age < 0 {
        throw UserError.negativeNumber
    }
    return user
}

func checkUserError(user:User) -> User?{
    do {
        return try isValidUserInfo(user: user)
    }
    catch {
        print(error)
        return nil
    }
}

func signUp(user:User) -> User? {
    let validUser = checkUserError(user: user)
    return validUser
}