wanted_preonboarding_android

원티드 프리온보딩 사전 과제입니다.

뉴스를 조회 및 저장할 수 있는 애플리케이션입니다.

Architecture

전체 아키텍처로 Clean Architecture 를 적용하였고, 각 레이어를 나눠 Multi Module 로 구성하였습니다.

특이사항으로 프로젝트의 규모가 크지 않다는 것을 고려하여 Clean Architecture 에서 주로 사용하는 DataSource 영역을 제외하였습니다.

Presentation 모듈에는 개별적으로 MVVM 디자인 패턴을 적용하였습니다.

Implementation

• 해당 프로젝트는 Single Activity 의 형태로 구현되었습니다.
• 제공된 디자인 가이드와 최대한 유사하게 구현하였습니다.
• 하단에 각 탭으로 진입할 수 있는 바텀 네비게이션이 있으며, 최신 뉴스와 카테고리별 뉴스, 저장한 뉴스를 조회할 수 있는 탭으로 구성되었습니다.
• 이미지를 불러올 수 없는 경우 준비된 이미지를 통해 유저에게 안내합니다. (공통)
• 모든 화면에 가로 모드 적용이 가능합니다.

Top News

• 최신 뉴스를 조회할 수 있습니다.
• 뉴스 게재 후 경과 시간을 화면에 표현합니다.
• 뉴스를 클릭하면 상세 정보를 확인할 수 있고, 별 모양 아이콘을 통해 내부 데이터베이스에 저장 및 삭제할 수 있습니다.
  • 만약 내부 데이터베이스에 이미 저장된 뉴스라면 우측 상단의 별 아이콘에 노란 배경이 추가됩니다.
• 화면을 위로 당겨 뉴스 새로고침이 가능합니다.

Category

• 카테고리별 뉴스를 조회할 수 있습니다.
• 상단 앱바에 선택한 카테고리명이 출력됩니다.
• 카테고리 선택 외에는 전체적으로 Top News 탭과 동일하게 동작합니다.

Save

• 내부 데이터베이스에 저장된 뉴스를 조회할 수 있습니다.
• 가장 최근에 게재된 순서대로 화면에 출력됩니다.
• 별 모양의 버튼을 클릭하여 내부 데이터베이스에 해당 뉴스를 추가 및 삭제할 수 있고, 이는 화면에도 바로 표현됩니다.
• 저장된 뉴스가 없을 경우 유저에게 안내 메시지를 출력합니다.
• 엡 종료 후 재실행하여도 해당 뉴스 데이터는 유지됩니다.

Error Handling

• 네트워크 통신 중 에러가 발생하면 유저에게 안내합니다.
• 유저는 재시도 버튼을 클릭하여 다시 네트워크 통신을 시도할 수 있습니다.
• 에러 핸들링 시 지원하는 에러 타입은 아래와 같습니다.
  • 타임아웃 에러
  • 서버 에러
  • 잘못된 요청
  • 원인 불명

Multiple Backstack

• 탭별 백스택을 지원합니다.
• 다른 탭으로 이동해도 백스택이 초기화되지 않습니다.

Package Structure

├── app
├── data
│     ├── di
│     ├── local
│     │    ├── dao
│     │    ├── entity
│     ├── remote
│     │    ├── api
│     │    ├── interactor
│     │    └── response
│     ├── repository
│     └── util
├── domain
│     ├── interactor
│     ├── model
│     ├── repository
│     └── usecase
├── presentation
│     ├── ui
│     │    ├── adapter
│     │    ├── category
│     │    ├── categoryNews
│     │    ├── detail
│     │    ├── main
│     │    ├── model
│     │    ├── news
│     │    ├── save
│     │    └── util

Tech Stack

Clean Architecture, MVVM, Multi Module, Kotlin, Navigation, Hilt, Okhttp3, Retrofit2, Room, Glide, Databinding, BindingAdapter, ListAdapter, LiveData, SwipeRefreshLayout

Commit Convention

• feat : {something} : 기능 추가
• fix : {something} : 문제 해결
• refactor : {something} : 코드 개선
• chore : {something} : 프로젝트 세팅
• rename : {something} : 단순 네이밍 변경
• docs : {something} : README 등 문서를 수정하는 경우

Environment

• Android Studio Chipmunk | 2021.2.1
• minSdkVersion 21
• targetSdkVersion 32
• Test Device | Galaxy Note 8