LogMacro 📝

SPM Swift License Platform Hits

Swift 매크로를 활용한 고성능 로깅 라이브러리

✨ 주요 특징

📚 상세 문서

🛠 기술적 기반

📦 설치 방법

Swift Package Manager (권장)

let package = Package(
 name: "YourProject",
 dependencies: [
 .package(url: "https://github.com/Roy-wonji/LogMacro.git", from: "1.0.5")
 ],
 targets: [
 .target(
 name: "YourTarget",
 dependencies: ["LogMacro"]
 )
 ]
)

https://github.com/Roy-wonji/LogMacro.git

라이브러리 import

import LogMacro

🚀 빠른 시작

기본 사용법

1️⃣ 매크로 방식 (권장)

#logDebug("디버깅 정보", userId, timestamp)
#logInfo("앱 시작됨", appVersion)
#logError("네트워크 오류", error.localizedDescription)

2️⃣ 정적 메서드 방식

Log.debug("디버깅 정보", userId, timestamp)
Log.info("앱 시작됨", appVersion) 
Log.error("네트워크 오류", error.localizedDescription)

📊 지원하는 로그 레벨

💡 상세 사용 예시

🟡 Debug - 개발 중 디버깅

// 기본 사용
Log.debug("현재 상태 확인")
#logDebug("변수 값", userId, userName)
// 복합 정보 로깅 
Log.debug("사용자 정보", "ID:", user.id, "이름:", user.name, "상태:", user.status)

🟠 Info - 일반 정보

// 앱 라이프사이클
Log.info("앱 시작됨", "버전:", appVersion)
#logInfo("초기화 완료", "소요시간:", initTime, "ms")
// 기능 실행 정보
Log.info("데이터 로딩 완료", "아이템 수:", items.count)

🔵 Network - 네트워크 이벤트

// API 요청/응답 로깅
Log.network("API 요청 시작", endpoint, method)
#logNetwork("응답 수신", "상태코드:", response.statusCode, "크기:", data.count)
// 실제 사용 예시
class NetworkService {
 func fetchUserProfile(userId: String) async {
 #logNetwork("사용자 프로필 요청", "userId:", userId)
 
 do {
 let profile = try await apiClient.fetchProfile(userId)
 Log.network("프로필 수신 성공", "데이터 크기:", profile.data.count)
 } catch {
 Log.error("프로필 요청 실패", error.localizedDescription)
 }
 }
}

🔴 Error - 오류 상황

// 에러 처리
Log.error("인증 실패", error.localizedDescription)
#logError("데이터베이스 연결 오류", "코드:", errorCode)
// 실제 사용 예시
do {
 try performRiskyOperation()
} catch let error as NetworkError {
 Log.error("네트워크 오류 발생", "타입:", error.type, "메시지:", error.message)
} catch {
 #logError("예상치 못한 오류", error)
}

🟡 Test - 테스트 실행

// 단위 테스트에서
func testUserLogin() {
 Log.test("로그인 테스트 시작", "사용자:", testUser.email)
 
 // 테스트 로직...
 
 #logTest("테스트 완료", "결과:", success ? "성공" : "실패")
}

🟢 Custom - 사용자 정의 카테고리

// 특정 기능별 로깅
Log.custom(category: "Analytics", "이벤트 추적", eventName, parameters)
#logCustom("Performance", "함수 실행시간", functionName, executionTime, "ms")
// 실제 사용 예시 
class AnalyticsManager {
 func trackEvent(_ name: String, parameters: [String: Any]) {
 Log.custom(category: "Analytics", "이벤트 추적", "이름:", name, "매개변수:", parameters)
 
 // 실제 분석 로직...
 }
}

🎯 실전 활용 예시

iOS 앱에서의 통합 사용

import LogMacro
import UIKit
class LoginViewController: UIViewController {
 @IBAction func loginButtonTapped(_ sender: UIButton) {
 #logInfo("로그인 버튼 터치됨")
 
 guard let email = emailTextField.text, !email.isEmpty else {
 Log.error("이메일 입력 누락")
 return
 }
 
 Task {
 await performLogin(email: email)
 }
 }
 
 private func performLogin(email: String) async {
 Log.debug("로그인 프로세스 시작", "이메일:", email)
 
 do {
 #logNetwork("로그인 API 호출")
 let result = try await AuthService.shared.login(email: email)
 
 Log.custom(category: "Auth", "로그인 성공", "userId:", result.userId)
 navigateToMainScreen()
 
 } catch {
 Log.error("로그인 실패", error.localizedDescription)
 showErrorAlert()
 }
 }
}

🔍 디버깅 및 로그 확인

Xcode에서 로그 보기

Console.app에서 로그 보기

성능 최적화

🛠 시스템 요구사항

⚡ 성능 특징

🤝 기여하기

기여 방법

개발 환경 설정

git clone https://github.com/Roy-wonji/LogMacro.git
cd LogMacro
swift build
swift test

👨‍💻 개발자 정보

📄 라이선스

MIT License
Copyright (c) 2024 서원지 (Roy)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction...

LogMacro와 함께 더 나은 Swift 개발 경험을 만들어가세요! 🚀

⭐ 이 프로젝트가 도움이 되었다면 Star를 눌러주세요! ⭐