开源项目 `annotation-processing-example` 使用教程

开源项目 annotation-processing-example 使用教程

annotation-processing-example It is the example project for the annotation processing tutorial. 项目地址: https://gitcode.com/gh_mirrors/an/annotation-processing-example

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

annotation-processing-example/
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   └── res/
│   ├── build.gradle
│   └── ...
├── binder-annotations/
│   ├── src/
│   │   ├── main/
│   │   │   └── java/
│   ├── build.gradle
│   └── ...
├── binder-compiler/
│   ├── src/
│   │   ├── main/
│   │   │   └── java/
│   ├── build.gradle
│   └── ...
├── binder/
│   ├── src/
│   │   ├── main/
│   │   │   └── java/
│   ├── build.gradle
│   └── ...
├── gradle/
│   └── wrapper/
├── .gitignore
├── LICENSE
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle

目录结构介绍

• app/: 主应用程序模块，包含应用程序的主要代码和资源。

  • src/main/java/: 存放Java源代码。
  • src/main/res/: 存放应用程序的资源文件。
  • build.gradle: 应用程序模块的构建脚本。

• binder-annotations/: 包含注解定义的模块。

  • src/main/java/: 存放注解的Java源代码。
  • build.gradle: 注解模块的构建脚本。

• binder-compiler/: 包含注解处理器的模块。

  • src/main/java/: 存放注解处理器的Java源代码。
  • build.gradle: 注解处理器模块的构建脚本。

• binder/: 包含注解处理器生成的代码的模块。

  • src/main/java/: 存放生成的Java源代码。
  • build.gradle: 生成的代码模块的构建脚本。

• gradle/: 包含Gradle Wrapper的配置文件。

  • wrapper/: 存放Gradle Wrapper的JAR文件和属性文件。

• .gitignore: Git忽略文件配置。

• LICENSE: 项目许可证文件。

• README.md: 项目说明文档。

• build.gradle: 项目的根构建脚本。

• gradle.properties: Gradle属性配置文件。

• gradlew: Gradle Wrapper的Unix脚本。

• gradlew.bat: Gradle Wrapper的Windows批处理脚本。

• settings.gradle: 项目的设置文件，定义了包含的模块。

2. 项目的启动文件介绍

项目的启动文件位于 app/src/main/java/ 目录下。具体启动文件的名称取决于应用程序的入口类。通常情况下，启动文件是 MainActivity.java 或 App.java。

示例启动文件 MainActivity.java

package com.example.app;

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

启动文件介绍

• MainActivity.java: 这是应用程序的主活动类，负责启动应用程序并加载主界面。
  • onCreate(Bundle savedInstanceState): 这是活动的生命周期方法，在活动创建时调用。它负责设置内容视图并初始化UI组件。

3. 项目的配置文件介绍

build.gradle (根目录)

// 根目录的build.gradle文件
buildscript {
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:7.0.2'
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

build.gradle (app模块)

// app模块的build.gradle文件
apply plugin: 'com.android.application'

android {
    compileSdkVersion 30
    defaultConfig {
        applicationId "com.example.app"
        minSdkVersion 21
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.3.1'
    implementation 'com.google.android.material:material:1.4.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.0'
    implementation project(':binder')
    annotationProcessor project(':binder-compiler')
}

settings.gradle

// settings.gradle文件
include ':app', ':binder-annotations', ':binder-compiler', ':binder'

配置文件介绍

• build.gradle (根目录): 定义了项目的构建脚本配置，包括构建工具的版本、依赖仓库和清理任务。
• build.gradle (app模块): 定义了应用程序模块的配置，包括编译SDK版本、默认配置、构建类型和依赖项。
• settings.gradle: 定义了项目中包含的模块。

通过以上配置文件，项目可以正确地构建和运行。

annotation-processing-example It is the example project for the annotation processing tutorial. 项目地址: https://gitcode.com/gh_mirrors/an/annotation-processing-example