# Androidbaselib

**Repository Path**: duxiangliang/Androidbaselib

## Basic Information

- **Project Name**: Androidbaselib
- **Description**: Android框架，集成大多数可能会有用的功能。用于快速搭建Android项目
- **Primary Language**: Android
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-07-26
- **Last Updated**: 2025-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Android框架，集成大多数可能会有用的功能。用于快速搭建Android项目

使用示例见：[https://github.com/duxl/AndroidQuicklib](https://github.com/duxl/AndroidQuicklib)



## 引入方式一，复制代码（用config.gradle可以让每个module引用库的版本一致）

1. **新建项目**

2. **在项目的根目录下创建[config.gradle](https://github.com/duxl/AndroidQuicklib/blob/master/config.gradle)文件**

3. **在项目的根目录下创建baselib目录，将所有代码复制到baselib目录**

4. **在新建项目根目录的`build.gradle`的第一行加入** 

   > apply from: "config.gradle"

   并添加`jitpack`仓库地址

   > maven { url 'https://jitpack.io' }

5. **修改app下的build.gradle，添加如下代码**

   **5.1 添加java编译版本**

```groovy
compileOptions {
    sourceCompatibility = '1.8'
    targetCompatibility = '1.8'
}
```

​		**5.2 将默认的`defaultConfig`替换成下面**

```groovy
defaultConfig {
    applicationId "your package name"
    minSdkVersion rootProject.ext.android["minSdkVersion"]
    targetSdkVersion rootProject.ext.android["targetSdkVersion"]
    versionCode rootProject.ext.android["appVersionCode"]
    versionName rootProject.ext.android["appVersionName"]
}
```

​		**5.3 同时将默认的dependencies替换成如下**

```
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation project(path: ':baselib')

    // annotationProcessor 在每个module中都必须配置才起作用
    annotationProcessor rootProject.ext.dependencies["glide-compiler"]
}
```

6. **修改app的主题样式**

```
<style name="AppTheme" parent="BaseAppTheme">
```

**ps:如果报如下错误，肯定是忘记了上面的第4步**

`ERROR: Cannot get property 'version' on extra properties extension as it does not exist`



7. **将Application继承至BaseApplication**



## 引入方式二，gradle引入（推荐：不用拷贝大量代码，相对简单很多）

1. **添加`jitpack`仓库地址**

   ```groovy
   maven { url 'https://jitpack.io' }
   ```

2. **在app下的build.gradle添加引用**

   ```groovy
   implementation 'com.github.duxl:AndroidQuicklib:v1.0.0_bate7.4.1'
   
   // annotationProcessor 在每个module中都必须配置才起作用
   annotationProcessor 'com.github.bumptech.glide:compiler:4.11.0'
   ```

3. **修改app的主题样式**

   ```xml
   <style name="AppTheme" parent="BaseAppTheme">
   ```

4. **将Application继承至BaseApplication**



ps：最新IDE创建的项目还需引入 `jcenter()` 仓库，并在gradle.properties中添加 `android.enableJetifier=true`

##### 如果使用 AndroidX 先在 gradle.properties 中添加，两行都不能少噢~

```
android.useAndroidX=true
android.enableJetifier=true
```

##### ~~新建高版本的项目，运行gradle可能会报找下面的错误，可以尝试添加`jcenter()`仓库解决，或者 `maven(url = "https://jcenter.bintray.com/")`~~

```groovy
> Could not resolve all files for configuration ':app:debugRuntimeClasspath'.
   > Could not find com.scwang.smart:refresh-layout-kernel:2.0.1.
     Searched in the following locations:
       - https://dl.google.com/dl/android/maven2/com/scwang/smart/refresh-layout-kernel/2.0.1/refresh-layout-kernel-2.0.1.pom
       - https://repo.maven.apache.org/maven2/com/scwang/smart/refresh-layout-kernel/2.0.1/refresh-layout-kernel-2.0.1.pom
       - https://jitpack.io/com/scwang/smart/refresh-layout-kernel/2.0.1/refresh-layout-kernel-2.0.1.pom
```

#### jcenter()仓库已停止服务，请使用google()、mavenCentral()或者[aliyun镜像](https://developer.aliyun.com/mvn/guide)，如果依赖库不能下载并报错如下错，可尝试升级gradle版本
```groovy
> The server may not support the client's requested TLS protocol versions: (TLSv1.2, TLSv1.3).
```



## BaseActivity API

### 页面基础通用

``` java
// 隐藏状态栏，默认显示（内容填充到状态栏区域）
public void hideStateBar()
```

``` java
// 显示状态栏，默认显示（内容在状态栏区域之下）
public void showStateBar()
```

```java
// 设置状态栏颜色
public void setStateBarColor(int color)
```

```java
// 设置状态栏背景
public void setStateBarResource(int resId)
```

*ActionBar与StateBar有如上相似的api，这里就不再累述*

```java
// 设置ActionBar悬浮（澄侵式ActionBar），也就是ActionBar透下去可已看到后面的内容
public void setActionBarFloat(boolean isFloat)
```

```java
// 设置标题
public void setTitle(int titleId)
public void setTitle(CharSequence title)
```

```java
// 返回按钮点击事件，可重写，默认是关闭Activity
protected void onClickActionBack(View v)
```

```java
// 关闭按钮点击事件，可重写，默认是关闭Activity。通常WebView页面有关闭按钮。
// 默认隐藏，需要显示请调用getActionBarView().getIvClose().setVisibility(View.VISIBLE);
protected void onClickActionClose(View v)
```

```java
// 设置右边文字点击事件
// 默认隐藏，需要显示请调用getActionBarView().getTvRight().setVisibility(View.VISIBLE);
protected void onClickActionTvRight(View v)
```

```java
// 设置右边图标点击事件
// 默认隐藏，需要显示请调用getActionBarView().getTvRight().setVisibility(View.VISIBLE);
protected void onClickActionIvRight(View v)
```

```java
// 重写此方法可单独修改页面的StatusView，全局配置可在app中重写global_status_view_config.xml
protected IStatusView initStatusView()
```

```java
// 设置状态栏字体和图标模式：深色和浅色
public void setStateBarDarkMode()
public void setStateBarLightMode()
```

*可配置全局[ActionBar](https://github.com/duxl/Androidbaselib/blob/master/src/main/res/values/global_action_bar_config.xml)和[StatusView](https://github.com/duxl/Androidbaselib/blob/master/src/main/res/values/global_status_view_config.xml)的样式*

### 页面刷新相关

```java
// 设置页面加载更多和下拉刷新是否可用
public void setEnableLoadMore(boolean enabled)
public void setEnableRefresh(boolean enabled)
```

```java
// 完成刷新/加载更多
public RefreshLayout finishRefresh()
public RefreshLayout finishLoadMore()
```

```java
// 完成加载并标记没有更多数据
public RefreshLayout finishLoadMoreWithNoMoreData()
```

```java
// 恢复没有更多数据的原始状态
public RefreshLayout resetNoMoreData()
```

```java
// 设置刷新、加载更多、点击重试 等监听
public void setOnLoadListener(OnLoadListener listener)
```



### http接口请求使用步骤

1. 重写Application的getGlobalHttpConfig()，配置全局的baseUrl、log处理器、网络监测处理、[code&msg](https://github.com/duxl/Androidbaselib/blob/master/src/main/res/values/global_http_exception_reason.xml)

2. 定义interface接口，用于描述接口地址和参数信息，示例如下

   ```java
   @GET("app/mock/258579/test_list_data")
   Observable<Root<List<String>>> getList(
           @Query("pageNum") int pageNum,
           @Query("pageSize") int pageSize
   );
   ```

3. 使用RetrofitManager发起请求，示例如下

   ```java
   private void loadData() {
           RetrofitManager
                   .getInstance()
                   .create(HttpService.class)
                   .getList(pageNum, 20)
                   .compose(new LifecycleTransformer<Root<List<String>>>(this))
                   // 如果刷新和状态view都是页面，这里可以传Activity.this作为参数，第一个参数adapter是必须的，后面两个是可选的
                   // 普通接口可以用 BaseHttpObserver
                   //.subscribe(new BaseRecyclerViewHttpObserver<Root<List<String>>, String>(mAdapter, this, this) {
                   .subscribe(new BaseRecyclerViewHttpObserver<Root<List<String>>, String>(mAdapter, mSmartRecyclerView, mSmartRecyclerView) {
                       @Override
                       public List<String> getListData(Root<List<String>> root) {
                           return root.data;
                       }
   
                       @Override
                       public boolean isFirstPage() {
                           return pageNum == 1;
                       }
   
                       @Override
                       public boolean hasMoreData(Root<List<String>> root) {
                           return pageNum < 3;
                       }
   
                       @Override
                       public void onError(int code, String msg, Root<List<String>> root) {
                           if(code == HttpExceptionReasons.CONNECT_NO.getCode()) {
                               // 这里可以特殊处理，比如弹框去设置打开wifi等
                           } else {
                               super.onError(code, msg, root);
                           }
                       }
                   });
       }
   ```




## BaseFragment API

BaseActivity 的 Api 在 BaseFragment中都有对应的，这里不再累述



## LazyFragment

LazyFragment继承至BaseFragment，扩充了懒加载的支持

`inflateLayout()` 加载布局文件，调用了此方法的Fragment会失去懒加载的功能，跟普通BaseFragment一样

`onLazyHiddenChanged(isVisible, isFirstVisible)` fragment可见状态改变的时候回调



## 工具类

- **AlbumUtils**

  *片选择和视频选择*

- **APKManager**

  *安装apk，版本升级*

- **AppManager**

  *统一管理activity生命周期 以及其他操作等*

- **AppSigning**

  *获取app的签名信息*

- **ArithmeticUtils**

   *算数相关工具类*

- **AnimUtils**
  *动画工具类*

- **BinaryUtils**

   *二进制位运算工具*

- **DesensitizationUtils**

  脱敏工具类：例如手机号中间4个加星号，姓名加星号

- **DisplayUtil**

  *显示相关工具类：获取屏幕高宽；dp、sp与px的转换等*

- **DoubleClickExit**

  *双击退出屏幕*

- **Dispatch**

  *任务分发队列（可选择主线程或子线程）*

- **EmptyUtils**

  *EmptyUtils，验证传入参数是否为null或者集合是否未空集合，数组是否为空数组。与NullUtils 的区别是，NullUtils 是用于转换，EmptyUtils用于验证判断。   前者着重转换，后者着重判断*

- **FontUtil**

  *FontUtil，获取字体，给TextView设置字体*


- **MultiTaskMarkUtil**

  *多任务标记工具类，可用于多个异步操作是否都执行完毕的判断举例：多个异步接口调用前显示dialog加载匡，所有接口都调用完毕后取消dialog这个工具类就可以用来记录这些接口是否都调用完毕，哪些已经调用完毕了*

- **MaterialUtils**

  *Google材料设计，提供阴影背景、带三角尖的背景等*

- **NetCheckUtil**

  *网络监测相关：获取网络状态、是否连接网络等*

- **NullUtils**

  *Null工具类，format方法将传入的参数转换为非null对象。与EmptyUtils 的区别是，EmptyUtils 用于验证判断，NullUtils是用于转换前者着重判断，后者着重转换*

- **RegexUtils**

  *正则表达式工具类，提供了正则表达式验证方法和一些常用的正则规则*

- **SpanUtils**

  *字体加粗、斜体、变色等*

- **SPUtils**

  *SharedPreferences数据存储封装*

- **TimeUtils**

  *时间日期工具类*

- **ToastUtils**

  *Toast吐丝提示工具*

- **Utils**

  *其它工具*

- **ViewClickDelayUtil**

  *延迟控件的点击响应，避免快速连续点击*

- **WindowSoftInputCompat**

  *Android全屏／沉浸式状态栏下，键盘挡住输入框解决办法*

## 工具类

- **AlbumUtils**

  *片选择和视频选择*


## widget

- **ActionBarView**

  *ActionBarView*

- **CenterLayoutManager**

  *RecyclerView横向列表item滚动居中*

- **ClearEditText**

  *监听输入内容是否为空，不为空显示清除按钮，点击清除按钮清空文本内容*

- **DividerView**

  *分割线，支持虚线*

- **FirstLineMarginFlowLayout**

  *首行可设置水平margin属性的FlowLayout*


- **HeartbeatTextView**

  *心跳TextView（可用于倒计时等功能）*

- **InputDigitalTextWatcher**

  *输入数字监听，控制输入数字的最小值，最大值和小数位位数*

- **JustifyTextView**

  *两端分散对齐的TextView（使用本控件前提条件：单行普通文本）*

- **LayerLayout**

  *横向叠放view的Layout(常用显示多个图标或头像，并且有重叠的效果)*

- **MaskImageView**

  *遮罩ImageView，使用遮罩实现任意的形状效果*

- **NoScrollViewPager**

  *禁用横向滑动的ViewPager*

- **SmartRecyclerView**

  *封装了上拉刷新，下载加载更多，显示各种状态的列表*


## 其它

- **BaseExpandableAdapter**

  *可折叠展开的适配器*

- **TimelineDecoration**

  *时间线装饰器*