StarWars 开源项目使用教程

1. 项目的目录结构及介绍

首先，我们来看一下 StarWars 项目的目录结构。以下是项目的主要目录和文件：

StarWars/
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── kotlin/
│   │   │   │   └── com/
│   │   │   │       └── joreilly/
│   │   │   │           └── starwars/
│   │   │   │               ├── MainActivity.kt
│   │   │   │               ├── data/
│   │   │   │               ├── di/
│   │   │   │               ├── ui/
│   │   │   │               └── util/
│   │   │   └── res/
│   │   └── test/
│   └── build.gradle.kts
├── build.gradle.kts
├── settings.gradle.kts
└── README.md

目录结构介绍

• app/src/main/kotlin/com/joreilly/starwars/: 包含项目的主要源代码文件。
  • MainActivity.kt: 项目的启动文件。
  • data/: 包含数据相关的代码，如数据模型和数据源。
  • di/: 包含依赖注入相关的代码。
  • ui/: 包含用户界面相关的代码。
  • util/: 包含工具类和辅助函数。
• app/src/main/res/: 包含资源文件，如布局文件、图片等。
• app/build.gradle.kts: 应用模块的构建脚本。
• build.gradle.kts: 项目的根构建脚本。
• settings.gradle.kts: 项目的设置脚本。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 MainActivity.kt，位于 app/src/main/kotlin/com/joreilly/starwars/ 目录下。以下是 MainActivity.kt 的简要介绍：

package com.joreilly.starwars

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.Preview
import com.joreilly.starwars.ui.theme.StarWarsTheme

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            StarWarsTheme {
                StarWarsApp()
            }
        }
    }
}

@Composable
fun StarWarsApp() {
    // 应用的主要界面
}

@Preview
@Composable
fun DefaultPreview() {
    StarWarsTheme {
        StarWarsApp()
    }
}

启动文件介绍

• MainActivity 继承自 ComponentActivity，是应用的主活动。
• onCreate 方法在活动创建时调用，设置内容视图。
• StarWarsApp 是一个可组合函数，定义了应用的主要界面。
• DefaultPreview 是一个预览函数，用于在设计时预览界面。

3. 项目的配置文件介绍

项目的配置文件主要包括 app/build.gradle.kts 和 settings.gradle.kts。

app/build.gradle.kts

plugins {
    id("com.android.application")
    id("kotlin-android")
    id("kotlin-kapt")
    id("dagger.hilt.android.plugin")
}

android {
    compileSdk = 31
    defaultConfig {
        applicationId = "com.joreilly.starwars"
        minSdk = 21
        targetSdk = 31
        versionCode = 1
        versionName = "1.0"
    }
    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
        }
    }
    compileOptions {
        sourceCompatibility