[Init/#1] 프로젝트 기초세팅을 진행합니다. #2

SYAAINN · 2025-01-06T07:33:38Z

Related issue 🛠

closed [Init] 프로젝트 기초세팅을 진행합니다. #1

Work Description ✏️

브랜치 규칙을 설정합니다.
이슈와 PR에 사용할 라벨을 추가합니다.
gitignore를 설정합니다.
이슈 템플릿과 PR 템플릿을 추가합니다.
pr리뷰어 자동등록 설정 (CODEOWNER)
dependency 추가합니다. (bulid-gradle, libs.versions.toml 세팅)
manifest를 설정합니다. (화면 회전 방지, 인터넷 권한 설정)
패키지 분리 및 더미 파일들을 추가합니다.
각종 확장함수를 추가합니다.

Screenshot 📸

N/A

Uncompleted Tasks 😅

NetworModule 다듬기
ktlint 적용
presentation > ui 패키징 보충

To Reviewers 📢

기초세팅 진행했습니다. 확인 후 궁금하신 부분, 추가하거나 수정하고 싶으신 부분 모두 리뷰 부탁드립니다!

wjdrjs00

기초세팅 고생 많았으!👍🏻
즉시 반영해야할 수정사항은 아닌거 같아서 바로 어푸했습니다!)
(그치만 몇가지 질문 스윽 남겨봤는데 한번 확인해보는것도 좋을듯 합니다!)
추가로 몇몇 파일들 마지막 라인 개행정도? 만 확인해주면 완벽!

wjdrjs00 · 2025-01-07T06:39:21Z

app/src/main/java/com/sopt/gongbaek/di/NetworkModule.kt

+            connectTimeout(10, TimeUnit.SECONDS)
+            writeTimeout(10, TimeUnit.SECONDS)
+            readTimeout(10, TimeUnit.SECONDS)


[3]: 개인취향이긴 한데, 타입을 명확하게 표시하는것도 좋은 방법이라 생각합니다~🙇🏻‍♂️

Suggested change

connectTimeout(10, TimeUnit.SECONDS)

writeTimeout(10, TimeUnit.SECONDS)

readTimeout(10, TimeUnit.SECONDS)

connectTimeout(10L, TimeUnit.SECONDS)

writeTimeout(10L, TimeUnit.SECONDS)

readTimeout(10L, TimeUnit.SECONDS)

wjdrjs00 · 2025-01-07T06:51:02Z

app/src/main/java/com/sopt/gongbaek/di/NetworkModule.kt

+    @Provides
+    @Singleton
+    fun providesJson(): Json =
+        Json {
+            isLenient = true
+            prettyPrint = true
+            explicitNulls = false
+            ignoreUnknownKeys = true
+        }


[2]: 현재 코드에서는 해당 부분이 사용이 안 되는 것으로 보이는데 의도한 건지 궁금합니다!

헉 만들어놓고 다른 json 객체를 사용하고 있었네요. 수정했습니다!

wjdrjs00 · 2025-01-07T06:53:08Z

app/src/main/java/com/sopt/gongbaek/di/NetworkModule.kt

+    @Auth
+    fun provideAuthInterceptor(): Interceptor = Interceptor { chain ->
+        val request = chain.request().newBuilder()
+            .addHeader("Authorization", "Bearer <Your_Token_Here>")


[3]: 요 부분도 개인취향이긴 한데, 이런식으로 작성하면 좀 더 명시적으로 확인가능할거 같습니다!🙇🏻‍♂️

Suggested change

.addHeader("Authorization", "Bearer <Your_Token_Here>")

.addHeader(

name = "Authorization",

value = "Bearer <Your_Token_Here>"

)

앱잼 내에서 로그인 구현 계획이 없어 불필요한 기능같아 삭제했습니다. 추후 참고하겠습니다!

wjdrjs00 · 2025-01-07T07:01:23Z

app/src/main/java/com/sopt/gongbaek/di/NetworkModule.kt

+        return Retrofit.Builder()
+            .baseUrl(baseUrl)
+            .client(okHttpClient)
+            .addConverterFactory(json.asConverterFactory("application/json".toMediaType()))


[3]: ConverterFactory 를 주입 받는 방법은 어떤지 질문+1 남겨봅니다!

좋은 것 같습니다! 반영하겠습니다!

wjdrjs00 · 2025-01-07T07:04:46Z

app/src/main/java/com/sopt/gongbaek/presentation/util/base/State.kt

@@ -0,0 +1,3 @@
+package com.sopt.gongbaek.presentation.util.base
+
+interface State


[3]: 이 부분만 UiState가 아니고 State인 이유가 있는지 궁금합니다!

서버통신에 대한 UiState(Idle,Loading,Success,Failure) sealed class와 혼동될 수 있을 것 같아 이렇게 진행했는데, 여기를 일관성 있게 UiState로 가져가고 서버통신 State에 대한 클래스명을 변경하는게 나을 것 같네요! 반영하겠습니다~

wjdrjs00 · 2025-01-07T07:11:58Z

app/src/main/java/com/sopt/gongbaek/presentation/util/base/BaseViewModel.kt

+    private val _uiState = MutableStateFlow<State>(initialState)
+    val uiState: StateFlow<State>
+        get() = _uiState.asStateFlow()


[2]: 기존 방식과 아래 방식이 어떤 차이가 있는지 슬쩍 질문을 남겨봅니다!🙇🏻‍♂️

Suggested change

private val _uiState = MutableStateFlow<State>(initialState)

val uiState: StateFlow<State>

get() = _uiState.asStateFlow()

private val _uiState = MutableStateFlow<State>(initialState)

val uiState: StateFlow<State> = _uiState.asStateFlow()

직접 Assign( = ) , getter를 이용한 Assign 이 두 가지에 대한 차이점은 링크에서 확인해보실 수 있습니다.
요약하자면, 객체의 값을 복사해서 가져오느냐 객체 자체를 가져오느냐 차이인데 변경되는 값을 관찰하는 기능에 있어서 get()을 이용하는게 더 유리하다고 판단하였습니다!
(call by value, call by reference 개념과 닮아있는 거 같다고 느꼈는데 이 부분은 확실하게는 모르겠습니다 ,, ㅎㅎ)

아함, 배워갑니다!(공부할거 +1,,)

wjdrjs00 · 2025-01-07T07:14:15Z

app/src/main/java/com/sopt/gongbaek/presentation/util/base/BaseViewModel.kt

+        get() = _event.asSharedFlow()
+
+    private val _sideEffect: MutableSharedFlow<SideEffect> = MutableSharedFlow()
+    val sideEffect: Flow<SideEffect>


[3]: 위 event과 달리 sideEffect는 Flow타입인 이유가 궁금합니다!

위에는 MutableSharedFlow로 선언해놓고 방출할때는 Flow로 하고 있었네요..! sideEffect도 sharedFlow로 선언하는게 바람직한 것 같습니다. 반영하겠습니다!

MinseoSONG

기초세팅 정말 너무 수고했음 .. !
더미데이터, 예시코드 모두 너무 잘작성해줘서 이해는 되는데, MVI, test 코드는 아직도 어렵다 . . ((개인적으로 공부 좀 더 해벌게요 ㅠ
나도 간단한 수정 요청과 질문사항들뿐이라 바로 어푸하겠습니당

MinseoSONG · 2025-01-07T08:56:56Z

app/build.gradle.kts

+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        buildConfigField("String", "GONGBAEK_BASE_URL", localProperties["gongbaek.base.url"].toString())
+        buildConfigField("String", "ANOTHER_BASE_URL", localProperties["another.base.url"].toString())
+    }


[3]: 여기서 base url을 2개를 받는 이유는 뭘까요 ??

추후에 프로젝트 규모가 커지면 base.url이 분리되는 상황이 있을 수 있습니다! 그래서 이런 것도 있다하고 넣어놓은 것이였는데, 사실 앱잼 수준에서 base.url 분리를 고려하기에는 아직 많이 시기상조이기에 그냥 제거하는 방향으로 진행하겠습니다. 감사합니다!

MinseoSONG · 2025-01-07T09:04:08Z

app/build.gradle.kts

+hilt {
+    enableAggregatingTask = false
+}


[2]: 요거 나도 지현이한테 받은 피드백인데 project 수준 gradle에서 hilt plugin을 추가해주지 않았기 때문에 발생하는 문제를 해결하려고 추가하는 코드라, hilt plugin 추가하고 이 코드는 지우는게 어떨까요 ?!

헉 좋습니다. 반영하겠습니다!!

MinseoSONG · 2025-01-07T09:22:04Z

build.gradle.kts

+    alias(libs.plugins.kotlin.compose) apply false
+    alias(libs.plugins.ksp) apply false
+    alias(libs.plugins.ktlint) apply false
+}


[2]: alias(libs.plugins.dagger.hilt) apply false
요거 !

SYAAINN added 14 commits January 5, 2025 20:51

[init] gitignore을 설정합니다.

fa6fe9d

[add] issue, pr template을 추가합니다.

c0dd74a

[init] 필요한 의존성들을 추가합니다.

2136a46

[init] 인터넷 권한을 설정하고, 가로모드를 제한합니다.

c4340c4

[init] 기본 생성 파일들입니다.

9b58cdc

[del] 불필요 import문을 삭제합니다.

b434c70

[add] CODEOWNERS를 추가합니다.

dece966

[chore] kotlin 2.0.0 버전에 맞추어 버전을 수정합니다.

f7a3f95

[add] hilt를 위한 AndroidApp을 생성합니다.

0585cb8

[chore] base.url을 분리합니다.

acd7101

[add] data layer 더미 파일을 추가합니다.

6ec25ef

[add] di layer 더미 파일을 추가합니다.

aefd996

[add] domain layer 더미 파일을 추가합니다.

3828c45

[add] presentation layer 더미 파일을 추가합니다.

196dcc1

SYAAINN added ⚙ Init 개발 환경 세팅 🌱 민재 labels Jan 6, 2025

SYAAINN requested a review from a team January 6, 2025 07:33

SYAAINN self-assigned this Jan 6, 2025

SYAAINN added 4 commits January 6, 2025 17:11

[add] ktlint 적용

c5067f4

[chore] ktlint formatting을 진행합니다.

d93dfa6

[chore] JDK Version을 11->17로 수정합니다.

771443a

[chore] JDK Version을 11->17로 수정합니다.

cc662fb

wjdrjs00 approved these changes Jan 7, 2025

View reviewed changes

MinseoSONG approved these changes Jan 7, 2025

View reviewed changes

SYAAINN added 6 commits January 8, 2025 14:10

[del] 사용하지 않는 base.url을 삭제합니다.

d914692

[refactor] 사용하지 않는 기능들을 삭제하고 NetworkModule을 수정합니다.

d0e367c

[chore] ktlint format

ff12acb

[add] UseCaseModule을 생성합니다.

6cebefc

[chore] NetworkUtil -> NetworkManager로 클래스명을 수정합니다.

1951304

[chore] project 수준 빌드 그래들에 hilt plugin을 추가합니다.

b9ccde6

SYAAINN added 5 commits January 8, 2025 14:32

[chore] timeout 시간의 타입을 명시합니다.

fb25a85

[refactor] ConverterFactory 의존성을 주입하는 메서드를 생성합니다.

5d2233b

[chore] State -> UiState로 인터페이스 이름을 일관성 있게 변경합니다.

88e6a9e

[chore] sideEffect 객체 타입을 Flow -> SharedFlow 로 변경합니다.

b893575

[chore] 상수로 된 버전을 분리하고, 카테고리화를 진행합니다.

ef2e0a2

SYAAINN merged commit 501ef6b into develop Jan 8, 2025
1 check passed

SYAAINN deleted the init-#1-basic-setting branch January 8, 2025 11:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Init/#1] 프로젝트 기초세팅을 진행합니다. #2

[Init/#1] 프로젝트 기초세팅을 진행합니다. #2

SYAAINN commented Jan 6, 2025 •

edited

Loading

wjdrjs00 left a comment

wjdrjs00 Jan 7, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

wjdrjs00 Jan 8, 2025

wjdrjs00 Jan 7, 2025

SYAAINN Jan 8, 2025

MinseoSONG left a comment

MinseoSONG Jan 7, 2025

SYAAINN Jan 8, 2025

MinseoSONG Jan 7, 2025

SYAAINN Jan 8, 2025

MinseoSONG Jan 7, 2025

		@@ -0,0 +1,3 @@
		package com.sopt.gongbaek.presentation.util.base

		interface State

[Init/#1] 프로젝트 기초세팅을 진행합니다. #2

[Init/#1] 프로젝트 기초세팅을 진행합니다. #2

Conversation

SYAAINN commented Jan 6, 2025 • edited Loading

Related issue 🛠

Work Description ✏️

Screenshot 📸

Uncompleted Tasks 😅

To Reviewers 📢

wjdrjs00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MinseoSONG left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SYAAINN commented Jan 6, 2025 •

edited

Loading