README.md · 零点创玩/AppSdk

# AppSdk接入文档

AppSdk是一款多功能聚合sdk与自动化接入工具，可以帮助我们快速接入国内外上架所必备的功能。

1. [AppCore](../master/AppCore.md)，核心库，集合了多样化基础信息与基础工具。
2. [AppConfig](../master/AppConfig.md)，在线配置库，聚合了友盟、Firebase、huawei的在线配置功能。
3. [AppEvent](../master/AppEvent.md)，埋点库，聚合了友盟、firebase,huawei,adjust,appsFlyer的埋点功能。
4. [AppAd](../master/AppAd.md)，基于适配器模式的广告聚合库，静态化API调用，极致简约，支持多场景广告策略配置。
5. AppCommon，内置了几种通用弹窗，例如隐私政策、防沉迷实名认证、适龄提示。
6. AppMessage，轻量级的应用内通讯库。
7. AppStatus，应用内轻量状态库，内置了一些定制埋点。
8. AppAnalysis，应用内轻量埋点库，需要申请并配置key才能生效。

### 环境说明
1. 需要支持AndroidX
2. 个别渠道需要支持kotlin 1.7.10
3. GP要求compileSdkVersion和targetSdkVersion大于等于31
4. 个别渠道要求minSdkVersion大于等于21
5. 新版本编译器要求支持Java11

### 一、接入AppSdk
```groovy
//对于高版本gradle，格式有所变化，需要自行进行一些调整
buildscript {
    repositories {
        maven {
            credentials {
                username '64902788b97ac8ef224e6817'
                password '99F9lqriqO4R'
            }
            url 'https://packages.aliyun.com/maven/repository/2254835-release-ZGwQoJ/'
        }
        gradlePluginPortal()
        google()
        mavenCentral()
    }
    dependencies {
        classpath("com.android.tools.build:gradle:7.1.3")
        classpath 'com.njxing.plugin:app-sdk:0.710.1201.0-t07'//支持AGP7.1.0以及以上(AGP 8.x目前还缺少测试)
        //classpath 'com.njxing.plugin:app-sdk:0.410.1201.1-t07'//支持AGP4.1.0-3.4.1
    }
}
```
高版本gradle需要对以下代码进行注释[setting.gradle]
```groovy
dependencyResolutionManagement {
//    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)//注释这一句
    repositories {
        
    }
}
```
启动AndroidX[gradle.properties]
```groovy
android.useAndroidX=true
android.enableJetifier=true
```

```groovy

plugins {
    id 'com.android.application'
    id 'app-sdk'
}

android{

//支持Java8
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    
    //渠道配置
    String dimen = "app"
    flavorDimensions dimen
    productFlavors {
        taptap {//渠道示例
            applicationId "com.njxing.demo"
            dimension dimen
        }
        mi {//渠道示例
            applicationId "com.njxing.demo.mi"
            dimension dimen
        }
    }

appSdkConfig{
        //目前支持的平台groMore,oppo,vivo,mi,topOn,maxAd
        channel = ['taptap':"groMore"]//渠道映射，如直接使用了平台名作为渠道名则不需要映射
    }
}

```

### 二、配置AppSdk
通过网页工具配置Sdk[广告配置生成器](http://app.sdk.njxing.cn/config/groMore)
配置文件（app-sdk-xxx.json）存放到当前gradle目录底下

### 三、初始化SDK
```java
public class App extends Application {

@Override
    public void onCreate() {
        super.onCreate();

AppCore.setDebug(BuildConfig.DEBUG);//设置debug
        AppCore.setChannel("test");//设置渠道【必须】
        AppCore.setConfigMode(ConfigMode.UMENG);//设置在线参数来源
        AppSdk.init(this);
    }
}
```
### 四、调用生命周期
注意：生命周期方法仅需在主Activity之后的Activity调用，类似开屏页不需要调用
```java
public class MainActivity extends AppCompatActivity {

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        AppSdk.onCreate(this);
        AppSdk.agreePrivacy(this);//等同意隐私政策后调用(仅需调用一次)

}

@Override
    protected void onResume() {
        super.onResume();
        AppSdk.onResume(this);
    }

@Override
    protected void onPause() {
        super.onPause();
        AppSdk.onPause(this);
    }

@Override
    protected void onDestroy() {
        super.onDestroy();
        AppSdk.onDestroy(this);
    }
}

```

### 五、其他API

#### 5.1 AppCore
```java

AppCore.getAppInfo()//获取应用基础信息
AppCore.isAgreePrivacy()//判断是否已同意隐私政策
AppCore.isNewUser()//判断是否是新增用户
AppCore.setConfigMode()//设置在线配置来源
AppThreadPool//通用线程池，包含可变线程池与单线程池
AppTools//集成了一些常用工具方法，还在扩展中
SharedPreferencesHelper//一款强大的持久化工具类
FileDownloader//一款多线程下载工具类
ImageLoader//一款多线程图片加载类
```

#### 5.2 AppConfig
```java
AppConfig.getString(key,defValue)//获取在线参数-字符串
AppConfig.getBoolean(key,defValue)//获取在线参数-布尔值
AppConfig.getXxxxxx(key,defValue)//获取在线参数-xx
```

#### 5.3 AppEvent
```java
AppEvent.event(platform,eventName,map)//埋点-指定平台
```

#### 5.4 AppAd
```java
AppAd.showVideo()
AppAd.showInterstitial()
AppAd.showInterstitialVideo()
AppAd.showBanner()
AppAd.hideBanner()
AppAd.showSplash()
```

### 六、更新日志
0.xxx.1201.x-t07
```
1、更新AppSdk到1.3.28(完善广告适配器功能，完善工具类，修复bug等)
2、支持admob平台
3、支持广告配置自动加密
4、支持自定义广告平台
```
0.xxx.1108.x-t08    日期：2023-06-28
```
1、更新AppSdk到1.3.9
2、升级与适配vivo、oppo等渠道sdk
```
0.xxx.1100-t08    日期：2023-02-09
```
1、支持通过json文件来配置AppSdk
2、appSdkConfig增加appSdk、sdk配置项，详情见上方说明
3、支持Max渠道
```

0.xxx.1007-t02    日期：2023-01-07
```
1、更新AppUnion，改为由AppSdk调用onCreate方法，无再需要另外调用。
2、新增对vivo、4399平台的支持。
```

0.xxx.1006-t01    日期：2023-01-04
```
1、更新AppSdk、AppAd：支持关闭自动加载并且支持手动调用加载广告接口。
2、支持自动添加networkSecurityConfig、org.apache.http.legacy两个基础网络配置。
```

零点创玩/AppSdk

简介

发行版

贡献者

近期动态

零点创玩/AppSdk .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

零点创玩/AppSdk