How indiaolx/media-picker-android works
Project Type & Purpose
• Two Gradle modules:
– “mediapicker”: a reusable Android library exposing a gallery-style media picker.
– “app”: a sample Android application demonstrating library usage.
• Purpose: scan device media (photos/videos), apply validation rules, and display in a carousel/grid UI.
File Structure
• Top-level:
– settings.gradle, build scripts, jitpack.yml.
– Modules: “mediapicker” (library) and “app” (sample app).
• “mediapicker/src/main/java/com/mediapicker/gallery”:
– domain (entities, actions, contracts, repositories)
– data (repository implementations, GalleryService)
– presentation (activities, fragments, adapters, viewmodels, factories, utils)
• “app/src/main/java/com/mediapicker/sample”:
– MainActivity, DemoHomeFragment, StepFragment – sample UI.
Key Architecture Patterns
• MVVM (ViewModels in presentation → domain/repositories → data/service → Android MediaStore).
• Clean-separation: UI (Activities/Fragments) vs. Presentation (ViewModel) vs. Domain (contracts/entities) vs. Data (GalleryService).
• Consumer-provider: the library exposes Gallery.init(config) and GalleryCommunicator to return selected media.
Main Components
a. Sample App UI
– MainActivity / DemoHomeFragment / StepFragment
– Invokes library via Gallery.init() and GalleryActivity / HomeFragment from library.
b. Library UI Bridge
– GalleryActivity, FolderViewActivity, HomeFragment, PhotoGridFragment, VideoGridFragment, PhotoCarousalFragment
– Adapters & custom Views (MediaGalleryViewPager, CarousalView, etc.)
c. Presentation Layer (MVVM)
– ViewModels (BridgeViewModel, HomeViewModel, LoadAlbumViewModel, LoadPhotoViewModel, LoadVideoViewModel)
– ViewModelFactory
d. Domain Layer
– Contracts (GalleryCommunicator, OnItemClickListener)
– Entities (Photo, PhotoAlbum, MediaGalleryEntity, Validation, RuleAction, etc.)
– Repositories interface (GalleryRepository)
e. Data Layer
– GalleryService (implements repository, queries Android MediaStore via ContentResolver)
f. External/System Dependencies
– Android Framework (Activities, Fragments, ViewModelProviders)
– MediaStore / ContentResolver
– FileProvider (for camera URIs)
– Device file system (camera photos/videos)
– JitPack / Gradle (build & distribution)
Interactions & Data Flow
• Startup:
Sample App → calls Gallery.init(GalleryConfig) → config stored in library core.
• Launch:
Sample App → launches GalleryActivity or injects HomeFragment.
• UI Event:
User taps media → Fragment → ViewModel receives event → consults validation/rules.
• Data Query:
ViewModel → GalleryRepository (contract) → GalleryService → Android MediaStore → returns media list.
• UI Rendering:
Data returned to ViewModel → LiveData/observers → Adapters populate RecyclerViews/ViewPager.
• Selection:
Selected items communicated back via GalleryCommunicator callback to Sample App.
Essential Elements
– Clear labels: e.g., “GalleryActivity (UI)”, “LoadPhotoViewModel”, “GalleryService”.
– Component groupings: package boundaries (com.mediapicker.gallery.presentation, etc.).