# XBaseAndroid **Repository Path**: javaining/XBaseAndroid ## Basic Information - **Project Name**: XBaseAndroid - **Description**: 一款集成了网络请求，本地缓存，配置文件，数据库映射，权限申请，链表管理Activity，简化Activity、Service、Broadcast启动， 万能ListView,GridView适配器、高仿IOS弹窗、倒计时/延迟执行，标题栏组件,图片显示，webview引擎，APP更新组件，APP崩溃日志组件 - **Primary Language**: Android - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 36 - **Created**: 2017-12-15 - **Last Updated**: 2021-11-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # XBaseAndroid 一款集成了网络请求，本地缓存，配置文件，数据库映射，权限申请，链表管理Activity，简化Activity、Service、Broadcast启动， 万能ListView,GridView适配器、高仿IOS弹窗、倒计时/延迟执行，标题栏组件,图片显示，webview引擎，APP更新组件，APP崩溃日志组件，事件总线（热更新组件暂未加入，有需要请联系）。 项目地址：[https://github.com/fanhua1994/XBaseAndroid](https://github.com/fanhua1994/XBaseAndroid) ![BaseAndroid](https://github.com/fanhua1994/BaseAndroid/blob/master/image/logo.png?raw=true) # 版本更新 目前最新版本是1.0.3 [更新日志](https://github.com/fanhua1994/XBaseAndroid/blob/master/LOG.md) # 引入方式 在项目root gradle加入 ``` allprojects { repositories { google() jcenter() //加入以下仓库 maven { url 'https://jitpack.io' } } } ``` app下的gradle加入 ``` dependencies { compile 'com.github.fanhua1994:XBaseAndroid:1.0.3' } ``` # 初始化框架 ## 1.初始化Application ``` ``` ## 2.继承XBaseActivity实现ButterKnife视图自动注入功能，不使用可不继承，直接使用XBaseActivity > 由于ButterKnife不能再lib中bind。所以必须继承XBaseActivity进行二次封装。XBaseAndroid不提供视图注解，如需使用请自行引入以下库。 ``` compile 'com.jakewharton:butterknife:8.5.1' annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1' ``` ``` package com.hengyi.baseandroiddemo; import android.os.Bundle; import com.hengyi.baseandroidcore.base.XBaseActivity; import butterknife.ButterKnife; import butterknife.Unbinder; /** * Created by Administrator on 2017/10/10. */ public abstract class BaseActivity extends XBaseActivity { private Unbinder unbind = null; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); unbind = ButterKnife.bind(this); } @Override public int setBaseContentView() { return setContentView(); } public abstract int setContentView(); @Override protected void onDestroy() { super.onDestroy(); unbind.unbind(); } } ``` ## 功能介绍 ### 弹窗 ![](https://github.com/fanhua1994/BaseAndroid/blob/master/image/%E4%BB%BFIOS%E5%BC%B9%E5%87%BA%E6%8F%90%E7%A4%BA%E6%A1%86.png?raw=true) ``` CustomAlertDialog dialog = new CustomAlertDialog(this).builder(); dialog.setTitle("温馨提示"); dialog.setMsg("你好啊"); dialog.show(); ``` ### 可以选择的弹窗 ![](https://github.com/fanhua1994/BaseAndroid/blob/master/image/%E4%BB%BFIOS%E5%BC%B9%E5%87%BA%E9%80%89%E6%8B%A9%E6%A1%86.png?raw=true) ``` CustomAlertDialog dialog = new CustomAlertDialog(this).builder(); dialog.setTitle("温馨提示"); dialog.setMsg("你好啊"); dialog.setNegativeButton("确定", new View.OnClickListener() { @Override public void onClick(View view) { toast("点击了确定"); } }); dialog.setPositiveButton("取消",null); dialog.show(); ``` ### 弹出输入框 ![](https://github.com/fanhua1994/BaseAndroid/blob/master/image/dialog_confirm.png?raw=true) ``` CustomConfirmDialog dialog = new CustomConfirmDialog(this).builder(); dialog.setTitle("温馨提示"); dialog.setInputNumber(false); dialog.setNegativeButton("取消", new View.OnClickListener() { @Override public void onClick(View view) { } }); dialog.setPositiveButton("取消",new CustomConfirmDialog.OnPostListener(){ @Override public void OnPost(String value) { toast(value); } }); dialog.show(); ``` ### 加载Loading ![](https://github.com/fanhua1994/BaseAndroid/blob/master/image/dialog_loading.png?raw=true) ``` showLoadingDialog("正在加载"); closeLoadingDialog(); ``` ### 倒计时控件 ``` countdownUtils = CountdownUtils.getInstance(); countdownUtils.start(100000,1000); countdownUtils.setCountdownListener(new CountdownUtils.setOnCountDownListener() { @Override public void onTick(int second) { numberProgressBar.setProgress(100 - second); } @Override public void onFinish() { } }); ``` ### 定时器控件 ``` TimerUtils timer = TimerUtils.getInstance(); timer.setTimer_id(123); timer.startTimer(5);//单位秒 timer.setTimerListener(new TimerUtils.TimerTaskCallbackListener() { @Override public void Timing(int timer_id, int timer_count) { toast("timer_id:"+timer_id); } }); ``` ### 权限申请 AndroidManifest.xml ``` ``` ``` PermissionUtils.requestPermissions(this,200,new String[]{"android.permission.READ_CONTACTS"},new PermissionUtils.OnPermissionListener(){ @Override public void onPermissionGranted() { toast("权限申请成功"); } @Override public void onPermissionDenied(String[] deniedPermissions) { toast("权限申请失败"); } }); ``` ### 创建工作组 > 工作组就好比我们将我们的外部储存分为很多很多目录，每个目录一个分组。文件互不影响。可以删除写入数据。目前默认的有db、cache、file分组。其他需要自定义。 ``` boolean isok = FileUtil.getInstance().setIdCard(true).setFileType(FileUtil.CACHE_FILE).createWorkGroup("mycache12"); toast("执行结果：" + isok); //setIdCard setFileType可以不调用。默认是自定义分组模式，外部储存有优先。 ``` ### 本地缓存使用 ``` DiskLruCacheHelper cache = DiskLruCacheHelper.getInstance(this); cache.put("cache","21424984034324934320434940494044904239"); toast(cache.getAsString("cache") +"缓存大小："+cache.getCacheCount()); ``` ### 配置文件使用 > ConfigUtil自主维护了一个哈希表可以很快的根据数据缓存拿到数据，不用去xml里面读取，性能很不错。 ``` ConfigUtils config = ConfigUtils.getInstance(this); config.addOrUpdateText("name","繁华"); toast(config.findStringByKey("name")); config.clearConfig(); ``` ### 标题栏使用 ``` ``` ``` @BindView(R.id.titleBar)EaseTitleBar easeTitleBar; easeTitleBar.setLeftLayoutClickListener(new View.OnClickListener(){ @Override public void onClick(View view) { ActivityStack.getInstance().popActivity(); } }); ``` ### 如何高效关闭Activity ``` ActivityStack.getInstance().popActivity(); 千万不要使用finish(); ``` ### 调用web引擎 > WebEngineActivity.java需要在Mainfast.xml注册activity。最新修复web引擎支持隐藏标题栏。 ``` StartActivity(WebEngineActivity.class,new String[]{WebEngineActivity.WEB_URL_PARAM,WebEngineActivity.WEB_SHOW_TITLE_BAR},"http://www.baidu.com/",false); ``` ### 本地数据库使用 #### 创建实体Student ``` package com.hengyi.db; import com.j256.ormlite.field.DatabaseField; import com.j256.ormlite.table.DatabaseTable; /** * Created by Administrator on 2017/10/8. */ @DatabaseTable public class Student { @DatabaseField private int id; public int getId() { return id; } public void setId(int id) { this.id = id; } @DatabaseField private String name; public String getName() { return name; } public void setName(String name) { this.name = name; } } ``` #### 创建StudentDao ``` package com.hengyi.db; import android.content.Context; import com.hengyi.baseandroidcore.database.BaseDao; import com.hengyi.baseandroidcore.database.BaseDaoImpl; import java.sql.SQLException; /** * Created by Administrator on 2017/10/11. */ public class StudentDao { private BaseDao studentDao; public StudentDao(Context context){ studentDao = new BaseDaoImpl<>(context,Student.class); } public int add(Student s){ try { return studentDao.save(s); } catch (SQLException e) { e.printStackTrace(); return 0; } } } ``` #### 初始化数据库（切记在启动界面做好初始化，或者Application文件做好相关初始化操作） ``` DatabaseHelper.setDatabase("easy",2);//设置数据库版本及名称 DatabaseHelper.addTable(Student.class); ``` #### 使用 ``` StudentDao sd = new StudentDao(context); Student s = new Student(); s.setId(1); s.setName("ggeegegerger"); int res = sd.add(s); toast("添加学生结果是：" + res); ``` #### 数据库版本变化监听 ``` DatabaseHelper.getInstance(this).setDatabaseVersionChangeListener(new DatabaseVersionChangeListener() { @Override public void onChange(int oldVersion, int newVersion) { toast("数据库版本繁盛变化：老版本:"+oldVersion +" 新版本："+newVersion); if(newVersion == 2){ try { DatabaseHelper.getInstance(getContext()).getDao(Student.class).executeRaw("ALTER TABLE 'student' ADD COLUMN sex int"); toast("数据更新成功"); } catch (SQLException e) { e.printStackTrace(); toast("数据更新失败"); } } } }); toast("当前数据库版本："+DatabaseHelper.getInstance(this).getVersion() +"数据库名："+DatabaseHelper.getInstance(this).getDatabaseName()); ``` ### 提供状态栏工具 ``` //set color for status bar StatusBarCompat.setStatusBarColor(Activity activity, int color) //add alpha to color StatusBarCompat.setStatusBarColor(Activity activity, int statusColor, int alpha) //translucent status bar StatusBarCompat.translucentStatusBar(activity); //should hide status bar background (default black background) when SDK >= 21 StatusBarCompat.translucentStatusBar(Activity activity, boolean hideStatusBarBackground); setStatusBarColorForCollapsingToolbar(Activity activity, AppBarLayout appBarLayout, CollapsingToolbarLayout collapsingToolbarLayout,Toolbar toolbar, int statusColor) ``` ### 网络请求 > 本框架网络请求使用的是OkGo框架，文档地址如下[wiki](https://github.com/jeasonlzy/okhttp-OkGo/wiki) ### 杀死当前APP进程 ``` ActivityStack.getInstance().clearAllActivity(); kill(); ``` ``` ### 表单校验 [参考文档](https://github.com/fanhua1994/java_validation) > 如果您只需要接入校验模块，请参考这个地址：[https://github.com/fanhua1994/java_validation](https://github.com/fanhua1994/java_validation) ### APP更新组件（AppUpdateManager） ![](https://github.com/fanhua1994/BaseAndroid/blob/master/image/APP_update.png?raw=true) + 支持MD5文件校验 + 支持强制更新(isForce) + 支持在获取root情况下静默安装 + 支持下载完跳转到安装界面 + 支持安卓7.0 + 支持各类回调接口 ### 如何兼容Android7.0 #### AndroidMainfest.xml application节点下添加 ``` ``` #### 将demo res-> xml文件夹复制到你的应用目录。 ``` UpdateBean updateBean = new UpdateBean(); updateBean.setDescription("今日更新了XBaseAndroid框架的更新管理器。"); updateBean.setDownload_url("http://file.cleveriip.com:88/group2/M00/00/03/rBJbXVnlcPCATMAtAtnNwW8wwRs625.apk"); updateBean.setForce(true);//是否强制更新 或 静默安装 updateBean.setAuthority("com.hengyi.XBaseandroid.fileProvider");//兼容安卓7.0 安装 updateBean.setMd5_code("a034366c2257281060a3ee27df38a793"); updateBean.setNew_version("1.0.0.1"); updateBean.setTitle("新版本来啦，立即更新吧"); AppUpdateManager appUpdateManager = AppUpdateManager.getInstance(); appUpdateManager.checkUpdate(updateBean,this); appUpdateManager.setAppUpdateListener(new AppUpdateManager.AppUpdateListener() { @Override public void downloadProgressBar(String progress, String speed) { Log.d("AppUpdateManager","进度条：" + progress +" 下载速度：" + speed); } @Override public void downloadSuccess(File app_path) { Log.d("AppUpdateManager","下载成功 路径如下：" + app_path.getAbsolutePath()); } @Override public void downloadStart() { Log.d("AppUpdateManager","下载开始"); } @Override public void downloadError(String message) { Log.d("AppUpdateManager","下载错误"); } @Override public void downloadFinish() { Log.d("AppUpdateManager","下载结束"); } @Override public void cancelDownload() { Log.d("AppUpdateManager","取消下载"); } @Override public void NoUpdate() { Log.d("AppUpdateManager","没有更新"); } }); ``` ### 下载日志 ``` :48:39.332 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：78.49 下载速度：789.25kb/s 11-12 05:48:39.645 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：79.43 下载速度：889.85kb/s 11-12 05:48:39.945 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：80.80 下载速度：1.03mb/s 11-12 05:48:40.250 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：82.20 下载速度：1.18mb/s 11-12 05:48:40.548 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：83.84 下载速度：1.37mb/s 11-12 05:48:41.186 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：85.09 下载速度：1.40mb/s 11-12 05:48:41.488 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：85.91 下载速度：1.45mb/s 11-12 05:48:41.791 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：86.79 下载速度：1.49mb/s 11-12 05:48:42.089 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：88.55 下载速度：1.66mb/s 11-12 05:48:42.440 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：89.74 下载速度：1.70mb/s 11-12 05:48:42.740 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：90.63 下载速度：1.71mb/s 11-12 05:48:43.046 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：91.54 下载速度：1.71mb/s 11-12 05:48:43.358 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：92.31 下载速度：1.61mb/s 11-12 05:48:43.663 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：93.06 下载速度：1.51mb/s 11-12 05:48:43.974 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：93.96 下载速度：1.40mb/s 11-12 05:48:44.309 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：94.55 下载速度：1.39mb/s 11-12 05:48:44.641 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：95.88 下载速度：1.44mb/s 11-12 05:48:45.027 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：96.70 下载速度：1.41mb/s 11-12 05:48:45.336 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：97.53 下载速度：1.27mb/s 11-12 05:48:45.638 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：98.34 下载速度：1.23mb/s 11-12 05:48:45.937 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：99.18 下载速度：1.23mb/s 11-12 05:48:46.243 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：99.93 下载速度：1.20mb/s 11-12 05:48:46.250 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 进度条：100.00 下载速度：1.35mb/s 11-12 05:48:46.253 9028-9028/com.hengyi.baseandroiddemo D/AppUpdateManager: 下载成功 路径如下：/storage/emulated/0/Android/data/com.hengyi.baseandroiddemo/download/XBaseAndroid_软件更新_1.0.0.1.apk ``` ### 图片压缩 #### 效果与对比 内容 | 原图 | `Luban` | `Wechat` ---- | ---- | ------ | ------ 截屏 720P |720*1280,390k|720*1280,87k|720*1280,56k 截屏 1080P|1080*1920,2.21M|1080*1920,104k|1080*1920,112k 拍照 13M(4:3)|3096*4128,3.12M|1548*2064,141k|1548*2064,147k 拍照 9.6M(16:9)|4128*2322,4.64M|1032*581,97k|1032*581,74k 滚动截屏|1080*6433,1.56M|1080*6433,351k|1080*6433,482k # 使用 ### 异步调用 `Luban`内部采用`IO`线程进行图片压缩，外部调用只需设置好结果监听即可： ``` Luban.with(this) .load(photos) // 传人要压缩的图片列表 .ignoreBy(100) // 忽略不压缩图片的大小 .setTargetDir(getPath()) // 设置压缩后文件存储位置 .setCompressListener(new OnCompressListener() { //设置回调 @Override public void onStart() { // TODO 压缩开始前调用，可以在方法内启动 loading UI } @Override public void onSuccess(File file) { // TODO 压缩成功后调用，返回压缩后的图片文件 } @Override public void onError(Throwable e) { // TODO 当压缩过程出现问题时调用 } }).launch(); //启动压缩 ``` ### 同步调用 同步方法请尽量避免在主线程调用以免阻塞主线程，下面以rxJava调用为例 ``` Flowable.just(photos) .observeOn(Schedulers.io()) .map(new Function, List>() { @Override public List apply(@NonNull List list) throws Exception { // 同步方法直接返回压缩后的文件 return Luban.with(MainActivity.this).load(list).get(); } }) .observeOn(AndroidSchedulers.mainThread()) .subscribe(); ``` ### 通知栏工具类 ``` NotifacationUtils notifacation = new NotifacationUtils(this);//实例化通知栏 notifacation.createProgressNotify(R.drawable.ic_launcher,200,"正在下载中","APP更新","App正在准备下载",new Intent());//创建进度条通知栏 notifacation.showProgressNotify(progress2,"当前下载网速" + speed);//设置进度条及文字显示 //notifacation.createNotify();//创建普通通知栏 ``` ### 事件总线 ``` //使用时，注册就行了 onCreate(){ EventBus.getDefault().register(this); } //界面销毁时 反注册 onDestroy(){ EventBus.getDefault().unregister(this); } ``` ``` @Subscribe(threadMode = ThreadMode.MAIN) public void onMessageEvent(DefaultMessageEvent event) {/* Do something */}; ``` 如何发送消息？ ``` EventManager.sendDefaultMessage(DefaultMessageEvent defaultMessageEvent); ``` DefaultMessageEvent是默认的消息类，您可以自定义消息。但默认的支持扩展数据，完全足够使用。DefaultMessageEvent支持以下的数据格式。 ``` private Object obj;//传输对象 private int code;//传输数字 private int status; private int mint; private int type; private float mfloat;//传输单精度数字 private double mdouble;//传输双精度数字 private long mlong;//传输长整型 private String content;//传输字符串 private Map map;//扩展包 ``` ### 数字进度条 ![](https://github.com/fanhua1994/XBaseAndroid/blob/master/image/%E6%95%B0%E7%BB%84%E8%BF%9B%E5%BA%A6%E6%9D%A1.gif?raw=true) ``` ``` 模拟进度条 采用倒计时控件 ``` CountDownUtils countDownUtils = new CountDownUtils(100000,1000); countDownUtils.start(new CountDownUtils.setOnCountDownListener() { @Override public void onTick(int second) { numberProgressBar.setProgress(100 - second); } @Override public void onFinish() { } }); ``` ### 复制黏贴（不再兼容API 11） ``` ClipboardUtils.getInstance().copy(Context context,String text);//复制 ClipboardUtils.getInstance().paste(Context context)//黏贴 ClipboardUtils.getInstance().setListener(Context context,ClipboardManager.OnPrimaryClipChangedListener m_listener); ``` ### 网络监测 ``` boolean status = NetworkUtils.isNetworkConnected(Context context); ``` ### JSON字符串转对象 源码如下： ``` public static T parseJsonWithGson(String jsonData, Class type) { if(gson == null) gson = new Gson(); T result = gson.fromJson(jsonData, type); return result; } ``` 使用如下： ``` User users = GsonUtils.parseJsonWithGson("{\"id\":1,\"name\":\"董志平\"}",User.class); ``` ### 感谢以下开源项目的支持 ``` compile 'com.google.code.gson:gson:2.6.2' compile 'com.j256.ormlite:ormlite-core:4.48' compile 'com.j256.ormlite:ormlite-android:4.48' compile 'com.squareup.okhttp3:okhttp:3.9.0' compile 'com.github.bumptech.glide:glide:3.7.0' compile 'jp.wasabeef:glide-transformations:2.0.2' compile 'com.github.johnkil.android-appmsg:appmsg:1.2.0' compile 'com.lzy.net:okgo:3.0.4' compile 'top.zibin:Luban:1.1.3' https://github.com/daimajia/NumberProgressBar ```