Pinstagram Android Mobile Client

Kotlin, AndroidX, JetPack, Rx, Hilt(Dagger), Coroutine 을 활용한 Android 프로젝트

목차

1.Pinstagram 프로젝트

2.개요

3.화면 설명

4.주요 구현 사항

5.기술부채

6.후기

7.업데이트

Pinstagram 프로젝트

• 기획 배경

  • 새로운 기술을 도입해야 될 때마다 새로운 토이프로젝트를 만들었는데(그러다보니 레파지토리가 250개를 넘었습니다..), 이렇게 계속 진행하다보니 다른 기술들과 유기적으로 연결되지 못하는 느낌을 받았습니다.
  • 이를 개선하고자 하나의 토이 프로젝트를 만들고, 이를 지속적으로 개선해나가는 것이 좋겠다고 판단하여 시작한 프로젝트입니다.

• 서비스 내용

  • 기획 내용은 단순히 특정한 위치에 사진을 올리고, 이를 볼 수 있는 서비스입니다.
  • 개발자가 처음으로 하는 프로젝트인 헬로우월드, 그리고 그 다음으로 많이하는 계산기, 그리고 그와 쌍두마차를 이루는 기본적인 게시판 어플의 확장 버전입니다.

• 개인적인 규약

  • Git Submodule 미활용 : WAS와 Android의 경우 각 모듈별로 git submodule에 등록하는게 효율적이지만, 레파지토리가 너무 많아지면 관리가 안될 것 같아서 통합된 Git으로 관리합니다.
  • 기획 디자인 최소화 : 개발적인 프로젝트이기 때문에 사업성, 당위성 등은 최대한 배제하고 개발하기에 깔끔한 기획과 디자인만 가져갑니다. 그렇기 때문에 기획 디자인적으로 뜬금없는 페이지(예: Talk)가 들어갈 수 있습니다
  • 기술부채 : 한시적으로 끝나는 프로젝트가 아닌, 지속적인 프로젝트임으로, 현재 가능한 기술을 사용하고, 볼륨 및 러닝커브로 못 가져간 기술은 천천히 도입할 예정입니다.

• 서비스 주요 기능

  • Home : 특정 위치에서 1KM 반경내에 있는 데이터들을 그리드뷰 형식으로 보여줍니다
  • Map : 특정 위치에서 1KM 반경내에 있는 데이터들을 지도 형식으로 보여줍니다.
  • Talk : Socket 통신을 이용한 메세지입니다. 위치기반으로 하는 지역톡 개념이아닌 서비스 이용자 전체와 소통합니다.
  • Write : 특정 위치에 게시물을 명시할 수 있습니다.
  • Auth : 로그인, 로그아웃, 회원가입 등을 진행할 수 있습니다.

• 프로젝트 목록

  • 📱 Pinstagram Android (Kotlin & AndroidX)

  • 🍃 Pinstagram WAS (Spring Boot)

  • 🚚 Pinstagram DevOps (GKE & K8s & Helm)

  • 🕳 Pinstagram Socket (Node.js & Socket.io)

개요

• 모듈 설명

이름	개요
app	실행되는 Application 을 담은 모듈
customui	Custom View를 모아둔 모듈
core	다양한 프로젝트에서 공통적으로 사용되는 것들을 모아둔 모듈
api	Http, Socket, Database, Storage 등 통신을 정의한 모듈
domain	api 등에서 사용할 Domain 객체를 모아둔 모듈

• 모듈 구조

• 주요 사용 라이브러리

라이브러리명	개요	범주
Rxjava, RxKotlin	FRP 프로그래밍 라이브러리	Functional Reactive Programing
Flow	코루틴 FRP 프로그래밍 라이브러리	Functional Reactive Programing
KTX	core, activity, fragment, viewmodel, lifecycle 사용	Android
Dagger, Hilt	DI Container	Dependency Injection
ViewBinding	View Dependency Injection	Dependency Injection
Jetpack Compose	Android Declarative UI	Declarative UI
Retrofit, okHttp	Networking	Networking
Gson, Rx Conveter	Network Convert	Networking
Socket.io	Socket Networking	Networking
JWT	Javascript Web Token Authenfitication	Networking
JUnit4	Unit Testing	Testing
Espresso	UI Testing	Testing
Robolectric	Instrumented unit Testing	Testing
Room	Local Database	Database
Lottie	60fps Animation	Animation
Firebase Storage	Image Storage	Storage
Firebase Crashlytics	Error Tracker	Tracker

화면 설명

이름	개요	기능	상위 클래스
SplashActivity	Splash 화면	권한 체크 및 요청	Activity
MainActivty	Main 화면 Container	각 Dialog, Fragment 생성 및 이벤트 처리	Activity
HomeFragment	Main 화면의 메인뷰 (Default)	데이터를 그리드뷰 형식으로 표현	Fragment
MapFragment	Main 화면의 맵을 활용한 뷰	데이터를 맵뷰 형식으로 표현	Fragment
TalkFragment	Main 화면의 메시지 뷰	소켓 통신으로 이용중인 유저간의 대화가 가능	Fragment
SignDialog	Sign 화면의 Container	SignInFragment, SignUpFragment 전환	DialogFragment
SignInFragment	Sign 화면의 로그인 뷰	로그인	Fragment
SignUpFramgent	Sign 화면의 회원가입 뷰	회원가입	Fragment
LogoutDialog	Logout 요청 뷰	로그아웃	AlertDialog
AddressDialog	주소 선택 뷰	주소 변경	DialogFragment
WriteDialog	게시글 생성 뷰	게시글 생성	DialogFragment
DetailActivity	게시물 자세히 보기 뷰	게시물 자세히보기	DetailActivity

• 화면 관계

주요 구현 사항

클릭하시면 해당 마크다운 파일로 리다이렉팅 됩니다.

• Gradle

  • Gradle 관리

• Clean Architecture

  • Clean Architecture

• Animation & View

  • Lottie Animation

  • Custom View

  • View Binding

• Optimization

  • 뷰 최적화

• Language

  • Generic

  • Enum

  • Delegate

  • Sealed Class

  • Flow

• JetPack : Hilt, Room 등은 각자 범주에 맞는 곳에 명시

  • LifeCycle

  • ViewModel

  • KTX

  • Compose

• Dependency Inject

  • Hilt

• Api

  • Room

  • Retrofit & OkHttp & JWT

  • Socket

  • Firebase Storage

• ReactiveX

  • ReactiveX 와 Coroutine

  • 연산자

  • 스케쥴러

  • Disposable 관리

• ErrorTracker

  • Firebase Crashlytics

• Test

  • 계측 테스트

  • UI 테스트

기술 부채

• CI/CD

  • 이전에 AWS에서 가장 싼 Compute 위에서 Jenkins로 CI/CD를 했다가, 빌드하는데 40분 걸려서 포기
  • 현재 비용 문제로 CI/CD는 못 하였고, 개인 iMAC이나 Macbook Pro 위에 생성할까 고민중입니다.

• JetPack Compose

  • 새로운 뷰는 Jetpack Compose를 이용해 개발할 계획입니다.
  • EventFragment 를 Compose로 개발중입니다

• Test Coverage

  • 계측 테스트
    • 진행 : 각 모듈별로 진행(socket, api, database 등)
    • 예정 : ViewModel 레이어
  • UI 테스트
    • 진행 : MainActivity
    • 예정 : 기타 다른 뷰
  • Test Double
    • 진행 : TDD가 아니라서 Mock객체 없이 진행
    • 예정 : 각 테스트의 유연성을 확보하기 위해 이전에 사용했던 mockito 도입 예정

• ReactiveX 3

  • Rxjava3를 도입하였지만 2.x 버전과 큰 차이가 없어서 조금펴 3.x 버전을 조금 더 살피고 리팩토링 필요
  • Maybe와 Flowable : 대부분 Single, Complatabe 로 구현되어있으며, 조금 더 상황에 맞게 Maybe와 Flowable을 채용할 예정입니다.
  • RxLifeCycle 도입 : 현재까지는 직접 lifeCycle에 맞게 관리되도록 구현되어있는데, RxLifeCycle이 조금더 직관적이어서 도입 예정입니다.

• 최적화

  • 현재 오버드로의 경우, AppBarLayout 등 안드로이드 프레임워크와 Talk의 CardView가 4회를 제외하고는 3회 이하로 실행되어 최적화
  • 로직의 경우에는 조금 더 검사를 해봐야합니다.

후기

• Coroutine에 관해
  • 비동기를 언어 레벨에서 사용한다는건 흥미롭습니다.
  • 전반적으로 완성도가 높은 기술이라 생각합니다.
  • 다만, Rx를 대처하기에는 유틸성 등과 같은 측면에서 설득력이 떨어집니다. -> 아래 Compose & Flow 참조
• Espresso Recorder 에 관해
  • UI 테스팅은 기본적으로 테스트할때 코드가 많은데
  • Espresso Recorder가 이런 코드를 제공해주는 부분이 좋습니다.
  • 다만 Hilt나 몇몇 스펙에 관해서는 적용되지 않아 생성 후 수정을 조금 해주어야하는 부분이 아쉽습니다.
• Flow & Compose 에 관해
  • Compose
    • findViewById로 의존성 주입 후 사용하던 기존 방식보다 선언형으로 이루어져 예기치 못한 에러를 줄일 수 있습니다.
    • Modifier는 너무 좋습니다. Flutter의 경우에는 Padding, Expanded 등 레이아웃을 변경할때마다 중첩해서 사용해야해야되서 용승천 코드가 만들어지는데, Modifier는 이러한 코드를 줄여줍니다.
  • Flow
    • 위에 코루틴은 유틸성이 떨어진다고 했는데, flow까지 사용하면 Rx를 충분히 대체할만합니다.
    • 다만 Compose를 썻을때 조금 더 빛을 발하는 것 같습니다.

업데이트

• 1.1.0 : 이벤트 프래그먼트 추가
  • Flow와 Compose 사용

License

MIT License

Copyright (c) 2021 Coguri

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, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.