• Stars
    star
    290
  • Rank 142,981 (Top 3 %)
  • Language
    Dart
  • License
    Apache License 2.0
  • Created almost 5 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Flutter plugin for XUpdate(Android Version Update Library)

flutter_xupdate

Version Build Status Issue Star

A Flutter plugin for XUpdate -- Android Update Library。See the use Chinese Document for details。

About me

WeChat public number juejin zhihu CSDN jianshu segmentfault bilibili toutiao
我的Android开源之旅 Click me Click me Click me Click me Click me Click me Click me

Video tutorial

How to use flutter_xupdate

Stargazers over time

Stargazers over time

Getting Started

You should ensure that you add the flutter_xupdate as a dependency in your flutter project.

// pub 集成
dependencies:
  flutter_xupdate: ^3.0.0

//github  集成
dependencies:
  flutter_xupdate:
    git:
      url: git://github.com/xuexiangjys/flutter_xupdate.git
      ref: master

UseCase

Initialization

  ///初始化
   void initXUpdate() {
     if (Platform.isAndroid) {
       FlutterXUpdate.init(
         ///是否输出日志
         debug: true,
         ///是否使用post请求
         isPost: false,
         ///post请求是否是上传json
         isPostJson: false,
         ///请求响应超时时间
         timeout: 25000,
         ///是否开启自动模式
         isWifiOnly: false,
         ///是否开启自动模式
         isAutoMode: false,
         ///需要设置的公共参数
         supportSilentInstall: false,
         ///在下载过程中,如果点击了取消的话,是否弹出切换下载方式的重试提示弹窗
         enableRetry: false
       ).then((value) {
         updateMessage("初始化成功: $value");
       }).catchError((error) {
         print(error);
       });

       FlutterXUpdate.setErrorHandler(
           onUpdateError: (Map<String, dynamic> message) async {
         print(message);
         setState(() {
           _message = "$message";
         });
       });
     } else {
       updateMessage("ios暂不支持XUpdate更新");
     }
   }

JSON Format

{
  "Code": 0, //0代表请求成功,非0代表失败
  "Msg": "", //请求出错的信息
  "UpdateStatus": 1, //0代表不更新,1代表有版本更新,不需要强制升级,2代表有版本更新,需要强制升级
  "VersionCode": 3,
  "VersionName": "1.0.2",
  "ModifyContent": "1、优化api接口。\r\n2、添加使用demo演示。\r\n3、新增自定义更新服务API接口。\r\n4、优化更新提示界面。",
  "DownloadUrl": "https://raw.githubusercontent.com/xuexiangjys/XUpdate/master/apk/xupdate_demo_1.0.2.apk",
  "ApkSize": 2048
  "ApkMd5": "..."  //md5值没有的话,就无法保证apk是否完整,每次都会重新下载。框架默认使用的是md5加密。
}

CheckUpdate

  ///默认App更新
  void checkUpdateDefault() {
    FlutterXUpdate.checkUpdate(url: _updateUrl);
  }

  ///默认App更新 + 支持后台更新
  void checkUpdateSupportBackground() {
    FlutterXUpdate.checkUpdate(url: _updateUrl, supportBackgroundUpdate: true);
  }

  ///调整宽高比
  void checkUpdateRatio() {
    FlutterXUpdate.checkUpdate(url: _updateUrl, widthRatio: 0.6);
  }

  ///强制更新
  void checkUpdateForce() {
    FlutterXUpdate.checkUpdate(url: mUpdateUrl2);
  }

  ///自动模式, 如果需要完全无人干预,自动更新,需要root权限【静默安装需要】
  void checkUpdateAutoMode() {
    FlutterXUpdate.checkUpdate(url: _updateUrl, isAutoMode: true);
  }

  ///下载时点击取消允许切换下载方式
  void enableChangeDownLoadType() {
    FlutterXUpdate.checkUpdate(
      url: _updateUrl,
      overrideGlobalRetryStrategy: true,
      enableRetry: true,
      retryContent: "Github下载速度太慢了,是否考虑切换蒲公英下载?",
      retryUrl: "https://www.pgyer.com/flutter_learn");
  }

Custom JSON Format

1.Setting up a custom update parser

FlutterXUpdate.setCustomParseHandler(onUpdateParse: (String json) async {
//Here is the custom JSON parsing
return customParseJson(json);
});

///Resolve the custom JSON content to the UpdateEntity entity class
UpdateEntity customParseJson(String json) {
  AppInfo appInfo = AppInfo.fromJson(json);
  return UpdateEntity(
      hasUpdate: appInfo.hasUpdate,
      isIgnorable: appInfo.isIgnorable,
      versionCode: appInfo.versionCode,
      versionName: appInfo.versionName,
      updateContent: appInfo.updateLog,
      downloadUrl: appInfo.apkUrl,
      apkSize: appInfo.apkSize);
}

2.Set the parameter isCustomParse to true

FlutterXUpdate.checkUpdate(url: _updateUrl3, isCustomParse: true);

Update By UpdateEntity Directly

///直接传入UpdateEntity进行更新提示
void checkUpdate8() {
    FlutterXUpdate.updateByInfo(updateEntity: customParseJson(_customJson));
}

Custom Update Prompt Style

Currently, only theme color and top picture customization are supported!

1.Configure top picture, Path: android/app/src/main/res/values/drawable, For example:

2.Set the parameter themeColortopImageRes and buttonTextColor

///自定义更新弹窗样式
void customPromptDialog() {
    FlutterXUpdate.checkUpdate(url: _updateUrl, themeColor: '#FFFFAC5D', topImageRes: 'bg_update_top', buttonTextColor: '#FFFFFFFF');
}

【Note】: When you use the command flutter build apk to make a release package, If you use the topImageRes property, you must configure shrinkResources to false, otherwise the pop-up window will display an exception!

Property value

Initialization

Name Type Default Description
debug bool false Whether Output log
isPost bool false Whether use post request
isPostJson bool false Whether post request upload json format
timeout int 20000(ms) Request response timeout
isWifiOnly bool true Whether update only under WiFi
isAutoMode bool false Whether to turn on automatic mode
supportSilentInstall bool false Whether to support silent installation requires that the device has root permission
enableRetry bool false In the process of downloading, if you click Cancel, whether the pop-up window for retrying to switch the download mode will pop up
retryContent String '' Try the prompt content of the prompt pop-up window again
retryUrl String '' Retrying prompt pop-up URL to jump after clicking
params Map / Public parameters to be set

CheckUpdate

Name Type Default Description
url String / URL of version check
params Map / Parameters
supportBackgroundUpdate bool false Whether to support background updates
isAutoMode bool false Whether to turn on automatic mode
isCustomParse bool false Is it a custom resolution protocol
themeColor String '' Apply pop-up theme color
topImageRes String '' The name of the top picture resource in the pop-up window
buttonTextColor String '' The color of the button text
widthRatio double / Proportion of version update Prompter width to screen
heightRatio double / Proportion of version update Prompter height to screen
overrideGlobalRetryStrategy bool false Whether to override the global retry policy
enableRetry bool false In the process of downloading, if you click Cancel, whether the pop-up window for retrying to switch the download mode will pop up
retryContent String '' Try the prompt content of the prompt pop-up window again
retryUrl String '' Retrying prompt pop-up URL to jump after clicking

More Repositories

1

XUI

💍A simple and elegant Android native UI framework, free your hands! (一个简洁而优雅的Android原生UI框架,解放你的双手!)
Java
4,849
star
2

XUpdate

🚀A lightweight, high availability Android version update framework.(一个轻量级、高可用性的Android版本更新框架)
Java
2,309
star
3

flutter_template

The project of the empty template with Flutter has built the basic framework to realize the functions of internationalization, theme peeling, login and registration, etc.(Flutter空壳模板工程,已搭建基础框架,实现国际化、主题换肤、登录注册、自动路由注册等功能,可在此基础上简单修改实现自己的应用功能)
Dart
897
star
4

TemplateAppProject

Android template project, fast construction (integrated XUI, XUtil, XAOP, XPage, XUpdate, XHttp2, Umeng Statistics and Walle multi-channel package). Android空壳模板工程,快速搭建(集成了XUI、XUtil、XAOP、XPage、XUpdate、XHttp2、友盟统计和walle多渠道打包)
Java
838
star
5

XPush

🚀一个轻量级、可插拔的Android消息推送框架。一键集成推送(极光推送、友盟推送、信鸽推送、华为、小米推送等),提供有效的保活机制,支持推送的拓展,充分解耦推送和业务逻辑,解放你的双手!
Java
767
star
6

XAOP

🔥A lightweight AOP(Android) application framework. Includes the most practical AOP applications.(一个轻量级的AOP(Android)应用框架。囊括了最实用的AOP应用)
Java
733
star
7

XHttp2

💪A powerful network request library, encapsulated using the RxJava2 + Retrofit2 + OKHttp combination.(一个功能强悍的网络请求库,使用RxJava2 + Retrofit2 + OKHttp组合进行封装)
Java
403
star
8

XPage

🔥A very useful Fragment page framework!(一个非常方便实用的fragment页面框架!)
Java
393
star
9

XUtil

一个方便实用的Android工具类库
Java
224
star
10

XUpdateService

Use Spring Boot easy build, Gradle build, and provide update service for XUpdate.(使用Spring Boot简易搭建,Gradle构建,为XUpdate提供更新服务)
Java
217
star
11

FlutterSample

Flutter使用指南,包含众多组件和插件的使用
Dart
205
star
12

XQRCode

A very convenient and practical qrcode scanning, analysis, generation library.(一个非常方便实用的二维码扫描、解析、生成库)
Java
193
star
13

XTask

一个拓展性极强的Android任务执行框架。可自由定义和组合任务来实现你想要的功能,尤其适用于处理复杂的业务流程,可灵活添加前置任务或者调整执行顺序。例如:应用的启动初始化流程。
Java
146
star
14

TemplateSimpleProject

简化版的Android空壳模板工程,快速搭建(集成了XUI、XUtil、XAOP、XPage、友盟统计和walle多渠道打包)
Java
131
star
15

xupdate-management

使用Vue.js编写的版本更新管理后台,为XUpdate提供版本更新管理
Vue
116
star
16

XVideo

一个能自动进行压缩的小视频录制库
C
102
star
17

XUpdateAPI

简化XUpdate的使用, 一键实现版本更新功能!
Java
92
star
18

RxUtil2

一个实用的RxJava2工具类库
Java
90
star
19

AndroidAdvancedLearning

Android进阶学习(源码分析、经验技术、感悟等)
71
star
20

XFloatView

一个简易的悬浮窗实现方案
Java
66
star
21

architect-java

成为架构师必须要看的算法实例
Java
56
star
22

TemplateAppProject-kotlin

Android空壳模板工程(kotlin版本),快速搭建(集成了XUI、XUtil、XAOP、XPage、XUpdate、XHttp2、友盟统计和walle多渠道打包)
Kotlin
56
star
23

XOrmlite

一个方便实用的OrmLite数据库框架,支持一键集成。
Java
55
star
24

react-native-xupdate

A React-Native plugin for XUpdate(Android Version Update Library)
Java
53
star
25

XHttpApi

一个简单的spring boot搭建的api服务,为XHttp提供服务支持。包括:常用的数据库数据增、删、改、查,文件上传下载,全局异常捕获、权限认证、日志记录等。
Java
50
star
26

TemplateAndServer

简化版的Android服务端模板,用于接口模拟测试。
Java
49
star
27

RxBus

一个简易的Android事件通知库,使用RxJava和Javassist设计,拒绝使用反射,保证性能高效稳定。
Java
43
star
28

Protobuf-gRPC-Android

教你如何使用ProtoBuf,通过gRPC服务在android上进行网络请求
Java
42
star
29

XRouter

一个轻量级的Android路由框架,基于ARouter上进行改良,优化Fragment的使用,可结合XPage使用。
Java
42
star
30

XLog

一个简易的日志打印框架(支持打印策略自定义,默认提供2种策略:logcat打印和磁盘打印)
Java
37
star
31

XIPC

一个Android通用的IPC(进程通信)框架。该项目主要是模仿饿了么开源项目Hermes的设计进行的自我理解改写。
Java
36
star
32

flutter_app_update_example

演示如何使用现有的flutter插件实现应用内的版本更新功能
Dart
33
star
33

flutter_update_dialog

Application version update dialog.
Dart
31
star
34

RxUtil

[DEPRECATED]囊括了最实用的RxJava工具类集合
Java
31
star
35

XMark

一个简易的埋点解决方案(基于JakeWharton的hugo基础上改造)
Java
29
star
36

RxJava3Sample

RxJava3使用演示, 包含简介、例子、日志和源码等内容。
Java
28
star
37

XTCP

一个便捷的TCP消息包拼装和解析框架
Java
24
star
38

TemplateSimpleProject-kotlin

简化版的Android空壳模版工程(kotlin版本),快速搭建(集成了XUI、XUtil、XAOP、XPage、友盟统计和walle多渠道打包)
Kotlin
22
star
39

TinkerTest

演示如何使用腾讯的热修复框架-Tinker
Java
21
star
40

MarqueeTextView

Android滚动字幕,支持动态添加和删除,支持消息数据的更新
Java
20
star
41

CloudBlindDate

云相亲,一种解决地域、时间、距离的快捷相亲方式。利用TemplateAppProject快速开发,半天完成主体功能。
Java
19
star
42

XPush-MQTT

MQTT在Android上的使用,目前已集成了XPush
Java
17
star
43

KotlinSample

Kotlin相关使用案例
Kotlin
15
star
44

AndroidPerformanceSample

Android性能优化实践
Java
14
star
45

AppAnalyticsDemo

App应用统计分析演示,集合了友盟数据统计/推送,Bugly的日志上报/更新以及美团的多渠道打包等
Java
13
star
46

XNoBug

一个轻量、高扩展性的Android日志上报框架。
Java
12
star
47

SandHookTest

SandHook在Android上的Hook应用
Java
11
star
48

OCRCamera

一个能够快速识别卡片的智能照相机,可配合百度OCR文字识别使用。
Java
9
star
49

GoogleComponentsDemo

Google Architecture Components 演示程序
Java
8
star
50

Navigation_XPage

Google官方Fragment页面框架Navigation和XPage开源框架的使用对比。
Java
8
star
51

AutoSizeTest

使用AndroidAutoSize屏幕适配演示
Java
8
star
52

UtilXX

UtilXX是Android的开源工具框架
Java
8
star
53

PhantomTest

满帮集团插件化框架Phantom使用演示
Java
8
star
54

CameraView

分别使用camera api1、api2和google的CameraView来实现照相机功能
Java
8
star
55

JPushSample

极光推送Android客户端使用指南
Java
7
star
56

UIThemeSample

Android的UI主题使用案例
Kotlin
7
star
57

JNI-CMake

Android使用CMake和Android.mk进行JNI开发演示
C++
6
star
58

WebRTC-Android

WebRTC在Android上的使用
Java
6
star
59

react-native-marquee-textview

MarqueeTextview for React Native
Java
6
star
60

TemplateSimpleProject-databinding

简化版的Android空壳模版工程(kotlin-databinding版本),快速搭建(集成了XUI、XUtil、XAOP、XPage、友盟统计和walle多渠道打包)
Kotlin
6
star
61

TemplateProject

模版空壳Android工程,快速搭建(添加了XUtil、XPage和XAOP)
Java
6
star
62

mace_demo

小米mace 深度学习框架 已经编译成功的android demo
Java
5
star
63

BuglyTest

腾讯Bugly(日志上报、运营统计、应用升级平台)接入演示demo
Java
5
star
64

AndroidStudioTemplates

Android Studio 自定义模板
FreeMarker
5
star
65

order

中小企业的订餐小系统
JavaScript
5
star
66

DeviceMonitor

监测手机或者指定应用的流量
Java
5
star
67

MyMVP

Dagger2 + Dagger2-android + ARouter + ButterKnife + MVP 的使用演示
Java
4
star
68

GreenDaoDemo

GreenDao数据库使用演示
Java
4
star
69

DataBindingSample

DataBinding使用集合
Kotlin
3
star
70

MyMVVM

ARouter + DataBinding + MVVM 的使用演示
Java
3
star
71

Resource

存放资源(图片、视频、gif等)
3
star
72

springboot-grpc-api

基于grpc-spring-boot-starter搭建起的grpc服务
Java
2
star
73

flutter_android_interactive

演示如何在android现有项目中集成flutter项目,进行混合开发
Dart
2
star
74

ComposeDemo

Compose的使用演示
Kotlin
2
star
75

XFtpClient

一个使用C++和java分别实现的FTP客户端
C++
2
star
76

TensorFlowDemo

TensorFlow在Android上使用案例的集合
Java
1
star
77

ImageProcess-Java

图片处理,使用opencv-java接口
Java
1
star
78

XSocialShare

社会化分享SDK
Java
1
star
79

uni-app-learn

uni-app 前端跨平台框架学习Demo
Vue
1
star
80

wechat-app-mall

微信小程序商城
1
star
81

SocialShareDemo

社会化分享演示
Java
1
star
82

xuexiangjys

1
star
83

VirtualApkTest

滴滴的VirtualApk插件化使用演示
Java
1
star