`shaky-android` 开源项目快速入门指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00095/article/details/139571165

`shaky-android` 开源项目快速入门指南

shaky-android Shake to send feedback for Android. 项目地址: https://gitcode.com/gh_mirrors/sh/shaky-android

项目简介

本指南旨在帮助开发者快速理解并上手 shaky-android 这一强大的Android反馈插件。该项目灵感来源于Google Maps的摇晃发送反馈功能，利用Square的Seismic库实现，方便用户通过简单的摇晃动作发送应用反馈。

目录结构及介绍

linkedin-shaky-android/
├── github/workflows            # GitHub Actions相关配置文件
├── config/checkstyle           # Checkstyle配置，用于代码风格检查
├── gradle                      # Gradle构建脚本
├── shaky-sample                # 示例应用程序，展示如何集成Shaky
├── shaky                       # 主要库源码
├── gitignore                   # 忽略文件列表
├── CHANGELOG.md                # 变更日志
├── CONTRIBUTING.md             # 贡献者指南
├── LICENSE                     # 许可证文件
├── NOTICE                      # 法律通知
├── README.md                   # 项目读我文件，含基本使用说明
├── RELEASING.md                # 发布流程说明
├── build.gradle                # 构建配置
├── gradle.properties           # Gradle属性文件
├── gradlew                     # Gradle wrapper，用于跨平台执行Gradle任务
├── gradlew.bat                 # Windows下的Gradle Wrapper批处理文件
├── res                         # 资源文件夹（不直接在根目录下，但需了解）
│   └── xml                     # XML资源文件，包括filepaths.xml等
├── screenshot.png              # 屏幕截图
└── settings.gradle             # Gradle设置文件，控制项目结构

启动文件介绍

虽然这个项目没有一个单一的“启动”文件，如传统意义上的Activity或Service入口点，但在实际应用中，集成始于你的App的主类，通常是继承自Application的类。你需要在该类的onCreate()方法中初始化Shaky，例如：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        // 初始化Shaky，这里以发送Email为例
        Shaky.with(this, new EmailShakeDelegate("feedback@example.com"));
    }
}

项目配置文件介绍

AndroidManifest.xml 修改

首先，需要在AndroidManifest.xml中添加FileProvider，允许Shaky捕捉到的文件被分享给外部应用：

<provider
    android:name="androidx.core.content.FileProvider"
    android:authorities="${applicationId}.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/filepaths"/>
</provider>

此外，还需创建一个对应的res/xml/filepaths.xml来定义共享路径：

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="files" path="."/>
</paths>