BadgeView 开源项目使用教程
1. 项目的目录结构及介绍
BadgeView 项目的目录结构如下:
BadgeView/
├── app/
│ ├── build.gradle
│ └── src/
│ └── main/
│ ├── java/
│ └── res/
├── badgeviewlib/
│ ├── build.gradle
│ └── src/
│ └── main/
│ ├── java/
│ └── res/
├── gradle/
│ └── wrapper/
├── .gitignore
├── LICENSE
├── README.md
├── build.gradle
├── demo.png
├── demo_gif.gif
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle
目录结构介绍
app/
: 包含示例应用的代码和资源文件。badgeviewlib/
: 包含 BadgeView 库的核心代码和资源文件。gradle/
: 包含 Gradle 包装器的文件。.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证文件。README.md
: 项目说明文档。build.gradle
: 项目的构建脚本。demo.png
: 示例应用的截图。demo_gif.gif
: 示例应用的动态图。gradle.properties
: Gradle 属性配置文件。gradlew
: Gradle 包装器脚本(Unix)。gradlew.bat
: Gradle 包装器脚本(Windows)。settings.gradle
: 项目设置文件。
2. 项目的启动文件介绍
BadgeView 项目的启动文件位于 app/src/main/java/
目录下。主要的启动文件是 MainActivity.java
,它负责初始化示例应用并展示 BadgeView 的功能。
package com.qstumn.badgeview.demo;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.TextView;
import com.qstumn.badgeview.Badge;
import com.qstumn.badgeview.BadgeView;
public class MainActivity extends AppCompatActivity {
private TextView textView;
private BadgeView badgeView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
textView = findViewById(R.id.textView);
badgeView = new BadgeView(this);
badgeView.bind(textView);
badgeView.setBadgeCount(5);
}
}
启动文件介绍
MainActivity.java
: 示例应用的主活动,负责初始化和展示 BadgeView 的功能。BadgeView.java
: BadgeView 库的核心类,用于创建和管理徽章视图。
3. 项目的配置文件介绍
BadgeView 项目的配置文件主要包括 build.gradle
和 gradle.properties
。
build.gradle
项目的根目录下的 build.gradle
文件包含整个项目的构建配置:
// 根目录下的 build.gradle
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.5.0'
}
}
allprojects {
repositories {
google()
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
app
和 badgeviewlib
模块下的 build.gradle
文件包含各自模块的构建配置:
// app 模块下的 build.gradle
apply plugin: 'com.android.application'
android {
compileSdkVersion 29
defaultConfig {
applicationId "com.qstumn.badgeview.demo"
minSdkVersion 14
targetSdkVersion 29
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules