- 사진, 인바디 정보, 운동 루틴으로 몸의 변화를 쉽게 관찰할 수 있는 헬스 기록 앱
- 평소 취미인 헬스를 하면서 필요한 기능들을 직접 기획하고 개발한 서비스입니다.
- 진행 기간
- 개발 : 2023.03 ~ 2023.08
- 출시
- 1.0.0 : 2023.07.28
- 기술 스택
- iOS : UIKit, SwiftUI, Rxswift, SwiftLint, Charts
- Deployment Target : iOS 16.0
- SwiftUI의 Charts 프레임워크를 사용하기 위해 16버전을 사용했습니다.
- 중복되는 코드를 줄이고 재사용성을 높이고자 했습니다.
- RealmManager의 테스트 코드를 작성할 수 있게끔 구성했습니다.
- ViewModel 마다 RealmSwift에 접근하는 코드를 반복적으로 사용해, 같은 기능을 하는 코드가 많아지는 문제점 발생
- protocol과 DI를 활용해 반복되는 코드를 묶어 코드 재사용성을 높이고자 했습니다.
- 기본적인 CRUD 기능을 가진 프로토콜을 정의
- 프로토콜을 채택하며 Realm의 CRUD 기능을 가진 RealmManager 생성
- RealmManager에 의존하는 각각의 데이터에 접근할 수 있는 DataManager 생성
import RealmSwift
protocol DataManager {
func createData<T>(data: T)
func readData<T: Object>(id: Int, type: T.Type) -> T?
func updateData<T: Object>(data: T, updateBlock: (T) -> Void)
func deleteData<T>(data: T)
}- Realm에서 사용될 기본적인
CRUD기능을 프로토콜로 정의해주었습니다.
class RealmManager: DataManager {
let realm: Realm
init(realm: Realm) {
self.realm = realm
}
// create
func createData<T>(data: T) {
do {
try realm.write {
if let dataArray = data as? [Object] {
realm.add(dataArray)
} else if let object = data as? Object {
realm.add(object)
} else {
print("Unsupported data type: \(type(of: data))")
}
}
} catch {
print("Error saving data: \(error)")
}
}
// read
func readData<T: Object>(id: Int, type: T.Type) -> T? {
let data = realm.object(ofType: type, forPrimaryKey: id)
return data
}
// update
func updateData<T: Object>(data: T, updateBlock: (T) -> Void) {
do {
try realm.write {
updateBlock(data)
}
} catch {
print("Error saving data: \(error)")
}
}
// delete
func deleteData<T>(data: T) {
do {
let realm = try Realm()
try realm.write {
if let data = data as? Object {
realm.delete(data)
} else {
print("Unsupported data type: \(type(of: data))")
}
}
} catch {
print("Error deleting data: \(error)")
}
}
}- 프로토콜을 채택해
CRUD기능을 만들어 주었습니다.
class BodyInfoDataManager {
let realmManager: RealmManager
init(realmManager: RealmManager) {
self.realmManager = realmManager
}
func readBodyInfoData(id: Int) -> BodyInfo? {
let bodyInfoData = realmManager.readData(id: id, type: WorkOutDoneData.self)?.bodyInfo
return bodyInfoData
}
func createBodyInfoData(weight: Double?, skeletalMusleMass: Double?, fatPercentage: Double?, date: String, id: Int) {
let workoutDoneData = WorkOutDoneData(id: id, date: date)
let bodyInfo = BodyInfo()
bodyInfo.weight = weight
bodyInfo.skeletalMuscleMass = skeletalMusleMass
bodyInfo.fatPercentage = fatPercentage
workoutDoneData.bodyInfo = bodyInfo
realmManager.createData(data: workoutDoneData)
}
func deleteBodyInfoData(id: Int) {
if let workoutDoneData = realmManager.readData(id: id, type: WorkOutDoneData.self) {
realmManager.deleteData(data: workoutDoneData.bodyInfo!)
}
}
func updateBodyInfoData(workoutDoneData: WorkOutDoneData, weight: Double?, skeletalMuscleMass: Double?, fatPercentage: Double?) {
realmManager.updateData(data: workoutDoneData) { updatedWorkOutDoneData in
let bodyInfo = BodyInfo()
bodyInfo.weight = weight
bodyInfo.skeletalMuscleMass = skeletalMuscleMass
bodyInfo.fatPercentage = fatPercentage
updatedWorkOutDoneData.bodyInfo = bodyInfo
}
}
}RealmManager에 의존하며 RealmManager를 통해 각각의 데이터에 접근할 수 있는 객체를 만들 수 있었습니다.
- 가장 중요한 중요한 기능인 Realm을 다루는 코드들이 제대로 동작하는지 일일이 확인해봐야하는 번거로움 존재
MockRealm을 활용해 테스트 코드를 작성해보고자 했습니다.
protocol RealmProviderProtocol {
func makeRealm() throws -> Realm
}- 어떤 Realm 객체를 제공해 줄 것인지 정할 수 있는 코드(실제 서비스 Realm, 테스트용 Realm)
class ProductionRealmProvider: RealmProviderProtocol {
func makeRealm() throws -> Realm {
return try Realm()
}
}
class MockRealmProvider: RealmProviderProtocol {
func makeRealm() throws -> Realm {
return try Realm(configuration: Realm.Configuration(inMemoryIdentifier: "testRealm"))
}
}- 해당 프로토콜을 채택하며 실제 서비스에 들어가느 Realm인지 테스트용 Realm인지 구별해주었습니다.
final class BodyInputDataValidatorTest: XCTestCase {
var sut: BodyInfoDataManager!
var realmProvider: MockRealmProvider!
var testRealm: Realm!
override func setUp() {
realmProvider = MockRealmProvider() // Mock Realm을 통해 테스트
testRealm = try! realmProvider.makeRealm()
let realmManager = RealmManager(realm: testRealm)
sut = BodyInfoDataManager(realmManager: realmManager)
sut.createBodyInfoData(weight: ExpectedBodyInfoData.weight,
skeletalMusleMass: ExpectedBodyInfoData.skeletalMusleMass,
fatPercentage: ExpectedBodyInfoData.fatPercentage,
date: ExpectedBodyInfoData.date,
id: ExpectedBodyInfoData.id)
}
override func tearDown() {
sut = nil
realmProvider = nil
testRealm = nil
}
- 테스트 코드 작성 시,
MockRealmProvieer를 넣어주어 실제 서비스 Realm과 구분하여 테스트를 진행할 수 있었습니다.
🔖 온보딩 플로우 - 앱에 대한 전반적인 설명 후, 온보딩을 넘어가면 다시 나타나지 않아요.
📈 몸무게, 체지방량, 골격근량 입력 및 분석 플로우 - 날마다 입력한 신체 정보를 차트로 한 눈에 비교할 수 있어요.
📸 오운완 사진 촬영 및 저장 플로우 - 날마다 사진을 찍고 저장해 몸의 변화를 한 눈에 비교할 수 있어요.
🎞️ 갤러리에서 사진 가져오기 및 저장 플로우 - 갤러리(전체 권한, 선택 권한)에서 가져와 몸의 변화를 한 눈에 비교할 수 있어요.
💪 운동 루틴 만들기 플로우 - 나만의 루틴을 만들고 확인할 수 있어요.
🏋️ 운동하기 플로우 - 날마다 루틴을 가져와 운동을 하거나 즉석에서 루틴을 만들어 운동을 하고 확인할 수 있어요.
🍎 네이밍
- UpperCamelCase 사용
// - example
struct MyTicketResponseDTO {
}
class UserInfo {
}- lowerCamelCase 사용하고 동사로 시작
// - example
private func setDataBind() {
}- pop, push, present, dismiss
- 동사 + To + 목적지 뷰 (다음에 보일 뷰)
- dismiss는 dismiss + 현재 뷰
// - example pop, push, present
popToFirstViewController()
pushToFirstViewController()
presentToFirstViewController()
dismissFirstViewController()- register + 목적어
// - example
registerXib()
registerCell()- 서비스함수명 + WithAPI
// - example
fetchListWithAPI()
requestListWithAPI()fetch는 무조건 성공
request는 실패할 수도 있는 요청
- 동사원형 + 목적어 + WithAnimation
showButtonsWithAnimation()delegate 메서드는 프로토콜명으로 네임스페이스를 구분
좋은 예:
protocol UserCellDelegate {
func userCellDidSetProfileImage(_ cell: UserCell)
func userCell(_ cell: UserCell, didTapFollowButtonWith user: User)
}
protocol UITableViewDelegate {
func tableview( ....)
func tableview...
}
protocol JunhoViewDelegate {
func junhoViewTouched()
func junhoViewScrolled()
}Delegate 앞쪽에 있는 단어를 중심으로 메서드 네이밍하기
나쁜 예:
protocol UserCellDelegate {
// userCellDidSetProfileImage() 가 옳음
func didSetProfileImage()
func followPressed(user: User)
// `UserCell`이라는 클래스가 존재할 경우 컴파일 에러 발생 (userCell 로 해주자)
func UserCell(_ cell: UserCell, didTapFollowButtonWith user: User)
}함수 이름 앞에는 되도록이면 get 을 붙이지 않습니다.
- lowerCamelCase 사용
let userName: String- 각 case 에는 lowerCamelCase 사용
enum UserType {
case viewDeveloper
case serverDeveloper
}약어로 시작하는 경우 소문자로 표기, 그 외에는 항상 대문자
// 좋은 예:
let userID: Int?
let html: String?
let websiteURL: URL?
let urlString: String?// 나쁜 예:
let userId: Int?
let HTML: String?
let websiteUrl: NSURL?
let URLString: String?setUI() : @IBOutlet 속성 설정
setLayout() : 레이아웃 관련 코드
setDataBind() : 배열 항목 세팅. 컬렉션뷰 에서 리스트 초기 세팅할때
setAddTarget() : addtarget 모음
setDelegate() : delegate, datasource 모음
setCollectionView() : 컬렉션뷰 관련 세팅
setTableView() : 테이블뷰 관련 세팅
initCell() : 셀 데이터 초기화
registerXib() : 셀 xib 등록.
setNotification() : NotificationCenter addObserver 모음
헷갈린다? set을 쓰세요 ^^🍎 코드 레이아웃
-
들여쓰기에는 탭(tab) 대신 4개의 space를 사용합니다.
-
콜론(
:)을 쓸 때에는 콜론의 오른쪽에만 공백을 둡니다.let names: [String: String]?let name: String -
연산자 오버로딩 함수 정의에서는 연산자와 괄호 사이에 한 칸 띄어씁니다.
func ** (lhs: Int, rhs: Int)
-
함수를 호출하는 코드가 최대 길이를 초과하는 경우에는 파라미터 이름을 기준으로 줄바꿈합니다. 파라미터가 3개 이상이면 줄바꿈하도록!!
단, 파라미터에 클로저가 2개 이상 존재하는 경우에는 무조건 내려쓰기합니다.
UIView.animate( withDuration: 0.25, animations: { // doSomething() }, completion: { finished in // doSomething() } )
-
if let구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.if let user = self.veryLongFunctionNameWhichReturnsOptionalUser(), let name = user.veryLongFunctionNameWhichReturnsOptionalName(), user.gender == .female { // ... }
-
guard let구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.else는 마지막 줄에 붙여쓰기guard let user = self.veryLongFunctionNameWhichReturnsOptionalUser(), let name = user.veryLongFunctionNameWhichReturnsOptionalName(), user.gender == .female else { return } guard let self = self else { return } (X) guard let self = self else { return } (O)
-
else 구문이 길 시 줄바꿈
-
클래스 선언 다음에 , extension 다음에 한 줄 띄어주기
-
빈 줄에는 공백이 포함되지 않도록 합니다. ( 띄어쓰기 쓸데없이 넣지 말기 )
-
모든 파일은 빈 줄로 끝나도록 합니다. ( 끝에 엔터 하나 넣기)
-
MARK 구문 위와 아래에는 공백이 필요합니다.
// MARK: Layout override func layoutSubviews() { // doSomething() } // MARK: Actions override func menuButtonDidTap() { // doSomething() }
모듈 임포트는 알파벳 순으로 정렬합니다. 내장 프레임워크를 먼저 임포트하고, 빈 줄로 구분하여 서드파티 프레임워크를 임포트합니다.
import UIKit
import Moya
import SnapKit
import SwiftyColor
import Thenimport UIKit
import SwiftyColor
import SwiftyImage
import JunhoKit
import Then
import URLNavigator🍎 클로저
-
파라미터와 리턴 타입이 없는 Closure 정의시에는
() -> Void를 사용합니다.좋은 예:
let completionBlock: (() -> Void)?나쁜 예:
let completionBlock: (() -> ())? let completionBlock: ((Void) -> (Void))? -
Closure 정의시 파라미터에는 괄호를 사용하지 않습니다.
좋은 예:
{ operation, responseObject in // doSomething() }
나쁜 예:
{ (operation, responseObject) in // doSomething() }
-
Closure 정의시 가능한 경우 타입 정의를 생략합니다.
좋은 예:
..., completion: { finished in // doSomething() }
나쁜 예:
..., completion: { (finished: Bool) -> Void in // doSomething() } completion: { data -> Void in // doSomething() } (X)
-
Closure 호출시 또다른 유일한 Closure를 마지막 파라미터로 받는 경우, 파라미터 이름을 생략합니다.
좋은 예:
UIView.animate(withDuration: 0.5) { // doSomething() }
나쁜 예:
UIView.animate(withDuration: 0.5, animations: { () -> Void in // doSomething() })
🍎 주석
코드는 가능하면 자체적으로 문서가 되어야 하므로, 코드와 함께 있는 인라인(inline) 주석은 피한다.
class ViewController: UIViewController {
// MARK: - Property
// MARK: - UI Property
// MARK: - Life Cycle
// MARK: - Setting
// MARK: - Action Helper
// MARK: - @objc Methods
// MARK: - Custom Method
}
// MARK: - Extensions커스텀 메서드, 프로토콜, 클래스의 경우에 퀵헬프 주석 달기
/// (서머리 부분)
/// (디스크립션 부분)
class MyClass {
let myProperty: Int
init(myProperty: Int) {
self.myProperty = myProperty
}
}
/**summary
(서머리 부분)
> (디스크립션 부분)
- parameters:
- property: 프로퍼티
- throws: 오류가 발생하면 customError의 한 케이스를 throw
- returns: "\\(name)는 ~" String
*/
func printProperty(property: Int) {
print(property)
}- 참고 :
🍎 프로그래밍 권장사항
좋은 예:
let name: String = "철수"
let height: Float = "10.0"나쁜 예:
let name = "철수"
let height = "10.0"프로토콜을 적용할 때에는 extension을 만들어서 관련된 메서드를 모아둡니다.
좋은 예:
final class MyViewController: UIViewController {
// ...
}
// MARK: - UITableViewDataSource
extension MyViewController: UITableViewDataSource {
// ...
}
// MARK: - UITableViewDelegate
extension MyViewController: UITableViewDelegate {
// ...
}나쁜 예:
final class MyViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {
// ...
}
// 프로토콜 여러개를 한곳에 몰아서 때려넣지 말자!🍎 기타규칙
-
self는 최대한 사용을 지양 →**알잘딱깔센 self…** -
viewDidLoad()에서는 함수호출만 -
delegate 지정, UI관련 설정 등등 모두 함수와 역할에 따라서 extension 으로 빼기
-
필요없는 주석 및 Mark 구문들 제거
-
deinit{}모든 뷰컨에서 활성화 -
guard let으로 unwrapping 할 시, nil 가능성이 높은 경우에는else{}안에print()해서 디버깅하기 쉽게 만들기 -
return사용시 두 줄 이상 코드가 있을 시, 한 줄 띄고return사용func fetchFalse() -> Bool { return false } (O) func isDataValid(data: Data?) -> Bool { guard let data else { return false } return true } (O) func isDataValid(data: Data?) -> Bool { guard let data else { return false } return true } (X)
-
강제 언래핑 금지 (!)
─── WorkoutDone
│ ├── 📁 Resources
│ │ ├── 📁 Fonts
│ │ ├── Assets.xcassets
│ │ ├── LaunchScreen
│ │ ├── AppDelegate.swift
│ │ ├── SceneDelegate.swift
│ │ └── Info.plist
│ │
│ ├── 📁 Sources
│ │ ├── 📁 Presenter
│ │ │ └── 📁 Scene
│ │ │ ├── 📁 ViewController
│ │ │ ├── 📁 ViewModel
│ │ │ └── 📁 Cells
│ │ │
│ │ ├── 📁 Model
│ │ ├── 📁 Classes
│ │ └── 📁 Extensions
│ │
│ └── 📁 Utils
└── 📁 WorkoutDoneTests
RxSwift
- https://github.com/ReactiveX/RxSwift
Realm
- https://github.com/realm/realm-swift
SnapKit
- https://github.com/SnapKit/SnapKit
Then
- https://github.com/devxoul/Then
DeviceKit
- https://github.com/devicekit/DeviceKit
| 류창휘 (@ryuchanghwi) |
봉혜미 (@hyemi) |
|---|---|
 |
 |