/IOS-Project-Rules

IOS 개발을 위한 규칙 모음집

Apache License 2.0Apache-2.0

프로젝트 진행이 힘들다 생각하시면, 당근을 넣어 주세요 🥕

IOS 프로젝트 진행을 위한 Himelo Rules

우리의 난리치는 코드를 피하기위해서 시작도 전에 정리하고자 규칙을 정해볼까 합니다..
선생님들도 번뜩이는 아이디어가 생기신다면 추가해 주시길 부탁드립니다...
Sections

Caution

스토리보드 파일 절대 공동 작업 금지

습관성 클릭 및 드래그 금지

다른사람 스토리보드 건들면 텍사스데브라질 쏘기

Naming Rule

상수와 변수를 구분하여 선언해 주세요. xcode project 내에서, ⌥ Option + click 으로 선언한 상수 또는 변수의 정확한 type을 확인할 수 있습니다.

Camel case를 따라 작성해주도록 합시다

함수 이름은 아직 정하진 않았지만, 너무 자기 맘대로 하지는 않았음 좋겠습니다. 자료 조사좀 더 하고 자세한 규칙 정해봅시다.

ex) 로그인 버튼을 터치했을 때 실행하는 함수

  func onPress_UserLogin(){...}  // x
  func handleLoginButtonPress(){...} // 0

상수/변수 이름은 Camel case rule에 따라 잘 작성해주십쇼. 단일 명사로 이름을 지을 때 단순한 (count, name, userID 등)
네이밍은 편하게 지어주세요.
그런데 단순 명사로 표현하기 힘들때, 길어도 더 이해하기 쉽게 작성좀 부탁드립니다. 괴롭습니다.

  /// nOfC 가 뭐지?
  let nOfC = 12;
  let numberOfCarrot = 12;
  
  /// to 가 뭐지?
  func printHello(to: String) {
    print ("Hello " + to)
  }
  printHello(to: "원영")

또한 상수/변수를 구분하여 선언해주세요.

  // Constant
  let numberOfCarrot = 5;
  
  // Variable
  var numberOfCarrot = "10";

Class, Struct와 enum은 대문자로 시작해서 선언합시다.

  // Struct
  struct Rectangle {
    let width: Int
    let height: Int
    
    var area: Int {
        return width * height
    }
    
    func isBiggerThan(_ rectangle: Rectangle) -> Bool {
        return area > rectangle.area
    }
  }
  
  // Enum
  // enum은 복수형은 사용하지 않습니다.
  enum FoodChoice{
    case apple, orange, banana
    
    switch self{
    case .apple
      return "🍎"
    case .orange
      return "🍊"
    case .banana
      return "🍌"
    }
  }

Types

선언한 상수/변수에 대하여 해당 타입을 정확히 명시해 주세요. 함수나 배열에도 마찬가지에요. 파라미터와 인자에도 정확한 타입을 명시해주세요.

 let numberOfCarrot : Int = 5;
 var currentState : String = "logged";
 let array : [Int] = [1,2,3,4,5];
 func handleUserActionOnPress(state : String) { ... };
 
 // 간단하게 인자를 명시할 때도 마찬가지로요
 func example(num : Int) -> Int{
    return num;
  }
  print(example(num: 10));

swift에서는, 프로그래머의 귀찮은 타입 명시를 그나마 편안하게 하기 위해서 다음과 같이 _ 문자를 통해 타입 입력을 제한할 수 있는데 우리는 하지 맙시다.

func printHelloTo(_ name: String) {
    print("Hello " + name + "🥕");
}

개발할때, 안정적인 프로그램을 만들고자 변수보다는 상수를, Class보다는 Struct을 써주세요.

Parameters and Results

Struct

Struct의 custom initalizer 사용법

  struct Rectangle {
    let width: Int
    let height: Int
    
    var area: Int {
        return width * height
    }
    
    init(myWidth: Int, myHeight: Int){
      area = myWidth * myHeight + 10
    }
    
    func isBiggerThan(_ rectangle: Rectangle) -> Bool {
        return area > rectangle.area
    }
  }

Struct 내부의 property 값을 바꾸는 method는 mutating을 사용해야합니다.

  struct Odometer {
    var count: Int = 0
    
    mutating func increment() {
      count += 1
    }
  }
  
  var odometer = Odometer()
  odometer.increment()

Coding Style

강의에 나온것 같이(App Dev 19강) Outlet은 viewDidLoad()위에 Action은 아래에 작성합시다.

  class ViewController: UIViewController {
    @IBOutlet weak var toggle: UISwitch!
    @IBOutlet weak var slider: UISlider!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
    }

    @IBAction func buttonTapped(_ sender: Any) {
        print("Button was tapped!")
        
        if toggle.isOn{
            print("The switch is on!")
        } else {
            print("The switch is off!")
        }
    }
  }

Singleton Pattern

객체를 하나만 생성하여, 생성된 객체를 어디서든 참조할 수 있도록 하는 패턴입니다.

생성
static 변수에 Singleton Pattern을 적용할 클래스의 인스턴스를 할당 initializer를 private으로 설정하여 다른 곳에서 또 인스턴스를 생성하지 못하도록 해야한다. (Thread-safe)

class Singleton { 
  static let shared = Singleton() 
  private init() {} 
  
  func printMessage(_ msg: String) { 
    print(msg) } 
  }

사용
클라이언트에서 .shared 변수를 불러와 사용

  Singleton.shared.printMesage()

High Order Function

Map

Map 함수는 컨테이너가 담고 있던 각각의 값을 매개변수를 통해 받은 함수에 적용한 후 새로운 컨테이너를 생성하여 반환합니다 (기존 컨테이너의 값은 변경되지 않고!) 시퀀스(Sequence), 콜렉션(Collection) 프로토콜을 따르는 타입과 옵셔널은 모두 맵을 사용할 수 있고. (배열, 딕셔너리, 세트, 옵셔널) for-in 구문 사용하는것과 비슷하나 코드가 더 간결하고 컴파일러 차원에서 성능 차이가 있으므로, 가능한 사용하는 것을 권장하지만
복잡한 Closure 사용은 오히려 코드를 읽는데 더 방해되니까 적당히 알아서..

// In Array
    let array = [0, 1, 2, 3]
    let newArray = array.map { $0 * 5 }
    print(newArray) //[0, 5, 10, 15]
  
// In Dictionary
    let dictionary = ["key1":"value1", "key2":"value2"]
    let keys = dictionary.map { $0.0 }
    let values = dictionary.map { $0.1 }

    print(keys) //["key1", "key2"]
    print(values) //["value1", "value2"]

    let keys2 = dictionary.map { $0.0 + "a" }
    let values2 = dictionary.map { $0.1 + "b" }

    print(keys2) //["key1a", "key2a"]
    print(values2) //["value1b", "value2b"]

Filter

Reduce

FlatMap